Merge branch 'master' into add-ability-to-assert-on-requests

.github/workflows/CI.yml

@@ -21,14 +21,15 @@ jobs:
           - '2.7'
           - '2.6'
           - jruby-head
-    continue-on-error: ${{ matrix.ruby == 'head' }}
+    continue-on-error: ${{ matrix.ruby == 'head' || matrix.ruby == 'jruby-head' }}
     name: Ruby ${{ matrix.ruby }}
     env:
       JRUBY_OPTS: "--debug"
     steps:
       - uses: actions/checkout@v4
       - name: Install Apt Packages
         run: |
+          sudo apt update
           sudo apt-get install libcurl4-openssl-dev -y
       - uses: ruby/setup-ruby@v1
         continue-on-error: false

lib/webmock.rb

@@ -4,7 +4,6 @@
 
 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/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'
 

lib/webmock/http_lib_adapters/http_rb/streamer.rb

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

lib/webmock/http_lib_adapters/patron_adapter.rb

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

lib/webmock/request_pattern.rb

@@ -84,11 +84,14 @@ def create_uri_pattern(uri)
         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 @@ def to_s
     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)

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

lib/webmock/util/parsers/parse_error.rb

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

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

spec/acceptance/http_rb/http_rb_spec.rb

@@ -89,6 +89,20 @@
 
       response.connection.close
     end
+
+    it "reports request finish" do
+      stub_request(:get, "example.com/foo")
+        .to_return(body: 'XX')
+      response = HTTP.get "http://example.com/foo"
+
+      expect(response.connection.finished_request?).to be(false)
+
+      response.body.readpartial(1)
+      expect(response.connection.finished_request?).to be(false)
+
+      response.body.readpartial
+      expect(response.connection.finished_request?).to be(true)
+    end
   end
 
   it "should preserve request body encoding when matching requests" do

spec/unit/request_pattern_spec.rb

@@ -436,6 +436,14 @@ def match(request_signature)
           end
         end
       end
+
+      describe "when uri is passed as Pathname" do
+        it "should raise an ArgumentError" do
+          expect {
+            WebMock::RequestPattern.new(:get, Pathname.new("www.example.com"))
+          }.to raise_error(ArgumentError, "URI should be a String, Regexp, Addressable::Template or a callable object. Got: Pathname")
+        end
+      end
     end
 
     describe "when matching requests with body" do
@@ -562,7 +570,7 @@ def match(request_signature)
             it "should not match when body is not json" do
               expect(WebMock::RequestPattern.new(:post, 'www.example.com', body: body_hash)).
                 not_to match(WebMock::RequestSignature.new(:post, "www.example.com",
-                                                               headers: {content_type: content_type}, body: "foo bar"))
+                                                               headers: {content_type: content_type}, body: "[foo bar"))
             end
 
             it "should not match if request body is different" do
@@ -614,7 +622,7 @@ def match(request_signature)
             it "should not match when body is not xml" do
               expect(WebMock::RequestPattern.new(:post, 'www.example.com', body: body_hash)).
                 not_to match(WebMock::RequestSignature.new(:post, "www.example.com",
-                                                               headers: {content_type: content_type}, body: "foo bar"))
+                                                               headers: {content_type: content_type}, body: "<foo bar"))
                 end
 
             it "matches when the content type include a charset" do

spec/unit/util/json_spec.rb → spec/unit/util/parsers/json_spec.rb

@@ -1,31 +1,38 @@
 # encoding: utf-8
 require 'spec_helper'
 
-describe WebMock::Util::JSON do
+describe WebMock::Util::Parsers::JSON do
   describe ".parse" do
     it "should parse json without parsing dates" do
-      expect(WebMock::Util::JSON.parse("\"a\":\"2011-01-01\"")).to eq(
+      expect(described_class.parse("\"a\":\"2011-01-01\"")).to eq(
         {"a" => "2011-01-01"}
       )
     end
 
     it "can parse json with multibyte characters" do
-      expect(WebMock::Util::JSON.parse(
+      expect(described_class.parse(
         "{\"name\":\"山田太郎\"\,\"job\":\"会社員\"}"
       )).to eq({"name" => "山田太郎", "job" => "会社員"})
     end
 
     it "rescues ArgumentError's from YAML.load" do
       allow(YAML).to receive(:load).and_raise(ArgumentError)
       expect {
-        WebMock::Util::JSON.parse("Bad JSON")
-      }.to raise_error WebMock::Util::JSON::ParseError
+        described_class.parse("Bad JSON")
+      }.to raise_error WebMock::Util::Parsers::ParseError
+    end
+
+    it "rescues Psych::SyntaxError's from YAML.load" do
+      allow(YAML).to receive(:load).and_raise(Psych::SyntaxError)
+      expect {
+        described_class.parse("Bad JSON")
+      }.to raise_error WebMock::Util::Parsers::ParseError
     end
   end
 
   describe ".convert_json_to_yaml" do
     it "parses multibyte characters" do
-      expect(WebMock::Util::JSON.convert_json_to_yaml(
+      expect(described_class.convert_json_to_yaml(
         "{\"name\":\"山田太郎\"\,\"job\":\"会社員\"}"
       )).to eq "{\"name\": \"山田太郎\", \"job\": \"会社員\"}"
     end