azuki-api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: afe6065c77aea82ac2829a163db1aa4b4d41ab64
+  data.tar.gz: a97499242dae8deb99b16754546300668a82380e
+SHA512:
+  metadata.gz: f5a0b3f09c2b808c5344f9e1e67ccef35c3e78685ab05774285e44765d6fbddf4812c88b6920dcea0012e2ac243fd4efddd7e048ca65b4ae1a5cbf00f9a17b43
+  data.tar.gz: 1dae8a18e0af5d66c5440bab57a12e222376c122feeda30f44b12a4d16ee13e347bab9bec03a8a09118b4dff9f9b16944ff7d63bb8623d0e1f99c1094dac5589

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,128 @@
+Azuki Ruby Client
+==================
+
+The Azuki Ruby Client is used to interact with the Azuki API from Ruby.
+
+For more about the Azuki API see <http://api-docs.azukiapp.com>.
+
+[![Build Status](https://travis-ci.org/azukiapp/azuki-api-ruby.png)](https://travis-ci.org/azukiapp/azuki-api-ruby)
+
+Usage
+-----
+
+Start by creating a connection to Azuki with your credentials:
+
+    require 'azuki-api'
+
+    azuki = Azuki::API.new(:api_key => API_KEY)                           # use API Key
+    azuki = Azuki::API.new(:username => USERNAME, :password => PASSWORD)  # use username and password
+    azuki = Azuki::API.new(:headers => {'User-Agent' => 'custom'})        # use custom header
+
+NOTE: You can leave out the `:api_key` if `ENV['AZUKI_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.azukiapp.com).
+
+### Add-ons
+
+    azuki.delete_addon(APP, ADD_ON)    # remove the ADD_ON add-on from the app named APP
+    azuki.post_addon(APP, ADD_ON)      # add ADD_ON add-on to an the app named APP
+    azuki.put_addon(APP, ADD_ON)       # update the ADD_ON add-on on the app named APP
+    azuki.get_addons                   # see a listing of all available add-ons
+    azuki.get_addons(APP)              # see listing of installed add-ons for the app named APP
+
+### Apps
+
+    azuki.delete_app(APP)                  # delete the app named APP
+    azuki.get_apps                         # get a list of your apps
+    azuki.get_app(APP)                     # get info about the app named APP
+    azuki.post_app                         # create an app with a generated name and the default stack
+    azuki.post_app_maintenance(APP, '1')   # toggle maintenance mode for the app named APP
+    azuki.post_app('name' => 'app')        # create an app with a specified name, APP
+    azuki.put_app('name' => 'myapp')       # update an app to have a different name
+
+### Collaborators
+
+    azuki.delete_collaborator(APP, 'email@example.com')   # remove 'email@example.com' collaborator from APP app
+    azuki.get_collaborators(APP)                          # list collaborators for APP app
+    azuki.post_collaborator(APP, 'email@example.com')     # add 'email@example.com' collaborator to APP app
+
+### Config Variables
+
+    azuki.delete_config_var(APP, KEY)               # remove KEY key from APP app
+    azuki.get_config_vars(APP)                      # get list of config vars for APP app
+    azuki.put_config_vars(APP, KEY => 'value')      # set KEY key to 'value' for APP app
+
+### Domains
+
+    azuki.delete_domain(APP, 'example.com')   # remove the 'example.com' domain from the APP app
+    azuki.get_domains(APP)                    # list configured domains for the APP app
+    azuki.post_domain(APP, 'example.com')     # add 'example.com' domain to the APP app
+
+### Keys
+
+    azuki.delete_key('user@hostname.local') # remove the 'user@hostname.local' key
+    azuki.delete_keys                       # remove all keys
+    azuki.get_keys                          # list configured keys
+    azuki.post_key('key data')              # add key defined by 'key data'
+
+### Logs
+
+    azuki.get_logs(APP) # return logs information for APP app
+
+### Processes
+
+    azuki.get_ps(APP)                               # list current processes for APP app
+    azuki.post_ps(APP, 'command')                   # run 'command' command in context of APP app
+    azuki.post_ps_restart(APP)                      # restart all processes for APP app
+    azuki.post_ps_scale(APP, TYPE, QTY)             # scale TYPE type processes to QTY for APP app
+    azuki.post_ps_stop(APP, 'ps' => 'web.1')        # stop 'web.1' process for APP app
+    azuki.post_ps_stop(APP, 'type' => 'web')        # stop all 'web' processes for APP app
+    azuki.post_ps_restart(APP, 'ps' => 'web.1')     # restart 'web.1' process for APP app
+    azuki.put_dynos(APP, DYNOS)                     # set number of dynos for bamboo app APP to DYNOS
+    azuki.put_workers(APP, WORKERS)                 # set number of workers for bamboo app APP to WORKERS
+    azuki.post_ps_scale(APP, 'worker', WORKERS)     # set number of workers for cedar app APP to WORKERS
+    
+### Releases
+
+    azuki.get_releases(APP)       # list of releases for the APP app
+    azuki.get_release(APP, 'v#')  # get details of 'v#' release for APP app
+    azuki.post_release(APP, 'v#') # rollback APP app to 'v#' release
+
+### Stacks
+
+    azuki.get_stack(APP)          # list available stacks
+    azuki.put_stack(APP, STACK) # migrate APP app to STACK stack
+
+### User
+
+    azuki.get_user                  # list user info
+
+Mock
+----
+
+For testing (or practice) you can also use a simulated Azuki account:
+
+    require 'azuki-api'
+
+    azuki = Azuki::API.new(:api_key => API_KEY, :mock => true)
+
+Commands will now behave as normal, however, instead of interacting with your actual Azuki account you'll be interacting with a **blank** test account.  Note: test accounts will have NO apps to begin with.  You'll need to create one:
+
+    azuki.post_app(:name => 'my-test-app')
+
+Tests
+-----
+
+To run tests, first set `ENV['AZUKI_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,41 @@
+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/azuki/api"
+    azuki = Azuki::API.new(:api_key => args.api_key)
+
+    addons = Azuki::API::OkJson.encode(azuki.get_addons.body)
+    File.open("#{File.dirname(__FILE__)}/lib/azuki/api/mock/cache/get_addons.json", 'w') do |file|
+      file.write(addons)
+    end
+
+    app_name = "azuki-api-#{Time.now.to_i}"
+    app = azuki.post_app('name' => app_name)
+    features = Azuki::API::OkJson.encode(azuki.get_features(app_name).body)
+    File.open("#{File.dirname(__FILE__)}/lib/azuki/api/mock/cache/get_features.json", 'w') do |file|
+      file.write(features)
+    end
+    azuki.delete_app(app_name)
+
+    user = azuki.get_user.body
+    user["email"] = "user@example.com"
+    user["id"] = "123456@users.azukiapp.com"
+    user = Azuki::API::OkJson.encode(user)
+    File.open("#{File.dirname(__FILE__)}/lib/azuki/api/mock/cache/get_user.json", 'w') do |file|
+      file.write(user)
+    end
+
+  end
+end

data/azuki-api.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "azuki/api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "azuki-api"
+  s.version     = Azuki::API::VERSION
+  s.authors     = ["Éverton Ribeiro"]
+  s.email       = ["everton@azukiapp.com"]
+  s.homepage    = "https://github.com/azukiapp/azuki-api-ruby"
+  s.summary     = %q{Ruby Client for the Azuki API}
+  s.description = %q{Ruby Client for the Azuki 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.20.0'
+
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rake'
+end

data/changelog.txt

@@ -0,0 +1,204 @@
+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
+================
+
+bump excon to get https proxy fixes
+
+0.3.6 10/31/2012
+================
+
+bump excon to latest
+allow username/password params to automagically lookup api_key
+readme cleanup/fixes
+
+0.3.5 09/11/2012
+================
+
+add get_attachments and mocks
+update enable features usage and mocks to use 200/201 based on update/create
+
+0.3.4 08/15/2012
+================
+
+update excon to get SSLv3 fix
+
+0.3.3 08/15/2012
+================
+
+update to more realistic self signed cert in tests
+update body format for delete_ssl_endpoint
+vendor latest okjson
+patch okjson to work around encoding bug
+bump excon and use blocking requests
+
+0.3.2 08/01/2012
+================
+
+don't request v3 apis
+first pass at ssl_endpoints support (no mocks yet)
+bump excon dep
+
+0.3.1 07/20/2012
+================
+
+fix bug in maintenance mocks not being reset after app delet
+
+0.3.0 07/20/2012
+================
+
+fixes for url segment escaping of config_vars, domains and keys
+add get_app_maintenance
+
+0.2.13 07/18/2012
+=================
+
+bump excon to rescue nonblock errors from readline
+
+0.2.12 07/17/2012
+=================
+
+more last minute excon fixes (proxies are hard)
+
+0.2.11 07/17/2012
+=================
+
+excon bump for further fixes
+
+0.2.10 07/16/2012
+=================
+
+excon bump for fixes
+
+0.2.9 07/16/2012
+================
+
+bump excon dep to get proxy fixes
+
+0.2.8 07/08/2012
+================
+
+return to OkJson usage, as json breaks with some legacy toolbelt installs
+
+0.2.7 07/05/2012
+================
+
+doc fixes (fixes delete_addon and improves consistency)
+post_collaborator returns 201 when users does not yet exist
+use json (instead of okjson) when available
+update excon dependency
+
+0.2.6 06/21/2012
+================
+
+processes scale mocks now more accurately update process list
+
+0.2.5 06/13/2012
+================
+
+make post_release release param optional (defaults to latest)
+fix for contructing addon_params
+fail gracefully on non-http-status errors
+
+0.2.4 05/31/2012
+================
+
+fix overly lax GET /user stub reveealed by changes in excon 0.14.0
+
+0.2.3 05/31/2012
+================
+
+fix overly lax DELETE /user/keys stub revealed by changes in excon 0.14.0
+
+0.2.2 05/31/2012
+================
+
+bump excon dep for improved stubs/instrumentation
+
+0.2.1 05/24/2012
+================
+
+update post_ps to properly munge ps_env params
+
+0.2.0 05/23/2012
+================
+
+fix mocks for stack requests
+add features (labs) functionality
+
+0.1.8 05/21/2012
+================
+
+fix tests to be individually runnable
+update cache function to get user data
+update domain tests to match new default plugins
+update collaborators mocks to be more accurate
+update domain tests to use random_domain
+use better transfer targets in app tests
+fix timestamp generation in mocks
+fix release creation in mocks
+fix release rollback mocks to rollback to last when no version is given
+more accurate addons mocks
+more accurate process mocks for attached processes
+
+
+0.1.7 05/15/2012
+================
+
+consolidate NotFound error handling to work more like other errors
+fixes for ps:scale mock accuracy
+fix default command for cedar web process mocks
+
+0.1.6 05/09/2012
+================
+
+fixes for GET /apps/:app/releases/:release mocks
+
+0.1.5 05/09/2012
+================
+
+add support for GET /apps/:app/releases/current
+
+0.1.4 05/09/2012
+================
+
+add DELETE /domains
+add POST /login
+
+0.1.3 05/03/2012
+================
+
+update README examples to include put_app
+correct mocks to change git/web urls during app rename
+split out known azuki errors into their own error classes
+
+0.1.2 04/10/2012
+================
+
+less aggressive gzip usage (checks content-encoding)
+update cache
+
+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
+================
+
+Initial release

data/lib/azuki-api.rb

@@ -0,0 +1 @@
+require(File.join(File.dirname(__FILE__), "azuki", "api"))

data/lib/azuki/api.rb

@@ -0,0 +1,146 @@
+require "base64"
+require "excon"
+require "securerandom"
+require "uri"
+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 "azuki/api/vendor/okjson"
+
+require "azuki/api/errors"
+require "azuki/api/mock"
+require "azuki/api/version"
+
+require "azuki/api/addons"
+require "azuki/api/apps"
+require "azuki/api/attachments"
+require "azuki/api/collaborators"
+require "azuki/api/config_vars"
+require "azuki/api/domains"
+require "azuki/api/features"
+require "azuki/api/keys"
+require "azuki/api/login"
+require "azuki/api/logs"
+require "azuki/api/processes"
+require "azuki/api/releases"
+require "azuki/api/ssl_endpoints"
+require "azuki/api/stacks"
+require "azuki/api/user"
+
+srand
+
+module Azuki
+  class API
+
+    HEADERS = {
+      'Accept'                => 'application/json',
+      'Accept-Encoding'       => 'gzip',
+      #'Accept-Language'       => 'en-US, en;q=0.8',
+      'User-Agent'            => "azuki-rb/#{Azuki::API::VERSION}",
+      'X-Ruby-Version'        => RUBY_VERSION,
+      'X-Ruby-Platform'       => RUBY_PLATFORM
+    }
+
+    OPTIONS = {
+      :headers  => {},
+      :host     => 'api.azukiapp.com',
+      :nonblock => false,
+      :scheme   => 'https'
+    }
+
+    def initialize(options={})
+      options = OPTIONS.merge(options)
+
+      @api_key = options.delete(:api_key) || ENV['AZUKI_API_KEY']
+      if !@api_key && options.has_key?(:username) && options.has_key?(:password)
+        @connection = Excon.new("#{options[:scheme]}://#{options[:host]}", options.merge(:headers => HEADERS))
+        @api_key = self.post_login(options[:username], options[:password]).body["api_key"]
+      end
+
+      user_pass = ":#{@api_key}"
+      options[:headers] = HEADERS.merge({
+        'Authorization' => "Basic #{Base64.encode64(user_pass).gsub("\n", '')}",
+      }).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::HTTPStatusError => error
+        klass = case error.response.status
+          when 401 then Azuki::API::Errors::Unauthorized
+          when 402 then Azuki::API::Errors::VerificationRequired
+          when 403 then Azuki::API::Errors::Forbidden
+          when 404
+            if error.request[:path].match /\/apps\/\/.*/
+              Azuki::API::Errors::NilApp
+            else
+              Azuki::API::Errors::NotFound
+            end
+          when 408 then Azuki::API::Errors::Timeout
+          when 422 then Azuki::API::Errors::RequestFailed
+          when 423 then Azuki::API::Errors::Locked
+          when /50./ then Azuki::API::Errors::RequestFailed
+          else Azuki::API::Errors::ErrorWithResponse
+        end
+
+        reerror = klass.new(error.message, error.response)
+        reerror.set_backtrace(error.backtrace)
+        raise(reerror)
+      end
+
+      if response.body && !response.body.empty?
+        if response.headers['Content-Encoding'] == 'gzip'
+          response.body = Zlib::GzipReader.new(StringIO.new(response.body)).read
+        end
+        begin
+          response.body = Azuki::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
+
+    def addon_params(params)
+      params.inject({}) do |accum, (key, value)|
+        accum["config[#{key}]"] = value
+        accum
+      end
+    end
+
+    def escape(string)
+      CGI.escape(string).gsub('.', '%2E')
+    end
+
+    def ps_options(params)
+      if ps_env = params.delete(:ps_env) || params.delete('ps_env')
+        ps_env.each do |key, value|
+          params["ps_env[#{key}]"] = value
+        end
+      end
+      params
+    end
+
+  end
+end