pauldix-typhoeus 0.0.14 → 0.0.15

data/lib/typhoeus/remote.rb

@@ -99,7 +99,51 @@ module Typhoeus
         raise MockExpectedError, message
       end
     end
-    
+
+    def check_expected_headers!(response_args, options)
+      missing_headers = {}
+
+      response_args[:expected_headers].each do |key, value|
+        if options[:headers].nil?
+          missing_headers[key] = [value, nil]
+        elsif ((options[:headers][key] && value != :anything) &&
+           options[:headers][key] != value)
+
+          missing_headers[key] = [value, options[:headers][key]]
+        end
+      end
+
+      unless missing_headers.empty?
+        raise headers_error_summary(response_args, options, missing_headers, 'expected')
+      end
+    end
+
+    def check_unexpected_headers!(response_args, options)
+      bad_headers = {}
+      response_args[:unexpected_headers].each do |key, value|
+        if (options[:headers][key] && value == :anything) ||
+           (options[:headers][key] == value)
+          bad_headers[key] = [value, options[:headers][key]]
+        end
+      end
+
+      unless bad_headers.empty?
+        raise headers_error_summary(response_args, options, bad_headers, 'did not expect')
+      end
+    end
+
+    def headers_error_summary(response_args, options, missing_headers, lead_in)
+      error = "#{lead_in} the following headers: #{response_args[:expected_headers].inspect}, but received: #{options[:headers].inspect}\n\n"
+      error   << "Differences:\n"
+      error   << "------------\n"
+      missing_headers.each do |key, values|
+        error << "  - #{key}: #{lead_in} #{values[0].inspect}, got #{values[1].inspect}\n"
+      end
+
+      error
+    end
+    private :headers_error_summary
+
     def get_mock_and_run_handlers(method, response_args, options)
       response = Response.new(response_args)
      
@@ -108,24 +152,29 @@ module Typhoeus
       end
       
       if response_args.has_key? :expected_headers
-        raise "#{method} expected body of \"#{response_args[:expected_headers].inspect}\" but received #{options[:headers].inspect}" if response_args[:expected_headers] != options[:headers]
+        check_expected_headers!(response_args, options)
       end
-      
+
+      if response_args.has_key? :unexpected_headers
+        check_unexpected_headers!(response_args, options)
+      end
+
       if response.code >= 200 && response.code < 300 && options.has_key?(:on_success)
         response = options[:on_success].call(response)
       elsif options.has_key?(:on_failure)
         response = options[:on_failure].call(response)
       end
-      response
+
+      encode_nil_response(response)
     end
-    
+       
     [:get, :post, :put, :delete].each do |method|
       line = __LINE__ + 2  # get any errors on the correct line num
       code = <<-SRC
         def #{method.to_s}(url, options = {})
           mock_object = get_mock(:#{method.to_s}, url, options)
           unless mock_object.nil?
-            mock_object
+            decode_nil_response(mock_object)
           else
             enforce_allow_net_connect!(:#{method.to_s}, url, options[:params])
             remote_proxy_object(url, :#{method.to_s}, options)
@@ -243,5 +292,14 @@ module Typhoeus
         end
       SRC
     end
+
+    private
+    def encode_nil_response(response)
+      response == nil ? :__nil__ : response
+    end
+
+    def decode_nil_response(response)
+      response == :__nil__ ? nil : response
+    end
   end # ClassMethods
 end

data/lib/typhoeus/remote_method.rb

@@ -12,6 +12,7 @@ module Typhoeus
       @cache_responses   = options.delete(:cache_responses)
       @memoize_responses = options.delete(:memoize_responses) || @cache_responses
       @cache_ttl         = @cache_responses == true ? 0 : @cache_responses
+      @keys              = nil
       
       clear_cache
     end
@@ -104,4 +105,4 @@ module Typhoeus
       end
     end
   end
-end
+end

data/lib/typhoeus.rb

@@ -12,7 +12,7 @@ require 'typhoeus/remote_proxy_object'
 require 'typhoeus/response'
 
 module Typhoeus
-  VERSION = "0.0.14"
+  VERSION = "0.0.15"
   
   def self.easy_object_pool
     @easy_objects ||= []

data/spec/typhoeus/remote_spec.rb

@@ -54,6 +54,20 @@ describe Typhoeus do
         }.should_not raise_error
       end
     end
+
+    describe "handlers" do
+      it "should be able to return nil as part of their block" do
+        @klass.allow_net_connect = false
+        url = 'http://api.mysite.com/v1/stuff.json'
+        @klass.mock(:get,
+                    :url => url,
+                    :body => '',
+                    :code => 500)
+        result = @klass.get(url,
+                            :on_failure => lambda { |response| nil })
+        result.should be_nil
+      end
+    end
   end
 
   describe "mocking" do
@@ -138,13 +152,68 @@ describe Typhoeus do
         }.should raise_error
       end
     end
-    
+
+    describe "check_expected_headers!" do
+      before(:each) do
+        @header_klass = Class.new do
+          include Typhoeus
+        end
+      end
+
+      it "should match a header with :anything" do
+        lambda {
+          @header_klass.check_expected_headers!(
+            { :expected_headers => { 'Content-Type' => :anything } },
+            { :headers => { 'Content-Type' => 'text/xml' } }
+          )
+        }.should_not raise_error
+      end 
+
+      it "should enforce exact matching" do
+        lambda {
+          @header_klass.check_expected_headers!(
+            { :expected_headers => { 'Content-Type' => 'text/html' } },
+            { :headers => { 'Content-Type' => 'text/xml' } }
+          )
+        }.should raise_error
+      end
+    end
+  
+    describe "check_unexpected_headers!" do
+      before(:each) do
+        @header_klass = Class.new do
+          include Typhoeus
+        end
+      end
+
+      it "should match a header with :anything" do
+        lambda {
+          @header_klass.check_unexpected_headers!(
+            { :unexpected_headers => { 'Content-Type' => :anything } },
+            { :headers => { "Content-Type" => "text/xml" } }
+          )
+        }.should raise_error
+      end
+
+      it "should not match if a header is different from the expected value" do
+        lambda {
+          @header_klass.check_unexpected_headers!(
+            { :unexpected_headers => { 'Content-Type' => 'text/html' } },
+            { :headers => { "Content-Type" => "text/xml" } }
+          )
+        }.should_not raise_error
+      end
+    end
+
     describe "request header expectations" do
       before(:all) do
         @header_klass = Class.new do
           include Typhoeus
         end
-        @header_klass.mock(:get, :url => "http://asdf", :expected_headers => {"If-None-Match" => "\"lkjsd90823\""})
+        @header_klass.mock(:get,
+                           :url => "http://asdf",
+                           :expected_headers => {"If-None-Match" => "\"lkjsd90823\""},
+                           :unexpected_headers => { 'Content-Type' => "text/xml" })
       end
       
       it "should take expected request headers" do
@@ -156,6 +225,13 @@ describe Typhoeus do
           @header_klass.get("http://asdf")
         }.should raise_error
       end
+
+      it "should raise if an unexpected header shows up" do
+        lambda {
+          @header_klass.get("http://asdf",
+                            :headers => { "Content-Type" => "text/xml" })
+        }.should raise_error
+      end
     end
     
     describe "remote methods" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pauldix-typhoeus
 version: !ruby/object:Gem::Version 
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors: 
 - Paul Dix