webmock 1.18.0 → 1.19.0

data/lib/webmock/util/uri.rb

@@ -14,8 +14,8 @@ module WebMock
       NORMALIZED_URIS = Hash.new do |hash, uri|
         normalized_uri = WebMock::Util::URI.heuristic_parse(uri)
         if normalized_uri.query_values
-          sorted_query_values = sort_query_values(WebMock::Util::QueryMapper.query_to_values(normalized_uri.query) || {})
-          normalized_uri.query = WebMock::Util::QueryMapper.values_to_query(sorted_query_values)
+          sorted_query_values = sort_query_values(WebMock::Util::QueryMapper.query_to_values(normalized_uri.query, :notation => Config.instance.query_values_notation) || {})
+          normalized_uri.query = WebMock::Util::QueryMapper.values_to_query(sorted_query_values, :notation => WebMock::Config.instance.query_values_notation)
         end
         normalized_uri = normalized_uri.normalize #normalize! is slower
         normalized_uri.query = normalized_uri.query.gsub("+", "%2B") if normalized_uri.query
@@ -74,7 +74,8 @@ module WebMock
       private
 
       def self.sort_query_values(query_values)
-        Hash[*query_values.sort.inject([]) { |values, pair| values + pair}]
+        sorted_query_values = query_values.sort
+        query_values.is_a?(Hash) ? Hash[*sorted_query_values.inject([]) { |values, pair| values + pair}] : sorted_query_values
       end
 
       def self.uris_with_inferred_port_and_without(uris)

data/lib/webmock/version.rb

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

data/lib/webmock/webmock.rb

@@ -75,6 +75,18 @@ module WebMock
     end
   end
 
+  def self.hide_stubbing_instructions!
+    Config.instance.show_stubbing_instructions = false
+  end
+
+  def self.show_stubbing_instructions!
+    Config.instance.show_stubbing_instructions = true
+  end
+
+  def self.show_stubbing_instructions?
+    Config.instance.show_stubbing_instructions
+  end
+
   def self.reset!
     WebMock::RequestRegistry.instance.reset!
     WebMock::StubRegistry.instance.reset!

data/spec/acceptance/em_http_request/em_http_request_spec.rb

@@ -267,6 +267,79 @@ unless RUBY_PLATFORM =~ /java/
           signature.uri.should == Addressable::URI.parse(uri)
         end
       end
+
+      describe 'get_response_cookie' do
+
+        before(:each) do
+          stub_request(:get, "http://example.org/").
+          to_return(
+            :status => 200,
+            :body => "",
+            :headers => { 'Set-Cookie' => cookie_string }
+          )
+        end
+
+        describe 'success' do
+
+          context 'with only one cookie' do
+
+            let(:cookie_name) { 'name_of_the_cookie' }
+            let(:cookie_value) { 'value_of_the_cookie' }
+            let(:cookie_string) { "#{cookie_name}=#{cookie_value}" }
+
+            it 'successfully gets the cookie' do
+              EM.run {
+                http = EventMachine::HttpRequest.new('http://example.org').get
+
+                http.errback { fail(http.error) }
+                http.callback {
+                  http.get_response_cookie(cookie_name).should == cookie_value
+                  EM.stop
+                }
+              }
+            end
+          end
+
+          context 'with several cookies' do
+
+            let(:cookie_name) { 'name_of_the_cookie' }
+            let(:cookie_value) { 'value_of_the_cookie' }
+            let(:cookie_2_name) { 'name_of_the_2nd_cookie' }
+            let(:cookie_2_value) { 'value_of_the_2nd_cookie' }
+            let(:cookie_string) { %W(#{cookie_name}=#{cookie_value} #{cookie_2_name}=#{cookie_2_value}) }
+
+            it 'successfully gets both cookies' do
+              EM.run {
+                http = EventMachine::HttpRequest.new('http://example.org').get
+
+                http.errback { fail(http.error) }
+                http.callback {
+                  http.get_response_cookie(cookie_name).should == cookie_value
+                  http.get_response_cookie(cookie_2_name).should == cookie_2_value
+                  EM.stop
+                }
+              }
+            end
+          end
+        end
+
+        describe 'failure' do
+
+          let(:cookie_string) { 'a=b' }
+
+          it 'returns nil when no cookie is found' do
+            EM.run {
+                http = EventMachine::HttpRequest.new('http://example.org').get
+
+                http.errback { fail(http.error) }
+                http.callback {
+                  http.get_response_cookie('not_found_cookie').should == nil
+                  EM.stop
+                }
+              }
+          end
+        end
+      end
     end
 
   end

data/spec/acceptance/excon/excon_spec.rb

@@ -17,12 +17,12 @@ describe "Excon" do
   end
 
   context "with response_block" do
-    it "should support excon response_block for real requests" do
+    it "should support excon response_block for real requests", :net_connect => true do
       a = []
       WebMock.allow_net_connect!
       r = Excon.new('http://httpstat.us/200').get(:response_block => lambda {|e, remaining, total| a << e}, :chunk_size => 1)
       a.should == ["2", "0", "0", " ", "O", "K"]
-      r.body.should == ""
+      r.body.should == "200 OK" #this should be "", but there is an issue in Excon https://github.com/excon/excon/issues/429
     end
 
     it "should support excon response_block" do
@@ -30,10 +30,10 @@ describe "Excon" do
       stub_request(:get, "http://example.com/").to_return(:body => "abc")
       r = Excon.new('http://example.com').get(:response_block => lambda {|e, remaining, total| a << e}, :chunk_size => 1)
       a.should == ['a', 'b', 'c']
-      r.body.should == ""
+      r.body.should == "abc" #this should be "", but there is an issue in Excon https://github.com/excon/excon/issues/429
     end
 
-    it "should invoke callbacks with response body even if a real request is made" do
+    it "should invoke callbacks with response body even if a real request is made", :net_connect => true do
       a = []
       WebMock.allow_net_connect!
       response = nil
@@ -43,7 +43,7 @@ describe "Excon" do
       r = Excon.new('http://httpstat.us/200').get(:response_block => lambda {|e, remaining, total| a << e}, :chunk_size => 1)
       response.body.should == "200 OK"
       a.should == ["2", "0", "0", " ", "O", "K"]
-      r.body.should == ""
+      r.body.should == "200 OK" #this should be "", but there is an issue in Excon https://github.com/excon/excon/issues/429
     end
   end
 
@@ -62,4 +62,14 @@ describe "Excon" do
 
     yielded_request_body.should eq(file_contents)
   end
+
+  describe '.request_params_from' do
+
+    it 'rejects invalid request keys' do
+      request_params = WebMock::HttpLibAdapters::ExconAdapter.request_params_from(:body => :keep, :fake => :reject)
+      request_params.should eq(:body => :keep)
+    end
+
+  end
+
 end

data/spec/acceptance/http_gem/http_gem_spec.rb

@@ -47,4 +47,13 @@ describe "HTTP Gem" do
       expect(headers).to include "Host" => "www.example.com"
     end
   end
+
+  it "restores request uri on replayed response object" do
+    uri = URI "http://example.com/foo"
+
+    stub_request :get, "example.com/foo"
+    response = HTTP.get uri
+
+    expect(response.uri).to eq uri
+  end
 end

data/spec/acceptance/httpclient/httpclient_spec.rb

@@ -136,10 +136,11 @@ describe "HTTPClient" do
     end
 
     it "client sends the Accept, User-Agent, and Date by default" do
+      WebMock.disable_net_connect!
       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
+        req.headers["Accept"] == "*/*" &&
+        req.headers["User-Agent"] == "#{HTTPClient::DEFAULT_AGENT_NAME} #{HTTPClient::LIB_NAME}" &&
+        req.headers["Date"]
       end
       http_request(:get, "www.example.com")
     end
@@ -152,4 +153,11 @@ describe "HTTPClient" do
 
   end
 
+  context 'httpclient response header' do
+    it 'receives request_method, request_uri, and request_query from the request header' do
+      stub_request :get, 'www.example.com'
+      message = HTTPClient.new.get 'www.example.com'
+      message.header.request_uri.to_s.should == 'www.example.com'
+    end
+  end
 end

data/spec/acceptance/httpclient/httpclient_spec_helper.rb

@@ -9,7 +9,7 @@ module HTTPClientSpecHelper
     c.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
     c.set_basic_auth(nil, uri.user, uri.password) if uri.user
     params = [method, "#{uri.omit(:userinfo, :query).normalize.to_s}",
-      WebMock::Util::QueryMapper.query_to_values(uri.query), options[:body], options[:headers] || {}]
+      WebMock::Util::QueryMapper.query_to_values(uri.query, :notation => WebMock::Config.instance.query_values_notation), options[:body], options[:headers] || {}]
     if HTTPClientSpecHelper.async_mode
       connection = c.request_async(*params)
       connection.join

data/spec/acceptance/patron/patron_spec_helper.rb

@@ -2,6 +2,7 @@ require 'ostruct'
 
 module PatronSpecHelper
   def http_request(method, uri, options = {}, &block)
+    method = method.to_sym
     uri = Addressable::URI.heuristic_parse(uri)
     sess = Patron::Session.new
     sess.base_url = "#{uri.omit(:userinfo, :path, :query).normalize.to_s}".gsub(/\/$/,"")

data/spec/acceptance/shared/request_expectations.rb

@@ -159,6 +159,24 @@ shared_context "request expectations" do |*adapter_info|
         end
       end
 
+      context "when using flat array notation" do
+        before :all do
+          WebMock::Config.instance.query_values_notation = :flat_array
+        end
+
+        it "should satisfy expectation if request includes different repeated query params in flat array notation" do
+          lambda {
+            stub_request(:get, "http://www.example.com/?a=1&a=2")
+            http_request(:get, "http://www.example.com/?a=1&a=2")
+            a_request(:get, "http://www.example.com/?a=1&a=2").should have_been_made
+          }.should_not raise_error
+        end
+
+        after :all do
+          WebMock::Config.instance.query_values_notation = nil
+        end
+      end
+
       it "should fail if request was made more times than expected" do
         lambda {
           http_request(:get, "http://www.example.com/")

data/spec/acceptance/shared/stubbing_requests.rb

@@ -71,6 +71,11 @@ shared_examples_for "stubbing requests" do |*adapter_info|
         http_request(:get, "http://www.example.com/").status.should == "200"
       end
 
+      it "should match stubbed request when http request was made with method given as string" do
+        stub_request(:get, "www.example.com")
+        http_request('get', "http://www.example.com/").status.should == "200"
+      end
+
       it "should raise error if stubbed request has different method" do
         stub_request(:get, "www.example.com")
         http_request(:get, "http://www.example.com/").status.should == "200"

data/spec/unit/errors_spec.rb

@@ -4,36 +4,38 @@ describe "errors" do
   describe WebMock::NetConnectNotAllowedError do
     describe "message" do
       it "should have message with request signature and snippet" do
-        request_signature = double(:to_s => "aaa")
-        request_stub = double
         WebMock::RequestStub.stub(:from_request_signature).and_return(request_stub)
         WebMock::StubRequestSnippet.stub(:new).
-          with(request_stub).and_return(double(:to_s => "bbb"))
-        expected =  "Real HTTP connections are disabled. Unregistered request: aaa" +
-               "\n\nYou can stub this request with the following snippet:\n\n" +
-               "bbb\n\n============================================================"
+           with(request_stub).and_return(stub_result)
+
+        expected =  \
+          "Real HTTP connections are disabled. Unregistered request: #{request_signature}" \
+          "\n\nYou can stub this request with the following snippet:" \
+          "\n\n#{stub_result}" \
+          "\n\n============================================================"
         WebMock::NetConnectNotAllowedError.new(request_signature).message.should == expected
       end
 
       it "should have message with registered stubs if available" do
-        request_signature = double(:to_s => "aaa")
-        request_stub = double
         WebMock::StubRegistry.instance.stub(:request_stubs).and_return([request_stub])
         WebMock::RequestStub.stub(:from_request_signature).and_return(request_stub)
         WebMock::StubRequestSnippet.stub(:new).
-          with(request_stub).and_return(double(:to_s => "bbb"))
-        expected =  "Real HTTP connections are disabled. Unregistered request: aaa" +
-               "\n\nYou can stub this request with the following snippet:\n\n" +
-               "bbb\n\nregistered request stubs:\n\nbbb\n\n============================================================"
+           with(request_stub).and_return(stub_result)
+
+        expected =  \
+          "Real HTTP connections are disabled. Unregistered request: #{request_signature}" \
+          "\n\nYou can stub this request with the following snippet:" \
+          "\n\n#{stub_result}" \
+          "\n\nregistered request stubs:" \
+          "\n\n#{stub_result}" \
+          "\n\n============================================================"
         WebMock::NetConnectNotAllowedError.new(request_signature).message.should == expected
       end
 
       it "should not be caught by a rescue block without arguments" do
-        request_signature = double(:to_s => "aaa")
-        request_stub = double
         WebMock::RequestStub.stub(:from_request_signature).and_return(request_stub)
         WebMock::StubRequestSnippet.stub(:new).
-          with(request_stub).and_return(double(:to_s => "bbb"))
+          with(request_stub).and_return(stub_result)
 
         exception = WebMock::NetConnectNotAllowedError.new(request_signature)
 
@@ -45,6 +47,42 @@ describe "errors" do
           end
         end.to raise_exception exception
       end
+
+      context "WebMock.show_stubbing_instructions? is false" do
+        before do
+          WebMock.hide_stubbing_instructions!
+        end
+
+        it "should have message with request signature and snippet" do
+          WebMock::RequestStub.stub(:from_request_signature).and_return(request_stub)
+          WebMock::StubRequestSnippet.stub(:new).
+            with(request_stub).and_return(stub_result)
+
+          expected =  \
+            "Real HTTP connections are disabled. Unregistered request: #{request_signature}" \
+            "\n\n============================================================"
+          WebMock::NetConnectNotAllowedError.new(request_signature).message.should == expected
+        end
+
+        it "should have message with registered stubs if available" do
+          WebMock::StubRegistry.instance.stub(:request_stubs).and_return([request_stub])
+          WebMock::RequestStub.stub(:from_request_signature).and_return(request_stub)
+          WebMock::StubRequestSnippet.stub(:new).
+            with(request_stub).and_return(stub_result)
+
+          expected =  \
+            "Real HTTP connections are disabled. Unregistered request: #{request_signature}" \
+            "\n\nregistered request stubs:" \
+            "\n\n#{stub_result}" \
+            "\n\n============================================================"
+          WebMock::NetConnectNotAllowedError.new(request_signature).message.should == expected
+        end
+      end
     end
+
+    let(:request_signature) { double(:to_s => rand(10**20).to_s) }
+    let(:stub_result)       { double(:to_s => rand(10**20).to_s) }
+    let(:request_stub)      { double }
+
   end
 end

data/spec/unit/request_pattern_spec.rb

@@ -286,6 +286,21 @@ describe WebMock::RequestPattern do
           :query => RSpec::Mocks::ArgumentMatchers::HashIncludingMatcher.new({"a" => ["b", "d"]})).
             should_not match(WebMock::RequestSignature.new(:get, "www.example.com?a[]=b&a[]=c&b=1"))
         end
+
+        context "when using query values notation as flat array" do
+          before :all do
+            WebMock::Config.instance.query_values_notation = :flat_array
+          end
+
+          it "should not match when repeated query params are not the same as declared as string" do
+            WebMock::RequestPattern.new(:get, "www.example.com", :query => "a=b&a=c").
+              should match(WebMock::RequestSignature.new(:get, "www.example.com?a=b&a=c"))
+          end
+
+          after :all do
+            WebMock::Config.instance.query_values_notation = nil
+          end
+        end
       end
     end
 

data/spec/unit/request_signature_spec.rb

@@ -26,6 +26,9 @@ describe WebMock::RequestSignature do
       WebMock::RequestSignature.new(:get, "www.example.com", :body => "abc").body.should == "abc"
     end
 
+    it "should symbolize the method" do
+      WebMock::RequestSignature.new('get', "www.example.com", :body => "abc").method.should == :get
+    end
   end
 
   it "should report string describing itself" do

data/spec/unit/util/hash_keys_stringifier_spec.rb

@@ -21,7 +21,7 @@ describe WebMock::Util::HashKeysStringifier do
         ]
       }
     }
-    WebMock::Util::HashKeysStringifier.stringify_keys!(hash).should == stringified
+    WebMock::Util::HashKeysStringifier.stringify_keys!(hash, :deep => true).should == stringified
   end
 
 end

data/spec/unit/util/query_mapper_spec.rb

@@ -1,30 +1,104 @@
 require 'spec_helper'
 
 describe WebMock::Util::QueryMapper do
-  let(:query_mapper) { described_class }
+  subject { described_class }
 
-  it "converts query to values" do
-    query = "key=value&other_key=other_value"
-    values = { 'key' => 'value', 'other_key' => 'other_value' }
-    expect(query_mapper.query_to_values query).to eq values
+  context '#query_to_values' do
+    it 'should raise on invalid notation' do
+      query = 'a=&b=c'
+      expect { subject.query_to_values(query, {:notation => 'foo'}) }.to raise_error(
+        ArgumentError,
+        'Invalid notation. Must be one of: [:flat, :dot, :subscript, :flat_array].'
+      )
+    end
+
+    it 'should parse hash queries' do
+      # {"one" => {"two" => {"three" => ["four", "five"]}}}
+      query = 'one%5Btwo%5D%5Bthree%5D%5B%5D=four&one%5Btwo%5D%5Bthree%5D%5B%5D=five'
+      hsh = subject.query_to_values(query)
+      expect(hsh['one']['two']['three']).to eq(%w(four five))
+    end
+
+    it 'should parse one nil value queries' do
+      # {'a' => nil, 'b' => 'c'}
+      query = 'a=&b=c'
+      hsh = subject.query_to_values(query)
+      expect(hsh['a']).to be_empty
+      expect(hsh['b']).to eq('c')
+    end
+
+    it 'should parse array queries' do
+      # {"one" => ["foo", "bar"]}
+      query = 'one%5B%5D=foo&one%5B%5D=bar'
+      hsh = subject.query_to_values(query)
+      expect(hsh['one']).to eq(%w(foo bar))
+    end
+
+    it 'should parse string queries' do
+      # {"one" => "two", "three" => "four"}
+      query = 'one=two&three=four'
+      hsh = subject.query_to_values(query)
+      expect(hsh).to  eq({'one' => 'two', 'three' => 'four'})
+    end
+
+    it 'should parse nested queries' do
+      # [{"b"=>[{"c"=>[{"d"=>["1", {"e"=>"2"}]}]}]}]
+      query = 'a%5B%5D%5Bb%5D%5B%5D%5Bc%5D%5B%5D%5Bd%5D%5B%5D=1&a%5B%5D%5Bb%5D%5B%5D%5Bc%5D%5B%5D%5Bd%5D%5B%5D%5Be%5D=2'
+      hsh = subject.query_to_values(query)
+      expect(hsh['a'][0]['b'][0]['c'][0]['d'][0]).to eq('1')
+      expect(hsh['a'][0]['b'][0]['c'][0]['d'][1]['e']).to eq('2')
+    end
   end
 
-  it 'converts values to a query string' do
-    query = "key=value&other_key=other_value"
-    values = [['key','value'],['other_key','other_value']]
-    expect(query_mapper.values_to_query values).to eq query
+  context '#to_query' do
+    it 'should transform nil value' do
+      expect(subject.to_query('a', nil)).to eq('a=')
+    end
+    it 'should transform string value' do
+      expect(subject.to_query('a', 'b')).to eq('a=b')
+    end
+    it 'should transform hash value' do
+      expect(subject.to_query('a', {'key' => 'value'})).to eq('a[key]=value')
+    end
+    it 'should transform array value' do
+      expect(subject.to_query('a', ['b', 'c'])).to eq('a[0]=b&a[1]=c')
+    end
+    it 'should transform TrueClass value' do
+      expect(subject.to_query('a', true)).to eq('a')
+    end
   end
 
-  it 'converts values with missing keys to a query string' do
-    query = "=value"
-    values = { '' => 'value' }
-    expect(query_mapper.values_to_query values).to eq query
+  context '#values_to_query' do
+    it 'converts values to a query string' do
+      query = "key=value&other_key=other_value"
+      values = [['key','value'],['other_key','other_value']]
+      expect(subject.values_to_query values).to eq query
+    end
+
+    it 'converts values with missing keys to a query string' do
+      query = "=value"
+      values = { '' => 'value' }
+      expect(subject.values_to_query values).to eq query
+    end
+
+    it 'converts values with nil keys to a query string' do
+      query = "=value"
+      values = { nil => 'value' }
+      expect(subject.values_to_query values).to eq query
+    end
   end
 
-  it 'converts values with nil keys to a query string' do
-    query = "=value"
-    values = { nil => 'value' }
-    expect(query_mapper.values_to_query values).to eq query
+  it 'converts array values, vice versa' do
+    query = "one%5B%5D=1&one%5B%5D=2"
+    values = {"one" => ["1","2"]}
+    expect(subject.values_to_query values).to eq query
+    expect(subject.query_to_values query).to eq values
   end
 
+  it 'converts hash values, vice versa' do
+    query = "one%5Ba%5D=1&one%5Bb%5D=2"
+    values = {"one" => {"a" => "1", "b" => "2"}}
+    expect(subject.values_to_query values).to eq query
+    expect(subject.query_to_values query).to eq values
+  end
 end