webmock 3.14.0 → 3.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8f150fbeccca419468dfebe632e3b5d365cb8c2df9a5e2a31e65591298786fb
-  data.tar.gz: d92950bc5ae3510e599c40545f3e7a0ebaafa54a698f79a3c82243e240d35948
+  metadata.gz: 379567500380d6df66bea0edab72f977ddbcab8fc2cc79f9c2e4c535c46cfeb4
+  data.tar.gz: fbab14a1e3a2d7a5563f293e735f521dc47481e7d574f4ace0e5cefa9a15fb8e
 SHA512:
-  metadata.gz: f58d569f7c633d758cee725e5dafb39edacb74e0017ba9c29de0cad8fe16d1f7740cc30847a9f129f6571232d2ca8172d7fb76a1eb3383e31ee8371472f141f9
-  data.tar.gz: 52191c4e12ac3bf79b575f36d58823ea37ab17f83c7a62602889f361eafadabfa4b0b8ffc1f466eee6de53ea77578fc0149a60e14abdd8a7459b651afbeb85d0
+  metadata.gz: 768bc4817766c1b5d2c799c8453bf59411d69f36c4d3b6dfc0630f2a830efa4b72b78dd999cce146bf8f4754a05fbd0dbbddcc72a7389f8b48b8546d4d98dba0
+  data.tar.gz: ca14f9cffef86ef82b52985f5ad58f662cbffcb33b86050ffd6e9390efaf5892eed0469595f153d7b0d8a8e6141a75a1e47cdd8076178385a92fe99593c8b3c3

data/CHANGELOG.md

@@ -1,5 +1,127 @@
 # Changelog
 
+# 3.19.0
+
+  * 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.
+
+  * 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)
+
+  * Fix supported http client gem version checks.
+
+      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
+
+    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.
+
+    Thanks to [Ray Zane](https://github.com/rzane)
+
+  * Allow specifying for what URIs or hosts, Net::HTTP should connect on start.
+
+    Thanks to [Ray Zane](https://github.com/rzane)
+
+# 3.15.2
+
+  * Minimum required Ruby version is 2.0.
+
+# 3.15.0 (yanked)
+
+  * fixed async-http adapter on Windows
+
+    Thanks to [Pavel Rosický](https://github.com/ahorek)
+
+  * Support for http.rb >= 5.0.2
+
+    Thanks to [ojab](https://github.com/ojab)
+
+  * Curb adapter supports headers with `:` character in the header value
+
+    Thanks to [Giorgio Gambino](https://github.com/mrbuzz)
+
+  * Support for matching body of JSON or application/x-www-form-urlencoded requests with content type header including charset.
+
+    Thanks to [Timmitry](https://github.com/Timmitry)
+
+  * Prevent double-wrapping http.rb features on non-stubbed requests
+
+    Thanks to [Michael Fairley](https://github.com/michaelfairley)
+
 # 3.14.0
 
   * Bump Addressable from 2.3.6 to 2.8.0
@@ -605,9 +727,9 @@
   * `WebMock.disable_net_connect` accepts `:allow` option with an object that responds to `#call`, receiving a `URI` object and returning a boolean:
 
 
-        blacklist = ['google.com', 'facebook.com', 'apple.com']
+        denylist = ['google.com', 'facebook.com', 'apple.com']
         allowed_sites = lambda{|uri|
-          blacklist.none?{|site| uri.host.include?(site) }
+          denylist.none?{|site| uri.host.include?(site) }
         }
         WebMock.disable_net_connect!(:allow => allowed_sites)
 

data/README.md

@@ -4,8 +4,6 @@ WebMock
 [![Build Status](https://github.com/bblimke/webmock/workflows/CI/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
@@ -550,9 +561,9 @@ RestClient.get('sample.org', '/bar')          # ===> Failure
 With an object that responds to `#call`, receiving a `URI` object and returning a boolean:
 
 ```ruby
-blacklist = ['google.com', 'facebook.com', 'apple.com']
+denylist = ['google.com', 'facebook.com', 'apple.com']
 allowed_sites = lambda{|uri|
-  blacklist.none?{|site| uri.host.include?(site) }
+  denylist.none?{|site| uri.host.include?(site) }
 }
 WebMock.disable_net_connect!(allow: allowed_sites)
 
@@ -1161,13 +1172,30 @@ People who submitted patches and new features or suggested improvements. Many th
 * Alex Vondrak
 * Will Storey
 * Eduardo Hernandez
+* ojab
+* Giorgio Gambino
+* 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
 
 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'
@@ -151,7 +153,12 @@ if defined?(Async::HTTP)
         private
 
         def create_connected_sockets
-          Async::IO::Socket.pair(Socket::AF_UNIX, Socket::SOCK_STREAM).tap do |sockets|
+          pair = begin
+            Async::IO::Socket.pair(Socket::AF_UNIX, Socket::SOCK_STREAM)
+          rescue Errno::EAFNOSUPPORT
+            Async::IO::Socket.pair(Socket::AF_INET, Socket::SOCK_STREAM)
+          end
+          pair.tap do |sockets|
             sockets.each do |socket|
               socket.instance_variable_set :@alpn_protocol, nil
               socket.instance_eval do

data/lib/webmock/http_lib_adapters/curb_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'curb'
 rescue LoadError
@@ -5,7 +7,7 @@ rescue LoadError
 end
 
 if defined?(Curl)
-  WebMock::VersionChecker.new('Curb', Curl::CURB_VERSION, '0.7.16', '0.9.1', ['0.8.7']).check_version!
+  WebMock::VersionChecker.new('Curb', Curl::CURB_VERSION, '0.7.16', '1.0.1', ['0.8.7']).check_version!
 
   module WebMock
     module HttpLibAdapters
@@ -128,7 +130,7 @@ if defined?(Curl)
       def headers_as_hash(headers)
         if headers.is_a?(Array)
           headers.inject({}) {|hash, header|
-            name, value = header.split(":").map(&:strip)
+            name, value = header.split(":", 2).map(&:strip)
             hash[name] = value
             hash
           }

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)
@@ -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
@@ -5,9 +7,7 @@ module HTTP
     def perform(request, options)
       return __perform__(request, options) unless webmock_enabled?
 
-      response = WebMockPerform.new(request) { __perform__(request, options) }.exec
-      options.features.each { |_name, feature| response = feature.wrap_response(response) }
-      response
+      WebMockPerform.new(request, options) { __perform__(request, options) }.exec
     end
 
     def webmock_enabled?

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

@@ -1,8 +1,10 @@
+# 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 } }
+                       String.new.tap { |string| body.each { |part| string << part } }
                      else
                        body
                      end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTTP
   class Response
     def to_webmock
@@ -24,7 +26,10 @@ module HTTP
         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)
+          Body.new(
+            Streamer.new(webmock_response.body, encoding: webmock_response.body.encoding),
+            encoding: webmock_response.body.encoding
+          )
         end
 
         return new(status, "1.1", headers, body, uri) if HTTP::VERSION < "1.0.0"

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,7 +17,8 @@ module HTTP
           end
         end
 
-        @io.read size, outbuf
+        chunk = @io.read size, outbuf
+        chunk.force_encoding(@encoding) if chunk
       end
 
       def close

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

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

data/lib/webmock/http_lib_adapters/manticore_adapter.rb

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