webmock 3.28.0 → 3.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 337d9a801a6b8cabda8c8d3646346e475d9ec46f15453301314b1575b5e6e1f6
-  data.tar.gz: c33b8a74b6fbd42807eb12bb2a385441f953abfb1112c63f8fc1249be0aea38d
+  metadata.gz: dd5a0e377558900faf49baabeca47478c71196acd38c625b30ed13d48cb3945a
+  data.tar.gz: 7956de226b2fa9ad8f692319e6ea5ea4ca666c77c48488feb58470e79474ce26
 SHA512:
-  metadata.gz: 6dad3e43360bf3a82ff3cb6ba1655884c6a0fa4de4767699cc1ce832da1eb1cfe6bf0f37082a1e6d4c80edd839925bb468fad5a75012eb786b6f31342ce510a5
-  data.tar.gz: bfbaecd774edb88c0c09de2c8079d05b0d94b197343684cdd426f66e6c24237d9ba7302373a32b3608a1ea59c902f766e9b28b8532671dedfb83e12b8474b4d3
+  metadata.gz: dd9d32d168c7a3e3719b467c519393158cf1b279213acc1e515ac0ff1f88f4f60bc4831e975eae23d18b2fb0d08c84390b180ce52f68a492852d1981dfa5e29d
+  data.tar.gz: e4bb8d187695bde02c1bcadd89923b24d26e2174676f094ac93cc551e5e5688b242ee519c565151ad7423162557d47ee86bb97c981529134ae4bebfccbd4d5d2

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # 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)

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

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/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.content_type
-      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
 
@@ -283,6 +271,8 @@ module WebMock
     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)
@@ -308,7 +298,7 @@ module WebMock
     def body_as_hash(body, content_type)
       return if body.nil?
 
-      case body_format(content_type)
+      case WebMock::Util::ContentType.body_format(content_type)
       when :json then
         WebMock::Util::Parsers::JSON.parse(body)
       when :xml then
@@ -320,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 :(")
@@ -380,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
 
@@ -391,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

@@ -43,11 +43,11 @@ module WebMock
     end
 
     def url_encoded?
-      !!content_type&.start_with?('application/x-www-form-urlencoded')
+      WebMock::Util::ContentType.url_encoded?(content_type)
     end
 
     def json_headers?
-      !!content_type&.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,6 +40,12 @@ 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)}"

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.28.0' 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.28.0
+  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.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
+  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: