webmock 3.22.0 → 3.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecff3692887f15d1f0e2e19df92093a40d4f6e5f7e4686d7e18ee4efaadf190f
-  data.tar.gz: 6cf4e165350b7878223e28687db13d57df6fe07d90f50a087527d5d001b305e6
+  metadata.gz: 8a2d1add2b84d303329a722f0c7e9643f237949d0dc471ea1678021324cd41b4
+  data.tar.gz: e00640f1b7664959922011ae2f7b922811d94be4fb1bea90a988f3cca83486bc
 SHA512:
-  metadata.gz: 566cf68fd9c0ee2de8c5e54693e0caa2b956c537f9b82362b7eb7547214349b7966029d6cf12dcac0ca930b0b0f9ad2c32c7dace3a2bd84d43eecd488b194144
-  data.tar.gz: a69faa775b378ee5108525cd431ab9bf242ac93afeb5fc351a7549aa852099fc9c84ceef4a6dccf265e7e27ed5e0894937a1abbc4fa9a641d9fb9c51c0e8ff90
+  metadata.gz: 87f797196dedde96873a3740234d33f799745df144953ccfc36403ca6fbe4bd239f5f05818eb7cec25730823c2f99f83a1f42b79cf977b5672d720ed02bb3495
+  data.tar.gz: af708a4202382fb1a55c90a7f2c14b1a9d9b277bc8c4ee898dd31b712162bee4e9fb1fb6dd2931c1e39123eee8f15545db9fcd198ea5751f746be7eabfad33eb

data/CHANGELOG.md

@@ -1,10 +1,15 @@
 # Changelog
 
+# 3.23.0
+
+ * Fixed HTTP.rb adapter to support streaming real responses when WebMock is enabled.
+
+    Thanks to [Viacheslav Nepomniashchikh](https://github.com/aka-nez) for reporting and investigating this [issue](https://github.com/bblimke/webmock/issues/1017).
+
 # 3.22.0
 
   * Addressed an issue in the HTTPClient adapter where memoized stubbed responses and memoized request_signatures were incorrectly persisted between subsequent requests ([#1019](https://github.com/bblimke/webmock/issues/1019)). The implementation of a more robust thread-safety solution by [Tom Beauvais](https://github.com/tbeauvais) in [PR #300](https://github.com/bblimke/webmock/pull/300) not only resolved the memoization problem but also enhanced the overall thread safety of the adapter. This update ensures that stubbed responses and request signatures are correctly isolated to individual requests, improving both consistency and thread safety.
 
-
 # 3.21.2
 
   * Corrected type checking in `WebMock::Response#assert_valid_body!` to accurately recognize `Hash` objects. Additionally, improved the clarity of the error message for unsupported body types, guiding users towards proper usage.

data/README.md

@@ -1,7 +1,7 @@
 WebMock
 =======
 [![Gem Version](https://badge.fury.io/rb/webmock.svg)](http://badge.fury.io/rb/webmock)
-[![Build Status](https://github.com/bblimke/webmock/workflows/CI/badge.svg?branch=master)](https://github.com/bblimke/webmock/actions)
+[![Build Status](https://github.com/bblimke/webmock/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/bblimke/webmock/actions)
 [![Code Climate](https://codeclimate.com/github/bblimke/webmock/badges/gpa.svg)](https://codeclimate.com/github/bblimke/webmock)
 [![Mentioned in Awesome Ruby](https://awesome.re/mentioned-badge.svg)](https://github.com/markets/awesome-ruby)
 

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

@@ -6,9 +6,19 @@ module HTTP
       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
 
@@ -21,16 +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),
-            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"
 
@@ -54,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
@@ -65,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_adapter.rb

@@ -31,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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webmock
 version: !ruby/object:Gem::Version
-  version: 3.22.0
+  version: 3.23.0
 platform: ruby
 authors:
 - Bartosz Blimke
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-21 00:00:00.000000000 Z
+date: 2024-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -371,9 +371,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/bblimke/webmock/issues
-  changelog_uri: https://github.com/bblimke/webmock/blob/v3.22.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/webmock/3.22.0
-  source_code_uri: https://github.com/bblimke/webmock/tree/v3.22.0
+  changelog_uri: https://github.com/bblimke/webmock/blob/v3.23.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/webmock/3.23.0
+  source_code_uri: https://github.com/bblimke/webmock/tree/v3.23.0
   wiki_uri: https://github.com/bblimke/webmock/wiki
 post_install_message:
 rdoc_options: []