hilarity-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f1ae3a442253b1117e494d6fafaa509acef62f85
+  data.tar.gz: a3745ec63482719134e8f9219dadfc8021287497
+SHA512:
+  metadata.gz: 67231c27b9211f98eac20622610f66f205b3544ef422fc167f28961a6d309e97ac4035ae5140e6bb18f843d1a3c06af9c1e325f72a1dcbab0c44df4420d69298
+  data.tar.gz: 1c4bdcf7b8043a7ce26656230a0c446e2ba25cc1422f3081ab6c019380a177a08dad84b06402b64197e425e7966f34f7781ed7746d2ada3ec9fdbc003ac4b245

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,127 @@
+Hilarity Ruby Client
+==================
+
+The Hilarity Ruby Client is used to interact with the [Hilarity API](https://hilarity.io/docs/) from Ruby.
+
+
+Usage
+-----
+
+Start by creating a connection to Hilarity with your credentials:
+
+    require 'hilarity-api'
+
+    hilarity = Hilarity::API.new(:api_key => API_KEY)                           # use API Key
+    hilarity = Hilarity::API.new(:username => USERNAME, :password => PASSWORD)  # use username and password
+    hilarity = Hilarity::API.new(:headers => {'User-Agent' => 'custom'})        # use custom header
+
+NOTE: You can leave out the `:api_key` if `ENV['HILARITY_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://legacy-api-docs.hilarity.io).
+
+### Add-ons
+
+    hilarity.delete_addon(APP, ADD_ON)    # remove the ADD_ON add-on from the app named APP
+    hilarity.post_addon(APP, ADD_ON)      # add ADD_ON add-on to an the app named APP
+    hilarity.put_addon(APP, ADD_ON)       # update the ADD_ON add-on on the app named APP
+    hilarity.get_addons                   # see a listing of all available add-ons
+    hilarity.get_addons(APP)              # see listing of installed add-ons for the app named APP
+
+### Apps
+
+    hilarity.delete_app(APP)                  # delete the app named APP
+    hilarity.get_apps                         # get a list of your apps
+    hilarity.get_app(APP)                     # get info about the app named APP
+    hilarity.get_dyno_types(APP)              # get dyno types for the app named APP    
+    hilarity.post_app                         # create an app with a generated name and the default stack
+    hilarity.post_app_maintenance(APP, '1')   # toggle maintenance mode for the app named APP
+    hilarity.post_app('name' => 'app')        # create an app with a specified name, APP
+    hilarity.put_app('name' => 'myapp')       # update an app to have a different name
+
+### Collaborators
+
+    hilarity.delete_collaborator(APP, 'email@example.com')   # remove 'email@example.com' collaborator from APP app
+    hilarity.get_collaborators(APP)                          # list collaborators for APP app
+    hilarity.post_collaborator(APP, 'email@example.com')     # add 'email@example.com' collaborator to APP app
+
+### Config Variables
+
+    hilarity.delete_config_var(APP, KEY)               # remove KEY key from APP app
+    hilarity.get_config_vars(APP)                      # get list of config vars for APP app
+    hilarity.put_config_vars(APP, KEY => 'value')      # set KEY key to 'value' for APP app
+
+### Domains
+
+    hilarity.delete_domain(APP, 'example.com')   # remove the 'example.com' domain from the APP app
+    hilarity.get_domains(APP)                    # list configured domains for the APP app
+    hilarity.post_domain(APP, 'example.com')     # add 'example.com' domain to the APP app
+
+### Keys
+
+    hilarity.delete_key('user@hostname.local') # remove the 'user@hostname.local' key
+    hilarity.delete_keys                       # remove all keys
+    hilarity.get_keys                          # list configured keys
+    hilarity.post_key('key data')              # add key defined by 'key data'
+
+### Logs
+
+    hilarity.get_logs(APP) # return logs information for APP app
+
+### Processes
+
+    hilarity.get_ps(APP)                               # list current dynos for APP app
+    hilarity.post_ps(APP, 'command')                   # run 'command' command in context of APP app
+    hilarity.post_ps_restart(APP)                      # restart all dynos for APP app
+    hilarity.post_ps_scale(APP, TYPE, QTY)             # scale TYPE type dynos to QTY for APP app
+    hilarity.post_ps_stop(APP, 'ps' => 'web.1')        # stop 'web.1' dyno for APP app
+    hilarity.post_ps_stop(APP, 'type' => 'web')        # stop all 'web' dynos for APP app
+    hilarity.post_ps_restart(APP, 'ps' => 'web.1')     # restart 'web.1' dyno for APP app
+    hilarity.put_dynos(APP, DYNOS)                     # set number of dynos for bamboo app APP to DYNOS
+    hilarity.put_workers(APP, WORKERS)                 # set number of workers for bamboo app APP to WORKERS
+    hilarity.post_ps_scale(APP, 'worker', WORKERS)     # set number of workers for cedar app APP to WORKERS
+    hilarity.put_formation(APP, 'web' => '2X')         # set dyno size to '2X' for all 'web' dynos for APP app
+
+### Releases
+
+    hilarity.get_releases(APP)       # list of releases for the APP app
+    hilarity.get_release(APP, 'v#')  # get details of 'v#' release for APP app
+    hilarity.post_release(APP, 'v#') # rollback APP app to 'v#' release
+
+### Stacks
+
+    hilarity.get_stack(APP)          # list available stacks
+    hilarity.put_stack(APP, STACK) # migrate APP app to STACK stack
+
+### User
+
+    hilarity.get_user                  # list user info
+
+Mock
+----
+
+For testing (or practice) you can also use a simulated Hilarity account:
+
+    require 'hilarity-api'
+
+    hilarity = Hilarity::API.new(:api_key => API_KEY, :mock => true)
+
+Commands will now behave as normal, however, instead of interacting with your actual Hilarity 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:
+
+    hilarity.post_app(:name => 'my-test-app')
+
+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,10 @@
+require "bundler/gem_tasks"
+
+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/hilarity/api"
+		hilarity = Hilarity::API.new(:api_key => args.api_key)
+	end
+end

data/changelog.txt

@@ -0,0 +1,3 @@
+0.0.1 08/26/2014
+=================
+Forked from hilarity.rb

data/hilarity-api.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hilarity/api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hilarity-api"
+  s.version     = Hilarity::API::VERSION
+  s.authors     = ["Zane Shannon"]
+  s.email       = ["zcs@hilarity.io"]
+  s.homepage    = "http://github.com/hilarity/hilarity.rb"
+  s.license     = 'MIT'
+  s.summary     = %q{Ruby Client for the Hilarity API}
+  s.description = %q{Ruby Client for the Hilarity 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.38'
+  s.add_runtime_dependency 'multi_json', '~>1.8'
+
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rake'
+end

data/lib/hilarity-api.rb

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

data/lib/hilarity/api.rb

@@ -0,0 +1,143 @@
+require "base64"
+require "cgi"
+require "excon"
+require "multi_json"
+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 "hilarity/api/errors"
+require "hilarity/api/version"
+
+require "hilarity/api/apps"
+require "hilarity/api/config_vars"
+require "hilarity/api/domains"
+require "hilarity/api/keys"
+require "hilarity/api/login"
+require "hilarity/api/user"
+
+srand
+
+module Hilarity
+	class API
+
+		HEADERS = {
+			'Accept'								=> 'application/json',
+			'Accept-Encoding'			 => 'gzip',
+			#'Accept-Language'			 => 'en-US, en;q=0.8',
+			'User-Agent'						=> "hilarity-rb/#{Hilarity::API::VERSION}",
+			'X-Ruby-Version'				=> RUBY_VERSION,
+			'X-Ruby-Platform'			 => RUBY_PLATFORM
+		}
+
+		OPTIONS = {
+			:headers	=> {},
+			:host		 => 'hilarity.io',
+			:nonblock => false,
+			:scheme	 => 'https'
+		}
+
+		def initialize(options={})
+			options = OPTIONS.merge(options)
+
+			@api_key = options.delete(:api_key) || ENV['HILARITY_API_KEY']
+			if !@api_key && options.has_key?(:username) && options.has_key?(:password)
+				username = options.delete(:username)
+				password = options.delete(:password)
+				@connection = Excon.new("#{options[:scheme]}://#{options[:host]}", options.merge(:headers => HEADERS))
+				@api_key = self.post_login(username, 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 Hilarity::API::Errors::Unauthorized
+					when 402 then Hilarity::API::Errors::VerificationRequired
+					when 403 then Hilarity::API::Errors::Forbidden
+					when 404
+						if error.request[:path].match /\/apps\/\/.*/
+							Hilarity::API::Errors::NilApp
+						else
+							Hilarity::API::Errors::NotFound
+						end
+					when 408 then Hilarity::API::Errors::Timeout
+					when 422 then Hilarity::API::Errors::RequestFailed
+					when 423 then Hilarity::API::Errors::Locked
+					when 429 then Hilarity::API::Errors::RateLimitExceeded
+					when /50./ then Hilarity::API::Errors::RequestFailed
+					else Hilarity::API::Errors::ErrorWithResponse
+				end
+
+				decompress_response!(error.response)
+				reerror = klass.new(error.message, error.response)
+				reerror.set_backtrace(error.backtrace)
+				raise(reerror)
+			end
+
+			if response.body && !response.body.empty?
+				decompress_response!(response)
+				begin
+					response.body = MultiJson.load(response.body)
+				rescue
+					# leave non-JSON body as is
+				end 
+			end
+
+			# reset (non-persistent) connection
+			@connection.reset
+
+			response
+		end
+
+		private
+
+		def decompress_response!(response)
+			return unless response.headers['Content-Encoding'] == 'gzip'
+			response.body = Zlib::GzipReader.new(StringIO.new(response.body)).read
+		end
+
+		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

data/lib/hilarity/api/apps.rb

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

data/lib/hilarity/api/config_vars.rb

@@ -0,0 +1,33 @@
+module Hilarity
+	class API
+
+		# DELETE /apps/:app/config/:key
+		def delete_config_var(app, key)
+			request(
+				:expects	=> 200,
+				:method	 => :delete,
+				:path		 => "/api/v1/apps/#{app}/config/#{escape(key)}"
+			)
+		end
+
+		# GET /apps/:app/config
+		def get_config_vars(app)
+			request(
+				:expects	=> 200,
+				:method	 => :get,
+				:path		 => "/api/v1/apps/#{app}/config"
+			)
+		end
+
+		# PUT /apps/:app/config
+		def put_config_vars(app, vars)
+			request(
+				:body		 => MultiJson.dump(vars),
+				:expects	=> 200,
+				:method	 => :put,
+				:path		 => "/api/v1/apps/#{app}/config"
+			)
+		end
+
+	end
+end

data/lib/hilarity/api/domains.rb

@@ -0,0 +1,42 @@
+module Hilarity
+	class API
+
+		# DELETE /apps/:app/domains/:domain
+		def delete_domain(app, domain)
+			request(
+				:expects	=> 200,
+				:method	 => :delete,
+				:path		 => "/api/v1/apps/#{app}/domains/#{escape(domain)}"
+			)
+		end
+
+		# DELETE /apps/:app/domains
+		def delete_domains(app)
+			request(
+				:expects	=> 200,
+				:method	 => :delete,
+				:path		 => "/api/v1/apps/#{app}/domains"
+			)
+		end
+
+		# GET /apps/:app/domains
+		def get_domains(app)
+			request(
+				:expects	=> 200,
+				:method	 => :get,
+				:path		 => "/api/v1/apps/#{app}/domains"
+			)
+		end
+
+		# POST /apps/:app/domains
+		def post_domain(app, domain)
+			request(
+				:expects	=> 201,
+				:method	 => :post,
+				:path		 => "/api/v1/apps/#{app}/domains",
+				:query		=> {'domain_name[url]' => domain}
+			)
+		end
+
+	end
+end

data/lib/hilarity/api/errors.rb

@@ -0,0 +1,28 @@
+module Hilarity
+	class API
+		module Errors
+			class Error < StandardError; end
+
+			class ErrorWithResponse < Error
+				attr_reader :response
+
+				def initialize(message, response)
+					message = message << "\nbody: #{response.body.inspect}"
+					super message
+					@response = response
+				end
+			end
+
+			class Unauthorized < ErrorWithResponse; end
+			class VerificationRequired < ErrorWithResponse; end
+			class Forbidden < ErrorWithResponse; end
+			class NotFound < ErrorWithResponse; end
+			class Timeout < ErrorWithResponse; end
+			class Locked < ErrorWithResponse; end
+			class RateLimitExceeded < ErrorWithResponse; end
+			class RequestFailed < ErrorWithResponse; end
+			class NilApp < ErrorWithResponse; end
+
+		end
+	end
+end

data/lib/hilarity/api/keys.rb

@@ -0,0 +1,42 @@
+module Hilarity
+	class API
+
+		# DELETE /ssh_keys/:key
+		def delete_key(key)
+			request(
+				:expects	=> 200,
+				:method	 => :delete,
+				:path		 => "/api/v1/ssh_keys/#{escape(key)}"
+			)
+		end
+
+		# DELETE /ssh_keys
+		def delete_keys
+			request(
+				:expects	=> 200,
+				:method	 => :delete,
+				:path		 => "/api/v1/ssh_keys"
+			)
+		end
+
+		# GET /ssh_keys
+		def get_keys
+			request(
+				:expects	=> 200,
+				:method	 => :get,
+				:path		 => "/api/v1/ssh_keys"
+			)
+		end
+
+		# POST /ssh_keys
+		def post_key(key)
+			request(
+				:body		 => key,
+				:expects	=> 200,
+				:method	 => :post,
+				:path		 => "/api/v1/ssh_keys"
+			)
+		end
+
+	end
+end

data/lib/hilarity/api/login.rb

@@ -0,0 +1,14 @@
+module Hilarity
+	class API
+
+		def post_login(username, password)
+			request(
+				:expects	=> 200,
+				:method	 => :post,
+				:path		 => '/api/v1/users/login',
+				:query		=> { 'username' => username, 'password' => password }
+			)
+		end
+
+	end
+end

data/lib/hilarity/api/user.rb

@@ -0,0 +1,14 @@
+module Hilarity
+	class API
+
+		# GET /user/me
+		def get_user
+			request(
+				:expects	=> 200,
+				:method	 => :get,
+				:path		 => "/api/v1/users/me"
+			)
+		end
+
+	end
+end

data/lib/hilarity/api/version.rb

@@ -0,0 +1,5 @@
+module Hilarity
+	class API
+		VERSION = "0.0.1"
+	end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: hilarity-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zane Shannon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Client for the Hilarity API
+email:
+- zcs@hilarity.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- changelog.txt
+- hilarity-api.gemspec
+- lib/hilarity-api.rb
+- lib/hilarity/api.rb
+- lib/hilarity/api/apps.rb
+- lib/hilarity/api/config_vars.rb
+- lib/hilarity/api/domains.rb
+- lib/hilarity/api/errors.rb
+- lib/hilarity/api/keys.rb
+- lib/hilarity/api/login.rb
+- lib/hilarity/api/user.rb
+- lib/hilarity/api/version.rb
+homepage: http://github.com/hilarity/hilarity.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby Client for the Hilarity API
+test_files: []