voorhees 0.2.0

data/spec/fixtures/resources.rb

@@ -0,0 +1,18 @@
+class Address
+  include Voorhees::Resource
+end
+
+class LatLon
+  include Voorhees::Resource
+end
+
+class Message
+  include Voorhees::Resource
+end
+
+class User
+  include Voorhees::Resource
+end
+
+class NotResource
+end

data/spec/fixtures/user.json

@@ -0,0 +1,32 @@
+{
+  "email":"bt@example.com",
+  "username":"btables",
+  "name":"Bobby Tables",
+  "id":1,
+  "address":{
+    "street":"24 Monkey Close",
+    "city":"Somesville",
+    "country":"Somewhere",
+    "coords":{
+      "lat":52.9876,
+      "lon":12.3456
+    }
+  },
+  "camelCase":"camel",
+  "pet":{
+    "kind":"dog",
+    "name":"spot"
+  },
+  "messages":[
+    {
+      "subject":"QWERTYUIOP",
+      "body":"ASDFHJKOIUFC G F IUH HGJBNM",
+      "id":1
+    },
+    {
+      "subject":"asdoifj sajf askjdfhuaerf kdshf dsaf asdf a skf dksf k.",
+      "body":"adsjfi asdif jaosdj fojasdf jasdjhf hsadkf ahjsdkf jasdhf jasdk;sadfjahsdf ;adfs",
+      "id":2
+    }
+  ]
+}

data/spec/fixtures/users.json

@@ -0,0 +1 @@
+[{"email":"bt@example.com","username":"btables","name":"Bobby Tables","id":1,"messages":[{"subject":"QWERTYUIOP","body":"ASDFHJKOIUFC G F IUH HGJBNM","id":1},{"subject":"asdoifj sajf askjdfhuaerf kdshf dsaf asdf a skf dksf k.","body":"adsjfi asdif jaosdj fojasdf jasdjhf hsadkf ahjsdkf jasdhf jasdk;sadfjahsdf ;adfs","id":2}]},{"email":"rm@example.com","username":"rmoore","name":"Roger Moore","id":2,"messages":[{"subject":"Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.","body":"Lorem ipsum dolor sit amet, consectetur adipisicing elit","id":4},{"subject":"Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.","body":"Excepteur sint o cat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.","id":5}]}]

data/spec/request_spec.rb

@@ -0,0 +1,455 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Voorhees::Request do
+  
+  before :each do 
+    @caller_class = User
+    @request = Voorhees::Request.new(@caller_class)
+    
+    # disable the logger
+    Voorhees::Config.reset
+    Voorhees::Config.logger = mock(:logger, :null_object => true)
+  end
+  
+  describe "global defaults" do
+    
+    before :each do
+      Voorhees::Config.setup do |c|
+        c.timeout = 1
+        c.retries = 50
+      end
+    end
+    
+    it "should override the global defaults if overridden" do
+      @request.timeout = 100
+      @request.timeout.should == 100
+    end
+    
+    it "should default to the global defaults if not overridden" do
+      @request.retries.should == 50
+    end
+    
+  end
+  
+  describe "defaults" do
+    
+    it "should be included in the parameters" do
+      @request.defaults   = {:all => true}
+      @request.parameters = {:order => 'surname'}
+      @request.parameters.should == {:all => true, :order => 'surname'}      
+    end
+    
+    it "should be overridden by matching parameters" do
+      @request.defaults   = {:all => true, :order => 'surname'}
+      @request.parameters = {:all => false}
+      @request.parameters.should == {:all => false, :order => 'surname'}
+    end    
+  
+  end
+  
+  
+  describe "uri" do
+    
+    before :each do
+      @base = "http://example.com"
+      @path = "/some/path"
+      Voorhees::Config.base_uri = @base
+    end
+    
+    it "should prepend the base_uri if it's given relative path" do
+      @request.path = @path
+      @request.uri.to_s.should == "#{@base}#{@path}"
+    end
+    
+    it "should not prepend the base_uri if it's given a full URI" do
+      @request.path = "#{@base}#{@path}"
+      @request.uri.to_s.should == "#{@base}#{@path}"
+    end
+    
+    describe "with parameters" do
+
+      before :each do
+        @request.parameters = {:monkeys => 2}        
+      end
+
+      describe "with a Net::HTTP::POST request" do
+
+        before :each do
+          Voorhees::Config[:http_method] = Net::HTTP::Post
+        end
+
+        it "should not append the query string with the parameters" do
+          @request.path = "#{@base}#{@path}"
+          @request.uri.to_s.should == "#{@base}#{@path}"
+        end
+
+      end
+      
+      [Net::HTTP::Get, Net::HTTP::Put, Net::HTTP::Delete].each do |type|
+        describe "with #{type} requests" do
+
+          before :each do
+            Voorhees::Config[:http_method] = type
+          end      
+
+          it "should set the query string with the parameters" do
+            @request.path = "#{@base}#{@path}"
+            @request.uri.to_s.should == "#{@base}#{@path}?monkeys=2"        
+          end
+        end
+      end
+    end
+    
+  end  
+  
+  describe "validation" do
+    
+    before :each do 
+      @request.required = [:id, :login]
+    end
+    
+    it "should raise Voorhees::ParameterMissingError if the params do not contain a required item" do
+      @request.parameters = {:id => 1}
+      
+      lambda{
+        @request.send(:validate)
+      }.should raise_error(Voorhees::ParameterMissingError)
+    end
+    
+    it "should not raise Voorhees::ParameterMissingError if the params contain all required items" do
+      @request.parameters = {:id => 1, :login => 'test'}      
+      
+      lambda{
+        @request.send(:validate)
+      }.should_not raise_error(Voorhees::ParameterMissingError)
+    end
+    
+  end
+    
+  describe "perform" do
+    
+    before :each do
+      @host       = "example.com"
+      @port       = 8080
+      @path       = "/endpoint"
+      @params     = {:bananas => 5}
+      @hierarchy  = {:address => Address}
+      
+      @request.path       = "http://#{@host}:#{@port}#{@path}"
+      @request.timeout    = 10
+      @request.retries    = 0
+      @request.hierarchy  = @hierarchy
+      @request.parameters = @params
+      
+      @mock_post = mock(:post, :null_object => true)
+      Net::HTTP::Post.stub!(:new).and_return(@mock_post)
+
+      @mock_get = mock(:get, :null_object => true)
+      Net::HTTP::Get.stub!(:new).and_return(@mock_get)
+      
+      @mock_put = mock(:put, :null_object => true)
+      Net::HTTP::Put.stub!(:put).and_return(@mock_put)
+      
+      @mock_delete = mock(:delete, :null_object => true)
+      Net::HTTP::Delete.stub!(:delete).and_return(@mock_delete)
+
+      Voorhees::Config[:http_method] = Net::HTTP::Get
+
+      body = '{"something":"result"}'
+      @http_response = Net::HTTPResponse::CODE_TO_OBJ["200"].new("1.1", 200, body)
+      @http_response.stub!(:body).and_return(body)
+      @json_response = body
+      
+      @mock_http  = MockNetHttp.new
+      @connection = @mock_http.connection
+      @connection.stub!(:request).and_return(@http_response)      
+      Net::HTTP.stub!(:new).and_return(@mock_http)
+    end    
+    
+    
+    def perform_catching_errors
+      @request.perform
+    rescue
+    end
+    
+    describe "with GET request" do
+      
+      before :each do 
+        Voorhees::Config[:http_method] = Net::HTTP::Get
+      end      
+      
+      it "should perform a HTTP::Get request to the correct path" do
+        Net::HTTP::Get.should_receive(:new).with(@path).and_return(@mock_get)
+        @request.perform
+      end      
+      
+    end
+    
+    describe "with POST request" do
+      
+      before :each do 
+        Voorhees::Config[:http_method] = Net::HTTP::Post
+      end      
+      
+      describe "with post_json set" do
+
+        before :each do 
+          @param_name = "json_data"
+          Voorhees::Config[:post_json]            = true
+          Voorhees::Config[:post_json_parameter]  = @param_name
+        end
+
+        it "should set the form_data to a hash with JSON parameters as :post_json_parameter" do
+          @mock_post.should_receive(:form_data=).with({ @param_name => @params.to_json })
+          @request.perform
+        end      
+        
+      end
+
+      describe "without post_json set" do
+
+        before :each do 
+          Voorhees::Config[:post_json] = false
+        end      
+
+        it "should set the form_data to the parameters" do
+          @mock_post.should_receive(:form_data=).with(@params)
+          @request.perform
+        end      
+      end      
+      
+      it "should perform a HTTP::Post request to the correct path" do
+        Net::HTTP::Post.should_receive(:new).with(@path).and_return(@mock_post)
+        @request.perform
+      end 
+      
+    end
+    
+    describe "with DELETE request" do
+      
+      before :each do 
+        Voorhees::Config[:http_method] = Net::HTTP::Delete
+      end      
+      
+      it "should perform a HTTP::Get request to the correct path" do
+        Net::HTTP::Delete.should_receive(:new).with(@path).and_return(@mock_delete)
+        @request.perform
+      end      
+      
+    end
+    
+    describe "with PUT request" do
+      
+      before :each do 
+        Voorhees::Config[:http_method] = Net::HTTP::Put
+      end      
+      
+      it "should perform a HTTP::Get request to the correct path" do
+        Net::HTTP::Put.should_receive(:new).with(@path).and_return(@mock_put)
+        @request.perform
+      end      
+      
+    end
+    
+    it "should create a Net::HTTP object with the correct host and port" do
+      Net::HTTP.should_receive(:new).with(@host, @port).and_return(@mock_http)
+      @request.perform
+    end
+    
+    it "should set Net::HTTP#open_timeout" do
+      @mock_http.should_receive(:open_timeout=).with(@request.timeout)
+      @request.perform   
+    end
+
+    it "should set Net::HTTP#read_timeout" do
+      @mock_http.should_receive(:read_timeout=).with(@request.timeout)      
+      @request.perform     
+    end    
+
+    it "should send one request to Net::HTTP#start" do
+      @connection.should_receive(:request).once.with(@mock_get)
+      @request.perform
+    end
+
+    it "should return the response from the service as a Voorhees::Response" do
+      @connection.stub!(:request).and_return(@http_response)
+      @request.perform.should be_a(Voorhees::Response)
+    end    
+    
+    it "should pass the json body, caller class and hierarcy to the response" do
+      @connection.stub!(:request).and_return(@http_response)
+            
+      Voorhees::Response.should_receive(:new).with(@json_response, @caller_class, @hierarchy)      
+      @request.perform
+    end
+    
+    describe "with 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{
+          @request.perform
+        }.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
+          @request.retries = 2          
+        end
+
+        describe "with subsequent success" do
+
+          it "should post the request 2 times" do
+            @connection.should_receive(:request).with(@mock_get).exactly(1).times.ordered.and_raise(Timeout::Error.new(nil))                
+            @connection.should_receive(:request).with(@mock_get).exactly(1).times.ordered
+            @request.perform                
+          end   
+
+          it "should return the response from the service" do
+            @connection.should_receive(:request).with(@mock_get).exactly(1).times.ordered.and_raise(Timeout::Error.new(nil))                
+            @connection.should_receive(:request).with(@mock_get).exactly(1).times.ordered.and_return(@http_response)
+            @request.perform.body.should == @json_response
+          end
+
+        end
+
+        describe "with subseqent failure" do
+
+          before :each do
+            @connection.stub!(:request).and_raise(Timeout::Error.new(nil))
+          end
+
+          it "should post the request 3 times (original + 2 retries)" do
+            @connection.should_receive(:request).with(@mock_get).exactly(3).times.and_raise(Timeout::Error.new(nil))        
+            perform_catching_errors
+          end
+
+          it "should raise an Voorhees::TimeoutError exception" do
+            lambda {
+              @request.perform
+            }.should raise_error(Voorhees::TimeoutError)
+          end
+        end
+      end
+    end
+    
+    
+    describe "with Net::HTTPNotFound" do
+      
+      it "should raise a Voorhees::NotFoundError" do
+        @connection.stub!(:request).and_return(Net::HTTPNotFound.new(404, 1.1, "Not Found"))
+        
+        lambda{
+          @request.perform
+        }.should raise_error(Voorhees::NotFoundError)
+      end      
+      
+      describe "with retries" do
+        
+        before :each do
+          @request.retries  = 2          
+        end        
+        
+        it "should not retry" do
+          @connection.should_receive(:request).with(@mock_get).exactly(1).times.and_return(Net::HTTPNotFound.new(404, 1.1, "Not Found"))             
+          perform_catching_errors
+        end
+      end
+    end
+    
+    
+    describe "with Errno::ECONNREFUSED" do
+      
+      it "should raise a Voorhees::UnavailableError" do
+        @connection.stub!(:request).and_raise(Errno::ECONNREFUSED)
+        
+        lambda{
+          @request.perform
+        }.should raise_error(Voorhees::UnavailableError)
+      end      
+      
+      it "should not sleep" do
+        @connection.stub!(:request).and_raise(Errno::ECONNREFUSED)        
+        @request.should_not_receive(:sleep)
+        perform_catching_errors
+      end      
+      
+      describe "with retries" do
+
+        before :each do
+          @request.retries  = 2          
+          @request.stub!(:sleep)              
+        end
+
+        it "should sleep for 1 second before each timeout" do
+          @connection.stub!(:request).and_raise(Errno::ECONNREFUSED)        
+          @request.should_receive(:sleep).with(1)
+          perform_catching_errors
+        end
+
+        describe "with subsequent success" do
+
+          it "should post the request 2 times" do
+            @connection.should_receive(:request).with(@mock_get).exactly(1).times.ordered.and_raise(Errno::ECONNREFUSED)                
+            @connection.should_receive(:request).with(@mock_get).exactly(1).times.ordered
+            @request.perform           
+          end   
+
+          it "should return the response from the service" do
+            @connection.should_receive(:request).with(@mock_get).exactly(1).times.ordered.and_raise(Errno::ECONNREFUSED)                
+            @connection.should_receive(:request).with(@mock_get).exactly(1).times.ordered.and_return(@http_response)
+            @request.perform.body.should == @json_response
+          end
+        end
+
+        describe "with subsequent failure" do
+
+          before :each do
+            @connection.stub!(:request).and_raise(Errno::ECONNREFUSED)      
+          end        
+
+          it "should post the request 3 times (original + 2 retries)" do
+            @connection.should_receive(:request).with(@mock_get).exactly(3).times.and_raise(Errno::ECONNREFUSED)        
+            perform_catching_errors
+          end      
+
+          it "should raise an Voorhees::UnavailableError exception" do
+            lambda {
+              @request.perform
+            }.should raise_error(Voorhees::UnavailableError)
+          end
+        end
+      end
+    end
+  end
+end
+
+
+
+class MockNetHttp
+  
+  attr_accessor :connection
+  
+  def initialize(*args)
+    @connection = mock(:connection)    
+  end
+  
+  def start
+    yield @connection
+  end  
+    
+  def method_missing(*args)
+    return self
+  end
+    
+end