webmock 3.16.2 → 3.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 438dab0f90920381d01009b8c75892ac83e46043e170c17e1dba5e46ca755c61
-  data.tar.gz: a760f4b2399f465c62cf03268c13a7ae973900945ed0c4631e146c44f688a97d
+  metadata.gz: 8a2d1add2b84d303329a722f0c7e9643f237949d0dc471ea1678021324cd41b4
+  data.tar.gz: e00640f1b7664959922011ae2f7b922811d94be4fb1bea90a988f3cca83486bc
 SHA512:
-  metadata.gz: c8033597431b3e8ce43e60837d31f18d1ffa52c35079827e122a4616587f29b480b2340786c841bbe9f6b9390c5df08e9b84e933160412c8dc1d5c8a9b214f8b
-  data.tar.gz: e0580a7b6b712073edf7d6c38fbf7b6df00a294aa9910f1de0e2de61535de67d07315b5d10f141d7e3387bf91aaee7ce6bb204d40190b5357b2120dc0d7d4427
+  metadata.gz: 87f797196dedde96873a3740234d33f799745df144953ccfc36403ca6fbe4bd239f5f05818eb7cec25730823c2f99f83a1f42b79cf977b5672d720ed02bb3495
+  data.tar.gz: af708a4202382fb1a55c90a7f2c14b1a9d9b277bc8c4ee898dd31b712162bee4e9fb1fb6dd2931c1e39123eee8f15545db9fcd198ea5751f746be7eabfad33eb

data/CHANGELOG.md

@@ -1,14 +1,148 @@
 # Changelog
 
-# 3.16.2
+# 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.
+
+    Thanks to [Jake Robb](https://github.com/jakerobb) for reporting.
+
+# 3.21.1
+
+  * The stubbed Net::HTTPResponse#uri now returns request.uri, aligning it with the behavior of an actual Net::HTTPResponse.
+
+    Thanks to [Abe Voelker](https://github.com/abevoelker) for reporting and to [Victor Maslov](https://github.com/Nakilon) and [Gio Lodi](https://github.com/mokagio) for the suggested solution.
+
+# 3.21.0
+
+  * Don't use deprecated Rack::VERSION for Rack >= 3
+
+    Thanks to [Étienne Barrié](https://github.com/etiennebarrie)
+
+  * Updated HTTPClient adapter, to build request signature using the URI after filters have been applied.
+
+    Thanks to [Matt Brown](https://github.com/mattbnz)
+
+# 3.20.0
+
+  * Optimised EmHttpRequestAdapter performance.
+
+    Thanks to [Ricardo Trindade](https://github.com/RicardoTrindade)
+
+  * Removed runtime dependency on base64.
+
+    Thanks to [Earlopain](https://github.com/Earlopain)
+
+  * Typhoeus::Response objects constructed from stubbed responses now have all timing attributes set to 0.0.
+
+    Thanks to [James Brown](https://github.com/Roguelazer)
+
+  * Optimised WebMock::Util::Headers by removing redundant freeze invocations.
+
+    Thanks to [Kazuhiro NISHIYAMA](https://github.com/znz)
+
+  * The default stubbed response body, which is an empty String, is unfrozen.
+
+  * When building signatures of requests made by http.rb, the request body encoding is now preserved.
+
+# 3.19.1
+
+  * When passing a Proc or lambda as response body to `to_return_json`, the body is evaluated at the time of request and not at the time of `to_return_json` method invocation.
+
+      Thanks to [Jason Karns](https://github.com/jasonkarns) for reporting.
+
+# 3.19.0
+
+  * Do not alter real (non-stubbed) request headers when handling em-http-request requests.
+
+      Thanks to [Yoann Lecuyer](https://github.com/ylecuyer)
+
+  * Fix matching stubs with HashExcludingMatcher
+
+      Thanks to [Lucas Arnaud](https://github.com/lucasarnaud)
+
+  * Remove development and test files from the gem package
+
+      Thanks to [Orien Madgwick](https://github.com/orien)
 
-  * Minimum required Ruby version is 2.0 again.
+  * Fix supported http client gem version checks.
 
-# 3.16.1
+      Thanks to [Marc Rohloff](https://github.com/marcrohloff) and [Roman Stražanec](https://github.com/romanstrazanec)
+
+  * Non-string body passed to #to_return_json is now converted to JSON string.
+
+      Thanks to [inkstak](https://github.com/inkstak)
+
+  * `[::1]` is recognised as localhost e.g when passing `allow_localhost` option to `disable_net_connect!`
+
+      Thanks to [Yuki Inoue](https://github.com/Yuki-Inoue)
+
+  * Optimized `normalize_headers` for performance
+
+      Thanks to [Brandon Weaver](https://github.com/baweaver)
+
+  * Added Frozen string literal to files to optimise memory usage
+
+      Thanks to [Josh Nichols](https://github.com/technicalpickles)
+
+# 3.18.1
+
+  * Reverted simplified connection handing in Net::HTTP adapter due to https://github.com/bblimke/webmock/issues/999
+
+# 3.18.0
+
+  * Net::BufferedIO is not replaced anymore.
+
+    Thanks to [Ray Zane](https://github.com/rzane)
+
+  * Simplified connection handing in Net::HTTP adapter.
+
+    Thanks to [Ray Zane](https://github.com/rzane)
+
+# 3.17.1
+
+  * Fixed Syntax Error
+
+    Thanks to [Mark Spangler](https://github.com/mspangler)
+
+# 3.17.0
 
   * Minimum required Ruby version is 2.3
 
-# 3.16.0
+    Thanks to [Go Sueyoshi](https://github.com/sue445)
+
+  * When using Net::HTTP, stubbed socket StubSocket#close and StubSocket#closed? behave more like the real sockets.
+
+    Thanks to [Ray Zane](https://github.com/rzane)
+
+  * Added `peeraddr`, `ssl_version` and `cipher` methods to stubbed sockets used by Net::HTTP.
+
+    Thanks to [Ray Zane](https://github.com/rzane)
+
+  * Added support for matching top-level array in JSON request body.
+
+    E.g.
+
+      ````
+      stub_request(:post, 'www.example.com').with(body: [{a: 1}])
+      ````
+
+    Thanks to [Cedric Sohrauer](https://github.com/cedrics)
+
+# 3.16.2
+
+  * Minimum required Ruby version is 2.0.
+
+# 3.16.0 (yanked)
 
   * Fix leaky file descriptors and reuse socket for persistent connections.
 
@@ -18,7 +152,11 @@
 
     Thanks to [Ray Zane](https://github.com/rzane)
 
-# 3.15.0
+# 3.15.2
+
+  * Minimum required Ruby version is 2.0.
+
+# 3.15.0 (yanked)
 
   * fixed async-http adapter on Windows
 
@@ -72,7 +210,7 @@
 
   * Fixed async-http adapter to only considered requests as real if they are real.
 
-    Thanks to Thanks to [Tony Schneider](https://github.com/tonywok) and [Samuel Williams](https://github.com/ioquatix)
+    Thanks to [Tony Schneider](https://github.com/tonywok) and [Samuel Williams](https://github.com/ioquatix)
 
 # 3.11.2
 

data/README.md

@@ -1,11 +1,9 @@
 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)
-[![Inline docs](http://inch-ci.org/github/bblimke/webmock.svg?branch=master)](http://inch-ci.org/github/bblimke/webmock)
-[![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=webmock&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=webmock&package-manager=bundler&version-scheme=semver)
 
 Library for stubbing and setting expectations on HTTP requests in Ruby.
 
@@ -40,32 +38,34 @@ Supported HTTP libraries
 
 Supported Ruby Interpreters
 ---------------------------
-
-* MRI 2.5
 * MRI 2.6
 * MRI 2.7
+* MRI 3.0
+* MRI 3.1
+* MRI 3.2
 * JRuby
-* Rubinius
 
 ## Installation
 
 ```bash
-    gem install webmock
+gem install webmock
 ```
 or alternatively:
 
 ```ruby
-    # add to your Gemfile
-    group :test do
-        gem "webmock"
-    end
+# add to your Gemfile
+group :test do
+  gem "webmock"
+end
 ```
 
 ### or to install the latest development version from github master
 
-    git clone http://github.com/bblimke/webmock.git
-    cd webmock
-    rake install
+```bash
+git clone http://github.com/bblimke/webmock.git
+cd webmock
+rake install
+```
 
 ## Upgrading from v1.x to v2.x
 
@@ -330,6 +330,16 @@ stub_request(:any, "www.example.com").
 Net::HTTP.get('www.example.com', '/')    # ===> "abc\n"
 ```
 
+### Response with JSON body
+
+```ruby
+
+stub_request(:any, "www.example.com").
+  to_return_json(body: {foo: "bar"})
+
+Net::HTTP.get('www.example.com', '/') # ===> "{\"foo\": \"bar\"}"
+```
+
 ### Response with custom status message
 
 ```ruby
@@ -383,7 +393,8 @@ RestClient.post('www.example.net', 'abc')    # ===> "abc\n"
 
 ### Dynamically evaluated raw responses recorded with `curl -is`
 
-    `curl -is www.example.com > /tmp/www.example.com.txt`
+`curl -is www.example.com > /tmp/www.example.com.txt`
+
 ```ruby
 stub_request(:get, "www.example.com").
   to_return(lambda { |request| File.new("/tmp/#{request.uri.host.to_s}.txt") })
@@ -540,7 +551,7 @@ RestClient.get('www.example.org:8080', '/') # ===> Allowed
 With a `Regexp` matching the URI:
 
 ```ruby
-WebMock.disable_net_connect!(allow: %r{ample.org/foo})
+WebMock.disable_net_connect!(allow: %r{ample\.org/foo})
 
 RestClient.get('www.example.org', '/foo/bar') # ===> Allowed
 RestClient.get('sample.org', '/foo')          # ===> Allowed
@@ -595,7 +606,11 @@ which can be passed to `WebMock.allow_net_connect!` and `WebMock.disable_net_con
 WebMock.allow_net_connect!(net_http_connect_on_start: true)
 ```
 
-This forces WebMock Net::HTTP adapter to always connect on `Net::HTTP.start`.
+This forces WebMock Net::HTTP adapter to always connect on `Net::HTTP.start`. At the time of connection being made there is no information about the request or URL yet, therefore WebMock is not able to decide whether to stub a request or not and all connections are allowed. To enable connections only to a specific domain (e.g. your test server) use:
+
+```ruby
+WebMock.allow_net_connect!(net_http_connect_on_start: "www.example.com")
+```
 
 ## Setting Expectations
 
@@ -1166,13 +1181,34 @@ People who submitted patches and new features or suggested improvements. Many th
 * Timmitry
 * Michael Fairley
 * Ray Zane
+* Go Sueyoshi
+* Cedric Sohrauer
+* Akira Matsuda
+* Mark Spangler
+* Henrik Nyh
+* Yoann Lecuyer
+* Lucas Arnaud
+* Marc Rohloff
+* inkstak
+* Yuki Inoue
+* Brandon Weaver
+* Josh Nichols
+* Ricardo Trindade
+* Earlopain
+* James Brown
+* Kazuhiro NISHIYAMA
+* Étienne Barrié
+* Matt Brown
+* Victor Maslov
+* Gio Lodi
+* Ryan Brooks
 
 For a full list of contributors you can visit the
 [contributors](https://github.com/bblimke/webmock/contributors) page.
 
 ## Background
 
-Thank you Fakeweb! This library was inspired by [FakeWeb](http://fakeweb.rubyforge.org).
+Thank you Fakeweb! This library was inspired by [FakeWeb](https://github.com/chrisk/fakeweb).
 I imported some solutions from that project to WebMock. I also copied some code i.e Net:HTTP adapter.
 Fakeweb architecture unfortunately didn't allow me to extend it easily with the features I needed.
 I also preferred some things to work differently i.e request stub precedence.

data/lib/webmock/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   module API
     extend self

data/lib/webmock/assertion_failure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   class AssertionFailure
     @error_class = RuntimeError

data/lib/webmock/callback_registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   class CallbackRegistry
     @@callbacks = []

data/lib/webmock/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   class Config
     include Singleton

data/lib/webmock/cucumber.rb

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

data/lib/webmock/deprecation.rb

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

data/lib/webmock/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
 
   class NetConnectNotAllowedError < Exception

data/lib/webmock/http_lib_adapters/async_http_client_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'async'
   require 'async/http'

data/lib/webmock/http_lib_adapters/curb_adapter.rb

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

data/lib/webmock/http_lib_adapters/em_http_request_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'em-http-request'
 rescue LoadError
@@ -101,7 +103,7 @@ if defined?(EventMachine::HttpClient)
 
       def connection_completed
         @state = :response_header
-        send_request(request_signature.headers, request_signature.body)
+        send_request(*headers_and_body_processed_by_middleware)
       end
 
       def send_request(head, body)
@@ -154,7 +156,7 @@ if defined?(EventMachine::HttpClient)
         raw_cookie = response_header.cookie
         raw_cookie = [raw_cookie] if raw_cookie.is_a? String
 
-        cookie = raw_cookie.select { |c| c.start_with? name }.first
+        cookie = raw_cookie.detect { |c| c.start_with? name }
         cookie and cookie.split('=', 2)[1]
       end
 
@@ -168,12 +170,18 @@ if defined?(EventMachine::HttpClient)
         webmock_response
       end
 
-      def build_request_signature
-        headers, body = build_request, @req.body
-
-        @conn.middleware.select {|m| m.respond_to?(:request) }.each do |m|
-          headers, body = m.request(self, headers, body)
+      def headers_and_body_processed_by_middleware
+        @headers_and_body_processed_by_middleware ||= begin
+          head, body = build_request, @req.body
+          @conn.middleware.each do |m|
+            head, body = m.request(self, head, body) if m.respond_to?(:request)
+          end
+          [head, body]
         end
+      end
+
+      def build_request_signature
+        headers, body = headers_and_body_processed_by_middleware
 
         method = @req.method
         uri = @req.uri.clone

data/lib/webmock/http_lib_adapters/excon_adapter.rb

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

data/lib/webmock/http_lib_adapters/http_lib_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   class HttpLibAdapter
     def self.adapter_for(lib)

data/lib/webmock/http_lib_adapters/http_lib_adapter_registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   class HttpLibAdapterRegistry
     include Singleton

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTTP
   class Client
     alias_method :__perform__, :perform

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

@@ -1,11 +1,23 @@
+# frozen_string_literal: true
+
 module HTTP
   class Request
     def webmock_signature
-      request_body = if defined?(HTTP::Request::Body)
-                       ''.tap { |string| body.each { |part| string << part } }
-                     else
-                       body
-                     end
+      request_body = nil
+
+      if defined?(HTTP::Request::Body)
+        request_body = String.new
+        first_chunk_encoding = nil
+        body.each do |part|
+          request_body << part
+          first_chunk_encoding ||= part.encoding
+        end
+
+        request_body.force_encoding(first_chunk_encoding) if first_chunk_encoding
+        request_body
+      else
+        request_body = body
+      end
 
       ::WebMock::RequestSignature.new(verb, uri.to_s, {
         headers: headers.to_h,

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,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"
 
@@ -52,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
@@ -63,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,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTTP
   class Response
     class Streamer

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTTP
   class WebMockPerform
     def initialize(request, options, &perform)

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