heroku-api 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,14 @@
+script: bundle exec rake
+
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+
+notifications:
+  email: false
+  webhooks:
+    on_success: always
+    on_failure: always
+    urls:
+      - http://dx-helper.herokuapp.com/travis

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in heroku-rb.gemspec
+gemspec

data/README.md

@@ -0,0 +1,120 @@
+Heroku Ruby Client
+==================
+
+The Heroku Ruby Client is used to interact with the Heroku API from Ruby.
+
+For more about the Heroku API see <http://api-docs.heroku.com>.
+
+[![Build Status](https://secure.travis-ci.org/heroku/heroku.rb.png)](https://secure.travis-ci.org/heroku/heroku.rb)
+
+Usage
+-----
+
+Start by creating a connection to Heroku with your credentials:
+
+    require 'heroku-rb'
+
+    heroku = Heroku.new(:api_key => API_KEY)
+
+NOTE: You can leave out the `:api_key` if `ENV['HEROKU_API_KEY']` is set instead.
+
+Now you can make requests to the api.
+
+Requests
+--------
+
+What follows is an overview of commands you can run for the client.
+
+For additional details about any of the commands, see the [API docs](http://api-docs.heroku.com).
+
+### Add-ons
+
+    heroku.delete('app', 'addon')     # remove 'addon' add-on from an 'app' app
+    heroku.get_addons                 # see a listing of all available add-ons
+    heroku.get_addons('app')          # see listing of installed add-ons for 'app' app
+    heroku.post_addon('app', 'addon') # add 'addon' add-on to 'app' app
+    heroku.put_addon('app', 'addon')  # update 'addon' add-on on 'app' app
+
+### Apps
+
+    heroku.delete_app('app')  # delete an app named 'app'
+    heroku.get_app('app')     # get info about an app named 'app'
+    heroku.get_apps           # get a list of your apps
+    heroku.post_apps          # create an app with a generated name and the default stack
+
+    heroku.post_apps('name' => 'app') # create an app with a specified name
+
+### Collaborators
+
+    delete_collaborator('app', 'email@example.com') # remove 'email@example.com' collaborator from 'app' app
+    delete_collaborator('app')                      # list collaborators for 'app' app
+    post_collaborator('app', 'email@example.com')   # add 'email@example.com' collaborator to 'app' app
+
+### Config Variables
+
+    delete_config_var('app', 'KEY')           # remove 'KEY' key from 'app' app
+    get_config_vars('app')                    # get list of config vars for 'app' app
+    put_config_vars('app', 'KEY' => 'value')  # set 'KEY' key to 'value' for 'app' app
+
+### Domains
+
+    delete_domain('app', 'example.com') # remove the 'example.com' domain from the 'app' app
+    get_domains('app')                  # list configured domains for the 'app' app
+    post_domains('app', 'example.com')  # add 'example.com' domain to the 'app' app
+
+### Keys
+
+    delete_key('user@hostname.local') # remove the 'user@hostname.local' key
+    delete_keys                       # remove all keys
+    get_keys                          # list configured keys
+    post_key('key data')              # add key defined by 'key data'
+
+### Logs
+
+    get_logs('app') # return logs information for 'app' app
+
+### Processes
+
+    get_ps('app')                             # list current processes for 'app' app
+    post_ps('app', 'command')                 # run 'command' command in context of 'app' app
+    post_ps_restart('app')                    # restart all processes for 'app' app
+    post_ps_scale('app', 'type', 'quantity')  # scale 'type' type processes to 'quantity' for 'app' app
+    post_ps_stop('app', 'ps' => 'web.1')      # stop 'web.1' process for 'app' app
+    post_ps_stop('app', 'type' => 'web')      # stop all 'web' processes for 'app' app
+    put_dynos('app', 'dynos')                 # set number of dynos for bamboo app 'app' to 'dynos'
+    put_workers('app', 'workers')             # set number of workers for bamboo app 'app' to 'workers'
+
+    post_ps_restart('app', 'ps' => 'web.1')   # restart 'web.1' process for 'app' app
+
+### Releases
+
+    get_releases('app')       # list of releases for 'app' app
+    get_release('app', 'v#')  # get details of 'v#' release for 'app' app
+    post_release('app', 'v#') # rollback 'app' app to 'v#' release
+
+### Stacks
+
+    get_stack('app')          # list available stacks
+    put_stack('app', 'stack') # migrate 'app' app to 'stack' stack
+
+
+Mock
+----
+
+For practice or testing you can also use a simulated Heroku:
+
+    require 'heroku-rb'
+
+    heroku = Heroku.new(:api_key => API_KEY, :mock => true)
+
+After that commands should still behave the same, but they will only modify some local data instead of updating the state of things on Heroku.
+
+Tests
+-----
+
+To run tests, first set `ENV['HEROKU_API_KEY']` to your api key.  Then use `bundle exec rake` to run mock tests or `MOCK=false bundle exec rake` to run integration tests.
+
+Meta
+----
+
+Released under the [MIT license](http://www.opensource.org/licenses/mit-license.php).

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |task|
+  task.name = :test
+  task.test_files = FileList['test/test*.rb']
+end
+
+task :cache, [:api_key] do |task, args|
+  unless args.api_key
+    puts('cache requires an api key, please call as `cache[api_key]`')
+  else
+    require "#{File.dirname(__FILE__)}/lib/heroku/api"
+    heroku = Heroku.new(:api_key => args.api_key)
+    data = Heroku::API::OkJson.encode(heroku.get_addons.body)
+    File.open("#{File.dirname(__FILE__)}/lib/heroku/stubs/cache/get_addons.json", 'w') do |file|
+      file.write(data)
+    end
+  end
+end

data/changelog.txt

@@ -0,0 +1,4 @@
+0.1.0 02/02/2012
+================
+
+Initial release

data/heroku-api.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "heroku/api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "heroku-api"
+  s.version     = Heroku::API::VERSION
+  s.authors     = ["geemus (Wesley Beary)"]
+  s.email       = ["wesley@heroku.com"]
+  s.homepage    = "http://github.com/heroku/heroku.rb"
+  s.summary     = %q{Ruby Client for the Heroku API}
+  s.description = %q{Ruby Client for the Heroku API}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'excon', '~>0.9.4'
+
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rake'
+end

data/lib/heroku-api.rb

@@ -0,0 +1 @@
+require "heroku/api"

data/lib/heroku/api.rb

@@ -0,0 +1,85 @@
+require "base64"
+require "cgi"
+require "excon"
+require "securerandom"
+
+require "heroku/api/vendor/okjson"
+
+require "heroku/api/errors"
+require "heroku/api/mock"
+require "heroku/api/version"
+
+require "heroku/api/addons"
+require "heroku/api/apps"
+require "heroku/api/collaborators"
+require "heroku/api/config_vars"
+require "heroku/api/domains"
+require "heroku/api/keys"
+require "heroku/api/logs"
+require "heroku/api/processes"
+require "heroku/api/releases"
+require "heroku/api/stacks"
+
+srand
+
+module Heroku
+  class API
+
+    def initialize(options={})
+      @api_key = options.delete(:api_key) || ENV['HEROKU_API_KEY']
+      user_pass = ":#{@api_key}"
+      options = {
+        :headers  => {},
+        :host     => 'api.heroku.com',
+        :scheme   => 'https'
+      }.merge(options)
+      options[:headers] = {
+        'Accept'                => 'application/json',
+        'Authorization'         => "Basic #{Base64.encode64(user_pass).gsub("\n", '')}",
+        'User-Agent'            => "heroku-rb/#{Heroku::API::VERSION}",
+        'X-Heroku-API-Version'  => '3',
+        'X-Ruby-Version'        => RUBY_VERSION,
+        'X-Ruby-Platform'       => RUBY_PLATFORM
+      }.merge(options[:headers])
+      @connection = Excon.new("#{options[:scheme]}://#{options[:host]}", options)
+    end
+
+    def request(params, &block)
+      begin
+        response = @connection.request(params, &block)
+      rescue Excon::Errors::NotFound => error
+        reerror = Heroku::API::Errors::NotFound.new(error.message)
+        reerror.set_backtrace(error.backtrace)
+        raise reerror
+      rescue Excon::Errors::Error => error
+        reerror = Heroku::API::Errors::Error.new(error.message)
+        reerror.set_backtrace(error.backtrace)
+        raise reerror
+      end
+
+      if response.body && !response.body.empty?
+        begin
+          response.body = Heroku::API::OkJson.decode(response.body)
+        rescue
+          # leave non-JSON body as is
+        end
+      end
+
+      # reset (non-persistent) connection
+      @connection.reset
+
+      response
+    end
+
+    private
+
+    def app_params(params)
+      app_params = {}
+      params.each do |key, value|
+        app_params["app[#{key}]"] = value
+      end
+      app_params
+    end
+
+  end
+end

data/lib/heroku/api/addons.rb

@@ -0,0 +1,47 @@
+module Heroku
+  class API
+
+    # DELETE /apps/:app/addons/:addon
+    def delete_addon(app, addon)
+      request(
+        :expects  => 200,
+        :method   => :delete,
+        :path     => "/apps/#{app}/addons/#{addon}"
+      )
+    end
+
+    # GET /addons
+    # GET /apps/:app/addons
+    def get_addons(app=nil)
+      path = if app
+        "/apps/#{app}/addons"
+      else
+        "/addons"
+      end
+      request(
+        :expects  => 200,
+        :method   => :get,
+        :path     => path
+      )
+    end
+
+    # POST /apps/:app/addons/:addon
+    def post_addon(app, addon)
+      request(
+        :expects  => 200,
+        :method   => :post,
+        :path     => "/apps/#{app}/addons/#{addon}"
+      )
+    end
+
+    # PUT /apps/:app/addons/:addon
+    def put_addon(app, addon)
+      request(
+        :expects  => 200,
+        :method   => :put,
+        :path     => "/apps/#{app}/addons/#{addon}"
+      )
+    end
+
+  end
+end

data/lib/heroku/api/apps.rb

@@ -0,0 +1,62 @@
+module Heroku
+  class API
+
+    # DELETE /apps/:app
+    def delete_app(app)
+      request(
+        :expects  => 200,
+        :method   => :delete,
+        :path     => "/apps/#{app}"
+      )
+    end
+
+    # GET /apps
+    def get_apps
+      request(
+        :expects  => 200,
+        :method   => :get,
+        :path     => "/apps"
+      )
+    end
+
+    # GET /apps/:app
+    def get_app(app)
+      request(
+        :expects  => 200,
+        :method   => :get,
+        :path     => "/apps/#{app}"
+      )
+    end
+
+    # POST /apps
+    def post_app(params={})
+      request(
+        :expects  => 202,
+        :method   => :post,
+        :path     => '/apps',
+        :query    => app_params(params)
+      )
+    end
+
+    # POST /apps/:app/server/maintenance
+    def post_app_server_maintenance(app, new_server_maintenance)
+      request(
+        :expects  => 200,
+        :method   => :post,
+        :path     => "/apps/#{app}/server/maintenance",
+        :query    => {'maintenance_mode' => maintenance_mode}
+      )
+    end
+
+    # PUT /apps/:app
+    def put_app(app, params)
+      request(
+        :expects  => 200,
+        :method   => :put,
+        :path     => "/apps/#{app}",
+        :query    => app_params(params)
+      )
+    end
+
+  end
+end

data/lib/heroku/api/collaborators.rb

@@ -0,0 +1,33 @@
+module Heroku
+  class API
+
+    # DELETE /apps/:app/collaborators/:email
+    def delete_collaborator(app, email)
+      request(
+        :expects  => 200,
+        :method   => :delete,
+        :path     => "/apps/#{app}/collaborators/#{email}"
+      )
+    end
+
+    # GET /apps/:app/collaborators
+    def get_collaborators(app)
+      request(
+        :expects  => 200,
+        :method   => :get,
+        :path     => "/apps/#{app}/collaborators"
+      )
+    end
+
+    # POST /apps/:app/collaborators
+    def post_collaborator(app, email)
+      request(
+        :expects  => 200,
+        :method   => :post,
+        :path     => "/apps/#{app}/collaborators",
+        :query    => {'collaborator[email]' => email}
+      )
+    end
+
+  end
+end

data/lib/heroku/api/config_vars.rb

@@ -0,0 +1,33 @@
+module Heroku
+  class API
+
+    # DELETE /apps/:app/config_vars/:key
+    def delete_config_var(app, key)
+      request(
+        :expects  => 200,
+        :method   => :delete,
+        :path     => "/apps/#{app}/config_vars/#{key}"
+      )
+    end
+
+    # GET /apps/:app/config_vars
+    def get_config_vars(app)
+      request(
+        :expects  => 200,
+        :method   => :get,
+        :path     => "/apps/#{app}/config_vars"
+      )
+    end
+
+    # PUT /apps/:app/config_vars
+    def put_config_vars(app, vars)
+      request(
+        :body     => Heroku::API::OkJson.encode(vars),
+        :expects  => 200,
+        :method   => :put,
+        :path     => "/apps/#{app}/config_vars"
+      )
+    end
+
+  end
+end