rainforest 1.0.7 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a8bd3b90d475c8bc357f753806096ea07ed035c
-  data.tar.gz: 29c3dff1169f776c2a7dea67fbb8addb0d496979
+  metadata.gz: 82b786fc24d65611d96a516701e188e587011fac
+  data.tar.gz: 13d9d3e95a6ecc8fa6422f4e75169615bb43de73
 SHA512:
-  metadata.gz: 4e313ffb420e372713f6975a0ad12edbb854b3255ead3d4d2291fe7443ea0b022778717ffb722e718fec09dd748cde27af08b21479aaeed80295e74c5c3d4d68
-  data.tar.gz: 764014897f979f739f9549079e3d2979fbcae4529e7ed6801d3679867f47796e304f5b5918c21b865acf61c950446ecbd6a76e508f45f5b498cd2753a4024078
+  metadata.gz: 8cc5b56ef4426f7c9284b6290842715e95efa7a274eb82781055f0209ec95bce8a381db10a7e4286dc97218c9b4010b61364c292bbff4b7b093e009196d9a1bf
+  data.tar.gz: 8b01181dbf47463375447865db939c80218a37363c53d024daf25bcde64c410449f6530335e58ef4d6fcbedc0f9b64fd2ed88d11ed1eafab108d78f317204d12

data/.gitignore

@@ -1,7 +1,4 @@
-/rainforest-*.gem
-/Gemfile.lock
-.rvmrc
+pkg
 Gemfile.lock
-tags
-.DS_Store
-*~
+*.gem
+.ruby-version

data/.travis.yml

@@ -1,4 +1,16 @@
 language: ruby
+
 rvm:
-  - 2.0.0
+  - 1.8.7
+  - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+
+gemfile:
+  - gemfiles/default-with-activesupport.gemfile
+  - gemfiles/json.gemfile
+  - gemfiles/yajl.gemfile
+
+sudo: false

data/Gemfile

@@ -1,2 +1,8 @@
 source "https://rubygems.org"
 gemspec
+
+if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('1.9.3')
+  gem 'i18n', '< 0.7'
+  gem 'rest-client', '~> 1.6.8'
+  gem 'activesupport', '~> 3.2'
+end

data/README.md

@@ -1,47 +1,98 @@
-[![Build Status](https://travis-ci.org/rainforestapp/rainforest-ruby.png?branch=master)](https://travis-ci.org/rainforestapp/rainforest-ruby)
+# Rainforest Ruby Bindings
 
-# Installation
 
-Install the gem:
 
-```
+## Installation
+
+You don't need this source code unless you want to modify the gem. If
+you just want to use the Rainforest Ruby bindings, you should run:
+
+```bash
 gem install rainforest
 ```
 
-Import the Rainforest client in your application:
+If you want to build & install the gem from source:
+
+```bash
+gem build rainforest.gemspec
+gem install rainforest-2.0.0.gem
+```
+
+
+## Requirements
+
+* Ruby 1.8.7 or above. (Ruby 1.8.6 may work if you load
+  ActiveSupport.) For Ruby versions before 1.9.2, you'll need to add this to your Gemfile:
 
 ```ruby
-require 'rainforest'
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.9.2')
+  gem 'rest-client', '~> 1.6.8'
+end
 ```
 
-# Requirements
+* rest-client, json
 
-* Ruby 1.9.3 or above.
-* rest-client, multi_json
 
+## Bundler
 
-# Examples
+If you are installing via bundler, you should be sure to use the https
+rubygems source in your Gemfile, as any gems fetched over http could potentially be compromised.
 
 ```ruby
-require 'rainforest'
-Rainforest.api_key = "985de0ba7d0820912a33aa696a77319d"
+source 'https://rubygems.org'
+
+gem 'rails'
+gem 'rainforest'
+```
+
+## Using the library
 
-# Get all of your runs
-runs = Rainforest::Run.all
+The following section covers some general info about this API library. If you are looking for documentation covering the entire API, check here: [https://docs.rainfroestqa.com](https://docs.rainfroestqa.com).
 
-run = Rainforest::Run.retrieve(2181) # retrieve a run
-run.delete # abort a run
+### Params and Headers
+
+All API methods accept 2 optional arguments - the params and headers. For example, if you had `SomeResource` and wanted to call `#some_method(some_arg)`, all of the following would be valid:
+
+```ruby
+# With no custom params or headers
+Rainforest::SomeResource.some_method(some_arg)
 
+# With only custom params
+Rainforest::SomeResource.some_method(some_arg, params)
 
-# Kick off a run with all tests
-new_run = Rainforest::Run.create(tests: ["all"])
+# With only custom headers
+Rainforest::SomeResource.some_method(some_arg, nil, headers)
+
+# With both custom params and headers
+Rainforest::SomeResource.some_method(some_arg, params, headers)
 ```
 
-# Docs
+This is mostly useful when creating new resources, or when trying to use an API endpoint that supports pagination.
+
 
-You can find the Rainforest docs here: https://docs.rainforestqa.com/
+### Using Multiple API Keys
 
+The API library was designed to support both developers who plan to only use one API key, as well as developers who may need to use multiple API keys in the same server.
 
-# Development
+By default most resource lookups use code like this:
+
+```ruby
+Rainforest.api_key = "your-api-key"
+test = Rainforest::Test.retrieve(id)
+```
+
+but since the API key is set on the module, this could cause issues if you need to use multiple API keys. To get around this, simply use one of the API clients located in the `clients` folder. For example:
+
+```ruby
+client = Rainforest::DefaultClient.new("your-api-key")
+test = client.tests.retreive(id)
+```
+
+The results from each will be the same, so if you prefer the client version you are welcome to use it even if you aren't using multiple API keys in production.
+
+
+## Development
 
 Test cases can be run with: `bundle exec rake test`
+
+We welcome suggestions and feedback from our users :D

data/Rakefile

@@ -1,15 +1,8 @@
-task :default => [:all]
+require 'rake/testtask'
+require 'yaml'
 
-task :test do
-  ret = true
-  Dir["test/**/*_test.rb"].each do |f|
-    ret = ret && ruby(f, '')
-  end
-end
+task :default => [:test]
 
-task :all do
-  Rake::Task["test"].invoke
-  require 'active_support/all'
-  Rake::Task["test"].reenable
-  Rake::Task["test"].invoke
-end
+Rake::TestTask.new do |t|
+  t.pattern = './test/**/[^_]*_test.rb'
+end

data/VERSION

@@ -1 +1 @@
-1.0.7
+2.0.0

data/bin/rainforest-console

@@ -3,5 +3,5 @@ irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
 
 libs =  " -r irb/completion"
 libs <<  " -r #{File.dirname(__FILE__) + '/../lib/rainforest'}"
-puts "Loading rainforest gem"
+puts "Loading Rainforest gem"
 exec "#{irb} #{libs} --simple-prompt"

data/gemfiles/default-with-activesupport.gemfile

@@ -1,3 +1,10 @@
 source "https://rubygems.org"
 gemspec :path => File.join(File.dirname(__FILE__), "..")
-gem "activesupport", "~> 3.0"
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.9.3')
+  gem 'i18n', '< 0.7'
+  gem 'rest-client', '~> 1.6.8'
+  gem 'activesupport', '~> 3.2'
+else
+  gem 'activesupport'
+end

data/gemfiles/json.gemfile

@@ -1,4 +1,12 @@
 source "https://rubygems.org"
 gemspec :path => File.join(File.dirname(__FILE__), "..")
-gem "json"
-gem "activesupport", "~> 3.0"
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.9.3')
+  gem 'i18n', '< 0.7'
+  gem 'rest-client', '~> 1.6.8'
+  gem 'activesupport', '~> 3.2'
+else
+  gem 'activesupport'
+end
+
+gem 'json'

data/gemfiles/yajl.gemfile

@@ -1,4 +1,12 @@
 source "https://rubygems.org"
 gemspec :path => File.join(File.dirname(__FILE__), "..")
-gem "yajl-ruby"
-gem "activesupport", "~> 3.0"
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.9.3')
+  gem 'i18n', '< 0.7'
+  gem 'rest-client', '~> 1.6.8'
+  gem 'activesupport', '~> 3.2'
+else
+  gem 'activesupport'
+end
+
+gem 'yajl-ruby'

data/lib/rainforest.rb

@@ -1,262 +1,83 @@
 # Rainforest Ruby bindings
-# API spec at https://rainforest.com/docs/api
+# API Docs are located at https://docs.rainfroestqa.com
 require 'cgi'
 require 'set'
 require 'openssl'
 require 'rest_client'
-require 'multi_json'
+require 'json'
+require 'base64'
 
 # Version
 require 'rainforest/version'
 
-# API operations
-require 'rainforest/api_operations/create'
-require 'rainforest/api_operations/update'
-require 'rainforest/api_operations/delete'
-require 'rainforest/api_operations/list'
-
-# Resources
-require 'rainforest/util'
-require 'rainforest/json'
-require 'rainforest/rainforest_object'
-require 'rainforest/api_resource'
-require 'rainforest/singleton_api_resource'
-require 'rainforest/list_object'
-require 'rainforest/run'
-
 # Errors
 require 'rainforest/errors/rainforest_error'
 require 'rainforest/errors/api_error'
 require 'rainforest/errors/api_connection_error'
-require 'rainforest/errors/invalid_request_error'
 require 'rainforest/errors/authentication_error'
 
-module Rainforest
-  @api_base = 'https://app.rainforestqa.com/api'
-  @api_version = 1
-
-  # TODO(jon): Verify that this will work with rainforest
-  @ssl_bundle_path  = File.dirname(__FILE__) + '/data/ca-certificates.crt'
-  @verify_ssl_certs = true
-
-  class << self
-    attr_accessor :api_key, :api_base, :verify_ssl_certs, :api_version
-  end
-
-  def self.api_url(url='')
-    @api_base + "/" + @api_version.to_s + url
-  end
-
-  def self.request(method, url, api_key, params={}, headers={})
-    unless api_key ||= @api_key
-      raise AuthenticationError.new('No API key provided. ' +
-        'Set your API key using "Rainforest.api_key = <API-KEY>". ' +
-        'You can generate API keys from the Rainforest web interface. ' +
-        'See https://rainforest.com/api for details, or email support@rainforest.com ' +
-        'if you have any questions.')
-    end
-
-    if api_key =~ /\s/
-      raise AuthenticationError.new('Your API key is invalid, as it contains ' +
-        'whitespace. (HINT: You can double-check your API key from the ' +
-        'Rainforest web interface. See https://rainforest.com/api for details, or ' +
-        'email support@rainforest.com if you have any questions.)')
-    end
-
-    request_opts = { :verify_ssl => false }
-
-    if ssl_preflight_passed?
-      request_opts.update(:verify_ssl => OpenSSL::SSL::VERIFY_PEER,
-                          :ssl_ca_file => @ssl_bundle_path)
-    end
-
-    params = Util.objects_to_ids(params)
-    url = api_url(url)
-
-    case method.to_s.downcase.to_sym
-    when :get, :head, :delete
-      # Make params into GET parameters
-      url += "#{URI.parse(url).query ? '&' : '?'}#{uri_encode(params)}" if params && params.any?
-      payload = nil
-    else
-      payload = uri_encode(params)
-    end
-
-    request_opts.update(:headers => request_headers(api_key).update(headers),
-                        :method => method, :open_timeout => 30,
-                        :payload => payload, :url => url, :timeout => 80)
-
-    begin
-      response = execute_request(request_opts)
-    rescue SocketError => e
-      handle_restclient_error(e)
-    rescue NoMethodError => e
-      # Work around RestClient bug
-      if e.message =~ /\WRequestFailed\W/
-        e = APIConnectionError.new('Unexpected HTTP response code')
-        handle_restclient_error(e)
-      else
-        raise
-      end
-    rescue RestClient::ExceptionWithResponse => e
-      if rcode = e.http_code and rbody = e.http_body
-        handle_api_error(rcode, rbody)
-      else
-        handle_restclient_error(e)
-      end
-    rescue RestClient::Exception, Errno::ECONNREFUSED => e
-      handle_restclient_error(e)
-    end
-
-    [parse(response), api_key]
-  end
-
-  private
-
-  def self.ssl_preflight_passed?
-    if !verify_ssl_certs && !@no_verify
-      $stderr.puts "WARNING: Running without SSL cert verification. " +
-        "Execute 'Rainforest.verify_ssl_certs = true' to enable verification."
-
-      @no_verify = true
-
-    elsif !Util.file_readable(@ssl_bundle_path) && !@no_bundle
-      $stderr.puts "WARNING: Running without SSL cert verification " +
-        "because #{@ssl_bundle_path} isn't readable"
-
-      @no_bundle = true
-    end
-
-    !(@no_verify || @no_bundle)
-  end
-
-  def self.user_agent
-    @uname ||= get_uname
-    lang_version = "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})"
-
-    {
-      :bindings_version => Rainforest::VERSION,
-      :lang => 'ruby',
-      :lang_version => lang_version,
-      :platform => RUBY_PLATFORM,
-      :publisher => 'rainforest',
-      :uname => @uname
-    }
-
-  end
-
-  def self.get_uname
-    `uname -a 2>/dev/null`.strip if RUBY_PLATFORM =~ /linux|darwin/i
-  rescue Errno::ENOMEM => ex # couldn't create subprocess
-    "uname lookup failed"
-  end
-
-  def self.uri_encode(params)
-    Util.flatten_params(params).
-      map { |k,v| "#{k}=#{Util.url_encode(v)}" }.join('&')
-  end
-
-  def self.request_headers(api_key)
-    headers = {
-      :user_agent => "Rainforest/#{api_version} RubyBindings/#{Rainforest::VERSION}",
-
-      # TODO(jon): Ask Rainforest guys about using http basic auth
-      # :authorization => "Bearer #{api_key}",
-      "Accept" => "application/json",
-      "CLIENT_TOKEN" => api_key,
-      :content_type => 'application/x-www-form-urlencoded'
-    }
-
-    headers[:rainforest_version] = api_version if api_version
-
-    begin
-      headers.update(:x_rainforest_client_user_agent => Rainforest::JSON.dump(user_agent))
-    rescue => e
-      headers.update(:x_rainforest_client_raw_user_agent => user_agent.inspect,
-                     :error => "#{e} (#{e.class})")
-    end
-  end
-
-  def self.execute_request(opts)
-    RestClient::Request.execute(opts)
-  end
-
-  def self.parse(response)
-    begin
-      # Would use :symbolize_names => true, but apparently there is
-      # some library out there that makes symbolize_names not work.
-      response = Rainforest::JSON.load(response.body)
-    rescue MultiJson::DecodeError
-      raise general_api_error(response.code, response.body)
-    end
-
-    Util.symbolize_names(response)
-  end
-
-  def self.general_api_error(rcode, rbody)
-    APIError.new("Invalid response object from API: #{rbody.inspect} " +
-                 "(HTTP response code was #{rcode})", rcode, rbody)
-  end
-
-  def self.handle_api_error(rcode, rbody)
-    begin
-      error_obj = Rainforest::JSON.load(rbody)
-      error_obj = Util.symbolize_names(error_obj)
-      error = error_obj[:error] or raise RainforestError.new # escape from parsing
-
-    rescue MultiJson::DecodeError, RainforestError
-      raise general_api_error(rcode, rbody)
-    end
-
-    case rcode
-    when 400, 404
-      raise invalid_request_error error, rcode, rbody, error_obj
-    when 401
-      raise authentication_error error, rcode, rbody, error_obj
-    else
-      raise api_error error, rcode, rbody, error_obj
-    end
+# Wrapper around RestClient
+require 'rainforest/apibits/requester'
+
+# Builders for creating API methods.
+require 'rainforest/apibits/path_builder'
+require 'rainforest/apibits/headers_builder'
+require 'rainforest/apibits/params_builder'
+require 'rainforest/apibits/api_method'
+
+# Generic resources
+require 'rainforest/apibits/api_endpoint'
+require 'rainforest/apibits/api_client'
+require 'rainforest/apibits/api_object'
+require 'rainforest/apibits/api_resource'
+require 'rainforest/apibits/api_list'
+require 'rainforest/apibits/util'
+
+# API specific resources
+require 'rainforest/resources/client_stats'
+require 'rainforest/resources/environment'
+require 'rainforest/resources/generator'
+require 'rainforest/resources/integration'
+require 'rainforest/resources/run'
+require 'rainforest/resources/schedule'
+require 'rainforest/resources/site_environment'
+require 'rainforest/resources/site'
+require 'rainforest/resources/test'
+require 'rainforest/resources/user'
+
+# API specific endpoints
+require 'rainforest/endpoints/client_stats_endpoint'
+require 'rainforest/endpoints/environment_runs_endpoint'
+require 'rainforest/endpoints/environments_endpoint'
+require 'rainforest/endpoints/generators_endpoint'
+require 'rainforest/endpoints/generator_rows_endpoint'
+require 'rainforest/endpoints/integrations_endpoint'
+require 'rainforest/endpoints/run_tests_endpoint'
+require 'rainforest/endpoints/runs_endpoint'
+require 'rainforest/endpoints/schedules_endpoint'
+require 'rainforest/endpoints/site_environments_endpoint'
+require 'rainforest/endpoints/sites_endpoint'
+require 'rainforest/endpoints/tests_endpoint'
+require 'rainforest/endpoints/users_endpoint'
+
+# API specific clients
+require 'rainforest/clients/default_client'
 
-  end
-
-  def self.invalid_request_error(error, rcode, rbody, error_obj)
-    InvalidRequestError.new("Invalid Request Error", error[:param], rcode,
-                            rbody, error_obj)
-  end
 
-  def self.authentication_error(error, rcode, rbody, error_obj)
-    AuthenticationError.new("Authentication Error", rcode, rbody, error_obj)
-  end
+module Rainforest
+  @api_base = "https://app.rainforestqa.com/api/1"
+  @api_staging = "https://app.rnfrst.com/api/1/"
+  @api_version = "v1"
+  @support_email = "help@rainforestqa.com"
+  @docs_url = "https://docs.rainfroestqa.com"
 
-  def self.api_error(error, rcode, rbody, error_obj)
-    APIError.new(error[:message], rcode, rbody, error_obj)
+  class << self
+    attr_accessor :api_base, :api_version
+    attr_reader :api_staging, :support_email, :docs_url
+    attr_accessor :api_key
   end
 
-  def self.handle_restclient_error(e)
-    case e
-    when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
-      message = "Could not connect to Rainforest (#{@api_base}). " +
-        "Please check your internet connection and try again. " +
-        "If this problem persists, you should check Rainforest's service status at " +
-        "https://twitter.com/rainforeststatus, or let us know at support@rainforest.com."
-
-    when RestClient::SSLCertificateNotVerified
-      message = "Could not verify Rainforest's SSL certificate. " +
-        "Please make sure that your network is not intercepting certificates. " +
-        "(Try going to https://api.rainforest.com/v1 in your browser.) " +
-        "If this problem persists, let us know at support@rainforest.com."
-
-    when SocketError
-      message = "Unexpected error communicating when trying to connect to Rainforest. " +
-        "You may be seeing this message because your DNS is not working. " +
-        "To check, try running 'host rainforest.com' from the command line."
-
-    else
-      message = "Unexpected error communicating with Rainforest. " +
-        "If this problem persists, let us know at support@rainforest.com."
-
-    end
-
-    raise APIConnectionError.new(message + "\n\n(Network error: #{e.message})")
+  def self.default_client
+    DefaultClient.new(Rainforest.api_key)
   end
 end