webmock 3.23.1 → 3.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cfe9b7372b311f25b6b531efc50e11297e19cb325306132b889bf2d67ab3fec
-  data.tar.gz: 4448d921dc29e08024392f7fe0c8ab5a832920a6e749801e1ca2257a1c050e0b
+  metadata.gz: 9283efd8ecb49795fe14fc5903295b0d143fbdd17f5cc1611e89d918f917c33f
+  data.tar.gz: ea556e59d242667816568c75f7c42be613e09f688c3ada07c65f0c9de0e3d05d
 SHA512:
-  metadata.gz: b6afe5a627d5c3c1498e5b4f35d07f9118977af57f4b7915b04bdeb67f2eb676bbbf5bfc28a895681c6635fe74d736d9a83d50916c2f80b1adb4b68d455de283
-  data.tar.gz: 8843478e3cbcd78b3e4cc6d6a09c757ff02328549ea37768f23d721adb3721ab0daf49a000fcc8fa600382964538d6bc5aec7a6d1fdde4668a608b3b2b6fda08
+  metadata.gz: bcd310894ba47584609ffafcd332cbd824d3921ec938a7ca63e84e983436188dbf7f44a13137e407b3c5798fd9a02ced95e5797ac9ee3e923adf588cf04c4015
+  data.tar.gz: 617bcf11b564bf6cc2faf4a973e9882dbb9639e685ed989fe6bc11b65c1ea7e66d12a106484e2e641ff4fda4c8c7336fe83509852b2a858f94fe0a657b5aae6c

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+# 3.24.0
+
+* Ignore parsing errors when parsing invalid JSON or XML body to match against body pattern #1066
+
+    Thanks to [Christian Schmidt](https://github.com/c960657)
+
+* Added support for mocked HTTP::Connection#finished_request? method #1065
+
+    Thanks to [Christian Schmidt](https://github.com/c960657)
+
+* Detect if Patron is loaded by checking if Patron::Session constant is defined #1068
+
+    Thanks to [Rodrigo Argumedo](https://github.com/rodrigoargumedo)
+
+* Raising an ArgumentError when uri is passed as a Pathname object to stub_request or request expectation declaration.
+
+* Dropped support for em-http-request on Ruby 3.4. The current version of em-http-request (1.1.7) is incompatible with Ruby 3.4 due to an unresolved issue (https://github.com/igrigorik/em-http-request/issues/365). Support for em-http-request will be re-enabled once the compatibility issue is resolved.
+
+    Thanks to [Christian Schmidt](https://github.com/c960657)
+
 # 3.23.1
 
 * Added support for async-http version >= 0.65.0 [PR](https://github.com/bblimke/webmock/pull/1056)

data/README.md

@@ -1204,6 +1204,8 @@ People who submitted patches and new features or suggested improvements. Many th
 * Gio Lodi
 * Ryan Brooks
 * Jacob Frautschi
+* Christian Schmidt
+* Rodrigo Argumedo
 
 For a full list of contributors you can visit the
 [contributors](https://github.com/bblimke/webmock/contributors) page.

data/lib/webmock/http_lib_adapters/async_http_client_adapter.rb

@@ -35,9 +35,9 @@ if defined?(Async::HTTP)
       class WebMockClientWrapper < Client
         def initialize(
           endpoint,
-          protocol = endpoint.protocol,
-          scheme = endpoint.scheme,
-          authority = endpoint.authority,
+          protocol: endpoint.protocol,
+          scheme: endpoint.scheme,
+          authority: endpoint.authority,
           **options
         )
           webmock_endpoint = WebMockEndpoint.new(scheme, authority, protocol)
@@ -45,6 +45,7 @@ if defined?(Async::HTTP)
           @network_client = WebMockClient.new(endpoint, **options)
           @webmock_client = WebMockClient.new(webmock_endpoint, **options)
 
+          @endpoint = endpoint
           @scheme = scheme
           @authority = authority
         end

data/lib/webmock/http_lib_adapters/em_http_request_adapter.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+return if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.4.0')
+
 begin
   require 'em-http-request'
 rescue LoadError

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

@@ -25,6 +25,10 @@ module HTTP
         @io.close
       end
 
+      def finished_request?
+        @io.eof?
+      end
+
       def sequence_id
         -1
       end

data/lib/webmock/http_lib_adapters/patron_adapter.rb

@@ -6,7 +6,7 @@ rescue LoadError
   # patron not found
 end
 
-if defined?(::Patron)
+if defined?(::Patron::Session)
   module WebMock
     module HttpLibAdapters
       class PatronAdapter < ::WebMock::HttpLibAdapter

data/lib/webmock/request_pattern.rb

@@ -84,11 +84,14 @@ module WebMock
         URIAddressablePattern.new(uri)
       elsif uri.respond_to?(:call)
         URICallablePattern.new(uri)
-      else
+      elsif uri.is_a?(::URI::Generic)
+        URIStringPattern.new(uri.to_s)
+      elsif uri.is_a?(String)
         URIStringPattern.new(uri)
+      else
+        raise ArgumentError.new("URI should be a String, Regexp, Addressable::Template or a callable object. Got: #{uri.class}")
       end
     end
-
   end
 
 
@@ -303,12 +306,14 @@ module WebMock
     def body_as_hash(body, content_type)
       case body_format(content_type)
       when :json then
-        WebMock::Util::JSON.parse(body)
+        WebMock::Util::Parsers::JSON.parse(body)
       when :xml then
-        Crack::XML.parse(body)
+        WebMock::Util::Parsers::XML.parse(body)
       else
         WebMock::Util::QueryMapper.query_to_values(body, notation: Config.instance.query_values_notation)
       end
+    rescue WebMock::Util::Parsers::ParseError
+      nil
     end
 
     def body_format(content_type)

data/lib/webmock/util/parsers/json.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# This is a copy of https://github.com/jnunemaker/crack/blob/master/lib/crack/json.rb
+# with date parsing removed
+# Copyright (c) 2004-2008 David Heinemeier Hansson
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require_relative "parse_error"
+
+module WebMock
+  module Util
+    module Parsers
+      class JSON
+        def self.parse(json)
+          yaml = unescape(convert_json_to_yaml(json))
+          YAML.load(yaml)
+        rescue ArgumentError, Psych::SyntaxError => e
+          raise ParseError, "Invalid JSON string: #{yaml}, Error: #{e.inspect}"
+        end
+
+        protected
+
+        def self.unescape(str)
+          str.gsub(/\\u([0-9a-f]{4})/) { [$1.hex].pack("U") }
+        end
+
+        # Ensure that ":" and "," are always followed by a space
+        def self.convert_json_to_yaml(json) #:nodoc:
+          scanner, quoting, marks, times = StringScanner.new(json), false, [], []
+          while scanner.scan_until(/(\\['"]|['":,\\]|\\.)/)
+            case char = scanner[1]
+            when '"', "'"
+              if !quoting
+                quoting = char
+              elsif quoting == char
+                quoting = false
+              end
+            when ":",","
+                marks << scanner.pos - 1 unless quoting
+            when "\\"
+                scanner.skip(/\\/)
+            end
+          end
+
+          if marks.empty?
+            json.gsub(/\\\//, '/')
+          else
+            left_pos  = [-1].push(*marks)
+            right_pos = marks << json.bytesize
+            output    = []
+
+            left_pos.each_with_index do |left, i|
+              if json.respond_to?(:byteslice)
+                output << json.byteslice(left.succ..right_pos[i])
+              else
+                output << json[left.succ..right_pos[i]]
+              end
+            end
+
+            output = output * " "
+
+            times.each { |i| output[i-1] = ' ' }
+            output.gsub!(/\\\//, '/')
+            output
+          end
+        end
+      end
+    end
+  end
+end

data/lib/webmock/util/parsers/parse_error.rb

@@ -0,0 +1,7 @@
+module WebMock
+  module Util
+    module Parsers
+      class ParseError < StandardError; end
+    end
+  end
+end

data/lib/webmock/util/parsers/xml.rb

@@ -0,0 +1,16 @@
+require_relative "parse_error"
+require "crack/xml"
+
+module WebMock
+  module Util
+    module Parsers
+      class XML
+        def self.parse(xml)
+          ::Crack::XML.parse(xml)
+        rescue ::REXML::ParseException => e
+          raise ParseError, "Invalid XML string: #{xml}, Error: #{e.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/webmock/version.rb

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

data/lib/webmock.rb

@@ -4,7 +4,6 @@ require 'singleton'
 
 require 'addressable/uri'
 require 'addressable/template'
-require 'crack/xml'
 
 require_relative 'webmock/deprecation'
 require_relative 'webmock/version'
@@ -17,7 +16,8 @@ require_relative 'webmock/util/headers'
 require_relative 'webmock/util/hash_counter'
 require_relative 'webmock/util/hash_keys_stringifier'
 require_relative 'webmock/util/values_stringifier'
-require_relative 'webmock/util/json'
+require_relative 'webmock/util/parsers/json'
+require_relative 'webmock/util/parsers/xml'
 require_relative 'webmock/util/version_checker'
 require_relative 'webmock/util/hash_validator'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webmock
 version: !ruby/object:Gem::Version
-  version: 3.23.1
+  version: 3.24.0
 platform: ruby
 authors:
 - Bartosz Blimke
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-24 00:00:00.000000000 Z
+date: 2024-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -359,7 +359,9 @@ files:
 - lib/webmock/util/hash_keys_stringifier.rb
 - lib/webmock/util/hash_validator.rb
 - lib/webmock/util/headers.rb
-- lib/webmock/util/json.rb
+- lib/webmock/util/parsers/json.rb
+- lib/webmock/util/parsers/parse_error.rb
+- lib/webmock/util/parsers/xml.rb
 - lib/webmock/util/query_mapper.rb
 - lib/webmock/util/uri.rb
 - lib/webmock/util/values_stringifier.rb
@@ -371,9 +373,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/bblimke/webmock/issues
-  changelog_uri: https://github.com/bblimke/webmock/blob/v3.23.1/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/webmock/3.23.1
-  source_code_uri: https://github.com/bblimke/webmock/tree/v3.23.1
+  changelog_uri: https://github.com/bblimke/webmock/blob/v3.24.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/webmock/3.24.0
+  source_code_uri: https://github.com/bblimke/webmock/tree/v3.24.0
   wiki_uri: https://github.com/bblimke/webmock/wiki
 post_install_message:
 rdoc_options: []
@@ -390,7 +392,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Library for stubbing HTTP requests in Ruby.

data/lib/webmock/util/json.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-# This is a copy of https://github.com/jnunemaker/crack/blob/master/lib/crack/json.rb
-# with date parsing removed
-# Copyright (c) 2004-2008 David Heinemeier Hansson
-# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-module WebMock
-  module Util
-    class JSON
-      class ParseError < StandardError; end
-
-      def self.parse(json)
-        yaml = unescape(convert_json_to_yaml(json))
-        YAML.load(yaml)
-      rescue ArgumentError => e
-        raise ParseError, "Invalid JSON string: #{yaml}, Error: #{e.inspect}"
-      end
-
-      protected
-      def self.unescape(str)
-        str.gsub(/\\u([0-9a-f]{4})/) { [$1.hex].pack("U") }
-      end
-
-      # Ensure that ":" and "," are always followed by a space
-      def self.convert_json_to_yaml(json) #:nodoc:
-        scanner, quoting, marks, times = StringScanner.new(json), false, [], []
-        while scanner.scan_until(/(\\['"]|['":,\\]|\\.)/)
-          case char = scanner[1]
-          when '"', "'"
-            if !quoting
-              quoting = char
-            elsif quoting == char
-              quoting = false
-            end
-          when ":",","
-              marks << scanner.pos - 1 unless quoting
-          when "\\"
-              scanner.skip(/\\/)
-          end
-        end
-
-        if marks.empty?
-          json.gsub(/\\\//, '/')
-        else
-          left_pos  = [-1].push(*marks)
-          right_pos = marks << json.bytesize
-          output    = []
-
-          left_pos.each_with_index do |left, i|
-            if json.respond_to?(:byteslice)
-              output << json.byteslice(left.succ..right_pos[i])
-            else
-              output << json[left.succ..right_pos[i]]
-            end
-          end
-
-          output = output * " "
-
-          times.each { |i| output[i-1] = ' ' }
-          output.gsub!(/\\\//, '/')
-          output
-        end
-      end
-    end
-  end
-end