webmock 3.14.0 → 3.24.0

data/lib/webmock/request_pattern.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
 
   module RSpecMatcherDetector
@@ -82,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
 
 
@@ -281,7 +286,9 @@ module WebMock
       if (@pattern).is_a?(Hash)
         return true if @pattern.empty?
         matching_body_hashes?(body_as_hash(body, content_type), @pattern, content_type)
-      elsif (@pattern).is_a?(WebMock::Matchers::HashIncludingMatcher)
+      elsif (@pattern).is_a?(Array)
+        matching_body_array?(body_as_hash(body, content_type), @pattern, content_type)
+      elsif (@pattern).is_a?(WebMock::Matchers::HashArgumentMatcher)
         @pattern == body_as_hash(body, content_type)
       else
         empty_string?(@pattern) && empty_string?(body) ||
@@ -299,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)
@@ -344,19 +353,33 @@ module WebMock
     def matching_body_hashes?(query_parameters, pattern, content_type)
       return false unless query_parameters.is_a?(Hash)
       return false unless query_parameters.keys.sort == pattern.keys.sort
-      query_parameters.each do |key, actual|
+
+      query_parameters.all? do |key, actual|
         expected = pattern[key]
+        matching_values(actual, expected, content_type)
+      end
+    end
 
-        if actual.is_a?(Hash) && expected.is_a?(Hash)
-          return false unless matching_body_hashes?(actual, expected, content_type)
-        else
-          expected = WebMock::Util::ValuesStringifier.stringify_values(expected) if url_encoded_body?(content_type)
-          return false unless expected === actual
-        end
+    def matching_body_array?(query_parameters, pattern, content_type)
+      return false unless query_parameters.is_a?(Array)
+      return false unless query_parameters.length == pattern.length
+
+      query_parameters.each_with_index do |actual, index|
+        expected = pattern[index]
+        return false unless matching_values(actual, expected, content_type)
       end
+
       true
     end
 
+    def matching_values(actual, expected, content_type)
+      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 === actual
+    end
+
     def empty_string?(string)
       string.nil? || string == ""
     end

data/lib/webmock/request_registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
 
   class RequestRegistry

data/lib/webmock/request_signature.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
 
   class RequestSignature
@@ -35,11 +37,11 @@ module WebMock
     alias == eql?
 
     def url_encoded?
-      !!(headers && headers['Content-Type'] == 'application/x-www-form-urlencoded')
+      !!(headers&.fetch('Content-Type', nil)&.start_with?('application/x-www-form-urlencoded'))
     end
 
     def json_headers?
-      !!(headers && headers['Content-Type'] == 'application/json')
+      !!(headers&.fetch('Content-Type', nil)&.start_with?('application/json'))
     end
 
     private

data/lib/webmock/request_signature_snippet.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pp"
 
 module WebMock

data/lib/webmock/request_stub.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   class RequestStub
 
@@ -24,6 +26,38 @@ module WebMock
     end
     alias_method :and_return, :to_return
 
+    def to_return_json(*response_hashes)
+      raise ArgumentError, '#to_return_json does not support passing a block' if block_given?
+
+      json_response_hashes = [*response_hashes].flatten.map do |resp_h|
+        headers, body = resp_h.values_at(:headers, :body)
+
+        json_body = if body.respond_to?(:call)
+          ->(request_signature) {
+            b = if body.respond_to?(:arity) && body.arity == 1
+              body.call(request_signature)
+            else
+              body.call
+            end
+            b = b.to_json unless b.is_a?(String)
+            b
+          }
+        elsif !body.is_a?(String)
+          body.to_json
+        else
+          body
+        end
+
+        resp_h.merge(
+          headers: {content_type: 'application/json'}.merge(headers.to_h),
+          body: json_body
+        )
+      end
+
+      to_return(json_response_hashes)
+    end
+    alias_method :and_return_json, :to_return_json
+
     def to_rack(app, options={})
       @responses_sequences << ResponsesSequence.new([RackResponse.new(app)])
     end

data/lib/webmock/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pathname"
 
 module WebMock
@@ -14,8 +16,11 @@ module WebMock
 
   class Response
     def initialize(options = {})
-      if options.is_a?(IO) || options.is_a?(String)
+      case options
+      when IO, StringIO
         self.options = read_raw_response(options)
+      when String
+        self.options = read_raw_response(StringIO.new(options))
       else
         self.options = options
       end
@@ -33,7 +38,7 @@ module WebMock
     end
 
     def body
-      @body || ''
+      @body || String.new("")
     end
 
     def body=(body)
@@ -112,21 +117,16 @@ module WebMock
       return if @body.nil?
       return if valid_types.any? { |c| @body.is_a?(c) }
 
-      if @body.class.is_a?(Hash)
-        raise InvalidBody, "must be one of: #{valid_types}, but you've used a #{@body.class}' instead." \
-          "\n What shall we encode it to? try calling .to_json .to_xml instead on the hash instead, or otherwise convert it to a string."
+      if @body.is_a?(Hash)
+        raise InvalidBody, "must be one of: #{valid_types}, but you've used a #{@body.class}. " \
+          "Please convert it by calling .to_json .to_xml, or otherwise convert it to a string."
       else
-        raise InvalidBody, "must be one of: #{valid_types}. '#{@body.class}' given"
+        raise InvalidBody, "must be one of: #{valid_types}. '#{@body.class}' given."
       end
     end
 
-    def read_raw_response(raw_response)
-      if raw_response.is_a?(IO)
-        string = raw_response.read
-        raw_response.close
-        raw_response = string
-      end
-      socket = ::Net::BufferedIO.new(raw_response)
+    def read_raw_response(io)
+      socket = ::Net::BufferedIO.new(io)
       response = ::Net::HTTPResponse.read_new(socket)
       transfer_encoding = response.delete('transfer-encoding') #chunks were already read by curl
       response.reading_body(socket, true) {}
@@ -138,6 +138,8 @@ module WebMock
       options[:body] = response.read_body
       options[:status] = [response.code.to_i, response.message]
       options
+    ensure
+      socket.close
     end
 
     InvalidBody = Class.new(StandardError)

data/lib/webmock/responses_sequence.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
 
   class ResponsesSequence

data/lib/webmock/rspec/matchers/request_pattern_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   class RequestPatternMatcher
 

data/lib/webmock/rspec/matchers/webmock_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   class WebMockMatcher
 

data/lib/webmock/rspec/matchers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'webmock'
 require 'webmock/rspec/matchers/request_pattern_matcher'
 require 'webmock/rspec/matchers/webmock_matcher'

data/lib/webmock/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'webmock'
 
 # RSpec 1.x and 2.x compatibility

data/lib/webmock/stub_registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
 
   class StubRegistry

data/lib/webmock/stub_request_snippet.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   class StubRequestSnippet
     def initialize(request_stub)

data/lib/webmock/test_unit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test/unit'
 require 'webmock'
 

data/lib/webmock/util/hash_counter.rb

@@ -1,29 +1,35 @@
+# frozen_string_literal: true
+
 require 'thread'
 
 module WebMock
   module Util
     class HashCounter
       attr_accessor :hash
+
       def initialize
-        self.hash = {}
+        self.hash = Hash.new(0)
         @order = {}
         @max = 0
         @lock = ::Mutex.new
       end
-      def put key, num=1
+
+      def put(key, num=1)
         @lock.synchronize do
-          hash[key] = (hash[key] || 0) + num
-          @order[key] = @max = @max + 1
+          hash[key] += num
+          @order[key] = @max += 1
         end
       end
-      def get key
+
+      def get(key)
         @lock.synchronize do
-          hash[key] || 0
+          hash[key]
         end
       end
 
       def select(&block)
         return unless block_given?
+
         @lock.synchronize do
           hash.select(&block)
         end

data/lib/webmock/util/hash_keys_stringifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   module Util
     class HashKeysStringifier

data/lib/webmock/util/hash_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   class HashValidator
     def initialize(hash)

data/lib/webmock/util/headers.rb

@@ -1,4 +1,4 @@
-require 'base64'
+# frozen_string_literal: true
 
 module WebMock
 
@@ -6,18 +6,21 @@ module WebMock
 
     class Headers
 
+      STANDARD_HEADER_DELIMITER = '-'
+      NONSTANDARD_HEADER_DELIMITER = '_'
+      JOIN = ', '
+
       def self.normalize_headers(headers)
         return nil unless headers
-        array = headers.map { |name, value|
-          [name.to_s.split(/_|-/).map { |segment| segment.capitalize }.join("-"),
-           case value
+
+        headers.each_with_object({}) do |(name, value), new_headers|
+          new_headers[normalize_name(name)] =
+            case value
             when Regexp then value
-            when Array then (value.size == 1) ? value.first.to_s : value.map {|v| v.to_s}.sort
+            when Array then (value.size == 1) ? value.first.to_s : value.map(&:to_s).sort
             else value.to_s
-           end
-          ]
-        }
-        Hash[*array.inject([]) {|r,x| r + x}]
+            end
+        end
       end
 
       def self.sorted_headers_string(headers)
@@ -54,7 +57,17 @@ module WebMock
       end
 
       def self.basic_auth_header(*credentials)
-        "Basic #{Base64.strict_encode64(credentials.join(':')).chomp}"
+        strict_base64_encoded = [credentials.join(':')].pack("m0")
+        "Basic #{strict_base64_encoded.chomp}"
+      end
+
+      def self.normalize_name(name)
+        name
+          .to_s
+          .tr(NONSTANDARD_HEADER_DELIMITER, STANDARD_HEADER_DELIMITER)
+          .split(STANDARD_HEADER_DELIMITER)
+          .map!(&:capitalize)
+          .join(STANDARD_HEADER_DELIMITER)
       end
 
     end

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/util/query_mapper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock::Util
   class QueryMapper
     class << self

data/lib/webmock/util/uri.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
 
   module Util
@@ -68,7 +70,7 @@ module WebMock
 
       def self.is_uri_localhost?(uri)
         uri.is_a?(Addressable::URI) &&
-        %w(localhost 127.0.0.1 0.0.0.0).include?(uri.host)
+        %w(localhost 127.0.0.1 0.0.0.0 [::1]).include?(uri.host)
       end
 
       private

data/lib/webmock/util/values_stringifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class WebMock::Util::ValuesStringifier
   def self.stringify_values(value)
     case value

data/lib/webmock/util/version_checker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This code was created based on https://github.com/myronmarston/vcr/blob/master/lib/vcr/util/version_checker.rb
 # Thanks to @myronmarston
 
@@ -84,12 +86,12 @@ module WebMock
     def compare_version
       case
         when @major < @min_major then :too_low
+        when @major == @min_major && @minor < @min_minor then :too_low
+        when @major == @min_major && @minor == @min_minor && @patch < @min_patch then :too_low
         when @max_major && @major > @max_major then :too_high
-        when @major > @min_major then :ok
-        when @minor < @min_minor then :too_low
-        when @max_minor && @minor > @max_minor then :too_high
-        when @minor > @min_minor then :ok
-        when @patch < @min_patch then :too_low
+        when @max_major && @major == @max_major && @max_minor && @minor > @max_minor then :too_high
+
+        else :ok
       end
     end
 

data/lib/webmock/version.rb

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

data/lib/webmock/webmock.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
 
   def self.included(clazz)
@@ -70,6 +72,16 @@ module WebMock
       Config.instance.allow && net_connect_explicit_allowed?(Config.instance.allow, uri) )
   end
 
+  def self.net_http_connect_on_start?(uri)
+    allowed = Config.instance.net_http_connect_on_start || false
+
+    if [true, false].include?(allowed)
+      allowed
+    else
+      net_connect_explicit_allowed?(allowed, uri)
+    end
+  end
+
   def self.net_connect_explicit_allowed?(allowed, uri=nil)
     case allowed
     when Array

data/lib/webmock.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'singleton'
 
 require 'addressable/uri'
 require 'addressable/template'
-require 'crack/xml'
 
 require_relative 'webmock/deprecation'
 require_relative 'webmock/version'
@@ -15,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'