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

add_collaborator   add_config_vars   add_domain   add_drain   add_key   add_ssl   addons   auth   bounce   bundle_capture   bundle_destroy   bundle_download   bundle_url   bundles   clear_config_vars   clear_drains   clear_ssl   config_vars   confirm_billing   console   create   create_complete?   create_request   cron_logs   database_reset   database_session   destroy   down   downgrade_addon   extract_warning   gem_version_string   httpcache_purge   info   install_addon   installed_addons   keys   list   list_collaborators   list_domains   list_drains   list_stacks   logs   maintenance   migrate_to_stack   new   on_warning   process   ps   rake   read_logs   release   releases   remove_all_keys   remove_collaborator   remove_config_var   remove_domain   remove_domains   remove_drain   remove_key   remove_ssl   resource   restart   rollback   run_console_command   service   set_dynos   set_workers   start   uninstall_addon   up   update   upgrade_addon   version  

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

add_collaborator(app_name, email)

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

add_key(key)

Add an ssh public key to the current user.

bundle_capture(app_name, bundle_name=nil)

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

bundle_url(app_name, bundle_name=nil)

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

bundles(app_name)

Get a list of bundles of the app.

create(name=nil, options={})

Create a new app, with an optional name.

cron_logs(app_name)

Fetch recent cron logs from the app server.

destroy(name)

Destroy the app permanently.

downgrade_addon(app_name, addon, config={})

Alias for upgrade_addon

info(name_or_domain)

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

keys()

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

list()

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

list_collaborators(app_name)

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

list_stacks(app_name, options={})

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

logs(app_name)

Fetch recent logs from the app server.

migrate_to_stack(app_name, stack)

Request a stack migration.

ps(app_name)

Retreive ps list for the given app name.

rake(app_name, cmd)

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

remove_all_keys()

Clear all keys on the current user.

remove_key(key)

Remove an existing ssh public key from the current user.

restart(app_name)

Restart the app servers.

run_console_command(url, command, prefix=nil)

internal method to run console commands formatting the output

service(app_name, upid)

Get a Service instance to execute commands against.

set_dynos(app_name, qty)

Scales the web processes.

set_workers(app_name, qty)

Scales the background processes.

start(app_name, command, attached=false)

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

update(name, attributes)

Update an app. Available attributes: 

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

[Validate]