Build Status

Heroku::Client

Client for accessing heroku api from ruby applications

Installation

Add this line to your application's Gemfile:

gem 'heroku-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install heroku-client

Usage

Create a new client:

client = Heroku::Client.create "your_api_key"

Get all your apps:

client.apps

You can iterate over apps:

client.apps.each { |a| puts a.name }

Get one app by name:

client.apps "example_app"

Get colaborators for an app

client.collaborators "example_app"

Get config vars for an app

client.config_vars "example_app"

Get domains for an app

client.domains "example_app"

Get user keys

client.keys

Get processes for an app

client.processes "example_app"

Get releases for an app

client.releases "example_app"

Get available stacks for an app

client.stacks "example_app"

For more examples of usage, look at the spec folder: api_spec.rb

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request