tddium_client 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+nbproject
+.DS_Store

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm use ruby-1.8.7-p302@tddium_client
+

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,4 @@
+# Copyright (c) 2011 Solano Labs All Rights Reserved
+
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/config/environment.yml

@@ -0,0 +1,21 @@
+# Copyright (c) 2011 Solano Labs All Rights Reserved
+
+development:
+  api:
+    scheme: http
+    host: localhost
+    port: 3000
+    version: 1
+
+production:
+  api:
+    scheme: https
+    host: api.tddium.com
+    version: 1
+
+test:
+  api:
+    scheme: http
+    host: localhost
+    port: 3000
+    version: 1

data/lib/tddium_client.rb

@@ -0,0 +1,70 @@
+=begin
+Copyright (c) 2011 Solano Labs All Rights Reserved
+=end
+
+require 'rubygems'
+require 'httparty'
+require 'json'
+
+class TddiumClient
+  API_KEY_HEADER = "X-tddium-api-key"
+  API_ERROR_TEXT = "An error occured: "
+
+  attr_accessor :environment
+
+  def initialize(env = :development)
+    self.environment = env
+  end
+
+  def call_api(method, api_path, params = {}, api_key = nil, retries = 5, &block)
+    headers = { API_KEY_HEADER => api_key } if api_key
+
+    done = false
+    tries = 0
+    while (retries < 0 || tries <= retries) && !done
+      begin
+        http = HTTParty.send(method, tddium_uri(api_path), :body => params, :headers => headers)
+        done = true
+      rescue Timeout::Error
+      ensure
+        tries += 1
+      end
+    end
+
+    raise Timeout::Error if tries > retries
+
+    response = JSON.parse(http.body) rescue {}
+
+    if http.success?
+      if response["status"] == 0
+        yield response
+      else
+        message = API_ERROR_TEXT + response["explanation"].to_s
+      end
+    else
+      message = API_ERROR_TEXT + http.response.header.msg.to_s
+      message << " #{response["explanation"]}" if response["status"].to_i > 0
+    end
+    [response["status"] || http.code, message]
+  end
+
+  private
+
+  def tddium_uri(path)
+    uri = URI.parse("")
+    uri.host = tddium_config["api"]["host"]
+    uri.port = tddium_config["api"]["port"]
+    uri.scheme = tddium_config["api"]["scheme"]
+    URI.join(uri.to_s, "#{tddium_config["api"]["version"]}/#{path}").to_s
+  end
+
+  def tddium_config
+   unless @tddium_config
+     @tddium_config = YAML.load(
+       File.read(File.join(File.dirname(__FILE__), "..", "config", "environment.yml"))
+     )[environment.to_s]
+   end
+   @tddium_config
+  end
+end
+

data/lib/tddium_client/tddium_spec_helpers.rb

@@ -0,0 +1,57 @@
+=begin
+Copyright (c) 2011 Solano Labs All Rights Reserved
+=end
+
+require 'httparty'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+
+module TddiumSpecHelpers
+
+  private
+
+  def register_uri_options(options = {})
+    if options.is_a?(Array)
+      options_array = []
+      options.each do |sub_options|
+        options_array << register_uri_options(sub_options)
+      end
+      options_array
+    else
+      options_for_fake_web = {:body => options[:body], :status => options[:status]}
+      if options[:response]
+        FakeFS.deactivate!
+        response = File.open(options[:response]) { |f| f.read }
+        FakeFS.activate!
+        options_for_fake_web.merge!(:response => response)
+      end
+      options_for_fake_web
+    end
+  end
+
+  def create_file(path, content = "blah")
+    FileUtils.mkdir_p(File.dirname(path))
+    File.open(path, 'w') do |f|
+      f.write(content)
+    end
+  end
+
+  def api_uri(path)
+    uri = URI.parse("")
+    uri.host = tddium_client_config["api"]["host"]
+    uri.scheme = tddium_client_config["api"]["scheme"]
+    uri.port = tddium_client_config["api"]["port"]
+    URI.join(uri.to_s, "#{tddium_client_config["api"]["version"]}/#{path}").to_s
+  end
+
+  def tddium_client_config(raw = false, environment = "test")
+   unless @tddium_config
+     FakeFS.deactivate!
+
+     @tddium_config = File.read(File.join(File.dirname(__FILE__), "..", "..", "config", "environment.yml"))
+     FakeFS.activate!
+   end
+   raw ? @tddium_config : YAML.load(@tddium_config)[environment]
+  end
+end

data/lib/tddium_client/version.rb

@@ -0,0 +1,7 @@
+=begin
+Copyright (c) 2011 Solano Labs All Rights Reserved
+=end
+
+module TddiumClient
+  VERSION = "0.0.1"
+end

data/spec/fixtures/post_suites_201.json

@@ -0,0 +1,13 @@
+HTTP/1.1 201 Created
+Date: Thu, 03 Mar 2011 10:25:28 GMT
+Server: Apache
+X-Powered-By: Phusion Passenger (mod_rails/mod_rack) 3.0.3
+Cache-Control: no-cache
+X-UA-Compatible: IE=Edge
+X-Runtime: 0.096863
+Set-Cookie: _tddium_site_session=BAh7BkkiD3Nlc3Npb25faWQGOgZFRiIlYjk0YTMzNmZmNzQ1NTI1NDk5YmE2NTc4Y2IxNTYxNGU%3D--d841305e17bd1b770b2b99ae74a03bc7aa5eddd5; path=/; HttpOnly
+Status: 201
+Transfer-Encoding: chunked
+Content-Type: application/json; charset=utf-8
+
+{"suite":{"created_at":"2011-03-03T10:25:28Z","id":19,"ruby_version":"1.9.2","ssh_key":"ssh-rsa blah","suite_name":"tddium/demo","test_pattern":"**/*_spec.rb","updated_at":"2011-03-03T10:25:28Z","user_id":null},"status":0}

data/spec/fixtures/post_suites_201_json_status_1.json

@@ -0,0 +1,13 @@
+HTTP/1.1 269 Duplicated
+Date: Thu, 03 Mar 2011 10:00:32 GMT
+Server: Apache
+X-Powered-By: Phusion Passenger (mod_rails/mod_rack) 3.0.3
+Cache-Control: no-cache
+X-UA-Compatible: IE=Edge
+X-Runtime: 0.045332
+Set-Cookie: _tddium_site_session=BAh7BkkiD3Nlc3Npb25faWQGOgZFRiIlOGZiMTgxZjM0ZGIwMmJlMzI2ZWQwMmFkYzUwZGEzZDU%3D--287be8a7de3c8535fc4d958d2fc036110e64e5b6; path=/; HttpOnly
+Status: 269
+Transfer-Encoding: chunked
+Content-Type: application/json; charset=utf-8
+
+{"status":1,"explanation":"{:suite_name=>[\"has already been taken\"]}"}

data/spec/fixtures/post_suites_409.json

@@ -0,0 +1,13 @@
+HTTP/1.1 409 Conflict
+Date: Thu, 03 Mar 2011 10:00:32 GMT
+Server: Apache
+X-Powered-By: Phusion Passenger (mod_rails/mod_rack) 3.0.3
+Cache-Control: no-cache
+X-UA-Compatible: IE=Edge
+X-Runtime: 0.045332
+Set-Cookie: _tddium_site_session=BAh7BkkiD3Nlc3Npb25faWQGOgZFRiIlOGZiMTgxZjM0ZGIwMmJlMzI2ZWQwMmFkYzUwZGEzZDU%3D--287be8a7de3c8535fc4d958d2fc036110e64e5b6; path=/; HttpOnly
+Status: 409
+Transfer-Encoding: chunked
+Content-Type: application/json; charset=utf-8
+
+{"status":1,"explanation":"{:suite_name=>[\"has already been taken\"]}"}

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+=begin
+Copyright (c) 2011 Solano Labs All Rights Reserved
+=end
+
+require "tddium_client"
+require "fakeweb"
+require "rack/test"
+require "fakefs/spec_helpers"
+require "tddium_client/tddium_spec_helpers"
+
+FakeWeb.allow_net_connect = false
+
+def fixture_path(fixture_name)
+  File.join File.dirname(__FILE__), "fixtures", fixture_name
+end

data/spec/tddium_client_spec.rb

@@ -0,0 +1,181 @@
+=begin
+Copyright (c) 2011 Solano Labs All Rights Reserved
+=end
+
+require "spec_helper"
+
+describe TddiumClient do
+  include FakeFS::SpecHelpers
+  include TddiumSpecHelpers
+
+  EXAMPLE_HTTP_METHOD = :post
+  EXAMPLE_TDDIUM_RESOURCE = "suites"
+  EXAMPLE_PARAMS = {"key" => "value"}
+  EXAMPLE_API_KEY = "afb12412bdafe124124asfasfabebafeabwbawf1312342erbfasbb"
+
+  def stub_tddium_client_config
+    create_file(File.join("config", "environment.yml"), tddium_client_config(true))
+  end
+
+  def stub_http_response(method, path, options = {})
+    uri = api_uri(path)
+    FakeWeb.register_uri(method, uri, register_uri_options(options))
+  end
+
+  def parse_request_params
+    Rack::Utils.parse_nested_query(FakeWeb.last_request.body)
+  end
+
+  let(:tddium_client) { TddiumClient.new }
+
+  it "should set the default environment to :development" do
+    tddium_client.environment.should == :development
+  end
+
+  describe "#environment" do
+    it "should set the environment" do
+      tddium_client.environment = :production
+      tddium_client.environment.should == :production
+    end
+  end
+
+  describe "#call_api" do
+    before do
+      FakeWeb.clean_registry
+      stub_tddium_client_config
+      stub_http_response(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE)
+    end
+
+    context "('#{EXAMPLE_HTTP_METHOD}', '#{EXAMPLE_TDDIUM_RESOURCE}')" do
+      it "should make a '#{EXAMPLE_HTTP_METHOD.to_s.upcase}' request to the api" do
+        tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE)
+        FakeWeb.last_request.method.downcase.to_sym.should == EXAMPLE_HTTP_METHOD
+      end
+
+      it "should make a request to the correct resource" do
+        tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE)
+        FakeWeb.last_request.path.should =~ /#{EXAMPLE_TDDIUM_RESOURCE}$/
+      end
+    end
+
+    context "raises an error" do
+      before do
+        HTTParty.stub(EXAMPLE_HTTP_METHOD).and_raise(Timeout::Error)
+      end
+
+      it "should retry 5 times by default to contact the API" do
+        HTTParty.should_receive(EXAMPLE_HTTP_METHOD).exactly(6).times
+        expect { tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE) }.to raise_error(Timeout::Error)
+      end
+
+      it "should retry as many times as we want to contact the API" do
+        HTTParty.should_receive(EXAMPLE_HTTP_METHOD).exactly(3).times
+        expect { tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE, {}, nil, 2) }.to raise_error(Timeout::Error)
+      end
+    end
+
+    context "('#{EXAMPLE_HTTP_METHOD}', '#{EXAMPLE_TDDIUM_RESOURCE}', {}, #{EXAMPLE_API_KEY}) # with api_key" do
+      it "should include #{TddiumClient::API_KEY_HEADER}=#{EXAMPLE_API_KEY} in the request headers" do
+        tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE, {}, EXAMPLE_API_KEY)
+        FakeWeb.last_request[TddiumClient::API_KEY_HEADER].should == EXAMPLE_API_KEY
+      end
+    end
+
+    context "('#{EXAMPLE_HTTP_METHOD}', '#{EXAMPLE_TDDIUM_RESOURCE}') # without api_key" do
+      it "should not include #{TddiumClient::API_KEY_HEADER} in the request headers" do
+        tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE, {})
+        FakeWeb.last_request[TddiumClient::API_KEY_HEADER].should be_nil
+      end
+    end
+
+    context "('#{EXAMPLE_HTTP_METHOD}', '#{EXAMPLE_TDDIUM_RESOURCE}', #{EXAMPLE_PARAMS}) # with params" do
+      it "should include #{EXAMPLE_PARAMS} in the request params" do
+        tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE, EXAMPLE_PARAMS)
+        parse_request_params.should include(EXAMPLE_PARAMS)
+      end
+    end
+
+    context "('#{EXAMPLE_HTTP_METHOD}', '#{EXAMPLE_TDDIUM_RESOURCE}') # without params" do
+      it "should not include any request params" do
+        tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE)
+        parse_request_params.should == {}
+      end
+    end
+
+    context "results in a successful response" do
+      let(:dummy_block) { Proc.new { |response| @parsed_http_response = response } }
+      before do
+        stub_http_response(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE, :response => fixture_path("post_suites_201.json"))
+      end
+
+      it "should try to contact the api only once" do
+        HTTParty.should_receive(EXAMPLE_HTTP_METHOD).exactly(1).times.and_return(mock(HTTParty).as_null_object)
+        tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE, {}, nil, &dummy_block)
+      end
+
+      it "should parse the JSON response" do
+        tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE, {}, nil, &dummy_block)
+        @parsed_http_response.should be_a(Hash)
+        @parsed_http_response["status"].should == 0
+        @parsed_http_response["suite"]["id"].should == 19
+      end
+
+      it "should return a tuple with element[0]==status and element[1]==nil" do
+        tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE, {}, nil, &dummy_block).should == [0, nil]
+      end
+    end
+
+    context "results in an unsuccessful response" do
+      before { stub_http_response(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE, :status => ["404", "Not Found"]) }
+
+      shared_examples_for "returning that an error occured" do
+        it "should return that an error occured in the second element" do
+          tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE)[1].should =~ /^#{TddiumClient::API_ERROR_TEXT}/
+        end
+      end
+
+      shared_examples_for("returning the API error") do
+        it "should return the API error in the second element" do
+          tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE)[1].should =~ /\{\:suite_name\=\>\[\"has already been taken\"\]\}$/
+        end
+      end
+
+      it "should return an array with two elements" do
+        tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE).size.should == 2
+      end
+
+      context "where the http request was successful but API status is not 0" do
+        before { stub_http_response(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE, :response => fixture_path("post_suites_201_json_status_1.json")) }
+        it_should_behave_like("returning that an error occured")
+        it_should_behave_like("returning the API error")
+
+        it "should return the API error code in the first element" do
+          tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE)[0].should == 1
+        end
+      end
+
+      context "where the http request was unsuccessful" do
+        before { stub_http_response(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE, :status => ["501", "Internal Server Error"]) }
+        it_should_behave_like("returning that an error occured")
+
+        it "should return the HTTP error message in the second element" do
+          tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE)[1].should =~ /Internal Server Error/
+        end
+
+        context "and an API error is returned" do
+          before { stub_http_response(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE, :response => fixture_path("post_suites_409.json")) }
+          it_should_behave_like("returning the API error")
+          it "should return the HTTP error code in the first element" do
+            tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE)[0].should == 1
+          end
+        end
+
+        context "and no API error is returned" do
+          it "should return the HTTP error code in the first element" do
+            tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE)[0].should == 501
+          end
+        end
+      end
+    end
+  end
+end

data/tddium_client.gemspec

@@ -0,0 +1,33 @@
+=begin
+Copyright (c) 2011 Solano Labs All Rights Reserved
+=end
+
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tddium_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tddium_client"
+  s.version     = TddiumClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jay Moorthi"]
+  s.email       = ["info@tddium.com"]
+  s.homepage    = "http://www.tddium.com/"
+  s.summary     = %q{tddium Client Gem}
+  s.description = %q{Internal Gem used to call the Tddium API}
+  
+  s.rubyforge_project = "tddium_client"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency("httparty")
+  s.add_runtime_dependency("json")
+
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("fakeweb")
+  s.add_development_dependency("fakefs")
+  s.add_development_dependency("rack-test")
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification 
+name: tddium_client
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jay Moorthi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: Internal Gem used to call the Tddium API
+email: 
+- info@tddium.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- README
+- Rakefile
+- config/environment.yml
+- lib/tddium_client.rb
+- lib/tddium_client/tddium_spec_helpers.rb
+- lib/tddium_client/version.rb
+- spec/fixtures/post_suites_201.json
+- spec/fixtures/post_suites_201_json_status_1.json
+- spec/fixtures/post_suites_409.json
+- spec/spec_helper.rb
+- spec/tddium_client_spec.rb
+- tddium_client.gemspec
+has_rdoc: true
+homepage: http://www.tddium.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: tddium_client
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: tddium Client Gem
+test_files: 
+- spec/fixtures/post_suites_201.json
+- spec/fixtures/post_suites_201_json_status_1.json
+- spec/fixtures/post_suites_409.json
+- spec/spec_helper.rb
+- spec/tddium_client_spec.rb