webmock 3.31.0 → 3.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd3966eb9bb71d2c1ef49c389d9f0a90520cd662cd2a2a10d36568eaadbffa33
-  data.tar.gz: ec1209ad4ec45fce69665fd4e64a1f59743716a043e42b3e63b8bcddced6911a
+  metadata.gz: 41c4be4a917d40c0448cdf920de152862f1ce887e379e49121020d506757c16d
+  data.tar.gz: 71ed3dc5e3df9671c7ce188fa579b86379ab365f95b666c7eeee7bf6851dc836
 SHA512:
-  metadata.gz: 58a66d8ce0f9f893d8862835d28728e585a8ebd2ff074a64b7a88b09508aa2caeb3181e62cfd7adcef7df67da463aa50c1718b6955aa4bf34f42d5fde35a9575
-  data.tar.gz: 3105e385e8f5aa63acf07a874a8d93100f3f8d739aae9d56cfe77e479576afe91541af70aa3a739828c59c170c2adb86335e2ad635b20b1c8941266e28a88202
+  metadata.gz: 79843a07ef28cee5968bf6e3eb4b5eac10f688c3aba9caeb44cd30c74ec28ee8e0129eef69eab8d1a87e3991512b63c96589bbf52aaa912f12217ed86b20b4d2
+  data.tar.gz: '009710347fc3bf01b14ab050ba19c316af32a8a2803b0d40b3388be7ed824a5e6de371a860810df8ebff0de2dd588ad6071c876cf79a029835ccab32c8d48fe4'

data/CHANGELOG.md

@@ -1,5 +1,63 @@
 # Changelog
 
+# 3.33.0
+
+* Return `effective_url` as a String for stubbed Typhoeus responses (#869)
+
+    Previously, this was an `Addressable::URI`. If your code calls methods such as `effective_url.host`, parse the returned string into a URI first.
+
+    The URL keeps the request's port, query order and encoding. It follows curl's formatting: for example, `http://example.com:80` becomes `http://example.com:80/`. Stubbed timeouts now provide an `effective_url` too.
+
+    Thanks to [Tom Brammar](https://github.com/tbrammar)
+
+* Fix incorrect removal of default ports from displayed URLs
+
+    WebMock could accidentally remove `:80` or `:443` from a URL's path or query. For example, an error message could show `/foo/bar` instead of `/foo:80/bar`.
+
+    Only the host's default port is now removed. This also works when the port is immediately followed by a query string, as in `http://example.com:80?a=b`.
+
+* Set `return_code` to `:ok` for completed stubbed Typhoeus requests (#736)
+
+    `return_code` is now `:ok` and `return_message` is now `"No error"`; both were previously `nil`. This includes HTTP error responses such as 404: `:ok` means the transfer completed. Stubbed timeouts still return `:operation_timedout`.
+
+    Thanks to [Michael Spiz](https://github.com/spizm)
+
+* Fix the raw headers returned by stubbed Typhoeus responses
+
+    The `response_headers` string now uses the stubbed HTTP status. For example, a 404 stub no longer reports `HTTP/1.1 200 OK`.
+
+    Stubs without headers now return an empty `headers` hash (`{}`) instead of `nil`. Their `response_headers` contains the status line instead of being `nil`.
+
+    The raw headers use binary string encoding, matching real responses. For timeouts, `response_headers` is now an empty string.
+
+# 3.32.0
+
+* Make a `Net::HTTP` object created while WebMock was enabled behave like any other `Net::HTTP` object after `WebMock.disable!` (#1067)
+
+    Such an object, like a connection cached by net-http-persistent or by Capybara with Selenium, used to raise `ArgumentError` on `start` or a stubbed request, and `WebMock::NetConnectNotAllowedError` on any other request, after WebMock was disabled. It now sends real requests until WebMock is enabled again.
+
+    Thanks to [Mike Taylor](https://github.com/sealabcore) and [James Rodovich](https://github.com/rodovich)
+
+* Connect again when a request is retried on a `Net::HTTP` object that WebMock started without connecting and whose first real connection failed
+
+    Such a retry used to raise `NoMethodError` (undefined method `closed?` for nil). It now tries to connect again, and raises the connection error if that fails too.
+
+* Drop the `Transfer-Encoding` header from stubbed async-http responses, as WebMock already does with `Content-Length` (#1044)
+
+    A stub with a `Transfer-Encoding` header, such as `chunked`, used to fail with "Message contains both transfer encoding and content length". async-http sets both headers itself from the body, and its responses from real servers don't include them either.
+
+    Thanks to [Tim Mertens](https://github.com/tmertens)
+
+* Record requests made with curb's `http_patch` as PATCH requests with their body (#1112)
+
+    curb has `http_patch` since 1.0.8. WebMock recorded such a request as a GET, or as a POST after `post_body=`, so a PATCH stub never matched it.
+
+    Thanks to [Andy Williams](https://github.com/sobakasu)
+
+* Record a curb request sent without a body as having none, even after an earlier `http_post` or `http_patch` call with a body on the same `Curl::Easy` object
+
+    For example, after `c.http_post("a=1")`, `c.reset` and `c.http(:POST)`, the second request was recorded with the body `a=1`, so a stub for that body matched it.
+
 # 3.31.0
 
 * Return the contents of a `File` or `Pathname` body given to `to_return_json`, or returned by its body lambda, instead of encoding the object as a JSON string (#1119)

data/lib/webmock/http_lib_adapters/async_http_client_adapter.rb

@@ -207,6 +207,10 @@ if defined?(Async::HTTP)
       module WebMockApplication
         WEBMOCK_REQUEST_ID_HEADER = 'x-webmock-request-id'.freeze
 
+        # async-http sets these from the body itself. A stub's own values would
+        # conflict, as Transfer-Encoding does with the Content-Length it adds.
+        FRAMING_HEADERS = %w[content-length transfer-encoding].freeze
+
         class << self
           def call(request)
             request.read
@@ -233,8 +237,10 @@ if defined?(Async::HTTP)
 
           def build_response(webmock_response)
             headers = (webmock_response.headers || {}).each_with_object([]) do |(k, value), o|
+              next if FRAMING_HEADERS.include?(k.downcase)
+
               Array(value).each do |v|
-                o.push [k, v] unless k.downcase == 'content-length' # async-http appends the exact content-length automatically
+                o.push [k, v]
               end
             end
 

data/lib/webmock/http_lib_adapters/curb_adapter.rb

@@ -261,6 +261,15 @@ if defined?(Curl)
         end
       end
 
+      # curb has http_patch since 1.0.8.
+      if method_defined?(:http_patch)
+        def http_patch *data
+          @webmock_method = :patch
+          @post_body = data.join('&') unless data.empty?
+          super
+        end
+      end
+
       def http_put data = nil
         @webmock_method = :put
         @put_data = data if data
@@ -270,7 +279,7 @@ if defined?(Curl)
 
       def http_post *data
         @webmock_method = :post
-        @post_body = data.join('&') if data && !data.empty?
+        @post_body = data.join('&') unless data.empty?
         super
       end
       alias post http_post
@@ -280,6 +289,8 @@ if defined?(Curl)
         curb_or_webmock { super }
       ensure
         reset_webmock_method
+        # The body given to http_post or http_patch is for this request only.
+        @post_body = nil
       end
 
       def put_data= data

data/lib/webmock/http_lib_adapters/net_http.rb

@@ -15,7 +15,15 @@ module WebMock
       # This will be removed in Ruby 3.5. In Ruby 3.4, const_remove will warn.
       HAS_LEGACY_CONSTANT = Net.const_defined?(:HTTPSession)
 
+      # Objects created while WebMock was enabled are instances of WebMock's
+      # Net::HTTP class, so they check this to act like Net::HTTP once
+      # WebMock is disabled.
+      def self.enabled?
+        @enabled
+      end
+
       def self.enable!
+        @enabled = true
         Net.send(:remove_const, :HTTP)
         Net.send(:const_set, :HTTP, @webMockNetHTTP)
         if HAS_LEGACY_CONSTANT
@@ -25,6 +33,7 @@ module WebMock
       end
 
       def self.disable!
+        @enabled = false
         Net.send(:remove_const, :HTTP)
         Net.send(:const_set, :HTTP, OriginalNetHTTP)
         if HAS_LEGACY_CONSTANT
@@ -83,12 +92,20 @@ module WebMock
         end
 
         def request(request, body = nil, &block)
+          unless webmock_enabled?
+            # Reconnect for real if started with WebMock's stub socket.
+            ensure_actual_connection if started?
+            return super
+          end
+
           request_signature = WebMock::NetHTTPUtility.request_signature_from_request(self, request, body)
 
           WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
 
           if webmock_response = WebMock::StubRegistry.instance.response_for_request(request_signature)
-            @socket = Net::HTTP.socket_type.new
+            # Close the real connection left by an earlier request, if any.
+            @socket&.close
+            @socket = self.class.socket_type.new
             WebMock::CallbackRegistry.invoke_callbacks(
               {lib: :net_http}, request_signature, webmock_response)
             build_net_http_response(webmock_response, request.uri, &block)
@@ -125,23 +142,22 @@ module WebMock
           raise IOError, 'HTTP session already opened' if @started
           if block_given?
             begin
-              @socket = Net::HTTP.socket_type.new
+              @socket = self.class.socket_type.new
               @started = true
               return yield(self)
             ensure
               do_finish
             end
           end
-          @socket = Net::HTTP.socket_type.new
+          @socket = self.class.socket_type.new
           @started = true
           self
         end
 
-
         def ensure_actual_connection
           if @socket.is_a?(StubSocket)
-            @socket&.close
-            @socket = nil
+            # Keep the closed stub socket, so a failed connect is retried.
+            @socket.close
             do_start
           end
         end
@@ -149,6 +165,8 @@ module WebMock
         alias_method :start_with_connect, :start
 
         def start(&block)
+          return super unless webmock_enabled?
+
           uri = Addressable::URI.parse(WebMock::NetHTTPUtility.get_uri(self))
 
           if WebMock.net_http_connect_on_start?(uri)
@@ -205,6 +223,12 @@ module WebMock
             @@already_checked_for_right_http_connection = true
           end
         end
+
+        private
+
+        def webmock_enabled?
+          WebMock::HttpLibAdapters::NetHttpAdapter.enabled?
+        end
       end
       @webMockNetHTTP.version_1_2
       [

data/lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb

@@ -52,8 +52,8 @@ if defined?(Typhoeus)
           Typhoeus.on_complete.delete_if {|v| v == AFTER_REQUEST_CALLBACK }
         end
 
-        def self.build_request_signature(req)
-          uri = WebMock::Util::URI.heuristic_parse(req.url)
+        def self.build_request_signature(req, url = req.url)
+          uri = WebMock::Util::URI.heuristic_parse(url)
           uri.path = uri.normalized_path.gsub("[^:]//","/")
 
           headers = req.options[:headers]
@@ -89,42 +89,69 @@ if defined?(Typhoeus)
           webmock_response
         end
 
-        def self.generate_typhoeus_response(request_signature, webmock_response)
-          response = if webmock_response.should_timeout
-            ::Typhoeus::Response.new(
+        def self.generate_typhoeus_response(webmock_response, url)
+          response_options = if webmock_response.should_timeout
+            {
               code: 0,
               status_message: "",
               body: "",
               headers: {},
               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
-            )
+              response_headers: ""
+            }
           else
-            ::Typhoeus::Response.new(
+            {
               code: webmock_response.status[0],
               status_message: webmock_response.status[1],
               body: webmock_response.body,
               headers: webmock_response.headers,
-              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
-            )
+              return_code: :ok,
+              response_headers: response_headers_string(webmock_response)
+            }
           end
+          response = ::Typhoeus::Response.new(response_options.merge(
+            effective_url: effective_url(url),
+            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
+          ))
           response.mock = :webmock
           response
         end
 
+        # Without response_headers, Typhoeus builds them for a mocked response
+        # from its return_code, as in "HTTP/1.1 ok Mock Reason Phrase".
+        def self.response_headers_string(webmock_response)
+          code, reason = webmock_response.status
+          lines = ["HTTP/1.1 #{code} #{reason}"]
+          (webmock_response.headers || {}).each do |name, values|
+            Array(values).each { |value| lines << "#{name}: #{value}" }
+          end
+          # Bytes, as in a real response, so values in different encodings join.
+          lines.map(&:b).join("\r\n") + "\r\n\r\n"
+        end
+
+        # The request URL as curl reports it: with its port, query and encoding as
+        # given, but with a lower case scheme, http:// when there is none, dot
+        # segments resolved, "/" for an empty path and no empty query or
+        # fragment. Like curl's, it is a binary string.
+        def self.effective_url(url)
+          # A scheme needs at least one slash after it, so localhost:3000 has
+          # none. heuristic_parse turns http:/ and http:/// into http://.
+          url = "http://#{url}" unless url.match?(%r{\A[a-z][a-z0-9+.\-]*:/}i)
+          uri = WebMock::Util::URI.heuristic_parse(url)
+          uri.scheme = uri.scheme.downcase
+          uri.path = Addressable::URI.normalize_path(uri.path)
+          uri.path = "/" if uri.path.empty?
+          uri.query = nil if uri.query == ""
+          uri.fragment = nil if uri.fragment == ""
+          uri.to_s.b
+        end
+
         def self.request_hash(request_signature)
           hash = {}
 
@@ -160,14 +187,15 @@ if defined?(Typhoeus)
           res = true
 
           unless WebMock::HttpLibAdapters::TyphoeusAdapter.disabled?
-            request_signature = ::WebMock::HttpLibAdapters::TyphoeusAdapter.build_request_signature(request)
+            # Typhoeus builds a curl handle to work out the URL, so do it once.
+            url = request.url
+            request_signature = ::WebMock::HttpLibAdapters::TyphoeusAdapter.build_request_signature(request, url)
             request.block_connection = false;
 
             ::WebMock::RequestRegistry.instance.requested_signatures.put(request_signature)
 
             if webmock_response = ::WebMock::StubRegistry.instance.response_for_request(request_signature)
-              # ::WebMock::HttpLibAdapters::TyphoeusAdapter.stub_typhoeus(request_signature, webmock_response, self)
-              response = ::WebMock::HttpLibAdapters::TyphoeusAdapter.generate_typhoeus_response(request_signature, webmock_response)
+              response = ::WebMock::HttpLibAdapters::TyphoeusAdapter.generate_typhoeus_response(webmock_response, url)
               if request.respond_to?(:on_headers)
                 request.execute_headers_callbacks(response)
               end

data/lib/webmock/util/uri.rb

@@ -58,8 +58,8 @@ module WebMock
 
       def self.strip_default_port_from_uri_string(uri_string)
         case uri_string
-        when %r{^http://}  then uri_string.sub(%r{:80(/|$)}, '\1')
-        when %r{^https://} then uri_string.sub(%r{:443(/|$)}, '\1')
+        when %r{^http://}  then uri_string.sub(%r{\A(http://[^/?#]+):80(?=[/?#]|\z)}, '\1')
+        when %r{^https://} then uri_string.sub(%r{\A(https://[^/?#]+):443(?=[/?#]|\z)}, '\1')
         else uri_string
         end
       end

data/lib/webmock/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webmock
 version: !ruby/object:Gem::Version
-  version: 3.31.0
+  version: 3.33.0
 platform: ruby
 authors:
 - Bartosz Blimke
@@ -360,9 +360,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/bblimke/webmock/issues
-  changelog_uri: https://github.com/bblimke/webmock/blob/v3.31.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/webmock/3.31.0
-  source_code_uri: https://github.com/bblimke/webmock/tree/v3.31.0
+  changelog_uri: https://github.com/bblimke/webmock/blob/v3.33.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/webmock/3.33.0
+  source_code_uri: https://github.com/bblimke/webmock/tree/v3.33.0
   wiki_uri: https://github.com/bblimke/webmock/wiki
 rdoc_options: []
 require_paths: