net-http-persistent 4.0.2 → 4.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9123e98741595dbcc1c9a9713ecdcfb517597dc52791dc546bd868c31cbe88d0
-  data.tar.gz: 462f4ae1dd63c8776ac18e3eab2b8e4c43e65d906722086a670d5ae3b764eb2b
+  metadata.gz: 3e1c40dff68b8e70cac3630ca6b19ff70679fe7462974c835bb8638ab2b5dd5b
+  data.tar.gz: 95185bc4624e14eaae5b31e65a7b8e474a07f621020a5096966ccfec200bf6f7
 SHA512:
-  metadata.gz: 45e3ea77d23e8c9829bba490c61546b71a221194cf8106bbb32ad746408283df04923649aef952d7317f06475a0a5466b19376c7a38e8b62490d65f24b6031cf
-  data.tar.gz: e46564075c2d655e258c5fd9ff3c45843b48c5bd6d8c5f80fe84450a36e7ac5811d0f97b5e8223277c2b607e7259df70e1e331c372e12a4bd33efec0e555e743
+  metadata.gz: 32089ec62a29518f3d6b1e9f1a1a677b65b1cc3b937506a9e3f985455f8c924b0c37c80516e9adc23420f8d25932607c4975cc042ec217bbd5bed2c626c2a57b
+  data.tar.gz: 28fc74bc92b2f63f752dfc8a2e86971f76b3cb064fe3647949005f9f1d7fa41d48d26122dd6f4c9d137d5255cd1b3dedc09ed779c937d12597fb9baba6c325e7

data/History.txt

@@ -1,3 +1,27 @@
+=== 4.0.6 / 2024-12-04
+
+Bug fixes:
+
+* Allow ConnectionPool exceptions from checkout to bubble up to caller.
+
+=== 4.0.5 / 2024-12-04
+
+Bug fixes:
+
+* Allow setting extra_chain_cert=
+
+=== 4.0.4 / 2024-09-09
+
+Bug fixes:
+
+* Allow setting verify_hostname to false
+
+=== 4.0.3 / 2024-09-09
+
+Bug fixes:
+
+* Handle Net::HTTP#verify_hostname was added in Ruby 3.0 or later. #120
+
 === 4.0.2 / 2023-03-29
 
 Bug fixes:

data/README.rdoc

@@ -1,7 +1,7 @@
 = net-http-persistent
 
 home :: https://github.com/drbrain/net-http-persistent
-rdoc :: https://rdoc.info/gems/net-http-persistent
+rdoc :: https://rubydoc.info/gems/net-http-persistent
 
 == DESCRIPTION:
 

data/lib/net/http/persistent/pool.rb

@@ -4,7 +4,7 @@ class Net::HTTP::Persistent::Pool < ConnectionPool # :nodoc:
   attr_reader :key # :nodoc:
 
   def initialize(options = {}, &block)
-    super
+    super(**options, &block)
 
     @available = Net::HTTP::Persistent::TimedStackMulti.new(@size, &block)
     @key = "current-#{@available.object_id}"

data/lib/net/http/persistent/timed_stack_multi.rb

@@ -1,5 +1,10 @@
 class Net::HTTP::Persistent::TimedStackMulti < ConnectionPool::TimedStack # :nodoc:
 
+  ##
+  # Detects if ConnectionPool 3.0+ is being used (needed for TimedStack subclass compatibility)
+
+  CP_USES_KEYWORD_ARGS = Gem::Version.new(ConnectionPool::VERSION) >= Gem::Version.new('3.0.0') # :nodoc:
+
   ##
   # Returns a new hash that has arrays for keys
   #
@@ -11,7 +16,11 @@ class Net::HTTP::Persistent::TimedStackMulti < ConnectionPool::TimedStack # :nod
   end
 
   def initialize(size = 0, &block)
-    super
+    if CP_USES_KEYWORD_ARGS
+      super(size: size, &block)
+    else
+      super(size, &block)
+    end
 
     @enqueued = 0
     @ques = self.class.hash_of_arrays
@@ -63,7 +72,8 @@ class Net::HTTP::Persistent::TimedStackMulti < ConnectionPool::TimedStack # :nod
     if @created >= @max && @enqueued >= 1
       oldest, = @lru.first
       @lru.delete oldest
-      @ques[oldest].pop
+      connection = @ques[oldest].pop
+      connection.close if connection.respond_to?(:close)
 
       @created -= 1
     end

data/lib/net/http/persistent.rb

@@ -1,6 +1,7 @@
 require 'net/http'
 require 'uri'
-require 'cgi' # for escaping
+require 'cgi/escape'
+require 'cgi/util' unless defined?(CGI::EscapeExt)
 require 'connection_pool'
 
 begin
@@ -47,9 +48,8 @@ autoload :OpenSSL, 'openssl'
 #   # perform the POST, the URI is always required
 #   response http.request post_uri, post
 #
-# Note that for GET, HEAD and other requests that do not have a body you want
-# to use URI#request_uri not URI#path.  The request_uri contains the query
-# params which are sent in the body for other requests.
+# ⚠ Note that for GET, HEAD and other requests that do not have a body,
+# it uses URI#request_uri as default to send query params
 #
 # == TLS/SSL
 #
@@ -65,6 +65,7 @@ autoload :OpenSSL, 'openssl'
 # #ca_path            :: Directory with certificate-authorities
 # #cert_store         :: An SSL certificate store
 # #ciphers            :: List of SSl ciphers allowed
+# #extra_chain_cert   :: Extra certificates to be added to the certificate chain
 # #private_key        :: The client's SSL private key
 # #reuse_ssl_sessions :: Reuse a previously opened SSL session for a new
 #                        connection
@@ -73,6 +74,8 @@ autoload :OpenSSL, 'openssl'
 # #verify_callback    :: For server certificate verification
 # #verify_depth       :: Depth of certificate verification
 # #verify_mode        :: How connections should be verified
+# #verify_hostname    :: Use hostname verification for server certificate
+#                        during the handshake
 #
 # == Proxies
 #
@@ -179,7 +182,7 @@ class Net::HTTP::Persistent
   ##
   # The version of Net::HTTP::Persistent you are using
 
-  VERSION = '4.0.2'
+  VERSION = '4.0.8'
 
   ##
   # Error class for errors raised by Net::HTTP::Persistent.  Various
@@ -270,6 +273,11 @@ class Net::HTTP::Persistent
 
   attr_reader :ciphers
 
+  ##
+  # Extra certificates to be added to the certificate chain
+
+  attr_reader :extra_chain_cert
+
   ##
   # Sends debug_output to this IO via Net::HTTP#set_debug_output.
   #
@@ -454,6 +462,28 @@ class Net::HTTP::Persistent
 
   attr_reader :verify_mode
 
+  ##
+  # HTTPS verify_hostname.
+  #
+  # If a client sets this to true and enables SNI with SSLSocket#hostname=,
+  # the hostname verification on the server certificate is performed
+  # automatically during the handshake using
+  # OpenSSL::SSL.verify_certificate_identity().
+  #
+  # You can set +verify_hostname+ as true to use hostname verification
+  # during the handshake.
+  #
+  # NOTE: This works with Ruby > 3.0.
+
+  attr_reader :verify_hostname
+
+
+  ##
+  #  Sets whether to ignore end-of-file when reading a response body
+  #  with Content-Length headers.
+
+  attr_accessor :ignore_eof
+
   ##
   # Creates a new Net::HTTP::Persistent.
   #
@@ -493,6 +523,7 @@ class Net::HTTP::Persistent
     @max_retries      = 1
     @socket_options   = []
     @ssl_generation   = 0 # incremented when SSL session variables change
+    @ignore_eof       = nil
 
     @socket_options << [Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1] if
       Socket.const_defined? :TCP_NODELAY
@@ -513,6 +544,7 @@ class Net::HTTP::Persistent
     @verify_callback    = nil
     @verify_depth       = nil
     @verify_mode        = nil
+    @verify_hostname    = nil
     @cert_store         = nil
 
     @generation         = 0 # incremented when proxy URI changes
@@ -574,6 +606,21 @@ class Net::HTTP::Persistent
     reconnect_ssl
   end
 
+  if Net::HTTP.method_defined?(:extra_chain_cert=)
+    ##
+    # Extra certificates to be added to the certificate chain.
+    # It is only supported starting from Net::HTTP version 0.1.1
+    def extra_chain_cert= extra_chain_cert
+      @extra_chain_cert = extra_chain_cert
+
+      reconnect_ssl
+    end
+  else
+    def extra_chain_cert= _extra_chain_cert
+      raise "extra_chain_cert= is not supported by this version of Net::HTTP"
+    end
+  end
+
   ##
   # Creates a new connection for +uri+
 
@@ -592,37 +639,50 @@ class Net::HTTP::Persistent
 
     connection = @pool.checkout net_http_args
 
-    http = connection.http
-
-    connection.ressl @ssl_generation if
-      connection.ssl_generation != @ssl_generation
+    begin
+      http = connection.http
 
-    if not http.started? then
-      ssl   http if use_ssl
-      start http
-    elsif expired? connection then
-      reset connection
-    end
+      connection.ressl @ssl_generation if
+        connection.ssl_generation != @ssl_generation
 
-    http.keep_alive_timeout = @idle_timeout  if @idle_timeout
-    http.max_retries        = @max_retries   if http.respond_to?(:max_retries=)
-    http.read_timeout       = @read_timeout  if @read_timeout
-    http.write_timeout      = @write_timeout if
-      @write_timeout && http.respond_to?(:write_timeout=)
+      if not http.started? then
+        ssl   http if use_ssl
+        start http
+      elsif expired? connection then
+        reset connection
+      end
 
-    return yield connection
-  rescue Errno::ECONNREFUSED
-    address = http.proxy_address || http.address
-    port    = http.proxy_port    || http.port
+      http.ignore_eof         = @ignore_eof    if @ignore_eof
+      http.keep_alive_timeout = @idle_timeout  if @idle_timeout
+      http.max_retries        = @max_retries   if http.respond_to?(:max_retries=)
+      http.read_timeout       = @read_timeout  if @read_timeout
+      http.write_timeout      = @write_timeout if
+        @write_timeout && http.respond_to?(:write_timeout=)
+
+      return yield connection
+    rescue Errno::ECONNREFUSED
+      if http.proxy?
+        address = http.proxy_address
+        port    = http.proxy_port
+      else
+        address = http.address
+        port    = http.port
+      end
 
-    raise Error, "connection refused: #{address}:#{port}"
-  rescue Errno::EHOSTDOWN
-    address = http.proxy_address || http.address
-    port    = http.proxy_port    || http.port
+      raise Error, "connection refused: #{address}:#{port}"
+    rescue Errno::EHOSTDOWN
+      if http.proxy?
+        address = http.proxy_address
+        port    = http.proxy_port
+      else
+        address = http.address
+        port    = http.port
+      end
 
-    raise Error, "host down: #{address}:#{port}"
-  ensure
-    @pool.checkin net_http_args
+      raise Error, "host down: #{address}:#{port}"
+    ensure
+      @pool.checkin net_http_args
+    end
   end
 
   ##
@@ -776,7 +836,7 @@ class Net::HTTP::Persistent
       @proxy_connection_id = [nil, *@proxy_args].join ':'
 
       if @proxy_uri.query then
-        @no_proxy = CGI.parse(@proxy_uri.query)['no_proxy'].join(',').downcase.split(',').map { |x| x.strip }.reject { |x| x.empty? }
+        @no_proxy = URI.decode_www_form(@proxy_uri.query).filter_map { |k, v| v if k == 'no_proxy' }.join(',').downcase.split(',').map { |x| x.strip }.reject { |x| x.empty? }
       end
     end
 
@@ -947,7 +1007,8 @@ class Net::HTTP::Persistent
   end
 
   ##
-  # Shuts down all connections
+  # Shuts down all connections. Attempting to checkout a connection after
+  # shutdown will raise an error.
   #
   # *NOTE*: Calling shutdown for can be dangerous!
   #
@@ -958,6 +1019,17 @@ class Net::HTTP::Persistent
     @pool.shutdown { |http| http.finish }
   end
 
+  ##
+  # Discard all existing connections. Subsequent checkouts will create
+  # new connections as needed.
+  #
+  # If any thread is still using a connection it may cause an error!  Call
+  # #reload when you are completely done making requests!
+
+  def reload
+    @pool.reload { |http| http.finish }
+  end
+
   ##
   # Enables SSL on +connection+
 
@@ -970,8 +1042,10 @@ class Net::HTTP::Persistent
     connection.min_version = @min_version if @min_version
     connection.max_version = @max_version if @max_version
 
-    connection.verify_depth = @verify_depth
-    connection.verify_mode  = @verify_mode
+    connection.verify_depth    = @verify_depth
+    connection.verify_mode     = @verify_mode
+    connection.verify_hostname = @verify_hostname if
+      @verify_hostname != nil && connection.respond_to?(:verify_hostname=)
 
     if OpenSSL::SSL::VERIFY_PEER == OpenSSL::SSL::VERIFY_NONE and
        not Object.const_defined?(:I_KNOW_THAT_OPENSSL_VERIFY_PEER_EQUALS_VERIFY_NONE_IS_WRONG) then
@@ -1013,6 +1087,10 @@ application:
       connection.key  = @private_key
     end
 
+    if defined?(@extra_chain_cert) and @extra_chain_cert
+      connection.extra_chain_cert = @extra_chain_cert
+    end
+
     connection.cert_store = if @cert_store then
                               @cert_store
                             else
@@ -1080,6 +1158,15 @@ application:
     reconnect_ssl
   end
 
+  ##
+  # Sets the HTTPS verify_hostname.
+
+  def verify_hostname= verify_hostname
+    @verify_hostname = verify_hostname
+
+    reconnect_ssl
+  end
+
   ##
   # SSL verification callback.
 
@@ -1092,4 +1179,3 @@ end
 
 require_relative 'persistent/connection'
 require_relative 'persistent/pool'
-

data/test/test_net_http_persistent.rb

@@ -80,7 +80,7 @@ class TestNetHttpPersistent < Minitest::Test
                   :read_timeout, :open_timeout, :keep_alive_timeout
     attr_accessor :ciphers, :ssl_timeout, :ssl_version, :min_version,
                   :max_version, :verify_depth, :verify_mode, :cert_store,
-                  :ca_file, :ca_path, :cert, :key
+                  :ca_file, :ca_path, :cert, :key, :ignore_eof
     attr_reader :req, :debug_output
     def initialize
       @started, @finished = 0, 0
@@ -116,6 +116,9 @@ class TestNetHttpPersistent < Minitest::Test
     end
     def proxy_port
     end
+    def proxy?
+      false
+    end
   end
 
   def basic_connection
@@ -244,6 +247,14 @@ class TestNetHttpPersistent < Minitest::Test
     assert_equal 1, @http.ssl_generation
   end
 
+  def test_extra_chain_cert_equals
+    skip 'extra_chain_cert is not supported by Net::HTTP' unless Net::HTTP.method_defined?(:extra_chain_cert)
+    @http.extra_chain_cert = :extra_chain_cert
+
+    assert_equal :extra_chain_cert, @http.extra_chain_cert
+    assert_equal 1, @http.ssl_generation
+  end
+
   def test_connection_for
     @http.open_timeout = 123
     @http.read_timeout = 321
@@ -269,6 +280,16 @@ class TestNetHttpPersistent < Minitest::Test
     assert_same used, stored
   end
 
+  def test_connection_for_exhaustion
+    @http = Net::HTTP::Persistent.new pool_size: 0
+
+    assert_raises Timeout::Error do
+      @http.connection_for @uri do |c|
+        assert_same nil, c
+      end
+    end
+  end
+
   def test_connection_for_cached
     cached = basic_connection
     cached.http.start
@@ -982,7 +1003,7 @@ class TestNetHttpPersistent < Minitest::Test
 
     # There's some roounding issue on jruby preventing this from passing
     unless RUBY_PLATFORM == "java"
-      assert_in_delta Time.now, c.last_use
+      assert_in_delta Time.now, c.last_use, 0.003
     end
 
     assert_equal 1, c.requests
@@ -1244,6 +1265,17 @@ class TestNetHttpPersistent < Minitest::Test
     refute c2.http.finished?, 'present generation connection must not be finished'
   end
 
+  def test_reload
+    c = connection
+
+    @http.reload
+
+    c2 = connection
+
+    assert c.http.finished?, 'last-generation connection must be finished'
+    refute c2.http.finished?, 'present generation connection must not be finished'
+  end
+
   def test_ssl
     skip 'OpenSSL is missing' unless HAVE_OPENSSL
 
@@ -1256,6 +1288,7 @@ class TestNetHttpPersistent < Minitest::Test
     assert_equal OpenSSL::SSL::VERIFY_PEER, c.verify_mode
     assert_kind_of OpenSSL::X509::Store,    c.cert_store
     assert_nil c.verify_callback
+    assert_nil c.verify_hostname if c.respond_to?(:verify_hostname)
   end
 
   def test_ssl_ca_file
@@ -1339,6 +1372,49 @@ class TestNetHttpPersistent < Minitest::Test
     assert_equal OpenSSL::SSL::VERIFY_NONE, c.verify_mode
   end
 
+  def test_ssl_enable_verify_hostname
+    skip 'OpenSSL is missing' unless HAVE_OPENSSL
+
+    @http.verify_hostname = true
+    c = Net::HTTP.new 'localhost', 80
+
+    skip 'net/http doesn\'t provide verify_hostname= method' unless
+      c.respond_to?(:verify_hostname=)
+
+    @http.ssl c
+
+    assert c.use_ssl?
+    assert c.verify_hostname
+  end
+
+  def test_ssl_disable_verify_hostname
+    skip 'OpenSSL is missing' unless HAVE_OPENSSL
+
+    @http.verify_hostname = false
+    c = Net::HTTP.new 'localhost', 80
+
+    skip 'net/http doesn\'t provide verify_hostname= method' unless
+      c.respond_to?(:verify_hostname=)
+
+    @http.ssl c
+
+    assert c.use_ssl?
+    assert c.verify_hostname == false
+  end
+
+  def test_ssl_extra_chain_cert
+    skip 'OpenSSL is missing' unless HAVE_OPENSSL
+    skip 'extra_chain_cert is not supported by Net::HTTP' unless Net::HTTP.method_defined?(:extra_chain_cert)
+
+    @http.extra_chain_cert = :extra_chain_cert
+    c = Net::HTTP.new 'localhost', 80
+
+    @http.ssl c
+
+    assert c.use_ssl?
+    assert_equal :extra_chain_cert, c.extra_chain_cert
+  end
+
   def test_ssl_warning
     skip 'OpenSSL is missing' unless HAVE_OPENSSL
 
@@ -1454,5 +1530,22 @@ class TestNetHttpPersistent < Minitest::Test
       connection.close
     end
   end
-end
 
+  def test_ignore_eof
+    @http.ignore_eof = true
+
+    connection
+
+    @http.connection_for @uri do |c|
+      assert c.http.ignore_eof
+    end
+
+    @http.ignore_eof = false
+
+    connection
+
+    @http.connection_for @uri do |c|
+      assert !c.http.ignore_eof
+    end
+  end
+end

data/test/test_net_http_persistent_timed_stack_multi.rb

@@ -4,10 +4,15 @@ require 'net/http/persistent'
 class TestNetHttpPersistentTimedStackMulti < Minitest::Test
 
   class Connection
-    attr_reader :host
+    attr_reader :host, :closed
 
     def initialize(host)
       @host = host
+      @closed = false
+    end
+
+    def close
+      @closed = true
     end
   end
 
@@ -24,7 +29,7 @@ class TestNetHttpPersistentTimedStackMulti < Minitest::Test
 
     assert_empty stack
 
-    stack.push connection_args: popped
+    stack.push popped, connection_args: 'default'
 
     refute_empty stack
   end
@@ -38,7 +43,7 @@ class TestNetHttpPersistentTimedStackMulti < Minitest::Test
 
     assert_equal 0, stack.length
 
-    stack.push connection_args: popped
+    stack.push popped, connection_args: 'default'
 
     assert_equal 1, stack.length
   end
@@ -57,7 +62,7 @@ class TestNetHttpPersistentTimedStackMulti < Minitest::Test
       @stack.pop timeout: 0
     end
 
-    assert_match 'Waited 0 sec', e.message
+    assert_includes e.message, 'Waited 0 sec'
   end
 
   def test_pop_full
@@ -69,6 +74,18 @@ class TestNetHttpPersistentTimedStackMulti < Minitest::Test
     assert_empty stack
   end
 
+  def test_pop_closes_extra_connections
+    stack = Net::HTTP::Persistent::TimedStackMulti.new(1) { |host| Connection.new(host) }
+
+    a_conn = stack.pop connection_args: 'a.example'
+    stack.push a_conn, connection_args: 'a.example'
+
+    b_conn = stack.pop connection_args: 'b.example'
+
+    assert a_conn.closed
+    refute b_conn.closed
+  end
+
   def test_pop_wait
     thread = Thread.start do
       @stack.pop
@@ -96,7 +113,7 @@ class TestNetHttpPersistentTimedStackMulti < Minitest::Test
 
     conn = stack.pop
 
-    stack.push connection_args: conn
+    stack.push conn, connection_args: 'default'
 
     refute_empty stack
   end
@@ -108,14 +125,16 @@ class TestNetHttpPersistentTimedStackMulti < Minitest::Test
       called << object
     end
 
-    @stack.push connection_args: Object.new
+    obj = Object.new
+    @stack.push obj, connection_args: 'default'
 
     refute_empty called
     assert_empty @stack
   end
 
   def test_shutdown
-    @stack.push connection_args: Object.new
+    obj = Object.new
+    @stack.push obj, connection_args: 'default'
 
     called = []
 

metadata

@@ -1,29 +1,34 @@
 --- !ruby/object:Gem::Specification
 name: net-http-persistent
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.8
 platform: ruby
 authors:
 - Eric Hodel
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 2.2.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.4
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '4'
 description: |-
   Manages persistent connections using Net::HTTP including a thread pool for
   connecting to multiple hosts.
@@ -63,7 +68,6 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/drbrain/net-http-persistent
-post_install_message: 
 rdoc_options:
 - "--main"
 - README.rdoc
@@ -80,8 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Manages persistent connections using Net::HTTP including a thread pool for
   connecting to multiple hosts