webmock 3.14.0 → 3.24.0

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

@@ -1,12 +1,24 @@
+# frozen_string_literal: true
+
 module HTTP
   class Response
     def to_webmock
       webmock_response = ::WebMock::Response.new
 
       webmock_response.status  = [status.to_i, reason]
+
       webmock_response.body    = body.to_s
-      webmock_response.headers = headers.to_h
+      # This call is used to reset the body of the response to enable it to be streamed if necessary.
+      # The `body.to_s` call above reads the body, which allows WebMock to trigger any registered callbacks.
+      # However, once the body is read to_s, it cannot be streamed again and attempting to do so
+      # will raise a "HTTP::StateError: body has already been consumed" error.
+      # To avoid this error, we replace the original body with a new one.
+      # The new body has its @stream attribute set to new Streamer, instead of the original Connection.
+      # Unfortunately, it's not possible to reset the original body to its initial streaming state.
+      # Therefore, this replacement is the best workaround currently available.
+      reset_body_to_allow_it_to_be_streamed!(webmock_response)
 
+      webmock_response.headers = headers.to_h
       webmock_response
     end
 
@@ -19,13 +31,7 @@ module HTTP
         # HTTP.rb 3.0+ uses a keyword argument to pass the encoding, but 1.x
         # and 2.x use a positional argument, and 0.x don't support supplying
         # the encoding.
-        body = if HTTP::VERSION < "1.0.0"
-          Body.new(Streamer.new(webmock_response.body))
-        elsif HTTP::VERSION < "3.0.0"
-          Body.new(Streamer.new(webmock_response.body), webmock_response.body.encoding)
-        else
-          Body.new(Streamer.new(webmock_response.body), encoding: webmock_response.body.encoding)
-        end
+        body = build_http_rb_response_body_from_webmock_response(webmock_response)
 
         return new(status, "1.1", headers, body, uri) if HTTP::VERSION < "1.0.0"
 
@@ -49,7 +55,18 @@ module HTTP
         })
       end
 
-      private
+      def build_http_rb_response_body_from_webmock_response(webmock_response)
+        if HTTP::VERSION < "1.0.0"
+          Body.new(Streamer.new(webmock_response.body))
+        elsif HTTP::VERSION < "3.0.0"
+          Body.new(Streamer.new(webmock_response.body), webmock_response.body.encoding)
+        else
+          Body.new(
+            Streamer.new(webmock_response.body, encoding: webmock_response.body.encoding),
+            encoding: webmock_response.body.encoding
+          )
+        end
+      end
 
       def normalize_uri(uri)
         return unless uri
@@ -60,5 +77,11 @@ module HTTP
         uri
       end
     end
+
+    private
+
+    def reset_body_to_allow_it_to_be_streamed!(webmock_response)
+      @body = self.class.build_http_rb_response_body_from_webmock_response(webmock_response)
+    end
   end
 end

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

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module HTTP
   class Response
     class Streamer
-      def initialize(str)
+      def initialize(str, encoding: Encoding::BINARY)
         @io = StringIO.new str
+        @encoding = encoding
       end
 
       def readpartial(size = nil, outbuf = nil)
@@ -14,13 +17,18 @@ module HTTP
           end
         end
 
-        @io.read size, outbuf
+        chunk = @io.read size, outbuf
+        chunk.force_encoding(@encoding) if chunk
       end
 
       def close
         @io.close
       end
 
+      def finished_request?
+        @io.eof?
+      end
+
       def sequence_id
         -1
       end

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

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module HTTP
   class WebMockPerform
-    def initialize(request, &perform)
+    def initialize(request, options, &perform)
       @request = request
+      @options = options
       @perform = perform
       @request_signature = nil
     end
@@ -38,7 +41,10 @@ module HTTP
       webmock_response.raise_error_if_any
 
       invoke_callbacks(webmock_response, real_request: false)
-      ::HTTP::Response.from_webmock @request, webmock_response, request_signature
+      response = ::HTTP::Response.from_webmock @request, webmock_response, request_signature
+
+      @options.features.each { |_name, feature| response = feature.wrap_response(response) }
+      response
     end
 
     def raise_timeout_error

data/lib/webmock/http_lib_adapters/http_rb_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require "http"
 rescue LoadError
@@ -29,9 +31,9 @@ if defined?(HTTP) && defined?(HTTP::VERSION)
     end
   end
 
-  require "webmock/http_lib_adapters/http_rb/client"
-  require "webmock/http_lib_adapters/http_rb/request"
-  require "webmock/http_lib_adapters/http_rb/response"
-  require "webmock/http_lib_adapters/http_rb/streamer"
-  require "webmock/http_lib_adapters/http_rb/webmock"
+  require_relative "http_rb/client"
+  require_relative "http_rb/request"
+  require_relative "http_rb/response"
+  require_relative "http_rb/streamer"
+  require_relative "http_rb/webmock"
 end

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|
@@ -98,13 +95,8 @@ module WebMock
               after_request.call(response)
             }
             if started?
-              if WebMock::Config.instance.net_http_connect_on_start
-                super_with_after_request.call
-              else
-                start_with_connect_without_finish {
-                  super_with_after_request.call
-                }
-              end
+              ensure_actual_connection
+              super_with_after_request.call
             else
               start_with_connect {
                 super_with_after_request.call
@@ -119,39 +111,40 @@ module WebMock
           raise IOError, 'HTTP session already opened' if @started
           if block_given?
             begin
+              @socket = Net::HTTP.socket_type.new
               @started = true
               return yield(self)
             ensure
               do_finish
             end
           end
+          @socket = Net::HTTP.socket_type.new
           @started = true
           self
         end
 
 
-        def start_with_connect_without_finish  # :yield: http
-          if block_given?
-            begin
-              do_start
-              return yield(self)
-            end
+        def ensure_actual_connection
+          if @socket.is_a?(StubSocket)
+            @socket&.close
+            @socket = nil
+            do_start
           end
-          do_start
-          self
         end
 
         alias_method :start_with_connect, :start
 
         def start(&block)
-          if WebMock::Config.instance.net_http_connect_on_start
+          uri = Addressable::URI.parse(WebMock::NetHTTPUtility.get_uri(self))
+
+          if WebMock.net_http_connect_on_start?(uri)
             super(&block)
           else
             start_without_connect(&block)
           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'
@@ -166,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
@@ -179,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 = [
@@ -222,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)
@@ -258,57 +233,13 @@ 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
 
@@ -325,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
@@ -341,7 +271,7 @@ module WebMock
       WebMock::RequestSignature.new(method, uri, body: request.body, headers: headers)
     end
 
-    def self.get_uri(net_http, path)
+    def self.get_uri(net_http, path = nil)
       protocol = net_http.use_ssl? ? "https" : "http"
 
       hostname = net_http.address
@@ -350,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,10 +1,12 @@
+# frozen_string_literal: true
+
 begin
   require 'patron'
 rescue LoadError
   # patron not found
 end
 
-if defined?(::Patron)
+if defined?(::Patron::Session)
   module WebMock
     module HttpLibAdapters
       class PatronAdapter < ::WebMock::HttpLibAdapter

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