rlivsey-voorhees 0.1.3 → 0.1.4

data/README.markdown

@@ -69,6 +69,16 @@ These cannot be globally set and can only be defined on individual services/requ
 * path: Path to the service. Can be relative if you have a base_uri set.
 * required: Array of required parameters. Raises a Voorhees::ParameterMissingError if a required parameter is not set.
 
+### Timeouts and Retries
+
+As well as setting the open_timeout/read_timeout of Net::HTTP, we also wrap each request in a timeout check.
+
+If [SystemTimer](http://ph7spot.com/articles/system_timer) is installed it will use this, otherwise it falls back on the Timeout library.
+
+If the request fails with a Timeout::Error, or a Errno::ECONNREFUSED, we attept the request again upto the number of retries specified.
+
+For Errno::ECONNREFUSED errors, we also sleep for 1 second to give the service a chance to wake up.
+
 ### Services and Requests
 
 There are 3 ways to communicate with the service.
@@ -197,6 +207,12 @@ With that we can now do:
     users[0].name               => "Bobby Tables"
     users[0].address.country    => "Somewhere"
     users[0].address.coords.lat => 52.9876
+
+### Requirements
+
+* A JSON library which supports JSON.parse
+* ActiveSupport
+* SystemTimer - falls back on Timer if it's not available
     
 ## Thanks
 

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/lib/voorhees/config.rb

@@ -14,7 +14,8 @@ module Voorhees
           :logger              => defined?(RAILS_DEFAULT_LOGGER) ? RAILS_DEFAULT_LOGGER : Logger.new(STDOUT),
           :timeout             => 10,
           :retries             => 0,
-          :http_method         => Net::HTTP::Get
+          :http_method         => Net::HTTP::Get,
+          :response_class      => Voorhees::Response
         }
       end
       

data/lib/voorhees/logging.rb

@@ -0,0 +1,5 @@
+module Voorhees
+  def self.debug(message)
+    Voorhees::Config[:logger].debug("VOORHEES: #{message}")
+  end
+end

data/lib/voorhees/request.rb

@@ -1,6 +1,14 @@
 require 'uri'
 require 'net/http'
 
+begin
+  require 'system_timer'
+  VoorheesTimer = SystemTimer
+rescue LoadError
+  require 'timeout'
+  VoorheesTimer = Timeout
+end
+
 module Voorhees 
   
   class Request
@@ -66,42 +74,47 @@ module Voorhees
                             parameters
                           end
         
-        @http.open_timeout = timeout || Voorhees::Config[:timeout]
-        @http.read_timeout = timeout || Voorhees::Config[:timeout]        
+        @http.open_timeout = timeout
+        @http.read_timeout = timeout
       end
     
       def perform_actual_request
-        
         retries_left = retries
         
+        Voorhees.debug("Performing #{http_method} request for #{uri.to_s}")
+        
         begin        
           retries_left -= 1
           
-          response = @http.start do |connection| 
-            connection.request(@req) 
-          end
+          response = VoorheesTimer.timeout(timeout) do
+                       @http.start do |connection| 
+                         connection.request(@req) 
+                       end
+                     end
           
         rescue Timeout::Error
           if retries_left >= 0
-            Voorhees::Config.logger.debug("Retrying due to Timeout::Error (#{uri.to_s})")            
+            Voorhees.debug("Retrying due to Timeout::Error (#{uri.to_s})")            
             retry
           end
           
+          Voorhees.debug("Request failed due to Timeout::Error (#{uri.to_s})")
           raise Voorhees::TimeoutError.new
           
         rescue Errno::ECONNREFUSED
           if retries_left >= 0          
-            Voorhees::Config.logger.debug("Retrying due to Errno::ECONNREFUSED (#{uri.to_s})")            
+            Voorhees.debug("Retrying due to Errno::ECONNREFUSED (#{uri.to_s})")            
             sleep(1) 
             retry
           end
           
+          Voorhees.debug("Request failed due to Errno::ECONREFUSED (#{uri.to_s})")
           raise Voorhees::UnavailableError.new
           
         end
 
         if response.is_a?(Net::HTTPNotFound)
-          Voorhees::Config.logger.error("Service Not Found (#{uri.to_s})")           
+          Voorhees.debug("Request failed due to Net::HTTPNotFound (#{uri.to_s})")           
           raise Voorhees::NotFoundError.new
         end
         
@@ -117,8 +130,9 @@ module Voorhees
       end
     
       def parse_response(response)
-        Voorhees::Response.new(JSON.parse(response.body), @caller_class, @hierarchy)
+        Voorhees::Config[:response_class].new(JSON.parse(response.body), @caller_class, @hierarchy)
       rescue JSON::ParserError
+        Voorhees.debug("Parsing JSON failed.\nFirst 500 chars of body:\n#{response.body[0...500]}")
         raise Voorhees::ParseError
       end
     

data/lib/voorhees/resource.rb

@@ -8,6 +8,7 @@ module Voorhees
       
       base.instance_eval do
         attr_accessor :raw_json, :json_hierarchy
+        undef_method :id        
       end
     end    
     
@@ -44,7 +45,7 @@ module Voorhees
     module InstanceMethods
       
       def json_attributes
-        @json_attributes ||= @raw_json.keys.collect{|x| x.to_sym}
+        @json_attributes ||= @raw_json.keys.collect{|x| x.underscore.to_sym}
       end
       
       def json_request(klass=nil)
@@ -55,7 +56,6 @@ module Voorhees
       
       def method_missing(*args)
         method_name = args[0]
-        
         if json_attributes.include?(method_name)
           value = value_from_json(method_name)
           build_methods(method_name, value)
@@ -70,7 +70,7 @@ module Voorhees
       private
         
         def value_from_json(method_name)
-          item = raw_json[method_name.to_s]
+          item = raw_json[method_name.to_s] || raw_json[method_name.to_s.camelize(:lower)]
           
           sub_hierarchy = nil
           if json_hierarchy && hierarchy = json_hierarchy[method_name] 

data/lib/voorhees.rb

@@ -1,3 +1,4 @@
+require "voorhees/logging"
 require "voorhees/config"
 require "voorhees/exceptions"
 require "voorhees/request"

data/spec/fixtures/user.json

@@ -12,6 +12,7 @@
       "lon":12.3456
     }
   },
+  "camelCase":"camel",
   "pet":{
     "kind":"dog",
     "name":"spot"

data/spec/request_spec.rb

@@ -284,7 +284,7 @@ describe Voorhees::Request do
     
     describe "with TimeoutError" do
       
-      it "should raise a Voorhees::TimeoutError" do
+      it "should raise a Voorhees::TimeoutError when Timeout::Error is from connection" do
         @connection.stub!(:request).and_raise(Timeout::Error.new(nil))
         
         lambda{
@@ -292,6 +292,14 @@ describe Voorhees::Request do
         }.should raise_error(Voorhees::TimeoutError)
       end
       
+      it "should raise a Voorhees::TimeoutError when Timeout::Error is from VoorheesTimer" do
+        VoorheesTimer.stub!(:timeout).and_raise(Timeout::Error.new(nil))
+        
+        lambda{
+          @request.perform
+        }.should raise_error(Voorhees::TimeoutError)
+      end      
+      
       describe "with retries" do
 
         before :each do

data/spec/resource_spec.rb

@@ -153,8 +153,8 @@ describe User  do
     end
     
     describe "#json_attributes" do
-      it "should contain symbols of the keys of the attributes available" do
-        user_from_json.json_attributes.sort.should == [:address, :email, :id, :messages, :name, :pet, :username]
+      it "should contain symbols of the keys of the attributes available as underscored" do
+        user_from_json.json_attributes.sort.should == [:address, :camel_case, :email, :id, :messages, :name, :pet, :username]
       end
     end
     
@@ -216,6 +216,11 @@ describe User  do
     
     describe "calling method with the name of a json attribute" do
       
+      it "should return the correct data from #id" do
+        user = user_from_json
+        user.id.should == @json["id"]
+      end
+      
       it "should define a method of the same name" do
         user = user_from_json
         
@@ -237,6 +242,12 @@ describe User  do
         end
       end
       
+      describe "which is camelCase in the JSON" do
+        it "should return the value of the attribute" do
+          user_from_json.camel_case.should == @json["camelCase"]
+        end
+      end
+      
       describe "which is a collection" do
         it "should return an array" do
           user_from_json.messages.should be_an_instance_of(Array)

data/voorhees.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{voorhees}
-  s.version = "0.1.3"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Livsey"]
-  s.date = %q{2009-06-21}
+  s.date = %q{2009-06-24}
   s.email = %q{richard@livsey.org}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
      "lib/voorhees.rb",
      "lib/voorhees/config.rb",
      "lib/voorhees/exceptions.rb",
+     "lib/voorhees/logging.rb",
      "lib/voorhees/request.rb",
      "lib/voorhees/resource.rb",
      "lib/voorhees/response.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rlivsey-voorhees
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Richard Livsey
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-21 00:00:00 -07:00
+date: 2009-06-24 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -32,6 +32,7 @@ files:
 - lib/voorhees.rb
 - lib/voorhees/config.rb
 - lib/voorhees/exceptions.rb
+- lib/voorhees/logging.rb
 - lib/voorhees/request.rb
 - lib/voorhees/resource.rb
 - lib/voorhees/response.rb