webmock 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b25e1f8ad8f3a8ffa79b1e54d0709069f9162b52
-  data.tar.gz: 8169ef32ad67fecba074d929fb6d584410950617
+  metadata.gz: 1ba7b559bad31fd1150447c4895e4517a96e5c0b
+  data.tar.gz: 6682c3a0689f7aaf06b11cef43e170d584694187
 SHA512:
-  metadata.gz: 3daea98f13930398bd12722ff33b727c4c3b02ce41f2aeb3060d437d246ed5284c0737979bea0b7a46fa6dba6c24e90b1e4519d9b7f4e6d8d9e8d212869d9469
-  data.tar.gz: 8f9fdee207513b9741f6245ed4b575120bd3232165edfa941a2f8113b11a2413f55945a5e5ce160cfb12da455545282b9e3f766903940fe7b878f49b5b59dbb9
+  metadata.gz: f77249e99b5553be7f9afea5de6112c7e63526c4c6ca42124bfa5089061b64eb469d927f903bf37d54245213b66d2217ee8112863848108dc262d995ca64c1d3
+  data.tar.gz: 779df5762aa1d72513d4cae0221b44e1dc92dee9b698db5ae6daf92fe12c29fb29d88af04968baabefe186ca9d51f1c564da89aa4c1e53fb31f55ead0f72d008

data/.travis.yml

@@ -1,14 +1,14 @@
+before_install:
+  - gem update bundler
+
 rvm:
-  - 2.0.0
-  - 2.1.0
-  - 2.2.1
-  - 2.2.3
-  - 2.3.0
-  - 2.4.0
+  - 2.2.8
+  - 2.3.5
+  - 2.4.2
   - rbx-2
   - ruby-head
   - jruby-9.0.5.0
-  - jruby-9.1.5.0
+  - jruby-9.1.13.0
   - jruby-head
 matrix:
   allow_failures:

data/CHANGELOG.md

@@ -1,5 +1,50 @@
 # Changelog
 
+## 3.1.0
+
+  * http.rb 3.0.0 compatibility
+
+    Thanks to [Piotr Boniecki](https://github.com/Bonias)
+
+  * Typhoeus 1.3.0 support
+
+    Thanks to [NARUSE, Yui](https://github.com/nurse)
+
+  * Added support for matching partial query params using hash_excluding
+
+        stub_request(:get, "www.example.com").
+          with(query: hash_excluding({"a" => "b"}))
+
+        RestClient.get("http://www.example.com/?a=b")    # ===> Failure
+        RestClient.get("http://www.example.com/?a=c")    # ===> Success
+
+    Thanks to [Olexandr Hoshylyk](https://github.com/Warrior109)
+
+  * Added MRI 2.3+ frozen string literal compatibility
+
+    Thanks to [Pat Allan](https://github.com/pat)
+
+  * Ensured that HTTPClient adapter does not yield block on empty response body if a block is provided
+
+    Thanks to [NARUSE, Yui](https://github.com/nurse)
+
+  * Fixed issue with `to_timeout` incorrectly raising `HTTP::ConnectionError` instead of `HTTP::TimeoutError` when using http.rb
+
+    Thanks to [Rick Song](https://github.com/RickCSong)
+
+  * Fixed problem with `response.connection.close` method being undefined when using http.rb
+
+    Thanks to [Janko Marohnić](https://github.com/janko-m)
+
+  * Fixed problem with matching Net::HTTP request header values assigned as numbers.
+
+    Thanks to [Felipe Constantino de Oliveira](https://github.com/felipecdo) for reporting the issue.
+
+  * Fixed problem with Net::HTTP adapter converting empty response body to nil for non 204 responses.
+
+    Thanks to [Jeffrey Charles](https://github.com/jeffcharles) for reporting the issue.
+
+
 ## 3.0.1
 
   * Suppressed \`warning: \`&' interpreted as argument prefix\`

data/README.md

@@ -32,8 +32,6 @@ Supported HTTP libraries
 Supported Ruby Interpreters
 ---------------------------
 
-* MRI 2.0
-* MRI 2.1
 * MRI 2.2
 * MRI 2.3
 * MRI 2.4
@@ -273,6 +271,16 @@ stub_request(:get, "www.example.com").
 RestClient.get("http://www.example.com/?a[]=b&a[]=c&x=1")    # ===> Success
 ```
 
+### Matching partial query params using hash_excluding
+
+```ruby
+stub_request(:get, "www.example.com").
+  with(query: hash_excluding({"a" => "b"}))
+
+RestClient.get("http://www.example.com/?a=b")    # ===> Failure
+RestClient.get("http://www.example.com/?a=c")    # ===> Success
+```
+
 ### Stubbing with custom response
 
 ```ruby
@@ -1035,6 +1043,12 @@ People who submitted patches and new features or suggested improvements. Many th
 * George Ulmer
 * Christof Koenig
 * Chung-Yi Chi
+* Olexandr Hoshylyk
+* Janko Marohnić
+* Pat Allan
+* Rick Song
+* NARUSE, Yui
+* Piotr Boniecki
 
 For a full list of contributors you can visit the
 [contributors](https://github.com/bblimke/webmock/contributors) page.

data/lib/webmock.rb

@@ -18,7 +18,10 @@ require 'webmock/util/json'
 require 'webmock/util/version_checker'
 require 'webmock/util/hash_validator'
 
+require 'webmock/matchers/hash_argument_matcher'
+require 'webmock/matchers/hash_excluding_matcher'
 require 'webmock/matchers/hash_including_matcher'
+require 'webmock/matchers/any_arg_matcher'
 
 require 'webmock/request_pattern'
 require 'webmock/request_signature'

data/lib/webmock/api.rb

@@ -54,6 +54,14 @@ module WebMock
       end
     end
 
+    def hash_excluding(*args)
+      if defined?(super)
+        super
+      else
+        WebMock::Matchers::HashExcludingMatcher.new(anythingize_lonely_keys(*args))
+      end
+    end
+
     def remove_request_stub(stub)
       WebMock::StubRegistry.instance.remove_request_stub(stub)
     end

data/lib/webmock/http_lib_adapters/curb_adapter.rb

@@ -153,7 +153,7 @@ if defined?(Curl)
         @body_str = webmock_response.body
         @response_code = webmock_response.status[0]
 
-        @header_str = "HTTP/1.1 #{webmock_response.status[0]} #{webmock_response.status[1]}\r\n"
+        @header_str = "HTTP/1.1 #{webmock_response.status[0]} #{webmock_response.status[1]}\r\n".dup
 
         @on_debug.call(@header_str, 1) if defined?( @on_debug )
 

data/lib/webmock/http_lib_adapters/excon_adapter.rb

@@ -92,7 +92,7 @@ if defined?(Excon)
         end
 
         def self.to_query(hash)
-          string = ""
+          string = "".dup
           for key, values in hash
             if values.nil?
               string << key.to_s << '&'

data/lib/webmock/http_lib_adapters/http_rb/request.rb

@@ -1,9 +1,15 @@
 module HTTP
   class Request
     def webmock_signature
+      request_body = if defined?(HTTP::Request::Body)
+                       ''.tap { |string| body.each { |part| string << part } }
+                     else
+                       body
+                     end
+
       ::WebMock::RequestSignature.new(verb, uri.to_s, {
         headers: headers.to_h,
-        body: body
+        body: request_body
       })
     end
   end

data/lib/webmock/http_lib_adapters/http_rb/streamer.rb

@@ -17,6 +17,10 @@ module HTTP
         @io.read size
       end
 
+      def close
+        @io.close
+      end
+
       def sequence_id
         -1
       end

data/lib/webmock/http_lib_adapters/http_rb/webmock.rb

@@ -43,7 +43,7 @@ module HTTP
 
     def raise_timeout_error
       raise Errno::ETIMEDOUT if HTTP::VERSION < "1.0.0"
-      raise HTTP::ConnectionError, "connection error: #{Errno::ETIMEDOUT.new}"
+      raise HTTP::TimeoutError, "connection error: #{Errno::ETIMEDOUT.new}"
     end
 
     def perform

data/lib/webmock/http_lib_adapters/httpclient_adapter.rb

@@ -75,8 +75,10 @@ if defined?(::HTTPClient)
         elsif block
           body = ''
           do_get_block_without_webmock(req, proxy, conn) do |http_res, chunk|
-            body += chunk
-            block.call(http_res, chunk)
+            if chunk && chunk.bytesize > 0
+              body += chunk
+              block.call(http_res, chunk)
+            end
           end
         else
           do_get_block_without_webmock(req, proxy, conn)
@@ -117,7 +119,7 @@ if defined?(::HTTPClient)
       raise HTTPClient::TimeoutError if webmock_response.should_timeout
       webmock_response.raise_error_if_any
 
-      block.call(response, body) if block
+      block.call(response, body) if block && body && body.bytesize > 0
 
       response
     end

data/lib/webmock/http_lib_adapters/net_http.rb

@@ -154,7 +154,7 @@ module WebMock
         def build_net_http_response(webmock_response, &block)
           response = Net::HTTPResponse.send(:response_class, webmock_response.status[0].to_s).new("1.0", webmock_response.status[0].to_s, webmock_response.status[1])
           body = webmock_response.body
-          body = nil if body.to_s == ''
+          body = nil if webmock_response.status[0].to_s == '204'
 
           response.instance_variable_set(:@body, body)
           webmock_response.headers.to_a.each do |name, values|
@@ -258,7 +258,7 @@ module Net  #:nodoc: all
   class WebMockNetBufferedIO < BufferedIO
     def initialize(io, read_timeout: 60, continue_timeout: nil, debug_output: nil)
       @read_timeout = read_timeout
-      @rbuf = ''
+      @rbuf = ''.dup
       @debug_output = debug_output
 
       @io = case io

data/lib/webmock/http_lib_adapters/patron_adapter.rb

@@ -106,11 +106,11 @@ if defined?(::Patron)
           header_data   = ([status_line] + header_fields).join("\r\n")
 
           ::Patron::Response.new(
-            "",
+            "".dup,
             webmock_response.status[0],
             0,
             header_data,
-            webmock_response.body,
+            webmock_response.body.dup,
             default_response_charset
           )
         end

data/lib/webmock/matchers/any_arg_matcher.rb

@@ -0,0 +1,13 @@
+module WebMock
+  module Matchers
+    # 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/matchers/hash_argument_matcher.rb

@@ -0,0 +1,21 @@
+module WebMock
+  module Matchers
+    # Base class for Hash matchers
+    # https://github.com/rspec/rspec-mocks/blob/master/lib/rspec/mocks/argument_matchers.rb
+    class HashArgumentMatcher
+      def initialize(expected)
+        @expected = Hash[WebMock::Util::HashKeysStringifier.stringify_keys!(expected, deep: true).sort]
+      end
+
+      def ==(_actual, &block)
+        @expected.all?(&block)
+      rescue NoMethodError
+        false
+      end
+
+      def self.from_rspec_matcher(matcher)
+        new(matcher.instance_variable_get(:@expected))
+      end
+    end
+  end
+end

data/lib/webmock/matchers/hash_excluding_matcher.rb

@@ -0,0 +1,15 @@
+module WebMock
+  module Matchers
+    # this is a based on RSpec::Mocks::ArgumentMatchers::HashExcludingMatcher
+    # https://github.com/rspec/rspec-mocks/blob/master/lib/rspec/mocks/argument_matchers.rb
+    class HashExcludingMatcher < HashArgumentMatcher
+      def ==(actual)
+        super { |key, value| !actual.key?(key) || value != actual[key] }
+      end
+
+      def inspect
+        "hash_excluding(#{@expected.inspect})"
+      end
+    end
+  end
+end

data/lib/webmock/matchers/hash_including_matcher.rb

@@ -1,14 +1,10 @@
 module WebMock
   module Matchers
-    #this is a based on RSpec::Mocks::ArgumentMatchers::HashIncludingMatcher
-    #https://github.com/rspec/rspec-mocks/blob/master/lib/rspec/mocks/argument_matchers.rb
-    class HashIncludingMatcher
-      def initialize(expected)
-        @expected = Hash[WebMock::Util::HashKeysStringifier.stringify_keys!(expected, deep: true).sort]
-      end
-
+    # this is a based on RSpec::Mocks::ArgumentMatchers::HashIncludingMatcher
+    # https://github.com/rspec/rspec-mocks/blob/master/lib/rspec/mocks/argument_matchers.rb
+    class HashIncludingMatcher < HashArgumentMatcher
       def ==(actual)
-        @expected.all? {|k,v| actual.has_key?(k) && v === actual[k]}
+        super { |key, value| actual.key?(key) && value === actual[key] }
       rescue NoMethodError
         false
       end
@@ -16,21 +12,6 @@ module WebMock
       def inspect
         "hash_including(#{@expected.inspect})"
       end
-
-      def self.from_rspec_matcher(matcher)
-        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/rack_response.rb

@@ -17,7 +17,7 @@ module WebMock
     end
 
     def body_from_rack_response(response)
-      body = ""
+      body = "".dup
       response.each { |line| body << line }
       response.close if response.respond_to?(:close)
       return body

data/lib/webmock/request_execution_verifier.rb

@@ -53,9 +53,8 @@ module WebMock
 
     def failure_message_phrase(is_negated=false)
       negation = is_negated ? "was not" : "was"
-      text = "The request #{request_pattern} #{negation} expected to execute #{quantity_phrase(is_negated)}but it executed #{times(times_executed)}"
-      text << self.class.executed_requests_message
-      text
+      "The request #{request_pattern} #{negation} expected to execute #{quantity_phrase(is_negated)}but it executed #{times(times_executed)}" +
+        self.class.executed_requests_message
     end
 
     def quantity_phrase(is_negated=false)

data/lib/webmock/request_pattern.rb

@@ -4,6 +4,10 @@ module WebMock
     def rSpecHashIncludingMatcher?(matcher)
       matcher.class.name =~ /R?Spec::Mocks::ArgumentMatchers::HashIncludingMatcher/
     end
+
+    def rSpecHashExcludingMatcher?(matcher)
+      matcher.class.name =~ /R?Spec::Mocks::ArgumentMatchers::HashExcludingMatcher/
+    end
   end
 
   class RequestPattern
@@ -37,7 +41,7 @@ module WebMock
     end
 
     def to_s
-      string = "#{@method_pattern.to_s.upcase}"
+      string = "#{@method_pattern.to_s.upcase}".dup
       string << " #{@uri_pattern.to_s}"
       string << " with body #{@body_pattern.to_s}" if @body_pattern
       string << " with headers #{@headers_pattern.to_s}" if @headers_pattern
@@ -115,10 +119,13 @@ module WebMock
     def add_query_params(query_params)
       @query_params = if query_params.is_a?(Hash)
         query_params
-      elsif query_params.is_a?(WebMock::Matchers::HashIncludingMatcher)
+      elsif query_params.is_a?(WebMock::Matchers::HashIncludingMatcher) \
+              || query_params.is_a?(WebMock::Matchers::HashExcludingMatcher)
         query_params
       elsif rSpecHashIncludingMatcher?(query_params)
         WebMock::Matchers::HashIncludingMatcher.from_rspec_matcher(query_params)
+      elsif rSpecHashExcludingMatcher?(query_params)
+        WebMock::Matchers::HashExcludingMatcher.from_rspec_matcher(query_params)
       else
         WebMock::Util::QueryMapper.query_to_values(query_params, notation: Config.instance.query_values_notation)
       end

data/lib/webmock/request_registry.rb

@@ -23,7 +23,7 @@ module WebMock
       if requested_signatures.hash.empty?
         "No requests were made."
       else
-        text = ""
+        text = "".dup
         self.requested_signatures.each do |request_signature, times_executed|
           text << "#{request_signature} was made #{times_executed} time#{times_executed == 1 ? '' : 's' }\n"
         end

data/lib/webmock/request_signature.rb

@@ -12,7 +12,7 @@ module WebMock
     end
 
     def to_s
-      string = "#{self.method.to_s.upcase}"
+      string = "#{self.method.to_s.upcase}".dup
       string << " #{WebMock::Util::URI.strip_default_port_from_uri_string(self.uri.to_s)}"
       string << " with body '#{body.to_s}'" if body && body.to_s != ''
       if headers && !headers.empty?

data/lib/webmock/request_signature_snippet.rb

@@ -13,14 +13,14 @@ module WebMock
     def stubbing_instructions
       return unless WebMock.show_stubbing_instructions?
 
-      text = "You can stub this request with the following snippet:\n\n"
-      text << WebMock::StubRequestSnippet.new(request_stub).to_s
+      "You can stub this request with the following snippet:\n\n" +
+        WebMock::StubRequestSnippet.new(request_stub).to_s
     end
 
     def request_stubs
       return if WebMock::StubRegistry.instance.request_stubs.empty?
 
-      text = "registered request stubs:\n"
+      text = "registered request stubs:\n".dup
       WebMock::StubRegistry.instance.request_stubs.each do |stub|
         text << "\n#{WebMock::StubRequestSnippet.new(stub).to_s(false)}"
         add_body_diff(stub, text) if WebMock.show_body_diff?
@@ -50,7 +50,7 @@ module WebMock
     end
 
     def pretty_print_to_string(string_to_print)
-      StringIO.open("") do |stream|
+      StringIO.open("".dup) do |stream|
         PP.pp(string_to_print, stream)
         stream.rewind
         stream.read