Class Heroku::Client
In: lib/heroku/client.rb
Parent: Object

A Ruby class to call the Heroku REST API. You might use this if you want to manage your Heroku apps from within a Ruby program, such as Capistrano.

Example:

  require 'heroku'
  heroku = Heroku::Client.new('me@example.com', 'mypass')
  heroku.create('myapp')

Methods

Included Modules

Heroku::Helpers

Classes and Modules

Module Heroku::Client::JSON
Class Heroku::Client::AppCrashed
Class Heroku::Client::ConsoleSession
Class Heroku::Client::Service

Attributes

host  [RW] 
password  [RW] 
user  [RW] 

Public Class methods

Public Instance methods

Invite a person by email address to collaborate on the app.

Add an ssh public key to the current user.

Capture a bundle from the given app, as a backup or for download.

Get a temporary URL where the bundle can be downloaded. If bundle_name is nil it will use the most recently captured bundle for the app

Get a list of bundles of the app.

Create a new app, with an optional name.

Fetch recent cron logs from the app server.

Destroy the app permanently.

downgrade_addon(app_name, addon, config={})

Alias for upgrade_addon

Show info such as mode, custom domain, and collaborators on an app.

Get the list of ssh public keys for the current user.

Show a list of apps which you are a collaborator on.

Get a list of collaborators on the app, returns an array of hashes each with :email

Get a list of stacks available to the app, with the current one marked.

Fetch recent logs from the app server.

Request a stack migration.

Retreive ps list for the given app name.

Run a rake command on the Heroku app and return all output as a string.

Clear all keys on the current user.

Remove an existing ssh public key from the current user.

Restart the app servers.

internal method to run console commands formatting the output

Get a Service instance to execute commands against.

Scales the web processes.

Scales the background processes.

Run a service. If Responds to each and yields output as it‘s received.

Update an app. Available attributes:

  :name => rename the app (changes http and git urls)

[Validate]