tddium_client 0.0.10 → 0.0.12

data/Gemfile.lock

@@ -1,20 +1,22 @@
 PATH
   remote: .
   specs:
-    tddium_client (0.0.9)
+    tddium_client (0.0.12)
       httparty
       json
 
 GEM
   remote: http://rubygems.org/
   specs:
-    crack (0.1.8)
     diff-lcs (1.1.2)
     fakefs (0.3.1)
     fakeweb (1.3.0)
-    httparty (0.7.4)
-      crack (= 0.1.8)
-    json (1.5.1)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
+    json (1.6.1)
+    multi_json (1.0.3)
+    multi_xml (0.4.1)
     rack (1.2.2)
     rack-test (0.5.7)
       rack (>= 1.0)

data/lib/tddium_client/version.rb

@@ -3,5 +3,5 @@ Copyright (c) 2011 Solano Labs All Rights Reserved
 =end
 
 module TddiumClient
-  VERSION = "0.0.10"
+  VERSION = "0.0.12"
 end

data/lib/tddium_client.rb

@@ -5,9 +5,12 @@ Copyright (c) 2011 Solano Labs All Rights Reserved
 require 'rubygems'
 require 'httparty'
 require 'json'
+require File.expand_path("../tddium_client/version", __FILE__)
+require "tddium_client/version"
 
 module TddiumClient
   API_KEY_HEADER = "X-tddium-api-key"
+  CLIENT_VERSION_HEADER = "X-tddium-client-version"
   API_ERROR_TEXT = "An error occured: "
 
   module Error
@@ -90,35 +93,50 @@ module TddiumClient
   end
 
   class InternalClient
-    def initialize(host, port=nil, scheme='https', version=1)
+    def initialize(host, port=nil, scheme='https', version=1, caller_version=nil)
       @tddium_config = {"host" => host,
                         "port" => port,
                         "scheme" => scheme,
-                        "version" => version}
+                        "version" => version,
+                        "caller_version" => caller_version}
     end
 
     def call_api(method, api_path, params = {}, api_key = nil, retries = 5)
-      headers = { API_KEY_HEADER => api_key } if api_key
+      headers = {}
+      headers.merge!(API_KEY_HEADER => api_key) if api_key
+      headers.merge!(CLIENT_VERSION_HEADER => version_header)
 
-      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
+
+      begin
+        http = HTTParty.send(method, tddium_uri(api_path), :body => params, :headers => headers)
+      rescue Timeout::Error, OpenSSL::SSL::SSLError, OpenSSL::SSL::Session::SessionError
+        tries += 1
+        retry if retries > 0 && tries <= retries
       end
 
-      raise Error::Timeout if tries > retries && retries >= 0
+      raise Error::Timeout if retries >= 0 && tries > retries
 
       Result::API.new(http)
     end
 
+    def caller_version
+      @tddium_config["caller_version"]
+    end
+
+    def caller_version=(version)
+      @tddium_config["caller_version"] = version
+    end
+
+
     protected
 
+      def version_header
+        hdr = "tddium_client-#{TddiumClient::VERSION}"
+        hdr += ";#{caller_version}" if caller_version
+        hdr
+      end
+
       def tddium_uri(path)
         uri = URI.parse("")
         uri.host = tddium_config["host"]
@@ -136,9 +154,10 @@ module TddiumClient
   class Client < InternalClient
     attr_reader :environment
 
-    def initialize(env = :development)
+    def initialize(env = :development, caller_version=nil)
       @all_config = YAML.load(File.read(config_path))
       self.environment = env.to_s
+      self.caller_version = caller_version
     end
 
     def environment=(new_environment)

data/spec/tddium_client_spec.rb

@@ -268,11 +268,8 @@ describe "TddiumClient" do
         end
       end
 
-      context "raises a timeout error" do
-        before do
-          HTTParty.stub(EXAMPLE_HTTP_METHOD).and_raise(Timeout::Error)
-        end
-
+      shared_examples_for "retry on exception" do
+        before { HTTParty.stub(EXAMPLE_HTTP_METHOD).and_raise(raised_exception) }
         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(TddiumClient::Error::Timeout)
@@ -284,10 +281,23 @@ describe "TddiumClient" do
         end
       end
 
+      context "raises a timeout error" do
+        it_behaves_like "retry on exception" do
+          let (:raised_exception) { Timeout::Error }
+        end
+        it_behaves_like "retry on exception" do
+          let (:raised_exception) { OpenSSL::SSL::SSLError }
+        end
+        it_behaves_like "retry on exception" do
+          let (:raised_exception) { OpenSSL::SSL::Session::SessionError }
+        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
+          FakeWeb.last_request[TddiumClient::CLIENT_VERSION_HEADER].should =~ /#{TddiumClient::VERSION}/
         end
       end
 
@@ -295,6 +305,17 @@ describe "TddiumClient" 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
+          FakeWeb.last_request[TddiumClient::CLIENT_VERSION_HEADER].should =~ /#{TddiumClient::VERSION}/
+        end
+      end
+
+      context "('#{EXAMPLE_HTTP_METHOD}', '#{EXAMPLE_TDDIUM_RESOURCE}') # with caller_version" do
+        it "should include #{TddiumClient::CLIENT_VERSION_HEADER} in req headers with caller_version" do
+          ver = "tddium-preview-0.8.1"
+          tddium_client.caller_version = ver
+          tddium_client.call_api(EXAMPLE_HTTP_METHOD, EXAMPLE_TDDIUM_RESOURCE, {})
+          FakeWeb.last_request[TddiumClient::API_KEY_HEADER].should be_nil
+          FakeWeb.last_request[TddiumClient::CLIENT_VERSION_HEADER].should =~ /#{TddiumClient::VERSION};#{ver}/
         end
       end
 

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: tddium_client
 version: !ruby/object:Gem::Version 
-  hash: 11
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 10
-  version: 0.0.10
+  version: 0.0.12
 platform: ruby
 authors: 
 - Jay Moorthi
@@ -15,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-29 00:00:00 -07:00
-default_executable: 
+date: 2011-10-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
@@ -26,9 +20,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -40,9 +31,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -54,9 +42,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id003
@@ -68,9 +53,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id004
@@ -82,9 +64,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id005
@@ -96,9 +75,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id006
@@ -110,9 +86,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id007
@@ -124,9 +97,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id008
@@ -156,7 +126,6 @@ files:
 - spec/spec_helper.rb
 - spec/tddium_client_spec.rb
 - tddium_client.gemspec
-has_rdoc: true
 homepage: http://www.tddium.com/
 licenses: []
 
@@ -170,23 +139,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   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.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: tddium Client Gem