webmock 1.15.2 → 1.16.0

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 1.16.0
+
+* Allow a Pathname to be passed as a Response body
+
+        stub_request(:get, /example.com/).to_return(
+          body: Rails.root.join('test/fixtures/foo.txt')
+        )
+
+  Thanks to [Ben Pickles](https://github.com/benpickles)
+
+* `hash_including` matcher can be initialized with empty keys to match any values.
+
+        stub_request(:post, "www.example.com").with(:body => hash_including(:a, :b => {'c'}))
+        RestClient.post('www.example.com', '{"a":"1","b":"c"}', :content_type => 'application/json')
+
+  Thanks to [Stefano Uliari](https://github.com/steookk)
+
 ## 1.15.2
 
 *  Fixed `hash_including` to accept a splat of solitary keys.

data/README.md

@@ -864,6 +864,7 @@ People who submitted patches and new features or suggested improvements. Many th
 * Brian D. Burns
 * Riley Strong
 * Tamir Duberstein
+* Stefano Uliari
 
 For a full list of contributors you can visit the
 [contributors](https://github.com/bblimke/webmock/contributors) page.

data/lib/webmock/api.rb

@@ -35,11 +35,21 @@ module WebMock
       assert_request_not_requested(*args)
     end
 
-    def hash_including(*expected)
+    # Similar to RSpec::Mocks::ArgumentMatchers#hash_including()
+    #
+    # Matches a hash that includes the specified key(s) or key/value pairs.
+    # Ignores any additional keys.
+    #
+    # @example
+    #
+    #   object.should_receive(:message).with(hash_including(:key => val))
+    #   object.should_receive(:message).with(hash_including(:key))
+    #   object.should_receive(:message).with(hash_including(:key, :key2 => val2))
+    def hash_including(*args)
       if defined?(super)
         super
       else
-        WebMock::Matchers::HashIncludingMatcher.new(expected)
+        WebMock::Matchers::HashIncludingMatcher.new(anythingize_lonely_keys(*args))
       end
     end
 
@@ -64,5 +74,12 @@ module WebMock
       WebMock::AssertionFailure.failure(verifier.negative_failure_message) unless verifier.does_not_match?
     end
 
+    #this is a based on RSpec::Mocks::ArgumentMatchers#anythingize_lonely_keys
+    def anythingize_lonely_keys(*args)
+      hash = args.last.class == Hash ? args.delete_at(-1) : {}
+      args.each { | arg | hash[arg] =  WebMock::Matchers::AnyArgMatcher.new(nil) }
+      hash
+    end
+
   end
 end

data/lib/webmock/http_lib_adapters/httpclient_adapter.rb

@@ -148,6 +148,7 @@ if defined?(::HTTPClient)
       hdrs[header[0]] << header[1]
       hdrs
     end
+    headers = headers_from_session(uri).merge(headers)
 
     if (auth_cred = auth.get(req)) && auth.scheme == 'Basic'
       userinfo = WebMock::Util::Headers.decode_userinfo_from_header(auth_cred)
@@ -186,4 +187,28 @@ if defined?(::HTTPClient)
     webmock_request_signatures.delete_at(index)
   end
 
+  private
+
+  # some of the headers sent by HTTPClient are derived from
+  # the client session
+  def headers_from_session(uri)
+    session_headers = HTTP::Message::Headers.new
+    @session_manager.send(:open, uri).send(:set_header, MessageMock.new(session_headers))
+    session_headers.all.inject({}) do |hdrs, header|
+      hdrs[header[0]] = header[1]
+      hdrs
+    end
+  end
+
+  # Mocks a HTTPClient HTTP::Message
+  class MessageMock
+    attr_reader :header
+
+    def initialize(headers)
+      @header = headers
+    end
+
+    def http_version=(value);end
+  end
+
 end

data/lib/webmock/http_lib_adapters/net_http.rb

@@ -97,7 +97,7 @@ module WebMock
               response = super(request, nil, &nil)
               after_request.call(response)
             }
-            response = if started?
+            if started?
               if WebMock::Config.instance.net_http_connect_on_start
                 super_with_after_request.call
               else

data/lib/webmock/matchers/hash_including_matcher.rb

@@ -21,5 +21,16 @@ module WebMock
         new(matcher.instance_variable_get(:@expected))
       end
     end
+
+    #this is a based on RSpec::Mocks::ArgumentMatchers::AnyArgMatcher
+    class AnyArgMatcher
+      def initialize(ignore)
+      end
+
+      def ==(other)
+        true
+      end
+    end
+
   end
 end

data/lib/webmock/response.rb

@@ -100,10 +100,10 @@ module WebMock
     private
 
     def stringify_body!
-      if @body.is_a?(IO)
+      if @body.is_a?(IO) || @body.is_a?(Pathname)
         io = @body
         @body = io.read
-        io.close
+        io.close if io.respond_to?(:close)
       end
     end
 

data/lib/webmock/version.rb

@@ -1,3 +1,3 @@
 module WebMock
-  VERSION = '1.15.2' unless defined?(::WebMock::VERSION)
+  VERSION = '1.16.0' unless defined?(::WebMock::VERSION)
 end

data/spec/acceptance/excon/excon_spec.rb

@@ -48,7 +48,7 @@ describe "Excon" do
   end
 
   let(:file) { File.new(__FILE__) }
-  let(:file_contents) { File.new(__FILE__).read }
+  let(:file_contents) { File.read(__FILE__) }
 
   it 'handles file uploads correctly' do
     stub_request(:put, "http://example.com/upload").with(:body => file_contents)

data/spec/acceptance/httpclient/httpclient_spec.rb

@@ -127,4 +127,29 @@ describe "HTTPClient" do
     end
   end
 
+  context 'session headers' do
+
+    it "client sends a User-Agent header when given an agent_name explicitly to the client" do
+      user_agent = "Client/0.1"
+      stub_request(:get, "www.example.com").with(:headers => { 'User-agent' => "#{user_agent} #{HTTPClient::LIB_NAME}" })
+      HTTPClient.new(:agent_name => user_agent).get("www.example.com")
+    end
+
+    it "client sends the Accept, User-Agent, and Date by default" do
+      stub_request(:get, "www.example.com").with do |req|
+        req.headers["Accept"].should == "*/*"
+        req.headers["User-Agent"].should == "#{HTTPClient::DEFAULT_AGENT_NAME} #{HTTPClient::LIB_NAME}"
+        req.headers["Date"].should_not be_nil
+      end
+      http_request(:get, "www.example.com")
+    end
+
+    it "explicitly defined headers take precedence over session defaults" do
+      headers = { 'Accept'  => 'foo/bar', 'User-Agent' => 'custom', 'Date' => 'today' }
+      stub_request(:get, "www.example.com").with(:headers => headers)
+      HTTPClient.new.get("www.example.com", nil, headers)
+    end
+
+  end
+
 end

data/spec/acceptance/shared/returning_declared_responses.rb

@@ -92,13 +92,13 @@ shared_context "declared responses" do |*adapter_info|
     describe "when response body was declared as IO" do
       it "should return response body" do
         stub_request(:get, "www.example.com").to_return(:body => File.new(__FILE__))
-        http_request(:get, "http://www.example.com/").body.should == File.new(__FILE__).read
+        http_request(:get, "http://www.example.com/").body.should == File.read(__FILE__)
       end
 
       it "should return response body if requested many times" do
         stub_request(:get, "www.example.com").to_return(:body => File.new(__FILE__))
         2.times do
-          http_request(:get, "http://www.example.com/").body.should == File.new(__FILE__).read
+          http_request(:get, "http://www.example.com/").body.should == File.read(__FILE__)
         end
       end
 
@@ -199,7 +199,7 @@ shared_context "declared responses" do |*adapter_info|
 
     describe "when response was declared as a string with a raw response" do
       before(:each) do
-        @input = File.new(CURL_EXAMPLE_OUTPUT_PATH).read
+        @input = File.read(CURL_EXAMPLE_OUTPUT_PATH)
         stub_request(:get, "www.example.com").to_return(@input)
         @response = http_request(:get, "http://www.example.com/")
       end

data/spec/acceptance/shared/stubbing_requests.rb

@@ -210,34 +210,62 @@ shared_examples_for "stubbing requests" do |*adapter_info|
       end
 
       describe "when body is declared as partial hash matcher" do
-        before(:each) do
-          stub_request(:post, "www.example.com").
-            with(:body => hash_including({:a => '1', 'c' => {'d' => ['e', 'f']} }))
-        end
+        subject(:request) { http_request( :post, "http://www.example.com/",
+                                :body => 'a=1&c[d][]=e&c[d][]=f&b=five') }
 
-        describe "for request with url encoded body" do
-          it "should match request if hash matches body" do
-            http_request(
-              :post, "http://www.example.com/",
-            :body => 'a=1&c[d][]=e&c[d][]=f&b=five').status.should == "200"
+        subject(:wrong_request) { http_request(:post, "http://www.example.com/",
+                                      :body => 'c[d][]=f&a=1&c[d][]=e').status }
+
+        describe "when using 'RSpec:Mocks::ArgumentMatchers#hash_including'" do
+          before(:each) do
+            stub_request(:post, "www.example.com").
+              with(:body => hash_including(:a, :c => {'d' => ['e', 'f']} ))
           end
 
-          it "should not match if hash doesn't match url encoded body" do
-            lambda {
+          describe "for request with url encoded body" do
+            it "should match request if hash matches body" do
+              expect(request.status).to eq("200")
+            end
+
+            it "should not match if hash doesn't match url encoded body" do
+              lambda { wrong_request }.should raise_error
+            end
+          end
+
+          describe "for request with json body and content type is set to json" do
+            it "should match if hash matches body" do
               http_request(
-                :post, "http://www.example.com/",
-              :body => 'c[d][]=f&a=1&c[d][]=e').status
-            }.should raise_error
+                :post, "http://www.example.com/", :headers => {'Content-Type' => 'application/json'},
+              :body => "{\"a\":\"1\",\"c\":{\"d\":[\"e\",\"f\"]},\"b\":\"five\"}").status.should == "200"
+            end
           end
         end
 
-        describe "for request with json body and content type is set to json" do
-          it "should match if hash matches body" do
-            http_request(
-              :post, "http://www.example.com/", :headers => {'Content-Type' => 'application/json'},
-            :body => "{\"a\":\"1\",\"c\":{\"d\":[\"e\",\"f\"]},\"b\":\"five\"}").status.should == "200"
+        describe "when using 'WebMock::API#hash_including'" do
+          before(:each) do
+            stub_request(:post, "www.example.com").
+              with(:body => WebMock::API.hash_including(:a, :c => {'d' => ['e', 'f']} ))
+          end
+
+          describe "for request with url encoded body" do
+            it "should match request if hash matches body" do
+              expect(request.status).to eq("200")
+            end
+
+            it "should not match if hash doesn't match url encoded body" do
+              lambda { wrong_request }.should raise_error
+            end
+          end
+
+          describe "for request with json body and content type is set to json" do
+            it "should match if hash matches body" do
+              http_request(
+                :post, "http://www.example.com/", :headers => {'Content-Type' => 'application/json'},
+              :body => "{\"a\":\"1\",\"c\":{\"d\":[\"e\",\"f\"]},\"b\":\"five\"}").status.should == "200"
+            end
           end
         end
+
       end
     end
 

data/spec/spec_helper.rb

@@ -17,7 +17,7 @@ require 'support/network_connection'
 require 'support/webmock_server'
 require 'support/my_rack_app'
 
-CURL_EXAMPLE_OUTPUT_PATH = File.expand_path(File.dirname(__FILE__)) + "/support/example_curl_output.txt" unless defined? CURL_EXAMPLE_OUTPUT_PATH
+CURL_EXAMPLE_OUTPUT_PATH = File.expand_path('../support/example_curl_output.txt', __FILE__)
 
 RSpec.configure do |config|
   unless NetworkConnection.is_network_available?

data/spec/unit/api_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe WebMock::API do
+  describe '#hash_including' do
+
+    subject { klass.new.hash_including(args) }
+    let(:args) { {:data => :one} }
+
+    context 'when mixed into a class that does not define `hash_including`' do
+      let(:klass) do
+        Class.new do
+          include WebMock::API
+        end
+      end
+
+      it 'uses WebMock::Matchers::HashIncludingMatcher' do
+        expect(subject).to be_a(WebMock::Matchers::HashIncludingMatcher)
+      end
+
+      #  by testing equality for HashIncludingMatcher (which stringifies the passed hash) we are
+      #  testing HashIncludingMatcher.initialize behavior as well
+      context "when args correspond to an hash" do
+        it "creates 'HashIncludingMatcher'" do
+          expect(subject).to eq("data" => :one)
+        end
+      end
+
+      context "when args are one or many keys" do
+        subject {klass.new.hash_including(:foo, :bar)}
+        let(:anything) { WebMock::Matchers::AnyArgMatcher.new(nil) }
+
+        it "creates 'HashIncludingMatcher' with keys anythingized" do
+          expect(subject).to eq("foo" => anything, "bar" => anything )
+        end
+      end
+
+      context "when args are both keys and key/value pairs" do
+        subject {klass.new.hash_including(:foo, :bar, :data => :one)}
+        let(:anything) { WebMock::Matchers::AnyArgMatcher.new(nil) }
+
+        it "creates 'HashIncludingMatcher' with keys anythingized" do
+          expect(subject).to eq("foo" => anything, "bar" => anything, "data" => :one)
+        end
+      end
+
+      context "when args are an emtpy hash" do
+        subject {klass.new.hash_including({})}
+
+        it "creates 'HashIncludingMatcher' with an empty hash" do
+          expect(subject).to eq({})
+        end
+      end
+    end
+
+
+    context 'when mixed into a class with a parent that defines `hash_including`' do
+      subject {klass.new.hash_including(*args)}
+      let(:args) { %w(:foo, :bar, {:data => :one}) }
+      let(:klass) do
+        Class.new(
+          Class.new do
+            def hash_including(*args)
+              args
+            end
+          end
+        ) { include WebMock::API }
+      end
+
+      it 'uses super and passes the args untampered' do
+        expect(subject).to eq(args)
+      end
+    end
+
+  end
+end

data/spec/unit/matchers/hash_including_matcher_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+module WebMock
+  module Matchers
+
+    describe HashIncludingMatcher do
+
+      it "stringifies the given hash keys" do
+        expect(HashIncludingMatcher.new(:a => 1, :b => 2)).to eq("a" => 1, "b" => 2)
+      end
+
+      it "sorts elements in the hash" do
+        expect(HashIncludingMatcher.new(:b => 2, :a => 1)).to eq("a" => 1, "b" => 2)
+      end
+
+      it "describes itself properly" do
+        expect(HashIncludingMatcher.new(:a => 1).inspect).to eq "hash_including({\"a\"=>1})"
+      end
+
+      describe "success" do
+        it "matches the same hash" do
+          expect(HashIncludingMatcher.new("a" => 1, "b" => 2)).to eq("a" => 1, "b" => 2)
+        end
+
+        it "matches a hash with extra stuff" do
+          expect(HashIncludingMatcher.new(:a => 1)).to eq("a" => 1, "b" => 2)
+        end
+
+        describe "when matching anythingized keys" do
+          let(:anything) { WebMock::Matchers::AnyArgMatcher.new(nil) }
+
+          it "matches an int against anything()" do
+            expect(HashIncludingMatcher.new(:a => anything, :b => 2)).to eq({'a' => 1, 'b' => 2})
+          end
+
+          it "matches a string against anything()" do
+            expect(HashIncludingMatcher.new(:a => anything, :b => 2)).to eq({'a' => "1", 'b' => 2})
+          end
+
+          it "matches if the key is present" do
+            expect(HashIncludingMatcher.new(:a => anything)).to eq({'a' => 1, 'b' => 2})
+          end
+
+          it "matches if more keys are present" do
+            expect(HashIncludingMatcher.new(:a => anything, :b => anything)).to eq({'a' => 1, 'b' => 2, 'c' => 3})
+          end
+
+          it "matches if passed many keys and many key/value pairs" do
+            expect(HashIncludingMatcher.new(:a => anything, :b => anything, :c => 3, :e => 5)).to eq({'a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5})
+          end
+        end
+
+        describe "when matching an empty hash" do
+          it "matches against any hash" do
+            expect(HashIncludingMatcher.new({})).to eq({:a => 1, :b => 2, :c => 3})
+          end
+        end
+      end
+
+      describe "failing" do
+        it "does not match a non-hash" do
+          expect(HashIncludingMatcher.new(:a => 1)).not_to eq 1
+        end
+
+        it "does not match a hash with a missing key" do
+          expect(HashIncludingMatcher.new(:a => 1)).not_to eq('b' => 2)
+        end
+
+        it "does not match an empty hash with a given key" do
+          expect(HashIncludingMatcher.new(:a => 1)).not_to eq({})
+        end
+
+        it "does not match a hash with a missing key when one pair is matching" do
+          expect(HashIncludingMatcher.new(:a => 1, :b => 2)).not_to eq('b' => 2)
+        end
+
+        it "does not match a hash with an incorrect value" do
+          expect(HashIncludingMatcher.new(:a => 1, :b => 2)).not_to eq('a' => 1, 'b' => 3)
+        end
+
+        it "does not match when values are nil but keys are different" do
+          expect(HashIncludingMatcher.new(:a => nil)).not_to eq('b' => nil)
+        end
+      end
+    end
+  end
+end

data/spec/unit/response_spec.rb

@@ -111,15 +111,19 @@ describe WebMock::Response do
 
     it "should report content of a IO object if provided" do
       @response = WebMock::Response.new(:body => File.new(__FILE__))
-      @response.body.should == File.new(__FILE__).read
+      @response.body.should == File.read(__FILE__)
     end
 
     it "should report many times content of a IO object if provided" do
       @response = WebMock::Response.new(:body => File.new(__FILE__))
-      @response.body.should == File.new(__FILE__).read
-      @response.body.should == File.new(__FILE__).read
+      @response.body.should == File.read(__FILE__)
+      @response.body.should == File.read(__FILE__)
     end
 
+    it "should work with Pathnames" do
+      @response = WebMock::Response.new(:body => Pathname.new(__FILE__))
+      @response.body.should == File.read(__FILE__)
+    end
   end
 
   describe "from raw response" do
@@ -157,7 +161,7 @@ describe WebMock::Response do
 
     describe "when input is String" do
       before(:each) do
-        @input = File.new(CURL_EXAMPLE_OUTPUT_PATH).read
+        @input = File.read(CURL_EXAMPLE_OUTPUT_PATH)
         @response = WebMock::Response.new(@input)
       end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: webmock
 version: !ruby/object:Gem::Version 
-  hash: 47
+  hash: 87
   prerelease: 
   segments: 
   - 1
-  - 15
-  - 2
-  version: 1.15.2
+  - 16
+  - 0
+  version: 1.16.0
 platform: ruby
 authors: 
 - Bartosz Blimke
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-10-30 00:00:00 Z
+date: 2013-11-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: addressable
@@ -291,10 +291,11 @@ files:
 - spec/support/my_rack_app.rb
 - spec/support/network_connection.rb
 - spec/support/webmock_server.rb
+- spec/unit/api_spec.rb
 - spec/unit/errors_spec.rb
 - spec/unit/http_lib_adapters/http_lib_adapter_registry_spec.rb
 - spec/unit/http_lib_adapters/http_lib_adapter_spec.rb
-- spec/unit/include_spec.rb
+- spec/unit/matchers/hash_including_matcher_spec.rb
 - spec/unit/rack_response_spec.rb
 - spec/unit/request_execution_verifier_spec.rb
 - spec/unit/request_pattern_spec.rb
@@ -381,10 +382,11 @@ test_files:
 - spec/support/my_rack_app.rb
 - spec/support/network_connection.rb
 - spec/support/webmock_server.rb
+- spec/unit/api_spec.rb
 - spec/unit/errors_spec.rb
 - spec/unit/http_lib_adapters/http_lib_adapter_registry_spec.rb
 - spec/unit/http_lib_adapters/http_lib_adapter_spec.rb
-- spec/unit/include_spec.rb
+- spec/unit/matchers/hash_including_matcher_spec.rb
 - spec/unit/rack_response_spec.rb
 - spec/unit/request_execution_verifier_spec.rb
 - spec/unit/request_pattern_spec.rb

data/spec/unit/include_spec.rb

@@ -1,37 +0,0 @@
-require 'spec_helper'
-
-describe WebMock::API do
-  describe '#hash_including' do
-    subject { klass.new.hash_including(*args) }
-
-    let(:args) { %w(foo bar) }
-
-    context 'when mixed into a class that does not define `hash_including`' do
-      let(:klass) do
-        Class.new do
-          include WebMock::API
-        end
-      end
-
-      it 'uses WebMock::Matchers::HashIncludingMatcher' do
-        expect(subject).to be_a(WebMock::Matchers::HashIncludingMatcher)
-      end
-    end
-
-    context 'when mixed into a class with a parent that defines `hash_including`' do
-      let(:klass) do
-        Class.new(
-          Class.new do
-            def hash_including(*args)
-              args
-            end
-          end
-        ) { include WebMock::API }
-      end
-
-      it 'uses super and passes the args untampered' do
-        expect(subject).to eq(args)
-      end
-    end
-  end
-end