webmock 3.0.1 → 3.18.1

data/spec/acceptance/shared/stubbing_requests.rb

@@ -63,6 +63,16 @@ shared_examples_for "stubbing requests" do |*adapter_info|
         stub_request(:get, "www.example.com").with(query: hash_including({"a" => ["b", "c"]})).to_return(body: "abc")
         expect(http_request(:get, "http://www.example.com/?a[]=b&a[]=c&b=1").body).to eq("abc")
       end
+
+      it 'should return stubbed response when stub expects exclude part of query params' do
+        stub_request(:get, 'www.example.com').with(query: hash_excluding(a: ['b', 'c'])).to_return(body: 'abc')
+        expect(http_request(:get, 'http://www.example.com/?a[]=c&a[]=d&b=1').body).to eq('abc')
+      end
+
+      it "should return stubbed response when stub expects an empty array" do
+        stub_request(:get, 'www.example.com').with(query: { a: [] }).to_return(body: 'abc')
+        expect(http_request(:get, 'http://www.example.com/?a[]').body).to eq('abc')
+      end
     end
 
     describe "based on method" do
@@ -150,6 +160,32 @@ shared_examples_for "stubbing requests" do |*adapter_info|
               body: 'c[d][]=f&a=1&c[d][]=e')
             }.to raise_error(WebMock::NetConnectNotAllowedError, %r(Real HTTP connections are disabled. Unregistered request: POST http://www.example.com/ with body 'c\[d\]\[\]=f&a=1&c\[d\]\[\]=e'))
           end
+
+          describe "for request with form url encoded body and content type" do
+            it "should match if stubbed request body hash has string values matching string values in request body" do
+              WebMock.reset!
+              stub_request(:post, "www.example.com").with(body: {"foo" => '1'})
+              expect(http_request(
+                :post, "http://www.example.com/", headers: {'Content-Type' => 'application/x-www-form-urlencoded'},
+              body: "foo=1").status).to eq("200")
+            end
+
+            it "should match if stubbed request body hash has NON string values matching string values in request body" do
+              WebMock.reset!
+              stub_request(:post, "www.example.com").with(body: {"foo" => 1})
+              expect(http_request(
+                :post, "http://www.example.com/", headers: {'Content-Type' => 'application/x-www-form-urlencoded'},
+              body: "foo=1").status).to eq("200")
+            end
+
+            it "should match if stubbed request body is hash_included" do
+              WebMock.reset!
+              stub_request(:post, "www.example.com").with(body: {"foo" => hash_including("bar" => '1')})
+              expect(http_request(
+                       :post, "http://www.example.com/", headers: {'Content-Type' => 'application/x-www-form-urlencoded'},
+                       body: "foo[bar]=1").status).to eq("200")
+            end
+          end
         end
 
 
@@ -182,6 +218,30 @@ shared_examples_for "stubbing requests" do |*adapter_info|
               :post, "http://www.example.com/", headers: {'Content-Type' => 'application/json'},
             body: "{\"foo\":\"a b c\"}").status).to eq("200")
           end
+
+          it "should match if stubbed request body hash has NON string values matching NON string values in request body" do
+            WebMock.reset!
+            stub_request(:post, "www.example.com").with(body: {"foo" => 1})
+            expect(http_request(
+              :post, "http://www.example.com/", headers: {'Content-Type' => 'application/json'},
+            body: "{\"foo\":1}").status).to eq("200")
+          end
+
+          it "should not match if stubbed request body hash has string values matching NON string values in request body" do
+            WebMock.reset!
+            stub_request(:post, "www.example.com").with(body: {"foo" => '1'})
+            expect{http_request(
+              :post, "http://www.example.com/", headers: {'Content-Type' => 'application/json'},
+            body: "{\"foo\":1}") }.to raise_error(WebMock::NetConnectNotAllowedError)
+          end
+
+          it "should not match if stubbed request body hash has NON string values matching string values in request body" do
+            WebMock.reset!
+            stub_request(:post, "www.example.com").with(body: {"foo" => 1})
+            expect{http_request(
+              :post, "http://www.example.com/", headers: {'Content-Type' => 'application/json'},
+            body: "{\"foo\":\"1\"}") }.to raise_error(WebMock::NetConnectNotAllowedError)
+          end
         end
 
         describe "for request with xml body and content type is set to xml" do
@@ -533,6 +593,23 @@ shared_examples_for "stubbing requests" do |*adapter_info|
           end
         end
       end
+
+      context "when global stub should be invoked last" do
+        before do
+          WebMock.globally_stub_request(:after_local_stubs) do
+            { body: "global stub body" }
+          end
+        end
+
+        it "uses global stub when non-global stub is not defined" do
+          expect(http_request(:get, "http://www.example.com/").body).to eq("global stub body")
+        end
+
+        it "uses non-global stub first" do
+          stub_request(:get, "www.example.com").to_return(body: 'non-global stub body')
+          expect(http_request(:get, "http://www.example.com/").body).to eq("non-global stub body")
+        end
+      end
     end
 
     describe "when stubbing request with a block evaluated on request" do
@@ -580,4 +657,22 @@ shared_examples_for "stubbing requests" do |*adapter_info|
       }.to raise_error(WebMock::NetConnectNotAllowedError, %r(Real HTTP connections are disabled. Unregistered request: GET http://www.example.com/))
     end
   end
+
+  describe "in Rspec around(:each) hook" do
+    # order goes
+    # around(:each)
+    # before(:each)
+    # after(:each)
+    # anything after example.run in around(:each)
+    around(:each) do |example|
+      example.run
+      expect {
+        http_request(:get, "http://www.example.com/")
+      }.to_not raise_error # WebMock::NetConnectNotAllowedError
+    end
+
+    it "should still allow me to make a mocked request" do
+      stub_request(:get, "www.example.com")
+    end
+  end
 end

data/spec/acceptance/typhoeus/typhoeus_hydra_spec.rb

@@ -127,7 +127,7 @@ unless RUBY_PLATFORM =~ /java/
           end
           hydra.queue @request
           hydra.run
-          expect(test_headers).to include('X-Test' => '1')
+          expect(test_headers.to_h).to include('X-Test' => '1')
         end
       end
     end

data/spec/acceptance/typhoeus/typhoeus_hydra_spec_helper.rb

@@ -6,7 +6,7 @@ module TyphoeusHydraSpecHelper
 
 
   def http_request(method, uri, options = {}, &block)
-    uri.gsub!(" ", "%20") #typhoeus doesn't like spaces in the uri
+    uri = uri.gsub(" ", "%20") #typhoeus doesn't like spaces in the uri
     request_options =  {
       method: method,
       body: options[:body],

data/spec/support/webmock_server.rb

@@ -36,6 +36,7 @@ class WebMockServer
         end
       end
       server.start do |socket|
+        socket.read(1)
         socket.puts <<-EOT.gsub(/^\s+\|/, '')
           |HTTP/1.1 200 OK\r
           |Date: Fri, 31 Dec 1999 23:59:59 GMT\r

data/spec/unit/api_spec.rb

@@ -2,9 +2,8 @@ require 'spec_helper'
 
 describe WebMock::API do
   describe '#hash_including' do
-
     subject { klass.new.hash_including(args) }
-    let(:args) { {data: :one} }
+    let(:args) { { data: :one } }
 
     context 'when mixed into a class that does not define `hash_including`' do
       let(:klass) do
@@ -54,7 +53,7 @@ describe WebMock::API do
 
 
     context 'when mixed into a class with a parent that defines `hash_including`' do
-      subject {klass.new.hash_including(*args)}
+      subject { klass.new.hash_including(*args) }
       let(:args) { %w(:foo, :bar, {:data => :one}) }
       let(:klass) do
         Class.new(
@@ -70,6 +69,107 @@ describe WebMock::API do
         expect(subject).to eq(args)
       end
     end
+  end
+
+  describe '#hash_excluding' do
+    subject { klass.new.hash_excluding(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::HashExcludingMatcher)
+      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
+        context 'creates "HashExcludingMatcher"' do
+          it 'equals hash with similar key but different value' do
+            expect(subject).to eq('data' => :two)
+          end
+
+          it 'equals hash with similar value but different key' do
+            expect(subject).to eq('data2' => :one)
+          end
+
+          it 'equals hash with defferent value and key' do
+            expect(subject).to eq('data2' => :two)
+          end
+
+          it 'not equals with similar value and key' do
+            expect(subject).not_to eq('data' => :one)
+          end
+        end
+      end
+
+      context 'when args are one or many keys' do
+        subject { klass.new.hash_excluding(:foo, :bar) }
+        let(:anything) { WebMock::Matchers::AnyArgMatcher.new(nil) }
+
+        it "creates 'HashExcludingMatcher' with keys anythingized" do
+          expect(subject).not_to eq('foo' => anything, 'bar' => anything )
+        end
+      end
+
+      context 'when args are both keys and key/value pairs' do
+        subject { klass.new.hash_excluding(:foo, :bar, data: :one) }
+        let(:anything) { WebMock::Matchers::AnyArgMatcher.new(nil) }
+
+        it 'creates "HashExcludingMatcher" with keys anythingized' do
+          expect(subject).not_to eq('foo' => anything, 'bar' => anything, 'data' => :one)
+        end
+      end
+
+      context 'when args are an empty hash' do
+        subject { klass.new.hash_excluding({}) }
+
+        it 'creates "HashExcludingMatcher" with an empty hash' do
+          expect(subject).to eq({})
+        end
+      end
+    end
+
+    context 'when mixed into a class with a parent that defines `hash_excluding`' do
+      subject { klass.new.hash_excluding(*args) }
+      let(:args) { %w(:foo, :bar, {:data => :one}) }
+      let(:klass) do
+        Class.new(
+          Class.new do
+            def hash_excluding(*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
+
+  describe '#reset_executed_requests!' do
+    subject {  WebMock::API.reset_executed_requests! }
+
+    let(:request_signature) { WebMock::RequestSignature.new(:get, "www.example.com") }
+    let(:request_pattern)   { WebMock::RequestPattern.new(:get, "www.example.com") }
 
+    before do
+      WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
+    end
+
+    it 'resets request registry counter' do
+      expect{
+        subject
+      }.to change{
+        WebMock::RequestRegistry.instance.times_executed(request_pattern)
+      }.from(1).to(0)
+    end
   end
 end

data/spec/unit/matchers/hash_excluding_matcher_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+module WebMock
+  module Matchers
+    describe HashExcludingMatcher do
+      it 'stringifies the given hash keys' do
+        expect(HashExcludingMatcher.new(a: 1, b: 2)).not_to eq('a' => 1, 'b' => 2)
+      end
+
+      it 'sorts elements in the hash' do
+        expect(HashExcludingMatcher.new(b: 2, a: 1)).not_to eq('a' => 1, 'b' => 2)
+      end
+
+      it 'describes itself properly' do
+        expect(HashExcludingMatcher.new(a: 1).inspect).to eq 'hash_excluding({"a"=>1})'
+      end
+
+      describe 'success' do
+        it 'match with hash with a missing key' do
+          expect(HashExcludingMatcher.new(a: 1)).to eq('b' => 2)
+        end
+
+        it 'match an empty hash with a given key' do
+          expect(HashExcludingMatcher.new(a: 1)).to eq({})
+        end
+
+        it 'match when values are nil but keys are different' do
+          expect(HashExcludingMatcher.new(a: nil)).to eq('b' => nil)
+        end
+
+        describe 'when matching an empty hash' do
+          it 'does not matches against any hash' do
+            expect(HashExcludingMatcher.new({})).to eq(a: 1, b: 2, c: 3)
+          end
+        end
+      end
+
+      describe 'failing' do
+        it 'does not match a hash with a one missing key when one pair is matching' do
+          expect(HashExcludingMatcher.new(a: 1, b: 2)).not_to eq('b' => 2)
+        end
+
+        it 'match a hash with an incorrect value' do
+          expect(HashExcludingMatcher.new(a: 1, b: 2)).not_to eq('a' => 1, 'b' => 3)
+        end
+
+        it 'does not matches the same hash' do
+          expect(HashExcludingMatcher.new('a' => 1, 'b' => 2)).not_to eq('a' => 1, 'b' => 2)
+        end
+
+        it 'does not matches a hash with extra stuff' do
+          expect(HashExcludingMatcher.new(a: 1)).not_to eq('a' => 1, 'b' => 2)
+        end
+
+        it 'does not match a non-hash' do
+          expect(HashExcludingMatcher.new(a: 1)).not_to eq 1
+        end
+      end
+    end
+  end
+end

data/spec/unit/request_execution_verifier_spec.rb

@@ -53,7 +53,7 @@ describe WebMock::RequestExecutionVerifier do
       @verifier.times_executed = 0
       @verifier.expected_times_executed = 2
       expected_text = "The request www.example.com was expected to execute 2 times but it executed 0 times"
-      expected_text << @executed_requests_info
+      expected_text += @executed_requests_info
       expect(@verifier.failure_message).to eq(expected_text)
     end
 
@@ -61,7 +61,7 @@ describe WebMock::RequestExecutionVerifier do
       @verifier.times_executed = 1
       @verifier.expected_times_executed = 1
       expected_text = "The request www.example.com was expected to execute 1 time but it executed 1 time"
-      expected_text << @executed_requests_info
+      expected_text += @executed_requests_info
       expect(@verifier.failure_message).to eq(expected_text)
     end
 
@@ -70,7 +70,7 @@ describe WebMock::RequestExecutionVerifier do
         @verifier.times_executed = 1
         @verifier.at_least_times_executed = 2
         expected_text = "The request www.example.com was expected to execute at least 2 times but it executed 1 time"
-        expected_text << @executed_requests_info
+        expected_text += @executed_requests_info
         expect(@verifier.failure_message).to eq(expected_text)
       end
 
@@ -78,7 +78,7 @@ describe WebMock::RequestExecutionVerifier do
         @verifier.times_executed = 2
         @verifier.at_least_times_executed = 3
         expected_text = "The request www.example.com was expected to execute at least 3 times but it executed 2 times"
-        expected_text << @executed_requests_info
+        expected_text += @executed_requests_info
         expect(@verifier.failure_message).to eq(expected_text)
       end
     end
@@ -88,7 +88,7 @@ describe WebMock::RequestExecutionVerifier do
         @verifier.times_executed = 3
         @verifier.at_most_times_executed = 2
         expected_text = "The request www.example.com was expected to execute at most 2 times but it executed 3 times"
-        expected_text << @executed_requests_info
+        expected_text += @executed_requests_info
         expect(@verifier.failure_message).to eq(expected_text)
       end
 
@@ -96,7 +96,7 @@ describe WebMock::RequestExecutionVerifier do
         @verifier.times_executed = 2
         @verifier.at_most_times_executed = 1
         expected_text = "The request www.example.com was expected to execute at most 1 time but it executed 2 times"
-        expected_text << @executed_requests_info
+        expected_text += @executed_requests_info
         expect(@verifier.failure_message).to eq(expected_text)
       end
     end
@@ -108,14 +108,14 @@ describe WebMock::RequestExecutionVerifier do
       @verifier.times_executed = 2
       @verifier.expected_times_executed = 2
       expected_text = "The request www.example.com was not expected to execute 2 times but it executed 2 times"
-      expected_text << @executed_requests_info
+      expected_text += @executed_requests_info
       expect(@verifier.failure_message_when_negated).to eq(expected_text)
     end
 
     it "reports failure message when not expected request but it executed" do
       @verifier.times_executed = 1
       expected_text = "The request www.example.com was not expected to execute but it executed 1 time"
-      expected_text << @executed_requests_info
+      expected_text += @executed_requests_info
       expect(@verifier.failure_message_when_negated).to eq(expected_text)
     end
 
@@ -124,7 +124,7 @@ describe WebMock::RequestExecutionVerifier do
         @verifier.times_executed = 3
         @verifier.at_least_times_executed = 2
         expected_text = "The request www.example.com was not expected to execute at least 2 times but it executed 3 times"
-        expected_text << @executed_requests_info
+        expected_text += @executed_requests_info
         expect(@verifier.failure_message_when_negated).to eq(expected_text)
       end
 
@@ -132,7 +132,7 @@ describe WebMock::RequestExecutionVerifier do
         @verifier.times_executed = 2
         @verifier.at_least_times_executed = 2
         expected_text = "The request www.example.com was not expected to execute at least 2 times but it executed 2 times"
-        expected_text << @executed_requests_info
+        expected_text += @executed_requests_info
         expect(@verifier.failure_message_when_negated).to eq(expected_text)
       end
     end
@@ -142,7 +142,7 @@ describe WebMock::RequestExecutionVerifier do
         @verifier.times_executed = 2
         @verifier.at_most_times_executed = 3
         expected_text = "The request www.example.com was not expected to execute at most 3 times but it executed 2 times"
-        expected_text << @executed_requests_info
+        expected_text += @executed_requests_info
         expect(@verifier.failure_message_when_negated).to eq(expected_text)
       end
 
@@ -150,7 +150,7 @@ describe WebMock::RequestExecutionVerifier do
         @verifier.times_executed = 1
         @verifier.at_most_times_executed = 2
         expected_text = "The request www.example.com was not expected to execute at most 2 times but it executed 1 time"
-        expected_text << @executed_requests_info
+        expected_text += @executed_requests_info
         expect(@verifier.failure_message_when_negated).to eq(expected_text)
       end
     end