heroku-api 0.3.7 → 0.3.8

data/README.md

@@ -16,6 +16,7 @@ Start by creating a connection to Heroku with your credentials:
 
     heroku = Heroku::API.new(:api_key => API_KEY)                           # use API Key
     heroku = Heroku::API.new(:username => USERNAME, :password => PASSWORD)  # use username and password
+    heroku = Heroku::API.new(:headers => {'User-Agent' => 'custom'})        # use custom header
 
 NOTE: You can leave out the `:api_key` if `ENV['HEROKU_API_KEY']` is set instead.
 
@@ -30,39 +31,39 @@ For additional details about any of the commands, see the [API docs](http://api-
 
 ### Add-ons
 
-    heroku.delete_addon('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
+    heroku.delete_addon(APP, ADD_ON)    # remove the ADD_ON add-on from the app named APP
+    heroku.post_addon(APP, ADD_ON)      # add ADD_ON add-on to an the app named APP
+    heroku.put_addon(APP, ADD_ON)       # update the ADD_ON add-on on the app named APP
+    heroku.get_addons                   # see a listing of all available add-ons
+    heroku.get_addons(APP)              # see listing of installed add-ons for the app named APP
 
 ### Apps
 
-    heroku.delete_app('app')                # delete an app named 'app'
+    heroku.delete_app(APP)                  # delete the app named APP
     heroku.get_apps                         # get a list of your apps
-    heroku.get_app('app')                   # get info about an app named 'app'
+    heroku.get_app(APP)                     # get info about the app named APP
     heroku.post_app                         # create an app with a generated name and the default stack
-    heroku.post_app('name' => 'app')        # create an app with a specified name
-    heroku.post_app_maintenance('app', '1') # toggle maintenance mode
+    heroku.post_app_maintenance(APP, '1')   # toggle maintenance mode for the app named APP
+    heroku.post_app('name' => 'app')        # create an app with a specified name, APP
     heroku.put_app('name' => 'myapp')       # update an app to have a different name
 
 ### Collaborators
 
-    heroku.delete_collaborator('app', 'email@example.com') # remove 'email@example.com' collaborator from 'app' app
-    heroku.get_collaborators('app')                        # list collaborators for 'app' app
-    heroku.post_collaborator('app', 'email@example.com')   # add 'email@example.com' collaborator to 'app' app
+    heroku.delete_collaborator(APP, 'email@example.com')   # remove 'email@example.com' collaborator from APP app
+    heroku.get_collaborators(APP)                          # list collaborators for APP app
+    heroku.post_collaborator(APP, 'email@example.com')     # add 'email@example.com' collaborator to APP app
 
 ### Config Variables
 
-    heroku.delete_config_var('app', 'KEY')           # remove 'KEY' key from 'app' app
-    heroku.get_config_vars('app')                    # get list of config vars for 'app' app
-    heroku.put_config_vars('app', 'KEY' => 'value')  # set 'KEY' key to 'value' for 'app' app
+    heroku.delete_config_var(APP, KEY)               # remove KEY key from APP app
+    heroku.get_config_vars(APP)                      # get list of config vars for APP app
+    heroku.put_config_vars(APP, KEY => 'value')      # set KEY key to 'value' for APP app
 
 ### Domains
 
-    heroku.delete_domain('app', 'example.com') # remove the 'example.com' domain from the 'app' app
-    heroku.get_domains('app')                  # list configured domains for the 'app' app
-    heroku.post_domain('app', 'example.com')  # add 'example.com' domain to the 'app' app
+    heroku.delete_domain(APP, 'example.com')   # remove the 'example.com' domain from the APP app
+    heroku.get_domains(APP)                    # list configured domains for the APP app
+    heroku.post_domain(APP, 'example.com')     # add 'example.com' domain to the APP app
 
 ### Keys
 
@@ -73,31 +74,31 @@ For additional details about any of the commands, see the [API docs](http://api-
 
 ### Logs
 
-    heroku.get_logs('app') # return logs information for 'app' app
+    heroku.get_logs(APP) # return logs information for APP app
 
 ### Processes
 
-    heroku.get_ps('app')                             # list current processes for 'app' app
-    heroku.post_ps('app', 'command')                 # run 'command' command in context of 'app' app
-    heroku.post_ps_restart('app')                    # restart all processes for 'app' app
-    heroku.post_ps_scale('app', 'type', 'quantity')  # scale 'type' type processes to 'quantity' for 'app' app
-    heroku.post_ps_stop('app', 'ps' => 'web.1')      # stop 'web.1' process for 'app' app
-    heroku.post_ps_stop('app', 'type' => 'web')      # stop all 'web' processes for 'app' app
-    heroku.put_dynos('app', 'dynos')                 # set number of dynos for bamboo app 'app' to 'dynos'
-    heroku.put_workers('app', 'workers')             # set number of workers for bamboo app 'app' to 'workers'
-
-    heroku.post_ps_restart('app', 'ps' => 'web.1')   # restart 'web.1' process for 'app' app
-
+    heroku.get_ps(APP)                               # list current processes for APP app
+    heroku.post_ps(APP, 'command')                   # run 'command' command in context of APP app
+    heroku.post_ps_restart(APP)                      # restart all processes for APP app
+    heroku.post_ps_scale(APP, TYPE, QTY)             # scale TYPE type processes to QTY for APP app
+    heroku.post_ps_stop(APP, 'ps' => 'web.1')        # stop 'web.1' process for APP app
+    heroku.post_ps_stop(APP, 'type' => 'web')        # stop all 'web' processes for APP app
+    heroku.post_ps_restart(APP, 'ps' => 'web.1')     # restart 'web.1' process for APP app
+    heroku.put_dynos(APP, DYNOS)                     # set number of dynos for bamboo app APP to DYNOS
+    heroku.put_workers(APP, WORKERS)                 # set number of workers for bamboo app APP to WORKERS
+    heroku.post_ps_scale(APP, 'worker', WORKERS)     # set number of workers for cedar app APP to WORKERS
+    
 ### Releases
 
-    heroku.get_releases('app')       # list of releases for 'app' app
-    heroku.get_release('app', 'v#')  # get details of 'v#' release for 'app' app
-    heroku.post_release('app', 'v#') # rollback 'app' app to 'v#' release
+    heroku.get_releases(APP)       # list of releases for the APP app
+    heroku.get_release(APP, 'v#')  # get details of 'v#' release for APP app
+    heroku.post_release(APP, 'v#') # rollback APP app to 'v#' release
 
 ### Stacks
 
-    heroku.get_stack('app')          # list available stacks
-    heroku.put_stack('app', 'stack') # migrate 'app' app to 'stack' stack
+    heroku.get_stack(APP)          # list available stacks
+    heroku.put_stack(APP, STACK) # migrate APP app to STACK stack
 
 ### User
 

data/changelog.txt

@@ -1,3 +1,14 @@
+0.3.8 02/27/2012
+================
+
+document custom headers
+remove SHARED_DATABASE from mocks
+clarify cedar scaling
+clarify README examples
+return more helpful error for blank app
+add legacy tier to mocks
+
+
 0.3.7 11/19/2012
 ================
 

data/lib/heroku/api.rb

@@ -77,7 +77,12 @@ module Heroku
           when 401 then Heroku::API::Errors::Unauthorized
           when 402 then Heroku::API::Errors::VerificationRequired
           when 403 then Heroku::API::Errors::Forbidden
-          when 404 then Heroku::API::Errors::NotFound
+          when 404
+            if error.request[:path].match /\/apps\/\/.*/
+              Heroku::API::Errors::NilApp
+            else
+              Heroku::API::Errors::NotFound
+            end
           when 408 then Heroku::API::Errors::Timeout
           when 422 then Heroku::API::Errors::RequestFailed
           when 423 then Heroku::API::Errors::Locked

data/lib/heroku/api/errors.rb

@@ -19,6 +19,8 @@ module Heroku
       class Timeout < ErrorWithResponse; end
       class Locked < ErrorWithResponse; end
       class RequestFailed < ErrorWithResponse; end
+      class NilApp < ErrorWithResponse; end
+
     end
   end
 end

data/lib/heroku/api/mock.rb

@@ -52,8 +52,7 @@ module Heroku
             'BUNDLE_WITHOUT'      => 'development:test',
             'DATABASE_URL'        => 'postgres://username:password@ec2-123-123-123-123.compute-1.amazonaws.com/username',
             'LANG'                => 'en_US.UTF-8',
-            'RACK_ENV'            => 'production',
-            'SHARED_DATABASE_URL' => 'postgres://username:password@ec2-123-123-123-123.compute-1.amazonaws.com/username'
+            'RACK_ENV'            => 'production'
           }
         else
           {}

data/lib/heroku/api/mock/apps.rb

@@ -78,6 +78,7 @@ module Heroku
             'owner_email'         => 'email@example.com',
             'slug_size'           => nil,
             'stack'               => stack,
+            'tier'                => "legacy",
             'requested_stack'     => nil,
             'git_url'             => "git@heroku.com:#{app}.git",
             'repo_migrate_status' => 'complete',

data/lib/heroku/api/mock/domains.rb

@@ -36,6 +36,9 @@ module Heroku
         end
       end
 
+      # stub DELETE /apps//domains/:domain
+      Excon.stub({:method => :delete, :path => %r{^/apps//domains/([^/]+)$} }, {:status => 404})
+
       # stub GET /apps/:app/domains
       Excon.stub(:expects => 200, :method => :get, :path => %r{^/apps/([^/]+)/domains$} ) do |params|
         request_params, mock_data = parse_stub_params(params)

data/lib/heroku/api/version.rb

@@ -1,5 +1,5 @@
 module Heroku
   class API
-    VERSION = "0.3.7"
+    VERSION = "0.3.8"
   end
 end

data/test/test_error_conditions.rb

@@ -0,0 +1,11 @@
+require File.expand_path("#{File.dirname(__FILE__)}/test_helper")
+
+class TestErrorConditions < MiniTest::Unit::TestCase
+
+  def test_request_without_app_returns_a_sensible_error
+    assert_raises(Heroku::API::Errors::NilApp) do
+      heroku.delete_domain("", 'example.com')
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroku-api
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-19 00:00:00.000000000 Z
+date: 2013-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -119,6 +119,7 @@ files:
 - test/test_collaborators.rb
 - test/test_config_vars.rb
 - test/test_domains.rb
+- test/test_error_conditions.rb
 - test/test_features.rb
 - test/test_helper.rb
 - test/test_keys.rb
@@ -141,12 +142,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2193435040644309504
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2193435040644309504
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -162,6 +169,7 @@ test_files:
 - test/test_collaborators.rb
 - test/test_config_vars.rb
 - test/test_domains.rb
+- test/test_error_conditions.rb
 - test/test_features.rb
 - test/test_helper.rb
 - test/test_keys.rb
@@ -172,4 +180,3 @@ test_files:
 - test/test_ssl_endpoints.rb
 - test/test_stacks.rb
 - test/test_user.rb
-has_rdoc: