webmock 3.16.2 → 3.23.0

data/lib/webmock/http_lib_adapters/httpclient_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'httpclient'
   require 'jsonclient' # defined in 'httpclient' gem as well
@@ -43,6 +45,8 @@ if defined?(::HTTPClient)
   end
 
   module WebMockHTTPClients
+    WEBMOCK_HTTPCLIENT_RESPONSES = :webmock_httpclient_responses
+    WEBMOCK_HTTPCLIENT_REQUEST_SIGNATURES = :webmock_httpclient_request_signatures
 
     REQUEST_RESPONSE_LOCK = Mutex.new
 
@@ -55,12 +59,14 @@ if defined?(::HTTPClient)
     end
 
     def do_get(req, proxy, conn, stream = false, &block)
+      clear_thread_variables unless conn.async_thread
+
       request_signature = build_request_signature(req, :reuse_existing)
 
       WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
 
       if webmock_responses[request_signature]
-        webmock_response = synchronize_request_response { webmock_responses.delete(request_signature) }
+        webmock_response = webmock_responses.delete(request_signature)
         response = build_httpclient_response(webmock_response, stream, req.header, &block)
         @request_filter.each do |filter|
           filter.filter_response(req, response)
@@ -71,7 +77,7 @@ if defined?(::HTTPClient)
         res
       elsif WebMock.net_connect_allowed?(request_signature.uri)
         # in case there is a nil entry in the hash...
-        synchronize_request_response { webmock_responses.delete(request_signature) }
+        webmock_responses.delete(request_signature)
 
         res = if stream
           do_get_stream_without_webmock(req, proxy, conn, &block)
@@ -101,12 +107,16 @@ if defined?(::HTTPClient)
     end
 
     def do_request_async(method, uri, query, body, extheader)
+      clear_thread_variables
       req = create_request(method, uri, query, body, extheader)
       request_signature = build_request_signature(req)
-      synchronize_request_response { webmock_request_signatures << request_signature }
+      webmock_request_signatures << request_signature
 
       if webmock_responses[request_signature] || WebMock.net_connect_allowed?(request_signature.uri)
-        super
+        conn = super
+        conn.async_thread[WEBMOCK_HTTPCLIENT_REQUEST_SIGNATURES] = Thread.current[WEBMOCK_HTTPCLIENT_REQUEST_SIGNATURES]
+        conn.async_thread[WEBMOCK_HTTPCLIENT_RESPONSES] = Thread.current[WEBMOCK_HTTPCLIENT_RESPONSES]
+        conn
       else
         raise WebMock::NetConnectNotAllowedError.new(request_signature)
       end
@@ -155,14 +165,14 @@ if defined?(::HTTPClient)
     end
 
     def build_request_signature(req, reuse_existing = false)
-      uri = WebMock::Util::URI.heuristic_parse(req.header.request_uri.to_s)
-      uri.query = WebMock::Util::QueryMapper.values_to_query(req.header.request_query, notation: WebMock::Config.instance.query_values_notation) if req.header.request_query
-      uri.port = req.header.request_uri.port
-
       @request_filter.each do |filter|
         filter.filter_request(req)
       end
 
+      uri = WebMock::Util::URI.heuristic_parse(req.header.request_uri.to_s)
+      uri.query = WebMock::Util::QueryMapper.values_to_query(req.header.request_query, notation: WebMock::Config.instance.query_values_notation) if req.header.request_query
+      uri.port = req.header.request_uri.port
+
       headers = req.header.all.inject({}) do |hdrs, header|
         hdrs[header[0]] ||= []
         hdrs[header[0]] << header[1]
@@ -186,22 +196,18 @@ if defined?(::HTTPClient)
     end
 
     def webmock_responses
-      @webmock_responses ||= Hash.new do |hash, request_signature|
-        synchronize_request_response do
-          hash[request_signature] = WebMock::StubRegistry.instance.response_for_request(request_signature)
-        end
+      Thread.current[WEBMOCK_HTTPCLIENT_RESPONSES] ||= Hash.new do |hash, request_signature|
+        hash[request_signature] = WebMock::StubRegistry.instance.response_for_request(request_signature)
       end
     end
 
     def webmock_request_signatures
-      @webmock_request_signatures ||= []
+      Thread.current[WEBMOCK_HTTPCLIENT_REQUEST_SIGNATURES] ||= []
     end
 
     def previous_signature_for(signature)
-      synchronize_request_response do
-        return nil unless index = webmock_request_signatures.index(signature)
-        webmock_request_signatures.delete_at(index)
-      end
+      return nil unless index = webmock_request_signatures.index(signature)
+      webmock_request_signatures.delete_at(index)
     end
 
     private
@@ -217,14 +223,9 @@ if defined?(::HTTPClient)
       end
     end
 
-    def synchronize_request_response
-      if REQUEST_RESPONSE_LOCK.owned?
-        yield
-      else
-        REQUEST_RESPONSE_LOCK.synchronize do
-          yield
-        end
-      end
+    def clear_thread_variables
+      Thread.current[WEBMOCK_HTTPCLIENT_REQUEST_SIGNATURES] = nil
+      Thread.current[WEBMOCK_HTTPCLIENT_RESPONSES] = nil
     end
   end
 

data/lib/webmock/http_lib_adapters/manticore_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'manticore'
 rescue LoadError

data/lib/webmock/http_lib_adapters/net_http.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'net/https'
 require 'stringio'
@@ -10,24 +12,19 @@ module WebMock
       adapter_for :net_http
 
       OriginalNetHTTP = Net::HTTP unless const_defined?(:OriginalNetHTTP)
-      OriginalNetBufferedIO = Net::BufferedIO unless const_defined?(:OriginalNetBufferedIO)
 
       def self.enable!
-        Net.send(:remove_const, :BufferedIO)
         Net.send(:remove_const, :HTTP)
         Net.send(:remove_const, :HTTPSession)
         Net.send(:const_set, :HTTP, @webMockNetHTTP)
         Net.send(:const_set, :HTTPSession, @webMockNetHTTP)
-        Net.send(:const_set, :BufferedIO, Net::WebMockNetBufferedIO)
       end
 
       def self.disable!
-        Net.send(:remove_const, :BufferedIO)
         Net.send(:remove_const, :HTTP)
         Net.send(:remove_const, :HTTPSession)
         Net.send(:const_set, :HTTP, OriginalNetHTTP)
         Net.send(:const_set, :HTTPSession, OriginalNetHTTP)
-        Net.send(:const_set, :BufferedIO, OriginalNetBufferedIO)
 
         #copy all constants from @webMockNetHTTP to original Net::HTTP
         #in case any constants were added to @webMockNetHTTP instead of Net::HTTP
@@ -80,7 +77,7 @@ module WebMock
             @socket = Net::HTTP.socket_type.new
             WebMock::CallbackRegistry.invoke_callbacks(
               {lib: :net_http}, request_signature, webmock_response)
-            build_net_http_response(webmock_response, &block)
+            build_net_http_response(webmock_response, request.uri, &block)
           elsif WebMock.net_connect_allowed?(request_signature.uri)
             check_right_http_connection
             after_request = lambda do |response|
@@ -128,7 +125,11 @@ module WebMock
 
 
         def ensure_actual_connection
-          do_start if @socket.is_a?(StubSocket)
+          if @socket.is_a?(StubSocket)
+            @socket&.close
+            @socket = nil
+            do_start
+          end
         end
 
         alias_method :start_with_connect, :start
@@ -143,7 +144,7 @@ module WebMock
           end
         end
 
-        def build_net_http_response(webmock_response, &block)
+        def build_net_http_response(webmock_response, request_uri, &block)
           response = Net::HTTPResponse.send(:response_class, webmock_response.status[0].to_s).new("1.0", webmock_response.status[0].to_s, webmock_response.status[1])
           body = webmock_response.body
           body = nil if webmock_response.status[0].to_s == '204'
@@ -158,10 +159,12 @@ module WebMock
 
           response.instance_variable_set(:@read, true)
 
+          response.uri = request_uri
+
           response.extend Net::WebMockHTTPResponse
 
           if webmock_response.should_timeout
-            raise timeout_exception, "execution expired"
+            raise Net::OpenTimeout, "execution expired"
           end
 
           webmock_response.raise_error_if_any
@@ -171,16 +174,6 @@ module WebMock
           response
         end
 
-        def timeout_exception
-          if defined?(Net::OpenTimeout)
-            # Ruby 2.x
-            Net::OpenTimeout
-          else
-            # Fallback, if things change
-            Timeout::Error
-          end
-        end
-
         def build_webmock_response(net_http_response)
           webmock_response = WebMock::Response.new
           webmock_response.status = [
@@ -214,31 +207,21 @@ module WebMock
   end
 end
 
-# patch for StringIO behavior in Ruby 2.2.3
-# https://github.com/bblimke/webmock/issues/558
-class PatchedStringIO < StringIO #:nodoc:
-
-  alias_method :orig_read_nonblock, :read_nonblock
-
-  def read_nonblock(size, *args, **kwargs)
-    args.reject! {|arg| !arg.is_a?(Hash)}
-    orig_read_nonblock(size, *args, **kwargs)
-  end
-
-end
-
 class StubSocket #:nodoc:
 
   attr_accessor :read_timeout, :continue_timeout, :write_timeout
 
   def initialize(*args)
+    @closed = false
   end
 
   def closed?
-    @closed ||= true
+    @closed
   end
 
   def close
+    @closed = true
+    nil
   end
 
   def readuntil(*args)
@@ -251,57 +234,12 @@ class StubSocket #:nodoc:
   class StubIO
     def setsockopt(*args); end
     def peer_cert; end
+    def peeraddr; ["AF_INET", 443, "127.0.0.1", "127.0.0.1"] end
+    def ssl_version; "TLSv1.3" end
+    def cipher; ["TLS_AES_128_GCM_SHA256", "TLSv1.3", 128, 128] end
   end
 end
 
-module Net  #:nodoc: all
-
-  class WebMockNetBufferedIO < BufferedIO
-    def initialize(io, *args, **kwargs)
-      io = case io
-      when Socket, OpenSSL::SSL::SSLSocket, IO
-        io
-      when StringIO
-        PatchedStringIO.new(io.string)
-      when String
-        PatchedStringIO.new(io)
-      end
-      raise "Unable to create local socket" unless io
-
-      # Prior to 2.4.0 `BufferedIO` only takes a single argument (`io`) with no
-      # options. Here we pass through our full set of arguments only if we're
-      # on 2.4.0 or later, and use a simplified invocation otherwise.
-      if RUBY_VERSION >= '2.4.0'
-        super
-      else
-        super(io)
-      end
-    end
-
-    if RUBY_VERSION >= '2.6.0'
-      # https://github.com/ruby/ruby/blob/7d02441f0d6e5c9d0a73a024519eba4f69e36dce/lib/net/protocol.rb#L208
-      # Modified version of method from ruby, so that nil is always passed into orig_read_nonblock to avoid timeout
-      def rbuf_fill
-        case rv = @io.read_nonblock(BUFSIZE, nil, exception: false)
-        when String
-          return if rv.nil?
-          @rbuf << rv
-          rv.clear
-          return
-        when :wait_readable
-          @io.to_io.wait_readable(@read_timeout) or raise Net::ReadTimeout
-        when :wait_writable
-          @io.to_io.wait_writable(@read_timeout) or raise Net::ReadTimeout
-        when nil
-          raise EOFError, 'end of file reached'
-        end while true
-      end
-    end
-  end
-
-end
-
-
 module WebMock
   module NetHTTPUtility
 
@@ -318,7 +256,6 @@ module WebMock
       method = request.method.downcase.to_sym
 
       headers = Hash[*request.to_hash.map {|k,v| [k, v]}.inject([]) {|r,x| r + x}]
-      validate_headers(headers)
 
       if request.body_stream
         body = request.body_stream.read
@@ -343,25 +280,6 @@ module WebMock
       "#{protocol}://#{hostname}:#{net_http.port}#{path}"
     end
 
-    def self.validate_headers(headers)
-      # For Ruby versions < 2.3.0, if you make a request with headers that are symbols
-      # Net::HTTP raises a NoMethodError
-      #
-      # WebMock normalizes headers when creating a RequestSignature,
-      # and will update all headers from symbols to strings.
-      #
-      # This could create a false positive in a test suite with WebMock.
-      #
-      # So before this point, WebMock raises an ArgumentError if any of the headers are symbols
-      # instead of the cryptic NoMethodError "undefined method `split' ...` from Net::HTTP
-      if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.3.0')
-        header_as_symbol = headers.keys.find {|header| header.is_a? Symbol}
-        if header_as_symbol
-          raise ArgumentError.new("Net:HTTP does not accept headers as symbols")
-        end
-      end
-    end
-
     def self.check_right_http_connection
       @was_right_http_connection_loaded = defined?(RightHttpConnection)
     end

data/lib/webmock/http_lib_adapters/net_http_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This code is entierly copied from VCR (http://github.com/myronmarston/vcr) by courtesy of Myron Marston
 
 # A Net::HTTP response that has already been read raises an IOError when #read_body

data/lib/webmock/http_lib_adapters/patron_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'patron'
 rescue LoadError

data/lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'typhoeus'
 rescue LoadError
@@ -94,7 +96,14 @@ if defined?(Typhoeus)
               status_message: "",
               body: "",
               headers: {},
-              return_code: :operation_timedout
+              return_code: :operation_timedout,
+              total_time: 0.0,
+              starttransfer_time: 0.0,
+              appconnect_time: 0.0,
+              pretransfer_time: 0.0,
+              connect_time: 0.0,
+              namelookup_time: 0.0,
+              redirect_time: 0.0
             )
           else
             ::Typhoeus::Response.new(
@@ -102,7 +111,14 @@ if defined?(Typhoeus)
               status_message: webmock_response.status[1],
               body: webmock_response.body,
               headers: webmock_response.headers,
-              effective_url: request_signature.uri
+              effective_url: request_signature.uri,
+              total_time: 0.0,
+              starttransfer_time: 0.0,
+              appconnect_time: 0.0,
+              pretransfer_time: 0.0,
+              connect_time: 0.0,
+              namelookup_time: 0.0,
+              redirect_time: 0.0
             )
           end
           response.mock = :webmock

data/lib/webmock/matchers/any_arg_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   module Matchers
     # this is a based on RSpec::Mocks::ArgumentMatchers::AnyArgMatcher

data/lib/webmock/matchers/hash_argument_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   module Matchers
     # Base class for Hash matchers

data/lib/webmock/matchers/hash_excluding_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   module Matchers
     # this is a based on RSpec::Mocks::ArgumentMatchers::HashExcludingMatcher

data/lib/webmock/matchers/hash_including_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   module Matchers
     # this is a based on RSpec::Mocks::ArgumentMatchers::HashIncludingMatcher

data/lib/webmock/minitest.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'minitest/test'
   test_class = Minitest::Test

data/lib/webmock/rack_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   class RackResponse < Response
     def initialize(app)
@@ -45,7 +47,9 @@ module WebMock
       # Rack-specific variables
       env['rack.input']      = StringIO.new(body)
       env['rack.errors']     = $stderr
-      env['rack.version']    = Rack::VERSION
+      if !Rack.const_defined?(:RELEASE) || Rack::RELEASE < "3"
+        env['rack.version']    = Rack::VERSION
+      end
       env['rack.url_scheme'] = uri.scheme
       env['rack.run_once']   = true
       env['rack.session']    = session

data/lib/webmock/request_body_diff.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "hashdiff"
 require "json"
 

data/lib/webmock/request_execution_verifier.rb

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

data/lib/webmock/request_pattern.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
 
   module RSpecMatcherDetector
@@ -281,7 +283,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) ||
@@ -344,19 +348,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.fetch('Content-Type', "").start_with?('application/x-www-form-urlencoded'))
+      !!(headers&.fetch('Content-Type', nil)&.start_with?('application/x-www-form-urlencoded'))
     end
 
     def json_headers?
-      !!(headers && headers.fetch('Content-Type', "").start_with?('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
 
@@ -29,9 +31,26 @@ module WebMock
 
       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: body.is_a?(Hash) ? body.to_json : body
+          body: json_body
         )
       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