webmock 3.26.4 → 3.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb0293b4433bbf3342d1f81abb5a1c773382f6f1a7fef6b44eb83fc0a38544a7
-  data.tar.gz: 00fbb149216fae39f04b689fc02c0f561e59e47843011fd8aaab36b35e86ba67
+  metadata.gz: 337d9a801a6b8cabda8c8d3646346e475d9ec46f15453301314b1575b5e6e1f6
+  data.tar.gz: c33b8a74b6fbd42807eb12bb2a385441f953abfb1112c63f8fc1249be0aea38d
 SHA512:
-  metadata.gz: 664302057fd929d144d09bb739c0cc581f4b80b40b67093989a4df01a21337f12594b765d9da0bc980ba981cfbe8db451cf0d23ce4ed10fa5d57eb2ddd98de79
-  data.tar.gz: bad8a582bd3b717e11182aef243b7167021187d63bd40b2dc1f0f54f13928e898e45ecf1cb598419e8dfc643d5b270db0d3a5408ab871ffb0725d5560dbd556b
+  metadata.gz: 6dad3e43360bf3a82ff3cb6ba1655884c6a0fa4de4767699cc1ce832da1eb1cfe6bf0f37082a1e6d4c80edd839925bb468fad5a75012eb786b6f31342ce510a5
+  data.tar.gz: bfbaecd774edb88c0c09de2c8079d05b0d94b197343684cdd426f66e6c24237d9ba7302373a32b3608a1ea59c902f766e9b28b8532671dedfb83e12b8474b4d3

data/CHANGELOG.md

@@ -1,5 +1,43 @@
 # Changelog
 
+# 3.28.0
+
+* Fix `to_rack` apps receiving a `rack.session` they did not set up (#985)
+
+    WebMock used to add a session hash to the Rack env, shared by every request to the same stub. This confused apps that check whether a session is present, such as Rails API-only apps, and carried session data over between requests. WebMock now leaves `rack.session` and `rack.session.options` unset, as a real server does. If your app needs a session, include session middleware in the app you pass to `to_rack`. `RackResponse#session` and `RackResponse#session_options` have been removed.
+
+    Thanks to [Jan Graichen](https://github.com/jgraichen)
+
+* Fix crash when matching a hash body pattern against a JSON or XML request that has no body
+
+    Thanks to [Chris](https://github.com/ChrisJr404)
+
+* No longer warn about curb versions newer than the last one tested
+
+* Document regexp values in `hash_including`
+
+    Thanks to [Christian Bruckmayer](https://github.com/ChrisBr)
+
+* Remove unused `RequestSignatureSnippet#request_params`
+
+    Thanks to [Daniel Pepper](https://github.com/dpep)
+
+# 3.27.0
+
+* Fix crash in async-http adapter when a request header has a nil value
+
+    Thanks to [hikmetba-bit](https://github.com/hikmetba-bit)
+
+* The async-http adapter now matches stubs against raw request header values instead of values parsed by protocol-http, consistent with the other adapters
+
+* Add RSpec `hash_excluding` support to body matching
+
+    Thanks to [Chris Gunther](https://github.com/cgunther)
+
+* Fix `hash_excluding` ignoring keys given without a value and regexp values, in both query and body matching
+
+* Fix crash when matching a request that has more than one `Content-Type` header
+
 # 3.26.4
 
 * Fix race condition in `HTTPClient` adapter async requests by @koic in #1131

data/README.md

@@ -184,6 +184,24 @@ stub_request(:post, "www.example.com").
 
 RestClient.post('www.example.com', "data[a]=1&data[b]=five&x=1",
 :content_type => 'application/x-www-form-urlencoded')    # ===> Success
+
+stub_request(:post, "www.example.com").
+  with(body: hash_including(id: /\d/))
+
+RestClient.post('www.example.com', "id=1",
+:content_type => 'application/x-www-form-urlencoded')    # ===> Success
+```
+
+### Matching request body against excluding partial hash.
+
+```ruby
+stub_request(:post, "www.example.com").
+  with(body: hash_excluding({data: {a: '2', b: 'six'}}))
+
+RestClient.post('www.example.com', "data[a]=1&data[b]=five&x=1",
+:content_type => 'application/x-www-form-urlencoded')    # ===> Success
+RestClient.post('www.example.com', "data[a]=2&data[b]=six&x=1",
+:content_type => 'application/x-www-form-urlencoded')    # ===> Failure
 ```
 
 ### Matching custom request headers
@@ -426,6 +444,8 @@ stub_request(:get, "www.example.com").to_rack(MyRackApp)
 RestClient.post('www.example.com')    # ===> "Hello"
 ```
 
+WebMock does not set `rack.session` in the Rack env, just as a real server would not. If your app needs a session, include session middleware in the app you pass to `to_rack`.
+
 ### Raising errors
 
 #### Exception declared by class

data/lib/webmock/http_lib_adapters/async_http_client_adapter.rb

@@ -111,11 +111,23 @@ if defined?(Async::HTTP)
           WebMock::RequestSignature.new(
             request.method.downcase.to_sym,
             "#{request.scheme}://#{request.authority}#{request.path}",
-            headers: request.headers.to_h,
+            headers: build_request_headers(request),
             body: body
           )
         end
 
+        # Protocol::HTTP::Headers#to_h parses values through the header policies
+        # (since protocol-http 0.56.0) and raises when a value is nil. Build the
+        # hash from the raw fields instead, skipping entries with no value since
+        # they carry nothing to match against. Keys are downcased so the same
+        # header sent in different casings is grouped together.
+        def build_request_headers(request)
+          request.headers.each.each_with_object({}) do |(key, value), headers|
+            next if value.nil?
+            (headers[key.downcase] ||= []) << value
+          end
+        end
+
         def build_webmock_response(response)
           body = response.read
           response.body = ::Protocol::HTTP::Body::Buffered.wrap(body)

data/lib/webmock/http_lib_adapters/curb_adapter.rb

@@ -13,7 +13,7 @@ if defined?(Curl)
   # in curb 1.3.0 through 1.3.5. Fixed in curb 1.3.6. See https://github.com/taf2/curb/issues/478
   unsupported_curb_versions += %w[1.3.0 1.3.1 1.3.2 1.3.3 1.3.4 1.3.5] if RUBY_VERSION < '2.7'
 
-  WebMock::VersionChecker.new('Curb', Curl::CURB_VERSION, '0.7.16', '1.3.7', unsupported_curb_versions).check_version!
+  WebMock::VersionChecker.new('Curb', Curl::CURB_VERSION, '0.7.16', nil, unsupported_curb_versions).check_version!
 
   module WebMock
     module HttpLibAdapters

data/lib/webmock/matchers/hash_excluding_matcher.rb

@@ -6,7 +6,7 @@ module WebMock
     # 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] }
+        super { |key, value| !actual.key?(key) || !(value === actual[key]) }
       end
 
       def inspect

data/lib/webmock/rack_response.rb

@@ -52,8 +52,6 @@ module WebMock
       end
       env['rack.url_scheme'] = uri.scheme
       env['rack.run_once']   = true
-      env['rack.session']    = session
-      env['rack.session.options'] = session_options
 
       headers.each do |k, v|
         env["HTTP_#{k.tr('-','_').upcase}"] = v
@@ -61,13 +59,5 @@ module WebMock
 
       env
     end
-
-    def session
-      @session ||= {}
-    end
-
-    def session_options
-      @session_options ||= {}
-    end
   end
 end

data/lib/webmock/request_pattern.rb

@@ -33,7 +33,7 @@ module WebMock
     end
 
     def matches?(request_signature)
-      content_type = request_signature.headers['Content-Type'] if request_signature.headers
+      content_type = request_signature.content_type
       content_type = content_type.split(';').first if content_type
       @method_pattern.matches?(request_signature.method) &&
         @uri_pattern.matches?(request_signature.uri) &&
@@ -275,6 +275,8 @@ module WebMock
         normalize_hash(pattern)
       elsif rSpecHashIncludingMatcher?(pattern)
         WebMock::Matchers::HashIncludingMatcher.from_rspec_matcher(pattern)
+      elsif rSpecHashExcludingMatcher?(pattern)
+        WebMock::Matchers::HashExcludingMatcher.from_rspec_matcher(pattern)
       else
         pattern
       end
@@ -304,6 +306,8 @@ module WebMock
     private
 
     def body_as_hash(body, content_type)
+      return if body.nil?
+
       case body_format(content_type)
       when :json then
         WebMock::Util::Parsers::JSON.parse(body)

data/lib/webmock/request_signature.rb

@@ -36,12 +36,18 @@ module WebMock
     end
     alias == eql?
 
+    # A request can carry Content-Type more than once, in which case the
+    # normalized header value is an Array. Use its first value.
+    def content_type
+      Array(headers&.fetch('Content-Type', nil)).first
+    end
+
     def url_encoded?
-      !!(headers&.fetch('Content-Type', nil)&.start_with?('application/x-www-form-urlencoded'))
+      !!content_type&.start_with?('application/x-www-form-urlencoded')
     end
 
     def json_headers?
-      !!(headers&.fetch('Content-Type', nil)&.start_with?('application/json'))
+      !!content_type&.start_with?('application/json')
     end
 
     private

data/lib/webmock/request_signature_snippet.rb

@@ -42,15 +42,6 @@ module WebMock
       diff.empty? ? "" : "Body diff:\n #{pretty_print_to_string(diff)}"
     end
 
-    def request_params
-      @request_params ||=
-        if request_signature.json_headers?
-          JSON.parse(request_signature.body)
-        else
-          ""
-        end
-    end
-
     def pretty_print_to_string(string_to_print)
       StringIO.open("".dup) do |stream|
         PP.pp(string_to_print, stream)

data/lib/webmock/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WebMock
-  VERSION = '3.26.4' unless defined?(::WebMock::VERSION)
+  VERSION = '3.28.0' unless defined?(::WebMock::VERSION)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webmock
 version: !ruby/object:Gem::Version
-  version: 3.26.4
+  version: 3.28.0
 platform: ruby
 authors:
 - Bartosz Blimke
@@ -358,9 +358,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/bblimke/webmock/issues
-  changelog_uri: https://github.com/bblimke/webmock/blob/v3.26.4/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/webmock/3.26.4
-  source_code_uri: https://github.com/bblimke/webmock/tree/v3.26.4
+  changelog_uri: https://github.com/bblimke/webmock/blob/v3.28.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/webmock/3.28.0
+  source_code_uri: https://github.com/bblimke/webmock/tree/v3.28.0
   wiki_uri: https://github.com/bblimke/webmock/wiki
 rdoc_options: []
 require_paths:
@@ -376,7 +376,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Library for stubbing HTTP requests in Ruby.
 test_files: []