webmock 3.18.1 → 3.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a7e964f28dd42787fd854c5fcc87dba4cd61ef214c3dee485d9bd0d71fc1cdd
-  data.tar.gz: f6921a9b14ccd71f18b4674aca8d4d24bf377545a4ef8c56862f95cc56b6e8a7
+  metadata.gz: ffda5916fee8f80d1d0a725b7de314652a588658189bb28ad7a984551d406a3a
+  data.tar.gz: f2aa5c1f78094f72f9c7310dfbb3e866be2acc6910bd3c3a1a4e562744e0fa65
 SHA512:
-  metadata.gz: 80e85d1bb83018bdaab80aed649134757ee8ac591b98e9ccf1b6df10c0d8930db167dd5fd3bb039dd56a955d22c0cc6b1a1227bb88e8f3e56d31d0e1c9d7708e
-  data.tar.gz: c67f1f8486d6ee932bd9d01dff2bfcec35d9c3e3ed937e50e1f56d34f664ca11db4c9399c51e82da9316245c1d4727c726b9e307646aef80477764609ecf95ee
+  metadata.gz: e3fbfb98e4a6d090abd630ccfea78f5b06038e3f6d4683bd1f651f6c8b07b31698f71f9588df1a8d90066ab0d38a088a604204b4f710bfd9249235a9f2664453
+  data.tar.gz: ffcaf10bc3cd523f6c12c2209fc4e48fb34813e520789ca78ee0cb65b3285f7bf1534ef36faafbd61a49d82ca547f2ecfb3ea74b33b5ba3b4294493f0683942d

data/CHANGELOG.md

@@ -1,5 +1,67 @@
 # Changelog
 
+# 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)
+
+  * 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

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
@@ -1170,6 +1181,18 @@ People who submitted patches and new features or suggested improvements. Many th
 * 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
 
 For a full list of contributors you can visit the
 [contributors](https://github.com/bblimke/webmock/contributors) page.

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,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTTP
   class Response
     def to_webmock

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

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

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'

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,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'patron'
 rescue LoadError

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)

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
 

data/lib/webmock/request_pattern.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
 
   module RSpecMatcherDetector
@@ -283,7 +285,7 @@ module WebMock
         matching_body_hashes?(body_as_hash(body, content_type), @pattern, content_type)
       elsif (@pattern).is_a?(Array)
         matching_body_array?(body_as_hash(body, content_type), @pattern, content_type)
-      elsif (@pattern).is_a?(WebMock::Matchers::HashIncludingMatcher)
+      elsif (@pattern).is_a?(WebMock::Matchers::HashArgumentMatcher)
         @pattern == body_as_hash(body, content_type)
       else
         empty_string?(@pattern) && empty_string?(body) ||

data/lib/webmock/request_registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
 
   class RequestRegistry

data/lib/webmock/request_signature.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
 
   class RequestSignature

data/lib/webmock/request_signature_snippet.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pp"
 
 module WebMock

data/lib/webmock/request_stub.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   class RequestStub
 
@@ -29,9 +31,26 @@ module WebMock
 
       json_response_hashes = [*response_hashes].flatten.map do |resp_h|
         headers, body = resp_h.values_at(:headers, :body)
+
+        json_body = if body.respond_to?(:call)
+          ->(request_signature) {
+            b = if body.respond_to?(:arity) && body.arity == 1
+              body.call(request_signature)
+            else
+              body.call
+            end
+            b = b.to_json unless b.is_a?(String)
+            b
+          }
+        elsif !body.is_a?(String)
+          body.to_json
+        else
+          body
+        end
+
         resp_h.merge(
           headers: {content_type: 'application/json'}.merge(headers.to_h),
-          body: body.is_a?(Hash) ? body.to_json : body
+          body: json_body
         )
       end
 

data/lib/webmock/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pathname"
 
 module WebMock
@@ -36,7 +38,7 @@ module WebMock
     end
 
     def body
-      @body || ''
+      @body || String.new("")
     end
 
     def body=(body)

data/lib/webmock/responses_sequence.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
 
   class ResponsesSequence

data/lib/webmock/rspec/matchers/request_pattern_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   class RequestPatternMatcher
 

data/lib/webmock/rspec/matchers/webmock_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   class WebMockMatcher
 

data/lib/webmock/rspec/matchers.rb

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

data/lib/webmock/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'webmock'
 
 # RSpec 1.x and 2.x compatibility

data/lib/webmock/stub_registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
 
   class StubRegistry

data/lib/webmock/stub_request_snippet.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WebMock
   class StubRequestSnippet
     def initialize(request_stub)

data/lib/webmock/test_unit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test/unit'
 require 'webmock'