heroku-api 0.1.0 → 0.1.1

data/README.md

@@ -12,9 +12,9 @@ Usage
 
 Start by creating a connection to Heroku with your credentials:
 
-    require 'heroku-rb'
+    require 'heroku-api'
 
-    heroku = Heroku.new(:api_key => API_KEY)
+    heroku = Heroku::API.new(:api_key => API_KEY)
 
 NOTE: You can leave out the `:api_key` if `ENV['HEROKU_API_KEY']` is set instead.
 
@@ -37,17 +37,17 @@ For additional details about any of the commands, see the [API docs](http://api-
 
 ### 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
+    heroku.delete_app('app')                # delete an app named 'app'
+    heroku.get_apps                         # get a list of your apps
+    heroku.get_app('app')                   # get info about an 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
 
 ### Collaborators
 
     delete_collaborator('app', 'email@example.com') # remove 'email@example.com' collaborator from 'app' app
-    delete_collaborator('app')                      # list collaborators for 'app' app
+    get_collaborators('app')                        # list collaborators for 'app' app
     post_collaborator('app', 'email@example.com')   # add 'email@example.com' collaborator to 'app' app
 
 ### Config Variables
@@ -97,15 +97,18 @@ For additional details about any of the commands, see the [API docs](http://api-
     get_stack('app')          # list available stacks
     put_stack('app', 'stack') # migrate 'app' app to 'stack' stack
 
+### User
+
+    get_user                  # list user info
 
 Mock
 ----
 
 For practice or testing you can also use a simulated Heroku:
 
-    require 'heroku-rb'
+    require 'heroku-api'
 
-    heroku = Heroku.new(:api_key => API_KEY, :mock => true)
+    heroku = Heroku::API.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.
 

data/Rakefile

@@ -14,7 +14,7 @@ task :cache, [:api_key] do |task, args|
     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)
+    heroku = Heroku::API.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)

data/changelog.txt

@@ -1,3 +1,14 @@
+0.1.1 04/06/2012
+================
+
+readme/docs updates and fixes
+add get_user method
+request/use gzip responses
+update vendored okjson
+allow passing config data to addon install
+fix STACK usage in mocks
+bump excon dep
+
 0.1.0 02/02/2012
 ================
 

data/heroku-api.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   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_runtime_dependency 'excon', '~>0.13.3'
 
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'rake'

data/lib/heroku-api.rb

@@ -1 +1 @@
-require "heroku/api"
+require(File.join(File.dirname(__FILE__), "heroku", "api"))

data/lib/heroku/api.rb

@@ -2,6 +2,13 @@ require "base64"
 require "cgi"
 require "excon"
 require "securerandom"
+require "stringio"
+require "zlib"
+
+__LIB_DIR__ = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+unless $LOAD_PATH.include?(__LIB_DIR__)
+  $LOAD_PATH.unshift(__LIB_DIR__)
+end
 
 require "heroku/api/vendor/okjson"
 
@@ -19,6 +26,7 @@ require "heroku/api/logs"
 require "heroku/api/processes"
 require "heroku/api/releases"
 require "heroku/api/stacks"
+require "heroku/api/user"
 
 srand
 
@@ -35,6 +43,8 @@ module Heroku
       }.merge(options)
       options[:headers] = {
         'Accept'                => 'application/json',
+        'Accept-Encoding'       => 'gzip',
+        #'Accept-Language'       => 'en-US, en;q=0.8',
         'Authorization'         => "Basic #{Base64.encode64(user_pass).gsub("\n", '')}",
         'User-Agent'            => "heroku-rb/#{Heroku::API::VERSION}",
         'X-Heroku-API-Version'  => '3',
@@ -58,6 +68,7 @@ module Heroku
       end
 
       if response.body && !response.body.empty?
+        response.body = Zlib::GzipReader.new(StringIO.new(response.body)).read
         begin
           response.body = Heroku::API::OkJson.decode(response.body)
         rescue
@@ -81,5 +92,8 @@ module Heroku
       app_params
     end
 
+    def addon_params(params)
+      {:config => params}
+    end
   end
 end

data/lib/heroku/api/addons.rb

@@ -26,22 +26,23 @@ module Heroku
     end
 
     # POST /apps/:app/addons/:addon
-    def post_addon(app, addon)
+    def post_addon(app, addon, config = {})
       request(
         :expects  => 200,
         :method   => :post,
-        :path     => "/apps/#{app}/addons/#{addon}"
+        :path     => "/apps/#{app}/addons/#{addon}",
+        :query    => addon_params(config)
       )
     end
 
     # PUT /apps/:app/addons/:addon
-    def put_addon(app, addon)
+    def put_addon(app, addon, config = {})
       request(
         :expects  => 200,
         :method   => :put,
-        :path     => "/apps/#{app}/addons/#{addon}"
+        :path     => "/apps/#{app}/addons/#{addon}",
+        :query    => addon_params(config)
       )
     end
-
   end
 end

data/lib/heroku/api/apps.rb

@@ -39,7 +39,7 @@ module Heroku
     end
 
     # POST /apps/:app/server/maintenance
-    def post_app_server_maintenance(app, new_server_maintenance)
+    def post_app_maintenance(app, maintenance_mode)
       request(
         :expects  => 200,
         :method   => :post,

data/lib/heroku/api/mock.rb

@@ -8,6 +8,7 @@ require 'heroku/api/mock/logs'
 require 'heroku/api/mock/processes'
 require 'heroku/api/mock/releases'
 require 'heroku/api/mock/stacks'
+require 'heroku/api/mock/user'
 
 module Heroku
   class API
@@ -26,7 +27,8 @@ module Heroku
           :keys             => [],
           :maintenance_mode => [],
           :ps               => {},
-          :releases         => {}
+          :releases         => {},
+          :user             => {}
         }
       end
 
@@ -120,6 +122,18 @@ module Heroku
         end
       end
 
+      def self.gzip(string)
+        io = StringIO.new
+        gzip = Zlib::GzipWriter.new(io)
+        gzip.write(string)
+        gzip.close
+        io.string
+      end
+
+      def self.json_gzip(string)
+        gzip(Heroku::API::OkJson.encode(string))
+      end
+
       def self.parse_stub_params(params)
         api_key = Base64.decode64(params[:headers]['Authorization']).split(':').last
 

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

@@ -14,24 +14,24 @@ module Heroku
               # addon is currently installed
               remove_mock_app_addon(mock_data, app, addon)
               {
-                :body   => Heroku::API::OkJson.encode({
-                  :message  => nil,
-                  :price    => get_mock_addon_price(mock_data, addon),
-                  :status   => 'Uninstalled'
+                :body   => Heroku::API::Mock::json_gzip({
+                  "message" => nil,
+                  "price"   => get_mock_addon_price(mock_data, addon),
+                  "status"  => 'Uninstalled'
                 }),
                 :status => 200
               }
             else
               # addon is not currently installed
               {
-                :body   => Heroku::API::OkJson.encode({'error' => "The add-on #{addon} is not installed for this app. Did you mean:\n\t#{addon_names.join("\n\t")}"}),
+                :body   => Heroku::API::Mock.json_gzip({'error' => "The add-on #{addon} is not installed for this app. Did you mean:\n\t#{addon_names.join("\n\t")}"}),
                 :status => 422
               }
             end
           else
             # addon does not exist
             {
-              :body   => Heroku::API::OkJson.encode({'error' => "Could not find add-on #{addon}. Did you mean:\n\t#{addon_names.join("\n\t")}"}),
+              :body   => Heroku::API::Mock.json_gzip({'error' => "Could not find add-on #{addon}. Did you mean:\n\t#{addon_names.join("\n\t")}"}),
               :status => 422
             }
           end
@@ -42,7 +42,7 @@ module Heroku
       Excon.stub(:expects => 200, :method => :get, :path => "/addons") do |params|
         request_params, mock_data = parse_stub_params(params)
         {
-          :body   => File.read("#{File.dirname(__FILE__)}/cache/get_addons.json"),
+          :body   => Heroku::API::Mock.gzip(File.read("#{File.dirname(__FILE__)}/cache/get_addons.json")),
           :status => 200
         }
       end
@@ -53,7 +53,7 @@ module Heroku
         app, _ = request_params[:captures][:path]
         with_mock_app(mock_data, app) do
           {
-            :body   => Heroku::API::OkJson.encode(mock_data[:addons][app].map {|addon| addon['configured'] = true; addon}),
+            :body   => Heroku::API::Mock.json_gzip(mock_data[:addons][app].map {|addon| addon['configured'] = true; addon}),
             :status => 200
           }
         end
@@ -72,31 +72,31 @@ module Heroku
                 # addon is not currently installed
                 add_mock_app_addon(mock_data, app, addon)
                 {
-                  :body   => Heroku::API::OkJson.encode({
-                    :message  => nil,
-                    :price    => get_mock_addon_price(mock_data, addon),
-                    :status   => 'Installed'
+                  :body   => Heroku::API::Mock.json_gzip({
+                    "message" => nil,
+                    "price"   => get_mock_addon_price(mock_data, addon),
+                    "status"  => 'Installed'
                   }),
                   :status => 200
                 }
               else
                 # addon is currently installed
                 {
-                  :body   => Heroku::API::OkJson.encode({'error' => "Add-on already installed."}),
+                  :body   => Heroku::API::Mock.json_gzip({'error' => "Add-on already installed."}),
                   :status => 422
                 }
               end
             else
               # addon of same type exists
               {
-                :body   => Heroku::API::OkJson.encode({'error' => "#{app_addon_type_data['name']} add-on already added.\nTo upgrade, use addons:upgrade instead.\n"}),
+                :body   => Heroku::API::Mock.json_gzip({'error' => "#{app_addon_type_data['name']} add-on already added.\nTo upgrade, use addons:upgrade instead.\n"}),
                 :status => 422
               }
             end
           else
             # addon does not exist
             {
-              :body   => Heroku::API::OkJson.encode({'error' => "Add-on not found."}),
+              :body   => Heroku::API::Mock.json_gzip({'error' => "Add-on not found."}),
               :status => 422
             }
           end
@@ -117,31 +117,31 @@ module Heroku
                 mock_data[:addons][app].delete(app_addon_data)
                 add_mock_app_addon(mock_data, app, addon)
                 {
-                  :body   => Heroku::API::OkJson.encode({
-                    :message  => nil,
-                    :price    => get_mock_addon_price(mock_data, addon),
-                    :status   => 'Updated'
+                  :body   => Heroku::API::Mock.json_gzip({
+                    "message" => nil,
+                    "price"   => get_mock_addon_price(mock_data, addon),
+                    "status"  => 'Updated'
                   }),
                   :status => 200
                 }
               else
                 # addon is currently installed
                 {
-                  :body   => Heroku::API::OkJson.encode({'error' => "Add-on already installed."}),
+                  :body   => Heroku::API::Mock.json_gzip({'error' => "Add-on already installed."}),
                   :status => 422
                 }
               end
             else
               # addon of same type not installed
               {
-                :body   => Heroku::API::OkJson.encode({'error' => "Can't upgrade, no #{addon.split(':').join(' ')} add-on has been added.\nTo add, use addons:add instead.\n"}),
+                :body   => Heroku::API::Mock.json_gzip({'error' => "Can't upgrade, no #{addon.split(':').join(' ')} add-on has been added.\nTo add, use addons:add instead.\n"}),
                 :status => 422
               }
             end
           else
             # addon does not exist
             {
-              :body   => Heroku::API::OkJson.encode({'error' => "Add-on not found."}),
+              :body   => Heroku::API::Mock.json_gzip({'error' => "Add-on not found."}),
               :status => 422
             }
           end

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

@@ -15,7 +15,7 @@ module Heroku
           mock_data[:ps].delete(app)
           mock_data[:releases].delete(app)
           {
-            :body   => Heroku::API::OkJson.encode({}),
+            :body   => Heroku::API::Mock.json_gzip({}),
             :status => 200
           }
         end
@@ -25,7 +25,7 @@ module Heroku
       Excon.stub(:expects => 200, :method => :get, :path => '/apps') do |params|
         request_params, mock_data = parse_stub_params(params)
         {
-          :body   => Heroku::API::OkJson.encode(mock_data[:apps]),
+          :body   => Heroku::API::Mock.json_gzip(mock_data[:apps]),
           :status => 200
         }
       end
@@ -36,7 +36,7 @@ module Heroku
         app, _ = request_params[:captures][:path]
         with_mock_app(mock_data, app) do |app_data|
           {
-            :body   => Heroku::API::OkJson.encode(app_data),
+            :body   => Heroku::API::Mock.json_gzip(app_data),
             :status => 200
           }
         end
@@ -49,7 +49,7 @@ module Heroku
 
         if get_mock_app(mock_data, app)
           {
-            :body => Heroku::API::OkJson.encode('error' => 'Name is already taken'),
+            :body => Heroku::API::Mock.json_gzip('error' => 'Name is already taken'),
             :status => 422
           }
         else
@@ -61,7 +61,7 @@ module Heroku
             'name'                => app,
             'owner_email'         => 'email@example.com',
             'slug_size'           => nil,
-            'stack'               => request_params[:query].has_key?('app[stack]') && request_params[:query]['app[stack]'] || 'bamboo-mri-1.9.2',
+            'stack'               => stack,
             'requested_stack'     => nil,
             'git_url'             => "git@heroku.com:#{app}.git",
             'repo_migrate_status' => 'complete',
@@ -112,7 +112,7 @@ module Heroku
           end
 
           {
-            :body   => Heroku::API::OkJson.encode(app_data),
+            :body   => Heroku::API::Mock.json_gzip(app_data),
             :status => 202
           }
         end
@@ -154,12 +154,12 @@ module Heroku
           end
           if email && !collaborator
             {
-              :body   => Heroku::API::OkJson.encode('error' => 'Only existing collaborators can receive ownership for an app'),
+              :body   => Heroku::API::Mock.json_gzip('error' => 'Only existing collaborators can receive ownership for an app'),
               :status => 422
             }
           else
             {
-              :body   => Heroku::API::OkJson.encode('name' => app_data['name']),
+              :body   => Heroku::API::Mock.json_gzip('name' => app_data['name']),
               :status => 200
             }
           end
@@ -173,7 +173,7 @@ module Heroku
 
         with_mock_app(mock_data, app) do |app_data|
           {
-            :body   => Heroku::API::OkJson.encode({}),
+            :body   => Heroku::API::Mock.json_gzip({}),
             :status => 201
           }
         end

data/lib/heroku/api/mock/cache/get_user.json

@@ -0,0 +1 @@
+{"created_at":"2011/10/24 12:23:54 -0700","last_login":"2012/03/01 18:09:06 -0800","id":"123456@users.heroku.com","email":"user@example.com"}

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

@@ -10,11 +10,11 @@ module Heroku
           if collaborator_data = get_mock_collaborator(mock_data, app, email)
             mock_data[:collaborators][app].delete(collaborator_data)
             {
-              :body => "#{email} has been removed as collaborator on #{app}",
+              :body => Heroku::API::Mock.gzip("#{email} has been removed as collaborator on #{app}"),
               :status => 200
             }
           else
-            { :body => 'User not found.', :status => 404 }
+            { :body => Heroku::API::Mock.gzip('User not found.'), :status => 404 }
           end
         end
       end
@@ -25,7 +25,7 @@ module Heroku
         app, _ = request_params[:captures][:path]
         with_mock_app(mock_data, app) do
           {
-            :body   => Heroku::API::OkJson.encode(mock_data[:collaborators][app]),
+            :body   => Heroku::API::Mock.json_gzip(mock_data[:collaborators][app]),
             :status => 200
           }
         end
@@ -39,7 +39,7 @@ module Heroku
         with_mock_app(mock_data, app) do
           mock_data[:collaborators][app] |= [{'access' => 'edit', 'email' => email}]
           {
-            :body   => "#{email} added as a collaborator on #{app}.",
+            :body   => Heroku::API::Mock.gzip("#{email} added as a collaborator on #{app}."),
             :status => 200
           }
           # Existing user response