rubyshift 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df4b8a4d2f92b613847fe9c73ab70647bfa91058
+  data.tar.gz: 17504bb2f8647fdcd8360e30dd89d9d233e6c5ca
+SHA512:
+  metadata.gz: 9697f930583eaac30ff54dfa29533a404f6d59b69814f9bbfb75941e206617232fb5612b450cf69f91b700e2abcf7e175d41ef013ab3b517a0efc48b72e900e6
+  data.tar.gz: 57b79a9bbe3bd19a9742b6373ff5609b1aa0103cdffbcf14cab3ad722c3e10f765c782c895e523e38c1568777317d92955f81f04e5d03076443d31aeb916d035

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+.config
+Gemfile.lock
+coverage
+doc/
+spec/reports
+test/tmp
+tmp
+.ruby-version
+.ruby-gemset

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## Changelog
+
+### 0.1.0
+  - Initial RubyShift release.

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2016 Anurag Patel <gnurag@gmail.com> All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,54 @@
+# RubyShift
+
+RubyShift is a Ruby client for [OpenShift's REST API](https://access.redhat.com/documentation/en-US/OpenShift_Online/2.0/html/REST_API_Guide/index.html)
+
+## Installation
+
+Installing from rubygems:
+
+```sh
+gem install rubyshift
+```
+
+Via Gemfile:
+
+```ruby
+gem 'rubyshift', github: 'gnurag/rubyshift'
+```
+
+## Usage
+
+Configuration example:
+
+```ruby
+require 'rubyshift'
+RubyShift.configure do |config|
+  config.endpoint = 'https://openshift.redhat.com/broker/rest'
+  config.access_token = '<secret-access-token>'
+  # Optional config options
+  config.httparty = { timeout: 90 }
+end                                                        
+```
+
+Usage example:
+
+```ruby
+RubyShift.applications
+# => []
+
+RubyShift.application_create('myapp', domain_name: 'rubyshift', cartridges: 'ruby-2.0', scale: true, gear_size: 'small')
+# => #<OpenStruct aliases=[], app_url="http://myapp-rubyshift.rhcloud.com/", auto_deploy=true, build_job_url=nil, building_app=nil, building_with=nil, creation_time="2016-04-13T21:00:01Z", deployment_branch="master", deployment_type="git", domain_id="rubyshift", embedded={"haproxy-1.4"=>{}}, framework="ruby-2.0", gear_count=1, gear_profile="small", git_url="ssh://500000000000000000000001@myapp-rubyshift.rhcloud.com/~/git/myapp.git/", ha=false, health_check_path="health", id="500000000000000000000001", initial_git_url=nil, keep_deployments=1, name="myapp", scalable=true, ssh_url="ssh://500000000000000000000001@myapp-rubyshift.rhcloud.com">
+
+RubyShift.application('500000000000000000000001')
+# => #<OpenStruct aliases=[], app_url="http://myapp-rubyshift.rhcloud.com/", auto_deploy=true, build_job_url=nil, building_app=nil, building_with=nil, creation_time="2016-04-13T21:00:01Z", deployment_branch="master", deployment_type="git", domain_id="rubyshift", embedded={"haproxy-1.4"=>{}}, framework="ruby-2.0", gear_count=1, gear_profile="small", git_url="ssh://500000000000000000000001@myapp-rubyshift.rhcloud.com/~/git/myapp.git/", ha=false, health_check_path="health", id="500000000000000000000001", initial_git_url=nil, keep_deployments=1, name="myapp", scalable=true, ssh_url="ssh://500000000000000000000001@myapp-rubyshift.rhcloud.com">
+
+RubyShift.application_restart('500000000000000000000001')
+# => #<OpenStruct aliases=[], app_url="http://myapp-rubyshift.rhcloud.com/", auto_deploy=true, build_job_url=nil, building_app=nil, building_with=nil, creation_time="2016-04-13T21:00:01Z", deployment_branch="master", deployment_type="git", domain_id="rubyshift", embedded={"haproxy-1.4"=>{}}, framework="ruby-2.0", gear_count=1, gear_profile="small", git_url="ssh://500000000000000000000001@myapp-rubyshift.rhcloud.com/~/git/myapp.git/", ha=false, health_check_path="health", id="500000000000000000000001", initial_git_url=nil, keep_deployments=1, name="myapp", scalable=true, ssh_url="ssh://500000000000000000000001@myapp-rubyshift.rhcloud.com">
+
+RubyShift.application_delete('500000000000000000000001')
+# => true
+```
+
+## Acknowledgement
+
+RubyShift is based on the excellent [gitlab](https://github.com/NARKOZ/gitlab) gem. 

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern    = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = ['--color', '--format d']
+end
+
+task default: :spec

data/lib/rubyshift/api.rb

@@ -0,0 +1,16 @@
+module RubyShift
+
+  class API < Request
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+    
+    # Creates a new API.
+    # @raise [Error:MissingCredentials]
+    def initialize(options={})
+      options = RubyShift.options.merge(options)
+      (Configuration::VALID_OPTIONS_KEYS + [:access_token]).each do |key|
+        send("#{key}=", options[key]) if options[key]
+      end
+      set_request_defaults
+    end
+  end
+end

data/lib/rubyshift/client/applications.rb

@@ -0,0 +1,78 @@
+class RubyShift::Client
+  module Applications
+    def applications(options={})
+      if options[:domain_name]
+        get("/domain/#{options[:domain_name]}/applications", query: options)
+      else
+        get("/applications", query: options)
+      end
+    end
+
+    def application(id)
+      get("/application/#{id}")
+    end
+
+    def application_resolve(id)
+      get("/application/#{id}/dns_resolvable")
+    end
+    
+    def application_create(name, options={})
+      url = "/domain/#{options[:domain_name]}/applications"
+      post(url, body: {name: name }.merge(options))
+    end
+
+    def application_update(id, options={})
+      put("/application/#{id}", body: options)
+    end
+
+    def application_delete(id)
+      delete("/application/#{id}")
+    end
+
+    def application_enable_ha(id)
+      post("/application/#{id}/events", body: {event: 'make-ha'})
+    end
+
+    def application_disable_ha(id)
+      post("/application/#{id}/events", body: {event: 'disable-ha'})
+    end
+    
+    def application_start(id)
+      post("/application/#{id}/events", body: {event: 'start'})
+    end
+    
+    def application_stop(id)
+      post("/application/#{id}/events", body: {event: 'stop'})
+    end
+
+    def application_force_stop(id)
+      post("/application/#{id}/events", body: {event: 'force-stop'})
+    end
+
+    def application_restart(id)
+      post("/application/#{id}/events", body: {event: 'restart'})
+    end
+
+    def application_reload(id)
+      post("/application/#{id}/events", body: {event: 'reload'})
+    end
+    
+    def application_scale_up(id)
+      post("/application/#{id}/events", body: {event: 'scale-up'})
+    end
+
+    def application_scale_up(id)
+      post("/application/#{id}/events", body: {event: 'scale-up'})
+    end
+
+    def application_scale_down(id)
+      post("/application/#{id}/events", body: {event: 'scale-down'})
+    end
+    
+    def application_tidy(id)
+      post("/application/#{id}/events", body: {event: 'tidy'})
+    end
+    
+    
+  end
+end

data/lib/rubyshift/client/cartridges.rb

@@ -0,0 +1,4 @@
+class RubyShift::Client
+  module Cartridges
+  end
+end

data/lib/rubyshift/client/domains.rb

@@ -0,0 +1,32 @@
+class RubyShift::Client
+  module Domains
+    def domains
+      get("/domains")
+    end
+
+    def domains_by_owner(owner="@self")
+      get("/domains", body: {owner: owner})
+    end
+
+    def domain(name)
+      get("/domains/#{name}")
+    end
+    
+    def domain_create(name, options={})
+      post("/domains", body: {name: name}.merge(options))
+    end
+
+    def domain_update(name, options={})
+      put("/domains/#{name}", body: options)
+    end
+
+    def domain_delete(name, options={})
+      delete("/domains/#{name}", body: options)
+    end
+
+    def domain_remove_self(name)
+      delete("/domain/#{name}/members/self")
+    end
+
+  end
+end

data/lib/rubyshift/client.rb

@@ -0,0 +1,9 @@
+module RubyShift
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
+
+    include Applications
+    include Domains
+    include Cartridges
+  end
+end

data/lib/rubyshift/configuration.rb

@@ -0,0 +1,61 @@
+require 'json'
+
+module RubyShift
+  module Configuration
+
+    VALID_OPTIONS_KEYS = [:endpoint, :username, :password, :access_token, :user_agent, :httparty].freeze
+
+    DEFAULT_ENDPOINT   = 'https://openshift.redhat.com/broker/rest'
+    DEFAULT_USER_AGENT = "RubyShift/#{RubyShift::VERSION}".freeze
+
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    def self.exetended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    def reset
+      self.endpoint = ENV['RUBYSHIFT_ENDPOINT']
+      self.username = ENV['RUBYSHIFT_USERNAME']
+      self.password = ENV['RUBYSHIFT_PASSWORD']
+      self.access_token = ENV['RUBYSHIFT_ACCESS_TOKEN']
+      self.httparty = get_httparty_config(ENV['RUBYSHIFT_HTTPARTY_OPTIONS'])
+      self.user_agent = DEFAULT_USER_AGENT
+    end
+
+    private
+
+    def get_httparty_config(options)
+      return options if options.nil?
+
+      httparty = JSON.parse options
+      raise ArgumentError, "HTTParty config should be a Hash." unless httparty.is_a? Hash
+      symbolize_keys httparty
+    end
+
+    def symbolize_keys(hash)
+      if hash.is_a?(Hash)
+        hash = hash.each_with_object({}) do |(key, value), newhash|
+          begin
+            newhash[key.to_sym] = symbolize_keys(value)
+          rescue NoMethodError
+            raise "Error: cannot convert hash key to symbol: #{key}"
+          end
+        end
+      end
+
+      hash
+    end
+    
+  end
+end

data/lib/rubyshift/error.rb

@@ -0,0 +1,43 @@
+module RubyShift
+  module Error
+    # Custom error class for rescuing from all Gitlab errors.
+    class Error < StandardError; end
+    
+    # Raised when API endpoint credentials not configured.
+    class MissingCredentials < Error; end
+
+    # Raised when impossible to parse response body.
+    class Parsing < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 400.
+    class BadRequest < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 401.
+    class Unauthorized < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 403.
+    class Forbidden < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 404.
+    class NotFound < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 405.
+    class MethodNotAllowed < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 409.
+    class Conflict < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 422.
+    class Unprocessable < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 500.
+    class InternalServerError < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 502.
+    class BadGateway < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 503.
+    class ServiceUnavailable < Error; end
+
+  end
+end

data/lib/rubyshift/request.rb

@@ -0,0 +1,138 @@
+require 'httparty'
+require 'json'
+require 'ostruct'
+
+module RubyShift
+  class Request
+    include HTTParty
+    format :json
+    headers 'Accept' => 'application/json'
+    parser proc { |body, _| parse(body) }
+
+    attr_accessor :access_token, :endpoint
+
+    def self.parse(body)
+      data = decode(body)['data']
+
+      if data.is_a? Hash
+        data.delete('links')
+        data.delete('members')
+        OpenStruct.new data
+      elsif data.is_a? Array
+        data.collect! { |d|
+          d.delete('links')
+          d.delete('members')
+          OpenStruct.new(d)
+        }
+      elsif data
+        true
+      elsif !data
+        false
+      elsif data.nil?
+        false
+      else
+        raise Error::Parsing.new "Couldn't parse the response body: #{body.inspect}" 
+      end
+    rescue
+      raise Error::Parsing.new "Couldn't parse the response body: #{body.inspect}"
+    end
+
+    def self.decode(response)
+      JSON.load response
+    rescue JSON::ParserError
+      raise Error::Parsing.new "The response is not a valid JSON"      
+    end
+
+    def get(path, options={})
+      set_httparty_config(options)
+      set_authorization_header(options)
+      validate self.class.get(@endpoint + path, options)
+    end
+
+    def post(path, options={})
+      set_httparty_config(options)
+      set_authorization_header(options, path)
+      validate self.class.post(@endpoint + path, options)
+    end
+
+    def put(path, options={})
+      set_httparty_config(options)
+      set_authorization_header(options)
+      validate self.class.put(@endpoint + path, options)
+    end
+
+    def delete(path, options={})
+      set_httparty_config(options)
+      set_authorization_header(options)
+      validate self.class.delete(@endpoint + path, options)
+    end
+    
+    # Checks the response code for common errors.
+    # Returns parsed response for successful requests.
+    def validate(response)
+      case response.code
+      when 400 then fail Error::BadRequest.new error_message(response)
+      when 401 then fail Error::Unauthorized.new error_message(response)
+      when 403 then fail Error::Forbidden.new error_message(response)
+      when 404 then fail Error::NotFound.new error_message(response)
+      when 405 then fail Error::MethodNotAllowed.new error_message(response)
+      when 409 then fail Error::Conflict.new error_message(response)
+      when 422 then fail Error::Unprocessable.new error_message(response)
+      when 500 then fail Error::InternalServerError.new error_message(response)
+      when 502 then fail Error::BadGateway.new error_message(response)
+      when 503 then fail Error::ServiceUnavailable.new error_message(response)
+      end
+
+      parsed = response.parsed_response
+      parsed.client = self if parsed.respond_to?(:client=)
+      parsed.parse_headers!(response.headers) if parsed.respond_to?(:parse_headers!)
+      parsed
+    end
+
+    # Sets default_params for requests.
+    # @raise [Error::MissingCredentials] if endpoint not set.
+    def set_request_defaults(httparty=nil)
+      raise Error::MissingCredentials.new("Please set an API endpoint") unless @endpoint
+      #self.class.default_params[:httparty] = {} if httparty.nil?
+    end
+
+    private
+
+    # Sets Authorization header for requests.
+    # @raise [Error::MissingCredentials] if access_token is not set.
+    def set_authorization_header(options, path=nil)
+      unless path and path.start_with? '/oauth'
+        raise Error::MissingCredentials.new("Please provide an access_token") unless @access_token
+        options[:headers] = { 'Authorization' => "Bearer #{@access_token}" }
+      end
+    end
+
+    # Set HTTParty configuration
+    # @see https://github.com/jnunemaker/httparty
+    def set_httparty_config(options)
+      options.merge!(httparty) if httparty
+    end
+
+    def error_message(response)
+      parsed_response = response.parsed_response
+      message = parsed_response
+
+      "Server responded with code #{response.code}, message: " \
+      "#{handle_error(message)}. " \
+      "Request URI: #{response.request.base_uri}#{response.request.path}"
+    end
+
+    def handle_error(message)
+      case message
+      when OpenStruct
+        message.to_h.sort.map do |key, val|
+          "'#{key}' #{(val.is_a?(Hash) ? val.sort.map { |k, v| "(#{k}: #{v.join(' ')})" } : val).join(' ')}"
+        end.join(', ')
+      when Array
+        message.join(' ')
+      else
+        message
+      end
+    end
+  end
+end

data/lib/rubyshift/version.rb

@@ -0,0 +1,3 @@
+module RubyShift
+  VERSION = "0.1.0"
+end

data/lib/rubyshift.rb

@@ -0,0 +1,35 @@
+require 'rubyshift/version'
+require 'rubyshift/configuration'
+require 'rubyshift/error'
+require 'rubyshift/request'
+require 'rubyshift/api'
+require 'rubyshift/client'
+
+module RubyShift
+  extend Configuration
+
+  def self.client(options={})
+    RubyShift::Client.new(options)
+  end
+
+  # Delegate to RubyShift::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    client.respond_to?(method_name) || super
+  end
+
+  # Delegate to HTTParty.http_proxy
+  def self.http_proxy(address=nil, port=nil, username=nil, password=nil)
+    RubyShift::Request.http_proxy(address, port, username, password)
+  end
+
+  # Return an array of available client methods
+  def self.actions
+    hidden = /endpoint|username|password|access_token|user_agent|get|post|put|\Adelete\z|validate|set_request_defaults|httparty/
+    (RubyShift::Client.instance_methods - Object.methods).reject { |e| e[hidden]}
+  end
+end

data/rubyshift.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubyshift/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rubyshift"
+  gem.version       = RubyShift::VERSION
+  gem.authors       = ["Anurag Patel"]
+  gem.email         = ["gnurag@gmail.com"]
+  gem.description   = %q{Ruby client for OpenShift REST API}
+  gem.summary       = %q{A Ruby wrapper for the OpenShift REST API}
+  gem.homepage      = "https://github.com/gnurag/rubyshift"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.license       = "BSD"
+
+  gem.add_runtime_dependency 'httparty', '~> 0.13'
+
+  gem.add_development_dependency 'pry', '~> 0.10'
+  gem.add_development_dependency 'rake', '~> 11.0'
+  gem.add_development_dependency 'rspec', '~> 3.4'
+  gem.add_development_dependency 'webmock', '~> 1.24'
+end

data/spec/fixtures/application.json

@@ -0,0 +1 @@
+{"api_version":1.7,"data":{"aliases":[],"app_url":"http://othello-rubyshift.rhcloud.com/","auto_deploy":true,"build_job_url":null,"building_app":null,"building_with":null,"creation_time":"2016-04-18T09:51:13Z","deployment_branch":"master","deployment_type":"git","domain_id":"rubyshift","embedded":{"haproxy-1.4":{}},"framework":"ruby-2.0","gear_count":1,"gear_profile":"small","git_url":"ssh://5714ae1189f5cf026b00002f@othello-rubyshift.rhcloud.com/~/git/othello.git/","ha":false,"health_check_path":"health","id":"5714ae1189f5cf026b00002f","initial_git_url":null,"keep_deployments":1,"links":{"GET":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f","method":"GET","optional_params":[],"rel":"Get application","required_params":[]},"GET_DESCRIPTOR":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/descriptor","method":"GET","optional_params":[],"rel":"Get application descriptor","required_params":[]},"GET_GEAR_GROUPS":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/gear_groups","method":"GET","optional_params":[],"rel":"Get application gear groups","required_params":[]},"START":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Start application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["start"]}]},"STOP":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Stop application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["stop"]}]},"FORCE_STOP":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Force stop application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["force-stop"]}]},"RESTART":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Restart application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["restart"]}]},"SCALE_UP":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Scale up application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["scale-up"]}]},"SCALE_DOWN":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Scale down application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["scale-down"]}]},"TIDY":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Tidy the application framework","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["tidy"]}]},"RELOAD":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Reload the application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["reload"]}]},"THREAD_DUMP":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Trigger thread dump","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["thread-dump"]}]},"ADD_CARTRIDGE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/cartridges","method":"POST","optional_params":[{"default_value":null,"description":"The component to colocate with","name":"colocate_with","type":"string","valid_options":["haproxy-1.4","ruby-2.0"]},{"default_value":null,"description":"Minimum number of gears to run the component on.","name":"scales_from","type":"integer","valid_options":[]},{"default_value":null,"description":"Maximum number of gears to run the component on.","name":"scales_to","type":"integer","valid_options":[]},{"default_value":null,"description":"Additional GB of space to request on all gears running this component.","name":"additional_gear_storage","type":"integer","valid_options":[]},{"default_value":"small","description":"Gear size for the cartridge.","name":"gear_size","type":"string","valid_options":["small"]},{"default_value":null,"description":"A URL to a downloadable cartridge.","name":"url","type":"string","valid_options":[]},{"default_value":null,"description":"Add or Update application environment variables, e.g.:[{'name':'FOO', 'value':'123'}, {'name':'BAR', 'value':'abc'}]","name":"environment_variables","type":"array","valid_options":[]}],"rel":"Add embedded cartridge","required_params":[{"description":"Name of a cartridge.","invalid_options":[],"name":"name","type":"string","valid_options":[]}]},"LIST_CARTRIDGES":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/cartridges","method":"GET","optional_params":[],"rel":"List embedded cartridges","required_params":[]},"DNS_RESOLVABLE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/dns_resolvable","method":"GET","optional_params":[],"rel":"Resolve DNS","required_params":[]},"ADD_ALIAS":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/aliases","method":"POST","optional_params":[{"default_value":null,"description":"Content of SSL Certificate","name":"ssl_certificate","type":"string","valid_options":[]},{"default_value":null,"description":"Private key for the certificate.  Required if adding a certificate","name":"private_key","type":"string","valid_options":[]},{"default_value":null,"description":"Optional passphrase for the private key","name":"pass_phrase","type":"string","valid_options":[]}],"rel":"Create new alias","required_params":[{"description":"Alias for application","invalid_options":[],"name":"id","type":"string","valid_options":[]}]},"LIST_ALIASES":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/aliases","method":"GET","optional_params":[],"rel":"List application aliases","required_params":[]},"LIST_MEMBERS":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/members","method":"GET","optional_params":[],"rel":"List members of this application","required_params":[]},"ADD_ENVIRONMENT_VARIABLE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/environment-variables","method":"POST","optional_params":[],"rel":"Add an environment variable","required_params":[{"description":"Name of the environment variable","invalid_options":[],"name":"name","type":"string","valid_options":[]},{"description":"Value of the environment variable","invalid_options":[],"name":"value","type":"string","valid_options":[]}]},"SET_UNSET_ENVIRONMENT_VARIABLES":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/environment-variables","method":"PATCH","optional_params":[{"default_value":null,"description":"Name of the environment variable to add/update","name":"name","type":"string","valid_options":[]},{"default_value":null,"description":"Value of the environment variable","name":"value","type":"string","valid_options":[]},{"default_value":null,"description":"Add/Update/Delete application environment variables, e.g. Add/Update: [{'name':'FOO', 'value':'123'}, {'name':'BAR', 'value':'abc'}], {Delete: [{'name':'FOO'}, {'name':'BAR'}]}","name":"environment_variables","type":"array","valid_options":[]}],"rel":"Add/Update/Delete one or more environment variables","required_params":[]},"LIST_ENVIRONMENT_VARIABLES":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/environment-variables","method":"GET","optional_params":[],"rel":"List all environment variables","required_params":[]},"DEPLOY":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/deployments","method":"POST","optional_params":[{"default_value":"master","description":"Git ref (tag, branch, commit id)","name":"ref","type":"string","valid_options":[]},{"default_value":null,"description":"URL where the deployment artifact can be downloaded from","name":"artifact_url","type":"string","valid_options":[]},{"default_value":false,"description":"Indicates whether this is a hot deployment","name":"hot_deploy","type":"boolean","valid_options":["true or false"]},{"default_value":false,"description":"Indicates whether a clean build should be performed","name":"force_clean_build","type":"string","valid_options":["true or false"]}],"rel":"Deploy the application","required_params":[]},"UPDATE_DEPLOYMENTS":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/deployments","method":"POST","optional_params":[],"rel":"Update deployments (Special permissions is required to update deployments)","required_params":[{"description":"An array of deployments","invalid_options":[],"name":"deployments","type":"array","valid_options":[]}]},"ACTIVATE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Activate a specific deployment of the application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["activate"]},{"description":"The deployment ID to activate the application","invalid_options":[],"name":"deployment_id","type":"string","valid_options":[]}]},"LIST_DEPLOYMENTS":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/deployments","method":"GET","optional_params":[],"rel":"List all deployments","required_params":[]},"UPDATE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f","method":"PUT","optional_params":[{"default_value":null,"description":"Indicates if OpenShift should build and deploy automatically whenever the user executes git push","name":"auto_deploy","type":"boolean","valid_options":[true,false]},{"default_value":null,"description":"Indicates whether the app is setup for binary or git based deployments","name":"deployment_type","type":"string","valid_options":["git","binary"]},{"default_value":null,"description":"Indicates which branch should trigger an automatic deployment, if automatic deployment is enabled.","name":"deployment_branch","type":"string","valid_options":[]},{"default_value":null,"description":"Indicates how many total deployments to preserve. Must be greater than 0","name":"keep_deployments","type":"integer","valid_options":[]}],"rel":"Update application","required_params":[]},"MAKE_HA":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Make the application Highly Available (HA)","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["make-ha"]}]},"DISABLE_HA":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Disable Highly Available (HA) on the application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["disable-ha"]}]},"DELETE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f","method":"DELETE","optional_params":[],"rel":"Delete application","required_params":[]}},"members":[{"explicit_role":null,"from":[{"type":"domain","role":"admin"}],"id":"511a77b2f2cb83597b000d32","links":{"GET":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/member/511a77b2f2cb83597b000d32","method":"GET","optional_params":[],"rel":"Get member","required_params":[]},"UPDATE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/member/511a77b2f2cb83597b000d32","method":"PUT","optional_params":[],"rel":"Update member","required_params":[{"description":"New role for member","invalid_options":[],"name":"role","type":"string","valid_options":[]}]},"DELETE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/member/511a77b2f2cb83597b000d32","method":"DELETE","optional_params":[],"rel":"Delete member","required_params":[]}},"login":"anurag@xinh.org","owner":true,"role":"admin","type":"user"}],"name":"othello","scalable":true,"ssh_url":"ssh://5714ae1189f5cf026b00002f@othello-rubyshift.rhcloud.com"},"messages":[{"exit_code":0,"field":null,"index":null,"severity":"info","text":"Application 'othello' found"}],"status":"ok","supported_api_versions":[1.0,1.1,1.2,1.3,1.4,1.5,1.6,1.7],"type":"application","version":"1.7"}

data/spec/fixtures/applications.json

@@ -0,0 +1 @@
+{"api_version":1.7,"data":[{"aliases":[],"app_url":"http://hamlet-rubyshift.rhcloud.com/","auto_deploy":true,"build_job_url":null,"building_app":null,"building_with":null,"creation_time":"2016-04-18T10:01:49Z","deployment_branch":"master","deployment_type":"git","domain_id":"rubyshift","embedded":{"haproxy-1.4":{}},"framework":"python-3.3","gear_count":1,"gear_profile":"small","git_url":"ssh://5714b08d2d52710974000123@hamlet-rubyshift.rhcloud.com/~/git/hamlet.git/","ha":false,"health_check_path":"health","id":"5714b08d2d52710974000123","initial_git_url":null,"keep_deployments":1,"links":{"GET":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123","method":"GET","optional_params":[],"rel":"Get application","required_params":[]},"GET_DESCRIPTOR":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/descriptor","method":"GET","optional_params":[],"rel":"Get application descriptor","required_params":[]},"GET_GEAR_GROUPS":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/gear_groups","method":"GET","optional_params":[],"rel":"Get application gear groups","required_params":[]},"START":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/events","method":"POST","optional_params":[],"rel":"Start application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["start"]}]},"STOP":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/events","method":"POST","optional_params":[],"rel":"Stop application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["stop"]}]},"FORCE_STOP":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/events","method":"POST","optional_params":[],"rel":"Force stop application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["force-stop"]}]},"RESTART":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/events","method":"POST","optional_params":[],"rel":"Restart application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["restart"]}]},"SCALE_UP":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/events","method":"POST","optional_params":[],"rel":"Scale up application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["scale-up"]}]},"SCALE_DOWN":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/events","method":"POST","optional_params":[],"rel":"Scale down application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["scale-down"]}]},"TIDY":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/events","method":"POST","optional_params":[],"rel":"Tidy the application framework","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["tidy"]}]},"RELOAD":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/events","method":"POST","optional_params":[],"rel":"Reload the application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["reload"]}]},"THREAD_DUMP":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/events","method":"POST","optional_params":[],"rel":"Trigger thread dump","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["thread-dump"]}]},"ADD_CARTRIDGE":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/cartridges","method":"POST","optional_params":[{"default_value":null,"description":"The component to colocate with","name":"colocate_with","type":"string","valid_options":["haproxy-1.4","python-3.3"]},{"default_value":null,"description":"Minimum number of gears to run the component on.","name":"scales_from","type":"integer","valid_options":[]},{"default_value":null,"description":"Maximum number of gears to run the component on.","name":"scales_to","type":"integer","valid_options":[]},{"default_value":null,"description":"Additional GB of space to request on all gears running this component.","name":"additional_gear_storage","type":"integer","valid_options":[]},{"default_value":"small","description":"Gear size for the cartridge.","name":"gear_size","type":"string","valid_options":["small"]},{"default_value":null,"description":"A URL to a downloadable cartridge.","name":"url","type":"string","valid_options":[]},{"default_value":null,"description":"Add or Update application environment variables, e.g.:[{'name':'FOO', 'value':'123'}, {'name':'BAR', 'value':'abc'}]","name":"environment_variables","type":"array","valid_options":[]}],"rel":"Add embedded cartridge","required_params":[{"description":"Name of a cartridge.","invalid_options":[],"name":"name","type":"string","valid_options":[]}]},"LIST_CARTRIDGES":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/cartridges","method":"GET","optional_params":[],"rel":"List embedded cartridges","required_params":[]},"DNS_RESOLVABLE":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/dns_resolvable","method":"GET","optional_params":[],"rel":"Resolve DNS","required_params":[]},"ADD_ALIAS":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/aliases","method":"POST","optional_params":[{"default_value":null,"description":"Content of SSL Certificate","name":"ssl_certificate","type":"string","valid_options":[]},{"default_value":null,"description":"Private key for the certificate.  Required if adding a certificate","name":"private_key","type":"string","valid_options":[]},{"default_value":null,"description":"Optional passphrase for the private key","name":"pass_phrase","type":"string","valid_options":[]}],"rel":"Create new alias","required_params":[{"description":"Alias for application","invalid_options":[],"name":"id","type":"string","valid_options":[]}]},"LIST_ALIASES":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/aliases","method":"GET","optional_params":[],"rel":"List application aliases","required_params":[]},"LIST_MEMBERS":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/members","method":"GET","optional_params":[],"rel":"List members of this application","required_params":[]},"ADD_ENVIRONMENT_VARIABLE":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/environment-variables","method":"POST","optional_params":[],"rel":"Add an environment variable","required_params":[{"description":"Name of the environment variable","invalid_options":[],"name":"name","type":"string","valid_options":[]},{"description":"Value of the environment variable","invalid_options":[],"name":"value","type":"string","valid_options":[]}]},"SET_UNSET_ENVIRONMENT_VARIABLES":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/environment-variables","method":"PATCH","optional_params":[{"default_value":null,"description":"Name of the environment variable to add/update","name":"name","type":"string","valid_options":[]},{"default_value":null,"description":"Value of the environment variable","name":"value","type":"string","valid_options":[]},{"default_value":null,"description":"Add/Update/Delete application environment variables, e.g. Add/Update: [{'name':'FOO', 'value':'123'}, {'name':'BAR', 'value':'abc'}], {Delete: [{'name':'FOO'}, {'name':'BAR'}]}","name":"environment_variables","type":"array","valid_options":[]}],"rel":"Add/Update/Delete one or more environment variables","required_params":[]},"LIST_ENVIRONMENT_VARIABLES":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/environment-variables","method":"GET","optional_params":[],"rel":"List all environment variables","required_params":[]},"DEPLOY":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/deployments","method":"POST","optional_params":[{"default_value":"master","description":"Git ref (tag, branch, commit id)","name":"ref","type":"string","valid_options":[]},{"default_value":null,"description":"URL where the deployment artifact can be downloaded from","name":"artifact_url","type":"string","valid_options":[]},{"default_value":false,"description":"Indicates whether this is a hot deployment","name":"hot_deploy","type":"boolean","valid_options":["true or false"]},{"default_value":false,"description":"Indicates whether a clean build should be performed","name":"force_clean_build","type":"string","valid_options":["true or false"]}],"rel":"Deploy the application","required_params":[]},"UPDATE_DEPLOYMENTS":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/deployments","method":"POST","optional_params":[],"rel":"Update deployments (Special permissions is required to update deployments)","required_params":[{"description":"An array of deployments","invalid_options":[],"name":"deployments","type":"array","valid_options":[]}]},"ACTIVATE":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/events","method":"POST","optional_params":[],"rel":"Activate a specific deployment of the application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["activate"]},{"description":"The deployment ID to activate the application","invalid_options":[],"name":"deployment_id","type":"string","valid_options":[]}]},"LIST_DEPLOYMENTS":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/deployments","method":"GET","optional_params":[],"rel":"List all deployments","required_params":[]},"UPDATE":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123","method":"PUT","optional_params":[{"default_value":null,"description":"Indicates if OpenShift should build and deploy automatically whenever the user executes git push","name":"auto_deploy","type":"boolean","valid_options":[true,false]},{"default_value":null,"description":"Indicates whether the app is setup for binary or git based deployments","name":"deployment_type","type":"string","valid_options":["git","binary"]},{"default_value":null,"description":"Indicates which branch should trigger an automatic deployment, if automatic deployment is enabled.","name":"deployment_branch","type":"string","valid_options":[]},{"default_value":null,"description":"Indicates how many total deployments to preserve. Must be greater than 0","name":"keep_deployments","type":"integer","valid_options":[]}],"rel":"Update application","required_params":[]},"MAKE_HA":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/events","method":"POST","optional_params":[],"rel":"Make the application Highly Available (HA)","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["make-ha"]}]},"DISABLE_HA":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/events","method":"POST","optional_params":[],"rel":"Disable Highly Available (HA) on the application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["disable-ha"]}]},"DELETE":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123","method":"DELETE","optional_params":[],"rel":"Delete application","required_params":[]}},"members":[{"explicit_role":null,"from":[{"type":"domain","role":"admin"}],"id":"511a77b2f2cb83597b000d32","links":{"GET":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/member/511a77b2f2cb83597b000d32","method":"GET","optional_params":[],"rel":"Get member","required_params":[]},"UPDATE":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/member/511a77b2f2cb83597b000d32","method":"PUT","optional_params":[],"rel":"Update member","required_params":[{"description":"New role for member","invalid_options":[],"name":"role","type":"string","valid_options":[]}]},"DELETE":{"href":"https://openshift.redhat.com/broker/rest/application/5714b08d2d52710974000123/member/511a77b2f2cb83597b000d32","method":"DELETE","optional_params":[],"rel":"Delete member","required_params":[]}},"login":"anurag@xinh.org","owner":true,"role":"admin","type":"user"}],"name":"hamlet","scalable":true,"ssh_url":"ssh://5714b08d2d52710974000123@hamlet-rubyshift.rhcloud.com"},{"aliases":[],"app_url":"http://macbeth-rubyshift.rhcloud.com/","auto_deploy":true,"build_job_url":null,"building_app":null,"building_with":null,"creation_time":"2016-04-18T09:55:11Z","deployment_branch":"master","deployment_type":"git","domain_id":"rubyshift","embedded":{},"framework":"php-5.4","gear_count":1,"gear_profile":"small","git_url":"ssh://5714aeff2d5271e5300000cb@macbeth-rubyshift.rhcloud.com/~/git/macbeth.git/","ha":false,"health_check_path":"health","id":"5714aeff2d5271e5300000cb","initial_git_url":null,"keep_deployments":1,"links":{"GET":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb","method":"GET","optional_params":[],"rel":"Get application","required_params":[]},"GET_DESCRIPTOR":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/descriptor","method":"GET","optional_params":[],"rel":"Get application descriptor","required_params":[]},"GET_GEAR_GROUPS":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/gear_groups","method":"GET","optional_params":[],"rel":"Get application gear groups","required_params":[]},"START":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/events","method":"POST","optional_params":[],"rel":"Start application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["start"]}]},"STOP":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/events","method":"POST","optional_params":[],"rel":"Stop application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["stop"]}]},"FORCE_STOP":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/events","method":"POST","optional_params":[],"rel":"Force stop application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["force-stop"]}]},"RESTART":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/events","method":"POST","optional_params":[],"rel":"Restart application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["restart"]}]},"SCALE_UP":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/events","method":"POST","optional_params":[],"rel":"Scale up application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["scale-up"]}]},"SCALE_DOWN":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/events","method":"POST","optional_params":[],"rel":"Scale down application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["scale-down"]}]},"TIDY":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/events","method":"POST","optional_params":[],"rel":"Tidy the application framework","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["tidy"]}]},"RELOAD":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/events","method":"POST","optional_params":[],"rel":"Reload the application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["reload"]}]},"THREAD_DUMP":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/events","method":"POST","optional_params":[],"rel":"Trigger thread dump","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["thread-dump"]}]},"ADD_CARTRIDGE":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/cartridges","method":"POST","optional_params":[{"default_value":null,"description":"The component to colocate with","name":"colocate_with","type":"string","valid_options":["php-5.4"]},{"default_value":null,"description":"Minimum number of gears to run the component on.","name":"scales_from","type":"integer","valid_options":[]},{"default_value":null,"description":"Maximum number of gears to run the component on.","name":"scales_to","type":"integer","valid_options":[]},{"default_value":null,"description":"Additional GB of space to request on all gears running this component.","name":"additional_gear_storage","type":"integer","valid_options":[]},{"default_value":"small","description":"Gear size for the cartridge.","name":"gear_size","type":"string","valid_options":["small"]},{"default_value":null,"description":"A URL to a downloadable cartridge.","name":"url","type":"string","valid_options":[]},{"default_value":null,"description":"Add or Update application environment variables, e.g.:[{'name':'FOO', 'value':'123'}, {'name':'BAR', 'value':'abc'}]","name":"environment_variables","type":"array","valid_options":[]}],"rel":"Add embedded cartridge","required_params":[{"description":"Name of a cartridge.","invalid_options":[],"name":"name","type":"string","valid_options":[]}]},"LIST_CARTRIDGES":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/cartridges","method":"GET","optional_params":[],"rel":"List embedded cartridges","required_params":[]},"DNS_RESOLVABLE":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/dns_resolvable","method":"GET","optional_params":[],"rel":"Resolve DNS","required_params":[]},"ADD_ALIAS":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/aliases","method":"POST","optional_params":[{"default_value":null,"description":"Content of SSL Certificate","name":"ssl_certificate","type":"string","valid_options":[]},{"default_value":null,"description":"Private key for the certificate.  Required if adding a certificate","name":"private_key","type":"string","valid_options":[]},{"default_value":null,"description":"Optional passphrase for the private key","name":"pass_phrase","type":"string","valid_options":[]}],"rel":"Create new alias","required_params":[{"description":"Alias for application","invalid_options":[],"name":"id","type":"string","valid_options":[]}]},"LIST_ALIASES":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/aliases","method":"GET","optional_params":[],"rel":"List application aliases","required_params":[]},"LIST_MEMBERS":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/members","method":"GET","optional_params":[],"rel":"List members of this application","required_params":[]},"ADD_ENVIRONMENT_VARIABLE":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/environment-variables","method":"POST","optional_params":[],"rel":"Add an environment variable","required_params":[{"description":"Name of the environment variable","invalid_options":[],"name":"name","type":"string","valid_options":[]},{"description":"Value of the environment variable","invalid_options":[],"name":"value","type":"string","valid_options":[]}]},"SET_UNSET_ENVIRONMENT_VARIABLES":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/environment-variables","method":"PATCH","optional_params":[{"default_value":null,"description":"Name of the environment variable to add/update","name":"name","type":"string","valid_options":[]},{"default_value":null,"description":"Value of the environment variable","name":"value","type":"string","valid_options":[]},{"default_value":null,"description":"Add/Update/Delete application environment variables, e.g. Add/Update: [{'name':'FOO', 'value':'123'}, {'name':'BAR', 'value':'abc'}], {Delete: [{'name':'FOO'}, {'name':'BAR'}]}","name":"environment_variables","type":"array","valid_options":[]}],"rel":"Add/Update/Delete one or more environment variables","required_params":[]},"LIST_ENVIRONMENT_VARIABLES":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/environment-variables","method":"GET","optional_params":[],"rel":"List all environment variables","required_params":[]},"DEPLOY":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/deployments","method":"POST","optional_params":[{"default_value":"master","description":"Git ref (tag, branch, commit id)","name":"ref","type":"string","valid_options":[]},{"default_value":null,"description":"URL where the deployment artifact can be downloaded from","name":"artifact_url","type":"string","valid_options":[]},{"default_value":false,"description":"Indicates whether this is a hot deployment","name":"hot_deploy","type":"boolean","valid_options":["true or false"]},{"default_value":false,"description":"Indicates whether a clean build should be performed","name":"force_clean_build","type":"string","valid_options":["true or false"]}],"rel":"Deploy the application","required_params":[]},"UPDATE_DEPLOYMENTS":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/deployments","method":"POST","optional_params":[],"rel":"Update deployments (Special permissions is required to update deployments)","required_params":[{"description":"An array of deployments","invalid_options":[],"name":"deployments","type":"array","valid_options":[]}]},"ACTIVATE":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/events","method":"POST","optional_params":[],"rel":"Activate a specific deployment of the application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["activate"]},{"description":"The deployment ID to activate the application","invalid_options":[],"name":"deployment_id","type":"string","valid_options":[]}]},"LIST_DEPLOYMENTS":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/deployments","method":"GET","optional_params":[],"rel":"List all deployments","required_params":[]},"UPDATE":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb","method":"PUT","optional_params":[{"default_value":null,"description":"Indicates if OpenShift should build and deploy automatically whenever the user executes git push","name":"auto_deploy","type":"boolean","valid_options":[true,false]},{"default_value":null,"description":"Indicates whether the app is setup for binary or git based deployments","name":"deployment_type","type":"string","valid_options":["git","binary"]},{"default_value":null,"description":"Indicates which branch should trigger an automatic deployment, if automatic deployment is enabled.","name":"deployment_branch","type":"string","valid_options":[]},{"default_value":null,"description":"Indicates how many total deployments to preserve. Must be greater than 0","name":"keep_deployments","type":"integer","valid_options":[]}],"rel":"Update application","required_params":[]},"MAKE_HA":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/events","method":"POST","optional_params":[],"rel":"Make the application Highly Available (HA)","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["make-ha"]}]},"DISABLE_HA":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/events","method":"POST","optional_params":[],"rel":"Disable Highly Available (HA) on the application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["disable-ha"]}]},"DELETE":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb","method":"DELETE","optional_params":[],"rel":"Delete application","required_params":[]}},"members":[{"explicit_role":null,"from":[{"type":"domain","role":"admin"}],"id":"511a77b2f2cb83597b000d32","links":{"GET":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/member/511a77b2f2cb83597b000d32","method":"GET","optional_params":[],"rel":"Get member","required_params":[]},"UPDATE":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/member/511a77b2f2cb83597b000d32","method":"PUT","optional_params":[],"rel":"Update member","required_params":[{"description":"New role for member","invalid_options":[],"name":"role","type":"string","valid_options":[]}]},"DELETE":{"href":"https://openshift.redhat.com/broker/rest/application/5714aeff2d5271e5300000cb/member/511a77b2f2cb83597b000d32","method":"DELETE","optional_params":[],"rel":"Delete member","required_params":[]}},"login":"anurag@xinh.org","owner":true,"role":"admin","type":"user"}],"name":"macbeth","scalable":false,"ssh_url":"ssh://5714aeff2d5271e5300000cb@macbeth-rubyshift.rhcloud.com"},{"aliases":[],"app_url":"http://othello-rubyshift.rhcloud.com/","auto_deploy":true,"build_job_url":null,"building_app":null,"building_with":null,"creation_time":"2016-04-18T09:51:13Z","deployment_branch":"master","deployment_type":"git","domain_id":"rubyshift","embedded":{"haproxy-1.4":{}},"framework":"ruby-2.0","gear_count":1,"gear_profile":"small","git_url":"ssh://5714ae1189f5cf026b00002f@othello-rubyshift.rhcloud.com/~/git/othello.git/","ha":false,"health_check_path":"health","id":"5714ae1189f5cf026b00002f","initial_git_url":null,"keep_deployments":1,"links":{"GET":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f","method":"GET","optional_params":[],"rel":"Get application","required_params":[]},"GET_DESCRIPTOR":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/descriptor","method":"GET","optional_params":[],"rel":"Get application descriptor","required_params":[]},"GET_GEAR_GROUPS":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/gear_groups","method":"GET","optional_params":[],"rel":"Get application gear groups","required_params":[]},"START":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Start application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["start"]}]},"STOP":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Stop application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["stop"]}]},"FORCE_STOP":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Force stop application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["force-stop"]}]},"RESTART":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Restart application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["restart"]}]},"SCALE_UP":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Scale up application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["scale-up"]}]},"SCALE_DOWN":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Scale down application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["scale-down"]}]},"TIDY":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Tidy the application framework","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["tidy"]}]},"RELOAD":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Reload the application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["reload"]}]},"THREAD_DUMP":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Trigger thread dump","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["thread-dump"]}]},"ADD_CARTRIDGE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/cartridges","method":"POST","optional_params":[{"default_value":null,"description":"The component to colocate with","name":"colocate_with","type":"string","valid_options":["haproxy-1.4","ruby-2.0"]},{"default_value":null,"description":"Minimum number of gears to run the component on.","name":"scales_from","type":"integer","valid_options":[]},{"default_value":null,"description":"Maximum number of gears to run the component on.","name":"scales_to","type":"integer","valid_options":[]},{"default_value":null,"description":"Additional GB of space to request on all gears running this component.","name":"additional_gear_storage","type":"integer","valid_options":[]},{"default_value":"small","description":"Gear size for the cartridge.","name":"gear_size","type":"string","valid_options":["small"]},{"default_value":null,"description":"A URL to a downloadable cartridge.","name":"url","type":"string","valid_options":[]},{"default_value":null,"description":"Add or Update application environment variables, e.g.:[{'name':'FOO', 'value':'123'}, {'name':'BAR', 'value':'abc'}]","name":"environment_variables","type":"array","valid_options":[]}],"rel":"Add embedded cartridge","required_params":[{"description":"Name of a cartridge.","invalid_options":[],"name":"name","type":"string","valid_options":[]}]},"LIST_CARTRIDGES":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/cartridges","method":"GET","optional_params":[],"rel":"List embedded cartridges","required_params":[]},"DNS_RESOLVABLE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/dns_resolvable","method":"GET","optional_params":[],"rel":"Resolve DNS","required_params":[]},"ADD_ALIAS":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/aliases","method":"POST","optional_params":[{"default_value":null,"description":"Content of SSL Certificate","name":"ssl_certificate","type":"string","valid_options":[]},{"default_value":null,"description":"Private key for the certificate.  Required if adding a certificate","name":"private_key","type":"string","valid_options":[]},{"default_value":null,"description":"Optional passphrase for the private key","name":"pass_phrase","type":"string","valid_options":[]}],"rel":"Create new alias","required_params":[{"description":"Alias for application","invalid_options":[],"name":"id","type":"string","valid_options":[]}]},"LIST_ALIASES":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/aliases","method":"GET","optional_params":[],"rel":"List application aliases","required_params":[]},"LIST_MEMBERS":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/members","method":"GET","optional_params":[],"rel":"List members of this application","required_params":[]},"ADD_ENVIRONMENT_VARIABLE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/environment-variables","method":"POST","optional_params":[],"rel":"Add an environment variable","required_params":[{"description":"Name of the environment variable","invalid_options":[],"name":"name","type":"string","valid_options":[]},{"description":"Value of the environment variable","invalid_options":[],"name":"value","type":"string","valid_options":[]}]},"SET_UNSET_ENVIRONMENT_VARIABLES":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/environment-variables","method":"PATCH","optional_params":[{"default_value":null,"description":"Name of the environment variable to add/update","name":"name","type":"string","valid_options":[]},{"default_value":null,"description":"Value of the environment variable","name":"value","type":"string","valid_options":[]},{"default_value":null,"description":"Add/Update/Delete application environment variables, e.g. Add/Update: [{'name':'FOO', 'value':'123'}, {'name':'BAR', 'value':'abc'}], {Delete: [{'name':'FOO'}, {'name':'BAR'}]}","name":"environment_variables","type":"array","valid_options":[]}],"rel":"Add/Update/Delete one or more environment variables","required_params":[]},"LIST_ENVIRONMENT_VARIABLES":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/environment-variables","method":"GET","optional_params":[],"rel":"List all environment variables","required_params":[]},"DEPLOY":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/deployments","method":"POST","optional_params":[{"default_value":"master","description":"Git ref (tag, branch, commit id)","name":"ref","type":"string","valid_options":[]},{"default_value":null,"description":"URL where the deployment artifact can be downloaded from","name":"artifact_url","type":"string","valid_options":[]},{"default_value":false,"description":"Indicates whether this is a hot deployment","name":"hot_deploy","type":"boolean","valid_options":["true or false"]},{"default_value":false,"description":"Indicates whether a clean build should be performed","name":"force_clean_build","type":"string","valid_options":["true or false"]}],"rel":"Deploy the application","required_params":[]},"UPDATE_DEPLOYMENTS":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/deployments","method":"POST","optional_params":[],"rel":"Update deployments (Special permissions is required to update deployments)","required_params":[{"description":"An array of deployments","invalid_options":[],"name":"deployments","type":"array","valid_options":[]}]},"ACTIVATE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Activate a specific deployment of the application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["activate"]},{"description":"The deployment ID to activate the application","invalid_options":[],"name":"deployment_id","type":"string","valid_options":[]}]},"LIST_DEPLOYMENTS":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/deployments","method":"GET","optional_params":[],"rel":"List all deployments","required_params":[]},"UPDATE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f","method":"PUT","optional_params":[{"default_value":null,"description":"Indicates if OpenShift should build and deploy automatically whenever the user executes git push","name":"auto_deploy","type":"boolean","valid_options":[true,false]},{"default_value":null,"description":"Indicates whether the app is setup for binary or git based deployments","name":"deployment_type","type":"string","valid_options":["git","binary"]},{"default_value":null,"description":"Indicates which branch should trigger an automatic deployment, if automatic deployment is enabled.","name":"deployment_branch","type":"string","valid_options":[]},{"default_value":null,"description":"Indicates how many total deployments to preserve. Must be greater than 0","name":"keep_deployments","type":"integer","valid_options":[]}],"rel":"Update application","required_params":[]},"MAKE_HA":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Make the application Highly Available (HA)","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["make-ha"]}]},"DISABLE_HA":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/events","method":"POST","optional_params":[],"rel":"Disable Highly Available (HA) on the application","required_params":[{"description":"event","invalid_options":[],"name":"event","type":"string","valid_options":["disable-ha"]}]},"DELETE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f","method":"DELETE","optional_params":[],"rel":"Delete application","required_params":[]}},"members":[{"explicit_role":null,"from":[{"type":"domain","role":"admin"}],"id":"511a77b2f2cb83597b000d32","links":{"GET":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/member/511a77b2f2cb83597b000d32","method":"GET","optional_params":[],"rel":"Get member","required_params":[]},"UPDATE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/member/511a77b2f2cb83597b000d32","method":"PUT","optional_params":[],"rel":"Update member","required_params":[{"description":"New role for member","invalid_options":[],"name":"role","type":"string","valid_options":[]}]},"DELETE":{"href":"https://openshift.redhat.com/broker/rest/application/5714ae1189f5cf026b00002f/member/511a77b2f2cb83597b000d32","method":"DELETE","optional_params":[],"rel":"Delete member","required_params":[]}},"login":"anurag@xinh.org","owner":true,"role":"admin","type":"user"}],"name":"othello","scalable":true,"ssh_url":"ssh://5714ae1189f5cf026b00002f@othello-rubyshift.rhcloud.com"}],"messages":[{"exit_code":0,"field":null,"index":null,"severity":"info","text":"Found 3 applications."}],"status":"ok","supported_api_versions":[1.0,1.1,1.2,1.3,1.4,1.5,1.6,1.7],"type":"applications","version":"1.7"}

data/spec/rubyshift/client/applications_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe RubyShift::Client do
+	it { should respond_to :applications }
+
+	describe ".applications" do
+		before do
+			stub_get("/applications", "applications")
+			@applications = RubyShift.applications
+		end		
+
+		it "should get the correct resource" do
+			expect(a_get("/applications")).to have_been_made
+		end
+
+		it "should return a list of applications" do
+			expect(@applications).to be_an Array
+			expect(@applications.first.name).to eq("hamlet")
+			expect(@applications.first.domain_id).to eq("rubyshift")
+			expect(@applications.first.framework).to eq("python-3.3")			
+		end
+	end
+
+	describe ".application" do
+		before do
+			stub_get("/application/5714ae1189f5cf026b00002f", "application")
+			@application = RubyShift.application("5714ae1189f5cf026b00002f")
+		end
+
+		it "should get the correct resource" do
+			expect(a_get("/application/5714ae1189f5cf026b00002f")).to have_been_made
+		end
+
+		it "should return application info json" do
+			expect(@application.name).to eq("othello")
+			expect(@application.domain_id).to eq("rubyshift")
+			expect(@application.framework).to eq("ruby-2.0")
+		end
+	end
+end

data/spec/rubyshift/request_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe RubyShift::Request do
+	it { should respond_to :get}
+	it { should respond_to :post}
+	it { should respond_to :put}
+	it { should respond_to :delete}
+
+	before do
+		@request = RubyShift::Request.new
+	end
+
+	describe ".default_options" do
+		it "should have default values set" do
+			default_options = RubyShift::Request.default_options
+			expect(default_options).to be_a Hash
+			expect(default_options[:parser]).to be_a Proc
+			expect(default_options[:format]).to eq(:json)
+			expect(default_options[:headers]).to eq({'Accept' => 'application/json'})
+			expect(default_options[:default_params]).to be_nil
+		end
+	end
+
+	describe ".parse" do
+		it "should return OpenStruct object" do
+			body = JSON.unparse(a: 1, b: 2)
+			expect(RubyShift::Request.parse(body)).to be_an OpenStruct
+			expect(RubyShift::Request.parse("true")).to be true
+			expect(RubyShift::Request.parse("false")).to be false
+
+			expect { RubyShift::Request.parse("test string") }.to raise_error(RubyShift::Error::Parsing)
+		end
+	end
+
+	describe "#set_request_defaults" do
+		context "when endpoint is not set" do
+			it "should raise Error::MissingCredentials" do
+				@request.endpoint = nil
+				expect do
+					@request.set_request_defaults
+				end.to raise_error(RubyShift::Error::MissingCredentials, 'Please set an API endpoint')
+			end
+		end
+
+		context "when endpoint is set" do
+			before(:each) do
+				@request.endpoint = 'http://openshift_spec.redhat.com/broker/rest'
+			end
+
+			it "should allow setting default_params" do
+				@request.set_request_defaults
+				expect(RubyShift::Request.default_params).to eq(httparty: {})
+			end
+		end
+	end
+
+	describe "#set_authorization_header" do
+		it "should raise MissingCredentials when access_token is not set" do
+			expect do
+				@request.send(:set_authorization_header, {})
+			end.to raise_error(RubyShift::Error::MissingCredentials)
+		end
+
+		it "should set Authorization header when access_token is provided" do
+			@request.access_token = 'Z5b5IhP1a0whYv5o6JyWcvj6WgZFbgDD3W7rZDCWMdacffBn5ZybTxtZXEFVYFUg'
+			expect(@request.send(:set_authorization_header, {})).to eq("Authorization" => "Bearer Z5b5IhP1a0whYv5o6JyWcvj6WgZFbgDD3W7rZDCWMdacffBn5ZybTxtZXEFVYFUg")
+		end
+	end
+
+	describe "#handle_error" do
+		before do
+			@array = ['First message.', 'Second message.']
+			@obj   = OpenStruct.new(firstkey: ['not set'], secondkey: ['x'], nested_key: { foo: ['bar'], baz: 'bleh' })
+		end
+
+		context "when passed an OpenStruct" do
+		end
+
+		context "when passed an Array" do
+			it "should return a concatenated string of messages" do
+				expect(@request.send(:handle_error, @array)).to eq('First message. Second message.')
+			end
+		end
+
+		context "when passed a string" do
+			it "should return the string untouched" do
+				error = 'here be error string'
+				expect(@request.send(:handle_error, error)).to eq('here be error string')
+			end
+		end
+	end
+end

data/spec/rubyshift_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe RubyShift do
+	after { RubyShift.reset }
+	
+	describe ".client" do
+		it "should be RubyShift::Client" do
+			expect(RubyShift.client).to be_a RubyShift::Client
+		end
+
+		it "should not override other RubyShift::Client objects" do
+			client1 = RubyShift.client(endpoint: 'https://openshift1.example.com', access_token: 'hunter1')
+			client2 = RubyShift.client(endpoint: 'https://openshift2.example.com', access_token: 'hunter2')
+			expect(client1.endpoint).to eq('https://openshift1.example.com')
+			expect(client2.endpoint).to eq('https://openshift2.example.com')
+			expect(client1.access_token).to eq('hunter1')
+			expect(client2.access_token).to eq('hunter2')
+		end
+	end
+
+	describe ".actions" do
+		it "should return an array of client methods" do
+			actions = RubyShift.actions
+			expect(actions).to be_an Array
+			expect(actions.first).to be_a Symbol
+			expect(actions.sort.first).to eq(:application)
+		end
+	end
+
+	describe ".endpoint=" do
+		it "should set endpoint" do
+			RubyShift.endpoint = 'https://openshift.example.com'
+			expect(RubyShift.endpoint).to eq('https://openshift.example.com')
+		end
+	end
+
+	describe ".username=" do
+		it "should set username" do
+			RubyShift.username = 'openshiftuser@example.com'
+			expect(RubyShift.username).to eq('openshiftuser@example.com')
+		end
+	end
+
+	describe ".password=" do
+		it "should set password" do
+			RubyShift.password = 'hunter2'
+			expect(RubyShift.password).to eq('hunter2')
+		end
+	end
+
+	describe ".access_token=" do
+		it "should set access_token" do
+			RubyShift.access_token = 'hunter2hunter2hunter2'
+			expect(RubyShift.access_token).to eq('hunter2hunter2hunter2')
+		end
+	end
+
+	describe ".user_agent" do
+		it "should return default user_agent" do
+			expect(RubyShift.user_agent).to eq(RubyShift::Configuration::DEFAULT_USER_AGENT)
+		end
+	end
+
+	describe ".user_agent=" do
+		it "should set access_token" do
+			RubyShift.user_agent = 'CustomUserAgent/1.1'
+			expect(RubyShift.user_agent).to eq('CustomUserAgent/1.1')
+		end
+	end
+
+	describe ".configure" do
+		RubyShift::Configuration::VALID_OPTIONS_KEYS.each do |key|
+			it "should set #{key}" do
+				RubyShift.configure do |config|
+					config.send("#{key}=", key)
+					expect(RubyShift.send(key)).to eq(key)
+				end
+			end
+		end
+	end
+
+	describe ".http_proxy" do
+		it "delegates the method to RubyShift::Request" do
+			RubyShift.endpoint = 'https://openshift.example.com'
+			request = class_spy(RubyShift::Request).as_stubbed_const
+
+			RubyShift.http_proxy('proxy.example.net', 1337, 'proxyuser', 'hunter2')
+			expect(request).to have_received(:http_proxy).
+			with('proxy.example.net', 1337, 'proxyuser', 'hunter2')
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require 'rspec'
+require 'webmock/rspec'
+
+require File.expand_path('../../lib/rubyshift', __FILE__)
+
+def capture_output
+	out = StringIO.new
+	$stdout = out
+	$stderr = out
+	yield
+	$stdout = STDOUT
+	$stderr = STDERR
+	out.string
+end
+
+def load_fixture(name)
+	File.new(File.dirname(__FILE__) + "/fixtures/#{name}.json")
+end
+
+
+RSpec.configure do |config|
+	config.before(:all) do
+		RubyShift.endpoint = 'https://openshift.example.com/broker/rest'
+		RubyShift.access_token = 'hunter2'
+	end
+end
+
+# GET 
+def stub_get(path, fixture)
+	stub_request(:get, "#{RubyShift.endpoint}#{path}").
+	with(headers: { 'Authorization' => "Bearer #{RubyShift.access_token}" }).
+	to_return(body: load_fixture(fixture))
+end
+
+def a_get(path)
+	a_request(:get, "#{RubyShift.endpoint}#{path}").
+	with(headers: { 'Authorization' => "Bearer #{RubyShift.access_token}" })
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: rubyshift
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anurag Patel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+description: Ruby client for OpenShift REST API
+email:
+- gnurag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/rubyshift.rb
+- lib/rubyshift/api.rb
+- lib/rubyshift/client.rb
+- lib/rubyshift/client/applications.rb
+- lib/rubyshift/client/cartridges.rb
+- lib/rubyshift/client/domains.rb
+- lib/rubyshift/configuration.rb
+- lib/rubyshift/error.rb
+- lib/rubyshift/request.rb
+- lib/rubyshift/version.rb
+- rubyshift.gemspec
+- spec/fixtures/application.json
+- spec/fixtures/applications.json
+- spec/rubyshift/client/applications_spec.rb
+- spec/rubyshift/request_spec.rb
+- spec/rubyshift_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gnurag/rubyshift
+licenses:
+- BSD
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the OpenShift REST API
+test_files:
+- spec/fixtures/application.json
+- spec/fixtures/applications.json
+- spec/rubyshift/client/applications_spec.rb
+- spec/rubyshift/request_spec.rb
+- spec/rubyshift_spec.rb
+- spec/spec_helper.rb