webmock 3.15.2 → 3.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16b4c7cbd605852940cec98061211c0e61be7fe3508def1800076febade08cdd
-  data.tar.gz: 43a33f7993589931deea7860b11c4562a0c76ac9a0dda8cba3bc320c796e36ce
+  metadata.gz: 263012f9e44fcac8ea946df8447eab008528eb83677b83a63ba4558c9f66fbf7
+  data.tar.gz: d5dbeaaba04501fbeeac6a10a95d8d5c9eca1824fec719d26b2ea769630bbce7
 SHA512:
-  metadata.gz: a6d5f9bc87ef66d6700b9b989ea3c30cadd74e62cd67ef9477ab581cbfcc21444d66aa3570b7f9e62949e1be834233c302a887e9a4ae7682009c8f4ccea582c2
-  data.tar.gz: 137e6d7e95d18539d85b1a1aa53f290aaef74f50a08dcbc330e15bbc26446dadab03cae7cef7cb8c8cd586f942ff6e54123ab13b03d919dfb554663e4b74bb29
+  metadata.gz: bbaa6dfb6563bf64a3ddf902977345cac5e909503db5eda9cd4f39a799a81f8f23d740bb113d860596752ad27ac8cd0ee2f1d3a9f91d535d611e7bba1c192547
+  data.tar.gz: 7732c64762933e689c2f5cbe147cc430580be9bfe5cc6b1480ccefdcf683a3849438090070e02f4f9ea5b4bfaa59e8c68028092e305c01147567b04357585211

data/CHANGELOG.md

@@ -1,18 +1,24 @@
 # Changelog
 
-# 3.15.2
+# 3.16.1
 
-  * Minimum required Ruby version is 2.0 again.
+  * Minimum required Ruby version is 2.3
 
-# 3.15.1
+# 3.16.0
 
-  * Minimum required Ruby version is 2.3
+  * 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.0
 
   * fixed async-http adapter on Windows
 
-    Tyanks to [Pavel Rosický](https://github.com/ahorek)
+    Thanks to [Pavel Rosický](https://github.com/ahorek)
 
   * Support for http.rb >= 5.0.2
 
@@ -635,9 +641,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

@@ -550,9 +550,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)
 
@@ -1165,6 +1165,7 @@ People who submitted patches and new features or suggested improvements. Many th
 * Giorgio Gambino
 * Timmitry
 * Michael Fairley
+* Ray Zane
 
 For a full list of contributors you can visit the
 [contributors](https://github.com/bblimke/webmock/contributors) page.

data/lib/webmock/http_lib_adapters/net_http.rb

@@ -98,13 +98,8 @@ module WebMock
               after_request.call(response)
             }
             if started?
-              if WebMock::Config.instance.net_http_connect_on_start
-                super_with_after_request.call
-              else
-                start_with_connect_without_finish {
-                  super_with_after_request.call
-                }
-              end
+              ensure_actual_connection
+              super_with_after_request.call
             else
               start_with_connect {
                 super_with_after_request.call
@@ -119,32 +114,29 @@ module WebMock
           raise IOError, 'HTTP session already opened' if @started
           if block_given?
             begin
+              @socket = Net::HTTP.socket_type.new
               @started = true
               return yield(self)
             ensure
               do_finish
             end
           end
+          @socket = Net::HTTP.socket_type.new
           @started = true
           self
         end
 
 
-        def start_with_connect_without_finish  # :yield: http
-          if block_given?
-            begin
-              do_start
-              return yield(self)
-            end
-          end
-          do_start
-          self
+        def ensure_actual_connection
+          do_start if @socket.is_a?(StubSocket)
         end
 
         alias_method :start_with_connect, :start
 
         def start(&block)
-          if WebMock::Config.instance.net_http_connect_on_start
+          uri = Addressable::URI.parse(WebMock::NetHTTPUtility.get_uri(self))
+
+          if WebMock.net_http_connect_on_start?(uri)
             super(&block)
           else
             start_without_connect(&block)
@@ -258,6 +250,7 @@ class StubSocket #:nodoc:
 
   class StubIO
     def setsockopt(*args); end
+    def peer_cert; end
   end
 end
 
@@ -341,7 +334,7 @@ module WebMock
       WebMock::RequestSignature.new(method, uri, body: request.body, headers: headers)
     end
 
-    def self.get_uri(net_http, path)
+    def self.get_uri(net_http, path = nil)
       protocol = net_http.use_ssl? ? "https" : "http"
 
       hostname = net_http.address

data/lib/webmock/request_signature.rb

@@ -35,11 +35,11 @@ module WebMock
     alias == eql?
 
     def url_encoded?
-      !!(headers && headers.fetch('Content-Type', "").start_with?('application/x-www-form-urlencoded'))
+      !!(headers&.fetch('Content-Type', nil)&.start_with?('application/x-www-form-urlencoded'))
     end
 
     def json_headers?
-      !!(headers && headers.fetch('Content-Type', "").start_with?('application/json'))
+      !!(headers&.fetch('Content-Type', nil)&.start_with?('application/json'))
     end
 
     private

data/lib/webmock/version.rb

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

data/lib/webmock/webmock.rb

@@ -70,6 +70,16 @@ module WebMock
       Config.instance.allow && net_connect_explicit_allowed?(Config.instance.allow, uri) )
   end
 
+  def self.net_http_connect_on_start?(uri)
+    allowed = Config.instance.net_http_connect_on_start || false
+
+    if [true, false].include?(allowed)
+      allowed
+    else
+      net_connect_explicit_allowed?(allowed, uri)
+    end
+  end
+
   def self.net_connect_explicit_allowed?(allowed, uri=nil)
     case allowed
     when Array

data/spec/acceptance/net_http/net_http_shared.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 shared_examples_for "Net::HTTP" do
   describe "when making real requests", net_connect: true do
     let(:port){ WebMockServer.instance.port }
@@ -26,21 +28,56 @@ shared_examples_for "Net::HTTP" do
 
     it "should connect only once when connected on start", net_connect: true do
       @http = Net::HTTP.new('localhost', port)
-      socket_id_before_request = socket_id_after_request = nil
+      socket_before_request = socket_after_request = nil
       @http.start {|conn|
-        socket_id_before_request = conn.instance_variable_get(:@socket).object_id
+        socket_before_request = conn.instance_variable_get(:@socket)
         conn.request(Net::HTTP::Get.new("/"))
-        socket_id_after_request = conn.instance_variable_get(:@socket).object_id
+        socket_after_request = conn.instance_variable_get(:@socket)
       }
 
-      if !defined?(WebMock::Config) || WebMock::Config.instance.net_http_connect_on_start
-        expect(socket_id_before_request).not_to eq(nil.object_id)
-        expect(socket_id_after_request).not_to eq(nil.object_id)
-        expect(socket_id_after_request).to eq(socket_id_before_request)
+      if !defined?(WebMock::NetHTTPUtility) || WebMock::Config.instance.net_http_connect_on_start
+        expect(socket_before_request).to be_a(Net::BufferedIO)
+        expect(socket_after_request).to be_a(Net::BufferedIO)
+        expect(socket_after_request).to be(socket_before_request)
+      else
+        expect(socket_before_request).to be_a(StubSocket)
+        expect(socket_after_request).to be_a(Net::BufferedIO)
+      end
+    end
+
+    it "should allow sending multiple requests when persisted", net_connect: true do
+      @http = Net::HTTP.new('example.org')
+      @http.start
+      expect(@http.get("/")).to be_a(Net::HTTPSuccess)
+      expect(@http.get("/")).to be_a(Net::HTTPSuccess)
+      expect(@http.get("/")).to be_a(Net::HTTPSuccess)
+      @http.finish
+    end
+
+    it "should not leak file descriptors", net_connect: true do
+      sockets = Set.new
+
+      @http = Net::HTTP.new('example.org')
+      @http.start
+      sockets << @http.instance_variable_get(:@socket)
+      @http.get("/")
+      sockets << @http.instance_variable_get(:@socket)
+      @http.get("/")
+      sockets << @http.instance_variable_get(:@socket)
+      @http.get("/")
+      sockets << @http.instance_variable_get(:@socket)
+      @http.finish
+
+      if !defined?(WebMock::NetHTTPUtility) || WebMock.net_http_connect_on_start?(Addressable::URI.parse("http://example.com/"))
+        expect(sockets.length).to eq(1)
+        expect(sockets.to_a[0]).to be_a(Net::BufferedIO)
       else
-        expect(socket_id_before_request).to eq(nil.object_id)
-        expect(socket_id_after_request).not_to eq(nil.object_id)
+        expect(sockets.length).to eq(2)
+        expect(sockets.to_a[0]).to be_a(StubSocket)
+        expect(sockets.to_a[1]).to be_a(Net::BufferedIO)
       end
+
+      expect(sockets.all?(&:closed?)).to be(true)
     end
 
     it "should pass the read_timeout value on", net_connect: true do

data/spec/acceptance/net_http/net_http_spec.rb

@@ -254,6 +254,21 @@ describe "Net:HTTP" do
         }
       end
 
+      it "should connect to the server on start when allowlisted", net_connect: true do
+        WebMock.disable_net_connect!(allow: "www.google.com", net_http_connect_on_start: "www.google.com")
+        @http.start {|conn|
+          cert = OpenSSL::X509::Certificate.new conn.peer_cert
+          expect(cert).to be_a(OpenSSL::X509::Certificate)
+        }
+      end
+
+      it "should not connect to the server on start when not allowlisted", net_connect: true do
+        WebMock.disable_net_connect!(allow: "www.google.com", net_http_connect_on_start: "www.yahoo.com")
+        @http.start {|conn|
+          expect(conn.peer_cert).to be_nil
+        }
+      end
+
       it "should connect to the server if the URI matches an regex", net_connect: true do
         WebMock.disable_net_connect!(allow: /google.com/)
         Net::HTTP.get('www.google.com','/')
@@ -282,6 +297,13 @@ describe "Net:HTTP" do
     it_should_behave_like "Net::HTTP"
   end
 
+  describe "when net_http_connect_on_start is a specific host" do
+    before(:each) do
+      WebMock.allow_net_connect!(net_http_connect_on_start: "localhost")
+    end
+    it_should_behave_like "Net::HTTP"
+  end
+
   describe 'after_request callback support', net_connect: true do
     let(:expected_body_regex) { /hello world/ }
 
@@ -365,5 +387,10 @@ describe "Net:HTTP" do
       path = '/example.jpg'
       expect(WebMock::NetHTTPUtility.get_uri(net_http, path)).to eq('http://www.example.com:80/example.jpg')
     end
+
+    it "does not require a path" do
+      net_http = Net::HTTP.new('www.example.com', 80)
+      expect(WebMock::NetHTTPUtility.get_uri(net_http)).to eq('http://www.example.com:80')
+    end
   end
 end

data/spec/acceptance/net_http/real_net_http_spec.rb

@@ -17,4 +17,4 @@ describe "Real Net:HTTP without webmock", without_webmock: true do
   end
 
   it_should_behave_like "Net::HTTP"
-end
+end

data/spec/unit/webmock_spec.rb

@@ -57,4 +57,58 @@ describe "WebMock" do
       end
     end
   end
+
+  describe ".net_http_connect_on_start?" do
+    let(:uri) { Addressable::URI.parse("http://example.org:5432") }
+
+    it "will not connect on start when false" do
+      WebMock.disable_net_connect!
+      expect(WebMock.net_http_connect_on_start?(uri)).to be(false)
+    end
+
+    it "will connect on start when true" do
+      WebMock.disable_net_connect!(net_http_connect_on_start: true)
+      expect(WebMock.net_http_connect_on_start?(uri)).to be(true)
+    end
+
+    it "will connect on start when regexp matches" do
+      WebMock.disable_net_connect!(net_http_connect_on_start: /example/)
+      expect(WebMock.net_http_connect_on_start?(uri)).to be(true)
+    end
+
+    it "will not connect on start when regexp does not match" do
+      WebMock.disable_net_connect!(net_http_connect_on_start: /nope/)
+      expect(WebMock.net_http_connect_on_start?(uri)).to be(false)
+    end
+
+    it "will connect on start when host matches" do
+      WebMock.disable_net_connect!(net_http_connect_on_start: "example.org")
+      expect(WebMock.net_http_connect_on_start?(uri)).to be(true)
+    end
+
+    it "will not connect on start when host does not match" do
+      WebMock.disable_net_connect!(net_http_connect_on_start: "localhost")
+      expect(WebMock.net_http_connect_on_start?(uri)).to be(false)
+    end
+
+    it "will connect on start when host + port matches" do
+      WebMock.disable_net_connect!(net_http_connect_on_start: "example.org:5432")
+      expect(WebMock.net_http_connect_on_start?(uri)).to be(true)
+    end
+
+    it "will not connect on start when host + port does not match" do
+      WebMock.disable_net_connect!(net_http_connect_on_start: "example.org:80")
+      expect(WebMock.net_http_connect_on_start?(uri)).to be(false)
+    end
+
+    it "will connect on start when scheme + host + port matches" do
+      WebMock.disable_net_connect!(net_http_connect_on_start: "http://example.org:5432")
+      expect(WebMock.net_http_connect_on_start?(uri)).to be(true)
+    end
+
+    it "will not connect on start when scheme + host + port does not match" do
+      WebMock.disable_net_connect!(net_http_connect_on_start: "https://example.org:5432")
+      expect(WebMock.net_http_connect_on_start?(uri)).to be(false)
+    end
+  end
 end

data/webmock.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
     'wiki_uri'          => 'https://github.com/bblimke/webmock/wiki'
   }
 
-  s.required_ruby_version = '>= 2.0'
+  s.required_ruby_version = '>= 2.3'
 
   s.add_dependency 'addressable', '>= 2.8.0'
   s.add_dependency 'crack', '>= 0.3.2'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webmock
 version: !ruby/object:Gem::Version
-  version: 3.15.2
+  version: 3.16.1
 platform: ruby
 authors:
 - Bartosz Blimke
@@ -421,9 +421,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/bblimke/webmock/issues
-  changelog_uri: https://github.com/bblimke/webmock/blob/v3.15.2/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/webmock/3.15.2
-  source_code_uri: https://github.com/bblimke/webmock/tree/v3.15.2
+  changelog_uri: https://github.com/bblimke/webmock/blob/v3.16.1/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/webmock/3.16.1
+  source_code_uri: https://github.com/bblimke/webmock/tree/v3.16.1
   wiki_uri: https://github.com/bblimke/webmock/wiki
 post_install_message:
 rdoc_options: []
@@ -433,7 +433,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="