webmock 3.32.0 → 3.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d20abb34dbaefa2fb02ae23a25f33f0762415ead54721033fd7c9ea53a399a9a
-  data.tar.gz: 8160f5688d2afa4bd0bf8671ddbf05be797ab7c064a03af7fa7386de7baf424e
+  metadata.gz: b66b694440da9739d8d23ccd8a260260739199235f076f4854387f7029c0c976
+  data.tar.gz: 96abe5bbe31e475bcec618aff66d43ac724b7cf15b08883ae864d62cac826e7c
 SHA512:
-  metadata.gz: 5fee3bec940d62b056f45cda8e62fab7839bb3d376f4db0b7db64b8a2e2a32ebe48d31b31a84f3c1e8a0662f9e9dd4aa924c44ef4e69a4eb6f63d40a8909c2aa
-  data.tar.gz: 38bae4b2800d672db58e5677d40288d5d0d9323414171056bcd19b56ab04432b6a2e64e1c99a600ca8ff5da86bbac29c588eefc3e2705cb792b549bb17b94a5b
+  metadata.gz: 99395c27d7c6c270f37309e69da7f3688c43b8f158327d23b62b9829b3fff7a667280542017c71f18e2b822de6639394b2aeaa078aae7b7c67d7fd497363e918
+  data.tar.gz: 9378a048d2a03b1309eff3b5264ddca35e4f9268399a92e98147fa0e2d60e376d31ca2f1ccaca912f6d7ca859268b1d9ce173530e885c5055b99f3c2632bfd46

data/CHANGELOG.md

@@ -1,5 +1,71 @@
 # Changelog
 
+# 3.34.0
+
+* Allow `with(query: :any)` to match any query string (#1099)
+
+    `stub_request(:get, "www.example.com").with(query: :any)` matches requests with any query string, or none. RSpec's `anything` works the same way. Previously, this raised `NoMethodError`, and you had to write `with(query: hash_including({}))`.
+
+    Use a URL without query parameters when passing `query: :any`. Otherwise, WebMock raises `ArgumentError`.
+
+    Thanks to [nightpool](https://github.com/nightpool)
+
+* Raise a clear `ArgumentError` for an unsupported `query` option
+
+    Previously, a value such as `with(query: :all)` raised `NoMethodError` (undefined method `split`). The new error lists the supported values.
+
+* Show `anything` for keys given without a value to `hash_including` or `hash_excluding` outside RSpec
+
+    Previously, with Minitest or Test::Unit, messages showed `#<WebMock::Matchers::AnyArgMatcher:0x...>`, for example for `with(query: hash_including(:a))`. RSpec's own matchers already showed `anything`.
+
+* Provide `HTTP_HOST` to `to_rack` apps when the client has not supplied a Host header (#1084)
+
+    Previously, requests from some HTTP clients reached the Rack app without `HTTP_HOST`. This caused host checks such as Sinatra's `HostAuthorization` to see an empty host.
+
+    WebMock now fills in the host from the request URL, including the port when it is not the default. An explicit Host header is preserved.
+
+    Thanks to [Benoit Tigeot](https://github.com/benoittgt)
+
+* Fix Rack compatibility for `to_rack` apps
+
+    The request environment now passes `Rack::Lint`.
+
+    `SERVER_PORT` and `CONTENT_LENGTH` are now strings. If your app or tests read them directly, use string comparisons, such as `env['SERVER_PORT'] == "80"`. The environment also includes `SERVER_PROTOCOL`.
+
+    `CONTENT_TYPE` is omitted when the request has no content type. The `Content-Length` header is passed only as `CONTENT_LENGTH`, without an extra `HTTP_CONTENT_LENGTH` entry. `Transfer-Encoding` is removed because the body has already been decoded.
+
+    Repeated header values are joined into one string. Header values and the body read from `rack.input` now use binary (`ASCII-8BIT`) strings.
+
+# 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)

data/README.md

@@ -299,6 +299,15 @@ Net::HTTP.get('www.example.com',
   '/thing/5.json?x=1&y=2&z=3&anyParam=4')    # ===> Success
 ```
 
+### Matching any query params
+
+```ruby
+stub_request(:get, "www.example.com").with(query: :any)
+
+RestClient.get("http://www.example.com/?q=example")    # ===> Success
+RestClient.get("http://www.example.com/")              # ===> Success
+```
+
 ### Matching query params using hash
 
 ```ruby

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/matchers/any_arg_matcher.rb

@@ -10,6 +10,10 @@ module WebMock
       def ==(other)
         true
       end
+
+      def inspect
+        "anything"
+      end
     end
   end
 end

data/lib/webmock/rack_response.rb

@@ -27,37 +27,56 @@ module WebMock
 
     def build_rack_env(request)
       uri = request.uri
+      port = uri.inferred_port
       headers = (request.headers || {}).dup
-      body = request.body || ''
+      body = (request.body || '').b
+      content_type = headers.delete('Content-Type')
+      headers.delete('Content-Length')
+      # The body is already decoded, as a server passes it on.
+      headers.delete('Transfer-Encoding')
 
       env = {
         # CGI variables specified by Rack
-        'REQUEST_METHOD' => request.method.to_s.upcase,
-        'CONTENT_TYPE'   => headers.delete('Content-Type'),
-        'CONTENT_LENGTH' => body.bytesize,
-        'PATH_INFO'      => uri.path,
-        'QUERY_STRING'   => uri.query || '',
-        'SERVER_NAME'    => uri.host,
-        'SERVER_PORT'    => uri.port,
-        'SCRIPT_NAME'    => ""
+        'REQUEST_METHOD'  => request.method.to_s.upcase,
+        'CONTENT_LENGTH'  => body.bytesize.to_s,
+        'PATH_INFO'       => uri.path,
+        'QUERY_STRING'    => uri.query || '',
+        'SERVER_NAME'     => uri.host,
+        'SERVER_PORT'     => port.to_s,
+        'SERVER_PROTOCOL' => 'HTTP/1.1',
+        'SCRIPT_NAME'     => ""
       }
+      env['CONTENT_TYPE'] = header_value('Content-Type', content_type) if content_type
 
       env['HTTP_AUTHORIZATION'] = 'Basic ' + [uri.userinfo].pack('m').delete("\r\n") if uri.userinfo
 
       # Rack-specific variables
       env['rack.input']      = StringIO.new(body)
       env['rack.errors']     = $stderr
-      if !Rack.const_defined?(:RELEASE) || Rack::RELEASE < "3"
-        env['rack.version']    = Rack::VERSION
+      if !Rack.const_defined?(:RELEASE) || Gem::Version.new(Rack::RELEASE) < Gem::Version.new("3")
+        env['rack.version']      = Rack::VERSION
+        env['rack.multithread']  = false
+        env['rack.multiprocess'] = false
       end
       env['rack.url_scheme'] = uri.scheme
       env['rack.run_once']   = true
 
       headers.each do |k, v|
-        env["HTTP_#{k.tr('-','_').upcase}"] = v
+        env["HTTP_#{k.tr('-','_').upcase}"] = header_value(k, v)
       end
 
+      # Many clients add Host only when sending, so fill it in as they would.
+      env['HTTP_HOST'] ||= port == uri.default_port ? uri.host : "#{uri.host}:#{port}"
+
       env
     end
+
+    private
+
+    # Like a server, pass header values as bytes and join repeated ones. Rack
+    # splits cookies on "; ", so join those that way.
+    def header_value(name, value)
+      Array(value).map { |v| v.to_s.b }.join(name == 'Cookie' ? '; ' : WebMock::Util::Headers::JOIN)
+    end
   end
 end

data/lib/webmock/request_pattern.rb

@@ -10,6 +10,10 @@ module WebMock
     def rSpecHashExcludingMatcher?(matcher)
       matcher.class.name =~ /R?Spec::Mocks::ArgumentMatchers::HashExcludingMatcher/
     end
+
+    def rSpecAnyArgMatcher?(matcher)
+      matcher.class.name =~ /R?Spec::Mocks::ArgumentMatchers::AnyArgMatcher/
+    end
   end
 
   class RequestPattern
@@ -129,6 +133,10 @@ module WebMock
     def add_query_params(query_params)
       @query_params = if query_params.is_a?(Hash)
         query_params
+      elsif query_params.equal?(:any) \
+              || query_params.is_a?(WebMock::Matchers::AnyArgMatcher) \
+              || rSpecAnyArgMatcher?(query_params)
+        WebMock::Matchers::AnyArgMatcher.new(nil)
       elsif query_params.is_a?(WebMock::Matchers::HashIncludingMatcher) \
               || query_params.is_a?(WebMock::Matchers::HashExcludingMatcher)
         query_params
@@ -136,8 +144,10 @@ module WebMock
         WebMock::Matchers::HashIncludingMatcher.from_rspec_matcher(query_params)
       elsif rSpecHashExcludingMatcher?(query_params)
         WebMock::Matchers::HashExcludingMatcher.from_rspec_matcher(query_params)
-      else
+      elsif query_params.nil? || query_params.is_a?(String)
         WebMock::Util::QueryMapper.query_to_values(query_params, notation: Config.instance.query_values_notation)
+      else
+        raise ArgumentError, "Query should be a String, Hash, :any, nil, or a hash_including or hash_excluding matcher. Got: #{query_params.class}"
       end
     end
 
@@ -153,6 +163,10 @@ module WebMock
 
     private
 
+    def raise_any_query_with_uri_query
+      raise ArgumentError, "query: :any can't be combined with a query in the URI #{pattern_inspect}, because no request would match. Remove the query from the URI."
+    end
+
     def pattern_inspect
       @pattern.inspect
     end
@@ -180,12 +194,17 @@ module WebMock
 
   class URIAddressablePattern  < URIPattern
     def add_query_params(query_params)
+      super(query_params)
+      # With query params, the template is matched against the URI without its
+      # query, so a literal query in the template can never match.
+      if @query_params.is_a?(WebMock::Matchers::AnyArgMatcher) && @pattern.pattern.gsub(/\{[^}]*\}/, '').include?('?')
+        raise_any_query_with_uri_query
+      end
       @@add_query_params_warned ||= false
       if not @@add_query_params_warned
         @@add_query_params_warned = true
         warn "WebMock warning: ignoring query params in RFC 6570 template and checking them with WebMock"
       end
-      super(query_params)
     end
 
     private
@@ -230,6 +249,9 @@ module WebMock
         query_hash = (WebMock::Util::QueryMapper.query_to_values(@pattern.query, notation: Config.instance.query_values_notation) || {}).merge(@query_params)
         @pattern.query = WebMock::Util::QueryMapper.values_to_query(query_hash, notation: WebMock::Config.instance.query_values_notation)
         @query_params = nil
+      elsif @query_params.is_a?(WebMock::Matchers::AnyArgMatcher) && @pattern.query
+        # The URI is then compared without its query, so it could never match.
+        raise_any_query_with_uri_query
       end
     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.32.0' unless defined?(::WebMock::VERSION)
+  VERSION = '3.34.0' unless defined?(::WebMock::VERSION)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webmock
 version: !ruby/object:Gem::Version
-  version: 3.32.0
+  version: 3.34.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.32.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/webmock/3.32.0
-  source_code_uri: https://github.com/bblimke/webmock/tree/v3.32.0
+  changelog_uri: https://github.com/bblimke/webmock/blob/v3.34.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/webmock/3.34.0
+  source_code_uri: https://github.com/bblimke/webmock/tree/v3.34.0
   wiki_uri: https://github.com/bblimke/webmock/wiki
 rdoc_options: []
 require_paths: