webmock 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9824be80903ce63b7e2f3a3b61c5924ba3d884ff
-  data.tar.gz: 4666fd52ab43ddd61feabf9b53b565b332d56d17
+SHA256:
+  metadata.gz: babd32444fb5057e9e1945acefbef6601b5b9e2c78a3670ff929a027b89529eb
+  data.tar.gz: 3016884b0119a6cf8e2685628744f661b7d0e0b59462b925b98598732d5cd1a7
 SHA512:
-  metadata.gz: a9e1a7c45d9e2ae020ebb116edcd3d52b529df4a29495f0539f234738f34dff65d2e38c45de3a2361cb203be364c94d1e1eebd88ccbdaac27d0c0ed15e7f614c
-  data.tar.gz: 421aca9b146365fa1f0c6425435620b290323e10230acdf39fe6b572fc3072aad7bca874243176b4cf03a39eb4ed239a3063b640f2abe3e7ebf9e6b15fb44785
+  metadata.gz: 15e986cdda0dc84d50d35e0e596e92ae18edac6d19c3dcf16930256fc518ddeecab5a5d7e0f5c404bf285f877627707872992547a35f4e4dee2fb31dc4af19f0
+  data.tar.gz: 3ac9e572b8785c1059c1c1388822854a7600cfc28017e48f6dbe2ee3934c29bab214f54b29cd73ee605e74abcac35a0d2dc7cb132bdc54bbfe6853f547626c55

data/CHANGELOG.md

@@ -1,10 +1,46 @@
 # Changelog
 
+## 3.4.0
+
+ * Ruby 2.6 support. Prevent `Net/ReadTimeout` error in Ruby 2.6
+
+    Thanks to [Koichi ITO](https://github.com/koic)
+
+ * Handling query params, which represent nested hashes with keys starting with non word characters.
+
+    Thanks to [rapides](https://github.com/rapides) for reporting the issue.
+
+ * Patron adapter handles PATCH requests with body.
+
+    Thanks to [Mattia](https://github.com/iMacTia) for reporting the issue.
+
+ * Allowing requests with url encoded body to be matched by request stubs declared with hash body with non-string values.
+
+        stub_request(:post, "www.example.com").with(body: {"a" => 1, "b" => false})
+
+        RestClient.post('www.example.com', 'a=1&b=false', :content_type => 'application/x-www-form-urlencoded') # ===> Success
+
+    Thanks to [Kenny Ortmann](https://github.com/yairgo) for suggesting this feature.
+
+ *  When request headers contain 'Accept'=>'application/json' and no registered stub matches the request, WebMock prints a suggested stub code with to_return body set to '{}'.
+
+    Thanks to [redbar0n](https://github.com/redbar0n)
+
+* Improved suggested stub output when the request stub only contains headers declaration.
+
+    Thanks to [Olia Kremmyda](https://github.com/oliakremmyda)
+
+* Fixed Curb adapter to handle `reset` method.
+
+    Thanks tp [dinhhuydh](https://github.com/dinhhuydh) for reporting the issue.
+    Thanks to [Olia Kremmyda](https://github.com/oliakremmyda) for fixing it.
+
+
 ## 3.3.0
 
  *  Better formatting of outputted request stub snippets, displayed on failures due to unstubbed requests.
 
-    Thanks to [Olia Kremmyda](https://github.com/Olia-Kremmyda)
+    Thanks to [Olia Kremmyda](https://github.com/oliakremmyda)
 
 
 ## 3.2.1
@@ -22,7 +58,7 @@
 
  * Fixed bug when handling redirection using Curb.
 
-    Thanks to [Olia Kremmyda](https://github.com/Olia-Kremmyda)
+    Thanks to [Olia Kremmyda](https://github.com/oliakremmyda)
 
 
 ## 3.1.1

data/README.md

@@ -1,6 +1,6 @@
 WebMock
 =======
-[![Gem Version](https://badge.fury.io/rb/webmock.svg)](http://badge.fury.io/rb/webmock) [![Build Status](https://secure.travis-ci.org/bblimke/webmock.svg?branch=master)](http://travis-ci.org/bblimke/webmock) [![Dependency Status](https://gemnasium.com/bblimke/webmock.svg)](http://gemnasium.com/bblimke/webmock) [![Code Climate](https://codeclimate.com/github/bblimke/webmock/badges/gpa.svg)](https://codeclimate.com/github/bblimke/webmock) [![Inline docs](http://inch-ci.org/github/bblimke/webmock.svg?branch=master)](http://inch-ci.org/github/bblimke/webmock)
+[![Gem Version](https://badge.fury.io/rb/webmock.svg)](http://badge.fury.io/rb/webmock) [![Build Status](https://secure.travis-ci.org/bblimke/webmock.svg?branch=master)](http://travis-ci.org/bblimke/webmock) [![Dependency Status](https://gemnasium.com/bblimke/webmock.svg)](http://gemnasium.com/bblimke/webmock) [![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)
 
 Library for stubbing and setting expectations on HTTP requests in Ruby.
 
@@ -1053,7 +1053,8 @@ People who submitted patches and new features or suggested improvements. Many th
 * Olia Kremmyda
 * Michał Matyas
 * Matt Brictson
-* Olia Kremmyda
+* Kenny Ortmann
+* redbar0n
 
 For a full list of contributors you can visit the
 [contributors](https://github.com/bblimke/webmock/contributors) page.

data/lib/webmock.rb

@@ -14,6 +14,7 @@ require 'webmock/util/uri'
 require 'webmock/util/headers'
 require 'webmock/util/hash_counter'
 require 'webmock/util/hash_keys_stringifier'
+require 'webmock/util/values_stringifier'
 require 'webmock/util/json'
 require 'webmock/util/version_checker'
 require 'webmock/util/hash_validator'

data/lib/webmock/http_lib_adapters/curb_adapter.rb

@@ -332,6 +332,11 @@ if defined?(Curl)
           end
         METHOD
       end
+
+      def reset
+        instance_variable_set(:@body_str, nil)
+        super
+      end
     end
   end
 end

data/lib/webmock/http_lib_adapters/net_http.rb

@@ -271,6 +271,20 @@ module Net  #:nodoc: all
       end
       raise "Unable to create local socket" unless @io
     end
+
+    if RUBY_VERSION >= '2.6.0'
+      def rbuf_fill
+        trace = TracePoint.trace(:line) do |tp|
+          if tp.binding.local_variable_defined?(:tmp)
+            tp.binding.local_variable_set(:tmp, nil)
+          end
+        end
+
+        super
+
+        trace.disable
+      end
+    end
   end
 
 end

data/lib/webmock/http_lib_adapters/patron_adapter.rb

@@ -69,7 +69,7 @@ if defined?(::Patron)
           uri = WebMock::Util::URI.heuristic_parse(req.url)
           uri.path = uri.normalized_path.gsub("[^:]//","/")
 
-          if [:put, :post].include?(req.action)
+          if [:put, :post, :patch].include?(req.action)
             if req.file_name
               if !File.exist?(req.file_name) || !File.readable?(req.file_name)
                 raise ArgumentError.new("Unable to open specified file.")

data/lib/webmock/request_pattern.rb

@@ -243,7 +243,7 @@ module WebMock
 
       if (@pattern).is_a?(Hash)
         return true if @pattern.empty?
-        matching_hashes?(body_as_hash(body, content_type), @pattern)
+        matching_body_hashes?(body_as_hash(body, content_type), @pattern, content_type)
       elsif (@pattern).is_a?(WebMock::Matchers::HashIncludingMatcher)
         @pattern == body_as_hash(body, content_type)
       else
@@ -298,15 +298,16 @@ module WebMock
     #
     # @return [Boolean] true if the paramaters match the comparison
     #   hash, false if not.
-    def matching_hashes?(query_parameters, pattern)
+    def matching_body_hashes?(query_parameters, pattern, content_type)
       return false unless query_parameters.is_a?(Hash)
       return false unless query_parameters.keys.sort == pattern.keys.sort
       query_parameters.each do |key, actual|
         expected = pattern[key]
 
         if actual.is_a?(Hash) && expected.is_a?(Hash)
-          return false unless matching_hashes?(actual, expected)
+          return false unless matching_body_hashes?(actual, expected, content_type)
         else
+          expected = WebMock::Util::ValuesStringifier.stringify_values(expected) if url_encoded_body?(content_type)
           return false unless expected === actual
         end
       end
@@ -321,6 +322,9 @@ module WebMock
       Hash[WebMock::Util::HashKeysStringifier.stringify_keys!(hash, deep: true).sort]
     end
 
+    def url_encoded_body?(content_type)
+      content_type =~ %r{^application/x-www-form-urlencoded}
+    end
   end
 
   class HeadersPattern

data/lib/webmock/stub_request_snippet.rb

@@ -20,13 +20,17 @@ module WebMock
       end
 
       if (request_pattern.headers_pattern)
-        with << ",\n  " unless with.empty?
+        with << "," unless with.empty?
 
-        with << "  headers: #{request_pattern.headers_pattern.pp_to_s}"
+        with << "\n    headers: #{request_pattern.headers_pattern.pp_to_s}"
       end
       string << ".\n  with(#{with})" unless with.empty?
       if with_response
-        string << ".\n  to_return(status: 200, body: \"\", headers: {})"
+        if request_pattern.headers_pattern && request_pattern.headers_pattern.matches?({ 'Accept' => "application/json" })
+          string << ".\n  to_return(status: 200, body: \"{}\", headers: {})"
+        else
+          string << ".\n  to_return(status: 200, body: \"\", headers: {})"
+        end
       end
       string
     end

data/lib/webmock/util/hash_counter.rb

@@ -2,7 +2,7 @@ require 'thread'
 
 module WebMock
   module Util
-    class Util::HashCounter
+    class HashCounter
       attr_accessor :hash
       def initialize
         self.hash = {}

data/lib/webmock/util/query_mapper.rb

@@ -122,7 +122,7 @@ module WebMock::Util
 
       def fill_accumulator_for_subscript(accumulator, key, value)
         current_node = accumulator
-        subkeys = key.split(/(?=\[\w)/)
+        subkeys = key.split(/(?=\[[^\[\]]+)/)
         subkeys[0..-2].each do |subkey|
           node = subkey =~ /\[\]\z/ ? [] : {}
           subkey = subkey.gsub(/[\[\]]/, '')

data/lib/webmock/util/values_stringifier.rb

@@ -0,0 +1,20 @@
+class WebMock::Util::ValuesStringifier
+  def self.stringify_values(value)
+    case value
+    when nil
+      value
+    when Hash
+      Hash[
+        value.map do |k, v|
+          [k, stringify_values(v)]
+        end
+      ]
+    when Array
+      value.map do |v|
+        stringify_values(v)
+      end
+    else
+      value.to_s
+    end
+  end
+end

data/lib/webmock/version.rb

@@ -1,3 +1,3 @@
 module WebMock
-  VERSION = '3.3.0' unless defined?(::WebMock::VERSION)
+  VERSION = '3.4.0' unless defined?(::WebMock::VERSION)
 end

data/spec/acceptance/curb/curb_spec.rb

@@ -462,5 +462,20 @@ unless RUBY_PLATFORM =~ /java/
       it_should_behave_like "Curb"
       include CurbSpecHelper::ClassPerform
     end
+
+    describe "using .reset" do
+      before do
+        @curl = Curl::Easy.new
+        @curl.url = "http://example.com"
+        body = "on_success fired"
+        stub_request(:any, "example.com").to_return(body: body)
+        @curl.http_get
+      end
+
+      it "should clear the body_str" do
+        @curl.reset
+        expect(@curl.body_str).to eq(nil)
+      end
+    end
   end
 end

data/spec/acceptance/patron/patron_spec.rb

@@ -19,6 +19,13 @@ unless RUBY_PLATFORM =~ /java/
         @sess.base_url = "http://www.example.com"
       end
 
+      it "should allow stubbing PATCH request with body" do
+        stub_request(:patch, "http://www.example.com/")
+          .with(body: "abc")
+
+        @sess.patch('/', "abc")
+      end
+
       describe "file requests" do
 
         before(:each) do

data/spec/acceptance/shared/stubbing_requests.rb

@@ -155,6 +155,24 @@ shared_examples_for "stubbing requests" do |*adapter_info|
               body: 'c[d][]=f&a=1&c[d][]=e')
             }.to raise_error(WebMock::NetConnectNotAllowedError, %r(Real HTTP connections are disabled. Unregistered request: POST http://www.example.com/ with body 'c\[d\]\[\]=f&a=1&c\[d\]\[\]=e'))
           end
+
+          describe "for request with form url encoded body and content type" do
+            it "should match if stubbed request body hash has string values matching string values in request body" do
+              WebMock.reset!
+              stub_request(:post, "www.example.com").with(body: {"foo" => '1'})
+              expect(http_request(
+                :post, "http://www.example.com/", headers: {'Content-Type' => 'application/x-www-form-urlencoded'},
+              body: "foo=1").status).to eq("200")
+            end
+
+            it "should match if stubbed request body hash has NON string values matching string values in request body" do
+              WebMock.reset!
+              stub_request(:post, "www.example.com").with(body: {"foo" => 1})
+              expect(http_request(
+                :post, "http://www.example.com/", headers: {'Content-Type' => 'application/x-www-form-urlencoded'},
+              body: "foo=1").status).to eq("200")
+            end
+          end
         end
 
 
@@ -187,6 +205,30 @@ shared_examples_for "stubbing requests" do |*adapter_info|
               :post, "http://www.example.com/", headers: {'Content-Type' => 'application/json'},
             body: "{\"foo\":\"a b c\"}").status).to eq("200")
           end
+
+          it "should match if stubbed request body hash has NON string values matching NON string values in request body" do
+            WebMock.reset!
+            stub_request(:post, "www.example.com").with(body: {"foo" => 1})
+            expect(http_request(
+              :post, "http://www.example.com/", headers: {'Content-Type' => 'application/json'},
+            body: "{\"foo\":1}").status).to eq("200")
+          end
+
+          it "should not match if stubbed request body hash has string values matching NON string values in request body" do
+            WebMock.reset!
+            stub_request(:post, "www.example.com").with(body: {"foo" => '1'})
+            expect{http_request(
+              :post, "http://www.example.com/", headers: {'Content-Type' => 'application/json'},
+            body: "{\"foo\":1}") }.to raise_error(WebMock::NetConnectNotAllowedError)
+          end
+
+          it "should not match if stubbed request body hash has NON string values matching string values in request body" do
+            WebMock.reset!
+            stub_request(:post, "www.example.com").with(body: {"foo" => 1})
+            expect{http_request(
+              :post, "http://www.example.com/", headers: {'Content-Type' => 'application/json'},
+            body: "{\"foo\":\"1\"}") }.to raise_error(WebMock::NetConnectNotAllowedError)
+          end
         end
 
         describe "for request with xml body and content type is set to xml" do

data/spec/unit/stub_request_snippet_spec.rb

@@ -34,7 +34,7 @@ describe WebMock::StubRequestSnippet do
       it "should print stub request snippet with headers if any" do
         @request_signature.headers = {'B' => 'b', 'A' => 'a'}
         expected = 'stub_request(:get, "http://www.example.com/?a=b&c=d").'+
-        "\n  with(  headers: {\n\t\  'A\'=>\'a\',\n\t  \'B\'=>\'b\'\n    })." +
+        "\n  with(\n    headers: {\n\t\  'A\'=>\'a\',\n\t  \'B\'=>\'b\'\n    })." +
         "\n  to_return(status: 200, body: \"\", headers: {})"
         @request_stub = WebMock::RequestStub.from_request_signature(@request_signature)
         expect(WebMock::StubRequestSnippet.new(@request_stub).to_s).to eq(expected)
@@ -94,8 +94,22 @@ stub_request(:post, "http://www.example.com/").
         STUB
         expect(WebMock::StubRequestSnippet.new(@request_stub).to_s).to eq(expected.strip)
       end
-    end
 
+      it "should print stub request snippet with valid JSON body when request header contains 'Accept'=>'application/json' " do
+        @request_signature = WebMock::RequestSignature.new(:post, "www.example.com",
+                   headers: {'Accept' => 'application/json'})
+        @request_stub = WebMock::RequestStub.from_request_signature(@request_signature)
+        expected = <<-STUB
+stub_request(:post, "http://www.example.com/").
+  with(
+    headers: {
+\t  'Accept'=>'application/json'
+    }).
+  to_return(status: 200, body: \"{}\", headers: {})
+        STUB
+        expect(WebMock::StubRequestSnippet.new(@request_stub).to_s).to eq(expected.strip)
+      end
+    end
 
   end
 end

data/spec/unit/util/query_mapper_spec.rb

@@ -70,6 +70,12 @@ describe WebMock::Util::QueryMapper do
       hsh = subject.query_to_values(query)
       expect(hsh['a']).to eq('foo')
     end
+
+    it "should parse hash query with key starting with non word character" do
+      query = "a[$in]=1".freeze
+      hsh = subject.query_to_values(query)
+      expect(hsh).to eql({'a' => {'$in' => '1'}})
+    end
   end
 
   context '#to_query' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webmock
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Bartosz Blimke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-18 00:00:00.000000000 Z
+date: 2018-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -305,6 +305,7 @@ files:
 - lib/webmock/util/json.rb
 - lib/webmock/util/query_mapper.rb
 - lib/webmock/util/uri.rb
+- lib/webmock/util/values_stringifier.rb
 - lib/webmock/util/version_checker.rb
 - lib/webmock/version.rb
 - lib/webmock/webmock.rb
@@ -398,7 +399,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: webmock
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Library for stubbing HTTP requests in Ruby.