rainforest-client 0.0.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67f3f0495908c60093c5dcd1df844643a51d064a
+  data.tar.gz: 6e2d86568a94f96bf25dfcf85acefe5b6dd40f25
+SHA512:
+  metadata.gz: 8fd7080807a7dd2a5656d3031f106bbecb36edf547141b0fbe8d595a6ebc39cbcf778704290fb9e23f8c9813aae692fe43310ad5ca2a29595b1fe3917289ee81
+  data.tar.gz: bb592ed884c0b1f4c645f46c2a140ece3af78d0f7905569542840c7e952035741a521220f14afe3dfea9c7b4e0183791fcd88dad5cf375b63777f7166c470358

data/.gitignore

@@ -0,0 +1,34 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swo
+*.swp
+
+## PROJECT::GENERAL
+config/mixpanel.yml
+coverage
+rdoc
+pkg
+doc
+.yardoc
+
+## PROJECT::SPECIFIC
+test/
+tmp/
+
+## Bundler/Gems
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+bin/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-gemset

@@ -0,0 +1 @@
+rainforest-client

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rainforest-cli.gemspec
+gemspec
+
+group :test do
+  gem "rspec"
+end

data/README.md

@@ -0,0 +1,71 @@
+[![Build Status](https://travis-ci.org/kureikain/rainforest-gem.png)](https://travis-ci.org/kureikain/rainforest-gem)
+
+# Rainforest-client
+
+API Client for RainForest
+
+## Installation
+
+    $ gem install rainforest-client
+
+or if you use a Gemfile
+
+    gem 'rainforest_client'
+
+or you can use direcly from github
+    
+    gem 'rainforest-client', 
+        :git => 'https://github.com/kureikain/rainforest-gem',
+        :branch => 'master'
+
+## Usage
+
+You can access end-point directly, via request method and receive JSON data back. Or use resource wrapper.
+    
+### Access API directly
+
+    require 'rubygems'
+    require 'rainforest-client'
+
+    Rainforest::Client.api_key="1f98f025af50d0d6732e79625abb5a06"
+
+    api = Rainforest::Client.new
+    payload = {tests: [2286]}
+
+    runs = api.request('runs', payload)
+    puts runs
+
+    # Or to get runs    
+    runs = api.request('runs', payload, :get)
+    puts runs
+
+    # Get a particular resource
+    
+    runs = api.request('runs/2286', nil, :get)
+    puts runs
+
+### Or via object/resource wrapper
+    
+    runs = Rainforest::Runs.new
+    puts runs.retrieve
+    
+    puts runs.retrieve 4208898
+    puts runs.delete
+
+    # These are not implemented yet
+    test = Rainforest::Tests.new
+    test.create
+    
+    puts runs.retrieve 4208898
+
+## Test
+    $ rake spec
+
+## Changelog
+
+### v0.0.2
+ * Separate API client and resource
+ * Add error handle via parsing response from API endpoint
+
+### v0.0.1
+ * Experimental

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+require 'rubygems'
+require 'rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc 'Run all default tests'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  #spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--format doc --color']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec 
+task :default => :spec

data/lib/rainforest/client.rb

@@ -0,0 +1,70 @@
+require "rainforest/client/version"
+require "rainforest/resource/base"
+require "rainforest/resource/runs"
+require "httparty"
+require "json"
+
+module Rainforest
+  class ConfigurationError < StandardError; end
+
+  class Client
+    @@api_key = nil
+    API_END_POINT = 'https://app.rainforestqa.com/api/1/'
+    
+    def self.api_key=(api_key)
+      @@api_key = api_key
+    end
+    def self.api_key
+      @@api_key
+    end
+
+    def initialize
+    end
+
+    # More information about resource at: https://app.rainforestqa.com/docs
+    def build_request_uri(resource)
+      _resource = resource.split('/')[0]
+      raise ArgumentError, 'resource is invalid' unless ['auth', 'clients', 'runs', 'tests', 'environments', 'pricing_plan'].include? _resource
+      return "#{API_END_POINT}#{resource}"
+    end
+
+    def request(cmd, payload, method = :post)
+      raise Rainforest::ConfigurationError, "Client token is missing" if @@api_key == nil
+
+      url = build_request_uri(cmd)
+      payload = payload.to_json if payload.class == Hash
+      
+      if [:get, :post, :put, :delete].include? method
+        case method
+          when :get
+            response = HTTParty.get url, {
+              body: payload, 
+              headers: {"CLIENT_TOKEN" => @@api_key, "Content-type" => "application/json"}
+            }
+          when :post
+            response = HTTParty.post url, {
+              body: payload, 
+              headers: {"CLIENT_TOKEN" => @@api_key, "Content-type" => "application/json"}
+            }
+          when :put
+            response = HTTParty.put url, {
+              body: payload, 
+              headers: {"CLIENT_TOKEN" => @@api_key, "Content-type" => "application/json"}
+            }
+          when :delete
+            response = HTTParty.delete url, {
+              body: payload, 
+              headers: {"CLIENT_TOKEN" => @@api_key, "Content-type" => "application/json"}
+            }
+        end
+        body = JSON.parse(response.body)
+        if body.include? 'error'
+          raise body['error']
+        end 
+        return JSON.parse(response.body)
+      end
+      raise ArgumentError, "Invalid Method. We support only: :get, :post, :put, :delete"
+    end 
+
+  end
+end

data/lib/rainforest/client/version.rb

@@ -0,0 +1,5 @@
+module Rainforest
+  class Client
+    VERSION = "0.0.10"
+  end
+end

data/lib/rainforest/resource/base.rb

@@ -0,0 +1,40 @@
+require "json"
+
+module Rainforest
+  class Resource
+    
+    def initialize(hash=nil)
+      if hash.class == Hash 
+        hash.each do |k,v|
+          self.instance_variable_set("@#{k}", v)
+        end
+      end  
+      @api_client = Rainforest::Client.new
+
+    end  
+
+    # Get resource
+    def retrieve(id=nil)
+      if id.is_a? Integer
+        object = self.class.name.split('::')[-1].downcase + '/' + id.to_s
+        @api_client.request(object, nil, :get)
+      else 
+        object = self.class.name.split('::')[-1].downcase + '/' + id.to_s
+        @api_client.request(object, nil, :get)
+      end
+    end
+
+    # Create resource
+    def create
+    end
+
+    # Delete resource
+    def delete
+    end
+
+    # @TODO
+    def update
+    end
+
+  end
+end

data/lib/rainforest/resource/runs.rb

@@ -0,0 +1,17 @@
+require "json"
+
+module Rainforest
+  class Runs < Resource
+    attr_accessor :id, 
+      :created_at, 
+      :environment_id, 
+      :test_count, 
+      :state_log, 
+      :state, 
+      :result,
+      :expected_wait_time,
+      :browsers,
+      :requested_tests
+   
+  end
+end

data/lib/rainforest_client.rb

@@ -0,0 +1 @@
+require "rainforest/client"

data/rainforest-client.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rainforest/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rainforest-client"
+  spec.version       = Rainforest::Client::VERSION
+  spec.authors       = ["Simon Mathieu", "Russell Smith", "kureikain"]
+  spec.email         = ["simon@rainforestqa.com", "russ@rainforestqa.com"]
+  spec.description   = %q{API Client for RainforestQA}
+  spec.summary       = %q{API Client for RainforestQA}
+  spec.homepage      = "https://www.rainforestqa.com/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/rainforest/client_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+require 'ostruct'
+
+describe Rainforest::Client do
+  # Should keep this API key for tets only
+  let(:api_key) { '1f98f025af50d0d6732e79625abb5a06'}
+  subject do
+    Rainforest::Client.new
+  end
+  
+  it "should create a new instance" do
+    subject.should be_an_instance_of Rainforest::Client
+  end
+
+  it 'should update API key' do
+    Rainforest::Client.api_key = api_key
+    Rainforest::Client.api_key.should == api_key
+  end
+
+  describe '#build_request_uri' do
+    it "should throw error with nil resource" do
+      expect { subject.build_request_uri}.to raise_error ArgumentError
+    end
+    
+    it "should throw error with empty resource" do
+      expect { subject.build_request_uri('  ')}.to raise_error ArgumentError
+    end
+
+    it "should throw error with invalid resource" do
+      expect { subject.build_request_uri('unknow resource')}.to raise_error ArgumentError
+    end
+
+    it "build correct end point" do
+      subject.build_request_uri('runs').should == 'https://app.rainforestqa.com/api/1/runs'
+    end
+  end
+
+  describe '#request' do
+    context "with invalid param" do 
+      it "should raise error without an API token" do 
+        Rainforest::Client.api_key = nil
+        expect { subject.request('runs', {}, :get)}.to raise_error Rainforest::ConfigurationError
+      end
+      it "should raise error with input argument" do 
+        Rainforest::Client.api_key = api_key
+        expect { subject.request('lopruns', {}, :invalid)}.to raise_error ArgumentError
+      end
+    end
+    
+    context "with valid param" do 
+      before(:each) do 
+        Rainforest::Client.api_key = api_key
+      end
+
+      it "should retrieve all runs" do
+        payload = {tests: [2286]}
+        uri = subject.build_request_uri('runs')
+        HTTParty.stub(:get).with(uri, {body: "{}", headers: {"CLIENT_TOKEN" => api_key, "Content-type" => "application/json"}}) do 
+          OpenStruct.new({body: '[{"id":4337,"object":"Run","created_at":"2013-11-16T08:30:36Z","environment_id":1235,"test_count":1,"state_log":[{"created_at":"2013-11-16T08:30:46Z","event":"validate_run!","from":"queued","id":11846764,"state_column":"state","stateful_id":4337,"stateful_type":"Run","to":"validating","transitioned_at":"2013-11-16T08:30:46Z","updated_at":"2013-11-16T08:30:46Z"},{"created_at":"2013-11-16T08:30:46Z","event":"validated!","from":"validating","id":11846763,"state_column":"state","stateful_id":4337,"stateful_type":"Run","to":"in_progress","transitioned_at":"2013-11-16T08:30:46Z","updated_at":"2013-11-16T08:30:46Z"}],"state":"in_progress","result":"no_result","expected_wait_time":5400.0,"browsers":[{"name":"chrome","state":"enabled"},{"name":"firefox","state":"enabled"},{"name":"ie8","state":"enabled"},{"name":"ie9","state":"enabled"},{"name":"safari","state":"enabled"}],"requested_tests":[2286]},{"id":4270,"object":"Run","created_at":"2013-11-14T05:47:46Z","environment_id":1235,"test_count":1,"state_log":[{"created_at":"2013-11-14T06:06:54Z","event":"complete!","from":"in_progress","id":11780317,"state_column":"state","stateful_id":4270,"stateful_type":"Run","to":"complete","transitioned_at":"2013-11-14T06:06:54Z","updated_at":"2013-11-14T06:06:54Z"},{"created_at":"2013-11-14T06:06:44Z","event":"failed!","from":"no_result","id":11780303,"state_column":"result","stateful_id":4270,"stateful_type":"Run","to":"failed","transitioned_at":"2013-11-14T06:06:44Z","updated_at":"2013-11-14T06:06:44Z"},{"created_at":"2013-11-14T06:06:43Z","event":"failed!","from":"no_result","id":11780301,"state_column":"result","stateful_id":4270,"stateful_type":"Run","to":"failed","transitioned_at":"2013-11-14T06:06:43Z","updated_at":"2013-11-14T06:06:43Z"},{"created_at":"2013-11-14T05:48:05Z","event":"validate_run!","from":"queued","id":11779865,"state_column":"state","stateful_id":4270,"stateful_type":"Run","to":"validating","transitioned_at":"2013-11-14T05:48:05Z","updated_at":"2013-11-14T05:48:05Z"},{"created_at":"2013-11-14T05:48:05Z","event":"validated!","from":"validating","id":11779864,"state_column":"state","stateful_id":4270,"stateful_type":"Run","to":"in_progress","transitioned_at":"2013-11-14T05:48:05Z","updated_at":"2013-11-14T05:48:05Z"}],"state":"complete","result":"failed","expected_wait_time":5400.0,"browsers":[{"name":"chrome","state":"enabled"},{"name":"firefox","state":"enabled"},{"name":"ie8","state":"enabled"},{"name":"ie9","state":"enabled"},{"name":"safari","state":"enabled"}],"requested_tests":[2286]},{"id":4269,"object":"Run","created_at":"2013-11-14T05:30:51Z","environment_id":1235,"test_count":1,"state_log":[{"created_at":"2013-11-14T05:54:29Z","event":"complete!","from":"in_progress","id":11780079,"state_column":"state","stateful_id":4269,"stateful_type":"Run","to":"complete","transitioned_at":"2013-11-14T05:54:29Z","updated_at":"2013-11-14T05:54:29Z"},{"created_at":"2013-11-14T05:48:01Z","event":"failed!","from":"failed","id":11779840,"state_column":"result","stateful_id":4269,"stateful_type":"Run","to":"failed","transitioned_at":"2013-11-14T05:48:01Z","updated_at":"2013-11-14T05:48:01Z"},{"created_at":"2013-11-14T05:36:19Z","event":"failed!","from":"no_result","id":11779597,"state_column":"result","stateful_id":4269,"stateful_type":"Run","to":"failed","transitioned_at":"2013-11-14T05:36:19Z","updated_at":"2013-11-14T05:36:19Z"},{"created_at":"2013-11-14T05:36:18Z","event":"failed!","from":"no_result","id":11779595,"state_column":"result","stateful_id":4269,"stateful_type":"Run","to":"failed","transitioned_at":"2013-11-14T05:36:18Z","updated_at":"2013-11-14T05:36:18Z"},{"created_at":"2013-11-14T05:31:05Z","event":"validate_run!","from":"queued","id":11779400,"state_column":"state","stateful_id":4269,"stateful_type":"Run","to":"validating","transitioned_at":"2013-11-14T05:31:05Z","updated_at":"2013-11-14T05:31:05Z"},{"created_at":"2013-11-14T05:31:05Z","event":"validated!","from":"validating","id":11779399,"state_column":"state","stateful_id":4269,"stateful_type":"Run","to":"in_progress","transitioned_at":"2013-11-14T05:31:05Z","updated_at":"2013-11-14T05:31:05Z"}],"state":"complete","result":"failed","expected_wait_time":5400.0,"browsers":[{"name":"chrome","state":"enabled"},{"name":"firefox","state":"enabled"},{"name":"ie8","state":"enabled"},{"name":"ie9","state":"enabled"},{"name":"safari","state":"enabled"}],"requested_tests":[2285]}]'})
+        end
+        runs = subject.request('runs', {}, :get)
+        expect(runs.count).to eq(3)
+        expect(runs[0]['id']).to eq(4337)
+        expect(runs[0]['object']).to eq('Run')
+      end
+
+      it "should create a run" do
+        payload = {tests: [2286]}
+        uri = subject.build_request_uri('runs')
+        HTTParty.stub(:post).with(uri, {body: payload.to_json, headers: {"CLIENT_TOKEN" => api_key, "Content-type" => "application/json"}}) do 
+          OpenStruct.new({:body=> '{"id":4338,"object":"Run","created_at":"2013-11-16T09:03:19Z","environment_id":1235,"test_count":0,"state_log":[],"state":"queued","result":"no_result","expected_wait_time":5400.0,"browsers":[{"name":"chrome","state":"disabled"},{"name":"firefox","state":"disabled"},{"name":"ie8","state":"disabled"},{"name":"ie9","state":"disabled"},{"name":"safari","state":"disabled"}],"requested_tests":[2286]}'})
+        end
+        runs = subject.request('runs', payload, :post)
+        expect(runs['id']).to eq(4338)
+        expect(runs['object']).to eq('Run')
+      end
+
+      it "should abort a run" do
+        run_id = 4338
+        payload = {:run => run_id}
+        uri = subject.build_request_uri('runs/4338')
+        HTTParty.stub(:delete).with(uri, {body: payload.to_json, headers: {"CLIENT_TOKEN" => api_key, "Content-type" => "application/json"}}) do 
+          OpenStruct.new({:body=> '{"id":4338,"object":"Run","created_at":"2013-11-16T09:03:19Z","environment_id":1235,"test_count":1,"state_log":[{"created_at":"2013-11-16T09:14:13Z","event":"abort!","from":"in_progress","id":11847319,"state_column":"state","stateful_id":4338,"stateful_type":"Run","to":"aborted","transitioned_at":"2013-11-16T09:14:13Z","updated_at":"2013-11-16T09:14:13Z"},{"created_at":"2013-11-16T09:03:39Z","event":"validate_run!","from":"queued","id":11847142,"state_column":"state","stateful_id":4338,"stateful_type":"Run","to":"validating","transitioned_at":"2013-11-16T09:03:39Z","updated_at":"2013-11-16T09:03:39Z"},{"created_at":"2013-11-16T09:03:39Z","event":"validated!","from":"validating","id":11847141,"state_column":"state","stateful_id":4338,"stateful_type":"Run","to":"in_progress","transitioned_at":"2013-11-16T09:03:39Z","updated_at":"2013-11-16T09:03:39Z"}],"state":"aborted","result":"no_result","expected_wait_time":5400.0,"browsers":[{"name":"chrome","state":"enabled"},{"name":"firefox","state":"enabled"},{"name":"ie8","state":"enabled"},{"name":"ie9","state":"enabled"},{"name":"safari","state":"enabled"}],"requested_tests":[2286]}'})
+        end
+        runs = subject.request('runs/4338', payload, :delete)
+        expect(runs['id']).to eq(4338)
+        expect(runs['state']).to eq('aborted')
+        expect(runs['state_log'][0]['to']).to eq('aborted')
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "rainforest_client"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: rainforest-client
+version: !ruby/object:Gem::Version
+  version: 0.0.10
+platform: ruby
+authors:
+- Simon Mathieu
+- Russell Smith
+- kureikain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API Client for RainforestQA
+email:
+- simon@rainforestqa.com
+- russ@rainforestqa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/rainforest/client.rb
+- lib/rainforest/client/version.rb
+- lib/rainforest/resource/base.rb
+- lib/rainforest/resource/runs.rb
+- lib/rainforest_client.rb
+- rainforest-client.gemspec
+- spec/rainforest/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.rainforestqa.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 4
+summary: API Client for RainforestQA
+test_files:
+- spec/rainforest/client_spec.rb
+- spec/spec_helper.rb