webmock 3.26.4 → 3.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb0293b4433bbf3342d1f81abb5a1c773382f6f1a7fef6b44eb83fc0a38544a7
-  data.tar.gz: 00fbb149216fae39f04b689fc02c0f561e59e47843011fd8aaab36b35e86ba67
+  metadata.gz: dd5a0e377558900faf49baabeca47478c71196acd38c625b30ed13d48cb3945a
+  data.tar.gz: 7956de226b2fa9ad8f692319e6ea5ea4ca666c77c48488feb58470e79474ce26
 SHA512:
-  metadata.gz: 664302057fd929d144d09bb739c0cc581f4b80b40b67093989a4df01a21337f12594b765d9da0bc980ba981cfbe8db451cf0d23ce4ed10fa5d57eb2ddd98de79
-  data.tar.gz: bad8a582bd3b717e11182aef243b7167021187d63bd40b2dc1f0f54f13928e898e45ecf1cb598419e8dfc643d5b270db0d3a5408ab871ffb0725d5560dbd556b
+  metadata.gz: dd9d32d168c7a3e3719b467c519393158cf1b279213acc1e515ac0ff1f88f4f60bc4831e975eae23d18b2fb0d08c84390b180ce52f68a492852d1981dfa5e29d
+  data.tar.gz: e4bb8d187695bde02c1bcadd89923b24d26e2174676f094ac93cc551e5e5688b242ee519c565151ad7423162557d47ee86bb97c981529134ae4bebfccbd4d5d2

data/CHANGELOG.md

@@ -1,5 +1,55 @@
 # Changelog
 
+# 3.29.0
+
+* Show a body diff for JSON requests whose content type has a `+json` suffix, such as `application/vnd.api+json`, and for the other content types WebMock already matches as JSON (#734)
+
+    Thanks to [Olivier Brisse](https://github.com/ouranos)
+
+* Ignore the case of JSON, XML and url-encoded content types when matching request bodies, and match bodies of any `+json` or `+xml` media type, such as `image/svg+xml`, as JSON or XML
+
+* Suggest declaring a JSON body as a hash when a request fails to match only because the JSON is formatted differently (#649)
+
+    A body declared as a string must match the request body exactly, including key order and whitespace. When that is the only difference, the error for an unregistered request and the failure message of a request expectation now say so, and suggest `with(body: JSON.parse(json_string))`. Matching JSON strings regardless of key order by default is planned for the next major version (#485).
+
+# 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

@@ -176,6 +176,8 @@ RestClient.post('www.example.com', '<data a="1" b="five" />',
   content_type: 'application/xml')    # ===> Success
 ```
 
+A body declared as a string must match the request body exactly. For JSON, that includes key order and whitespace, so declare the body as a hash to match it as JSON, for example `with(body: JSON.parse(json_string))`.
+
 ### Matching request body against partial hash.
 
 ```ruby
@@ -184,6 +186,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 +446,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/json_body_hint.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "json"
+
+module WebMock
+  # A body declared as a string must match the request body exactly, which for
+  # JSON includes key order and whitespace. When a request fails to match only
+  # because of that, failure messages suggest declaring the body as a hash.
+  # See #485.
+  module JsonBodyHint
+    ADVICE = "A body declared as a string must match exactly. To match it as JSON, " \
+             "declare it as a hash, for example with(body: JSON.parse(json_string))."
+
+    STUB_HINT = "Hint: the request body is the same JSON as the body of this stub, " \
+                "but formatted differently, for example with keys in another order. #{ADVICE}"
+
+    EXPECTATION_HINT = "Hint: a request was made with the same JSON body as expected, " \
+                       "but formatted differently, for example with keys in another order. #{ADVICE}"
+
+    # True when the pattern declares its body as a JSON object or array string,
+    # the request has a JSON content type and a body that parses to the same
+    # JSON but is written differently, and the pattern's method, URI and headers
+    # match the request. A block given to the pattern is not called.
+    def self.applies?(request_pattern, request_signature)
+      return false unless request_pattern.is_a?(RequestPattern) && request_pattern.body_pattern
+
+      expected = request_pattern.body_pattern.pattern
+      actual = request_signature.body
+      return false unless expected.is_a?(String) && actual.is_a?(String) && expected != actual
+      return false unless request_signature.json_headers?
+
+      expected_json = parse_json(expected)
+      return false unless expected_json.is_a?(Hash) || expected_json.is_a?(Array)
+      # eql? compares nested values strictly, so 1 and 1.0 are different.
+      return false unless expected_json.eql?(parse_json(actual))
+
+      matches_except_body?(request_pattern, request_signature)
+    end
+
+    def self.matches_except_body?(request_pattern, request_signature)
+      request_pattern.method_pattern.matches?(request_signature.method) &&
+        request_pattern.uri_pattern.matches?(request_signature.uri) &&
+        (request_pattern.headers_pattern.nil? || request_pattern.headers_pattern.matches?(request_signature.headers))
+    end
+
+    def self.parse_json(string)
+      ::JSON.parse(string)
+    rescue ::JSON::JSONError, EncodingError
+      nil
+    end
+    private_class_method :matches_except_body?, :parse_json
+  end
+end

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_execution_verifier.rb

@@ -56,9 +56,31 @@ module WebMock
     def failure_message_phrase(is_negated=false)
       negation = is_negated ? "was not" : "was"
       "The request #{request_pattern} #{negation} expected to execute #{quantity_phrase(is_negated)}but it executed #{times(times_executed)}" +
+        (is_negated ? "" : json_body_hint) +
         self.class.executed_requests_message
     end
 
+    # Only when too few requests matched: with too many, declaring the body
+    # as a hash would match even more of them.
+    def json_body_hint
+      return "" unless WebMock.show_body_diff? && too_few_requests_executed?
+
+      requests = RequestRegistry.instance.requested_signatures.select do |request_signature, _|
+        JsonBodyHint.applies?(request_pattern, request_signature)
+      end
+      requests.empty? ? "" : "\n\n#{JsonBodyHint::EXPECTATION_HINT}"
+    end
+
+    def too_few_requests_executed?
+      if @at_least_times_executed
+        times_executed < @at_least_times_executed
+      elsif @at_most_times_executed
+        false
+      else
+        times_executed < (@expected_times_executed || 1)
+      end
+    end
+
     def quantity_phrase(is_negated=false)
       if @at_least_times_executed
         "at least #{times(@at_least_times_executed)} "

data/lib/webmock/request_pattern.rb

@@ -33,11 +33,9 @@ module WebMock
     end
 
     def matches?(request_signature)
-      content_type = request_signature.headers['Content-Type'] if request_signature.headers
-      content_type = content_type.split(';').first if content_type
       @method_pattern.matches?(request_signature.method) &&
         @uri_pattern.matches?(request_signature.uri) &&
-        (@body_pattern.nil? || @body_pattern.matches?(request_signature.body, content_type || "")) &&
+        (@body_pattern.nil? || @body_pattern.matches?(request_signature.body, request_signature.content_type)) &&
         (@headers_pattern.nil? || @headers_pattern.matches?(request_signature.headers)) &&
         (@with_block.nil? || @with_block.call(request_signature))
     end
@@ -255,18 +253,8 @@ module WebMock
   class BodyPattern
     include RSpecMatcherDetector
 
-    BODY_FORMATS = {
-      'text/xml'               => :xml,
-      'application/xml'        => :xml,
-      'application/json'       => :json,
-      'text/json'              => :json,
-      'application/javascript' => :json,
-      'text/javascript'        => :json,
-      'text/html'              => :html,
-      'application/x-yaml'     => :yaml,
-      'text/yaml'              => :yaml,
-      'text/plain'             => :plain
-    }
+    # Kept so existing references to the constant still resolve.
+    BODY_FORMATS = WebMock::Util::ContentType::BODY_FORMATS
 
     attr_reader :pattern
 
@@ -275,12 +263,16 @@ 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
     end
 
     def matches?(body, content_type = "")
+      # Checked on the raw value, so body patterns used with mixed case
+      # multipart content types keep working as in earlier versions.
       assert_non_multipart_body(content_type)
 
       if (@pattern).is_a?(Hash)
@@ -304,7 +296,9 @@ module WebMock
     private
 
     def body_as_hash(body, content_type)
-      case body_format(content_type)
+      return if body.nil?
+
+      case WebMock::Util::ContentType.body_format(content_type)
       when :json then
         WebMock::Util::Parsers::JSON.parse(body)
       when :xml then
@@ -316,11 +310,6 @@ module WebMock
       nil
     end
 
-    def body_format(content_type)
-      normalized_content_type = content_type.sub(/\A(application\/)[a-zA-Z0-9.-]+\+(json|xml)\Z/,'\1\2')
-      BODY_FORMATS[normalized_content_type]
-    end
-
     def assert_non_multipart_body(content_type)
       if content_type =~ %r{^multipart/form-data}
         raise ArgumentError.new("WebMock does not support matching body for multipart/form-data requests yet :(")
@@ -376,7 +365,7 @@ module WebMock
       return matching_body_hashes?(actual, expected, content_type) if actual.is_a?(Hash) && expected.is_a?(Hash)
       return matching_body_array?(actual, expected, content_type) if actual.is_a?(Array) && expected.is_a?(Array)
 
-      expected = WebMock::Util::ValuesStringifier.stringify_values(expected) if url_encoded_body?(content_type)
+      expected = WebMock::Util::ValuesStringifier.stringify_values(expected) if WebMock::Util::ContentType.url_encoded?(content_type)
       expected === actual
     end
 
@@ -387,10 +376,6 @@ module WebMock
     def normalize_hash(hash)
       Hash[WebMock::Util::HashKeysStringifier.stringify_keys!(hash, deep: true).sort]
     end
-
-    def url_encoded_body?(content_type)
-      content_type =~ %r{^application/x-www-form-urlencoded}
-    end
   end
 
   class HeadersPattern

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'))
+      WebMock::Util::ContentType.url_encoded?(content_type)
     end
 
     def json_headers?
-      !!(headers&.fetch('Content-Type', nil)&.start_with?('application/json'))
+      WebMock::Util::ContentType.body_format(content_type) == :json
     end
 
     private

data/lib/webmock/request_signature_snippet.rb

@@ -25,7 +25,10 @@ module WebMock
       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?
+        if WebMock.show_body_diff?
+          add_body_diff(stub, text)
+          add_json_body_hint(stub, text)
+        end
       end
       text
     end
@@ -37,20 +40,17 @@ module WebMock
       text << "\n\n#{body_diff_str}" unless body_diff_str.empty?
     end
 
+    def add_json_body_hint(stub, text)
+      return unless JsonBodyHint.applies?(stub.request_pattern, request_signature)
+
+      text << "\n\n#{JsonBodyHint::STUB_HINT}\n"
+    end
+
     def signature_stub_body_diff(stub)
       diff = RequestBodyDiff.new(request_signature, stub).body_diff
       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/util/content_type.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module WebMock
+  module Util
+    module ContentType
+      BODY_FORMATS = {
+        'text/xml'               => :xml,
+        'application/xml'        => :xml,
+        'application/json'       => :json,
+        'text/json'              => :json,
+        'application/javascript' => :json,
+        'text/javascript'        => :json,
+        'text/html'              => :html,
+        'application/x-yaml'     => :yaml,
+        'text/yaml'              => :yaml,
+        'text/plain'             => :plain
+      }
+
+      def self.media_type(content_type)
+        content_type.to_s.scrub.split(';', 2).first.to_s.strip.downcase
+      end
+
+      def self.url_encoded?(content_type)
+        media_type(content_type) == 'application/x-www-form-urlencoded'
+      end
+
+      def self.body_format(content_type)
+        type = media_type(content_type)
+
+        BODY_FORMATS.fetch(type) do
+          case type
+          when %r{\A[^/\s]+/[^/\s]+\+json\z} then :json
+          when %r{\A[^/\s]+/[^/\s]+\+xml\z} then :xml
+          end
+        end
+      end
+    end
+  end
+end

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.29.0' unless defined?(::WebMock::VERSION)
 end

data/lib/webmock.rb

@@ -13,6 +13,7 @@ require_relative 'webmock/errors'
 require_relative 'webmock/util/query_mapper'
 require_relative 'webmock/util/uri'
 require_relative 'webmock/util/headers'
+require_relative 'webmock/util/content_type'
 require_relative 'webmock/util/hash_counter'
 require_relative 'webmock/util/hash_keys_stringifier'
 require_relative 'webmock/util/values_stringifier'
@@ -36,6 +37,7 @@ require_relative 'webmock/rack_response'
 require_relative 'webmock/stub_request_snippet'
 require_relative 'webmock/request_signature_snippet'
 require_relative 'webmock/request_body_diff'
+require_relative 'webmock/json_body_hint'
 
 require_relative 'webmock/assertion_failure'
 require_relative 'webmock/request_execution_verifier'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webmock
 version: !ruby/object:Gem::Version
-  version: 3.26.4
+  version: 3.29.0
 platform: ruby
 authors:
 - Bartosz Blimke
@@ -318,6 +318,7 @@ files:
 - lib/webmock/http_lib_adapters/net_http_response.rb
 - lib/webmock/http_lib_adapters/patron_adapter.rb
 - lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb
+- lib/webmock/json_body_hint.rb
 - lib/webmock/matchers/any_arg_matcher.rb
 - lib/webmock/matchers/hash_argument_matcher.rb
 - lib/webmock/matchers/hash_excluding_matcher.rb
@@ -340,6 +341,7 @@ files:
 - lib/webmock/stub_registry.rb
 - lib/webmock/stub_request_snippet.rb
 - lib/webmock/test_unit.rb
+- lib/webmock/util/content_type.rb
 - lib/webmock/util/hash_counter.rb
 - lib/webmock/util/hash_keys_stringifier.rb
 - lib/webmock/util/hash_validator.rb
@@ -358,9 +360,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.29.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/webmock/3.29.0
+  source_code_uri: https://github.com/bblimke/webmock/tree/v3.29.0
   wiki_uri: https://github.com/bblimke/webmock/wiki
 rdoc_options: []
 require_paths:
@@ -376,7 +378,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: []