net-http-persistent 4.0.1 → 4.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 776350367e44e2bf8c4e4fd84b1fd1c03eca4c785462c3dd58c8f214fc9b74ab
-  data.tar.gz: f79c075c1a091389c030137bdcbcf5ef3079fbb66702a7ebf6ef8e8bfb75146d
+  metadata.gz: 182064ce89718e66d95177021a7005adeb6e1d4299925e90fc6ac2a537dc533d
+  data.tar.gz: ef7588300c587a1f71e49496ed6131acdf3cad110fa6653acab3779f5f01e3ee
 SHA512:
-  metadata.gz: 10ec9cc95f92954730b37ea924ef4eea9491b7fa5f5b913e9dea762e19381a8f9516caa4201aafe33f8028984c0aed429f6d7533d2056375f49558882fcc67dc
-  data.tar.gz: cd107612612cb1f70513bfe858dd75b6d8aeb2a5415b892e1fa98158b126152820c0b7c3b6a4ba2f0b6da42157da230182f49ffd0453c5b9779c6db29f088958
+  metadata.gz: 14c95c55ea8c89616d13917ba1fb9b05253181fd7007cf5aa03ab03c8e9987e8d4dc936b21481bf37f810df5931994ea6e5dc2eb6c259ab6591f2cfa75bff24f
+  data.tar.gz: e7560d360ac6b20b750a19f6b84c7e5f8656e44962fbb8223ae1295e18dea513456df99c268fa06c2909b9c7e1c4e96655b7055432032d1044187ce07a2ba40b

data/Gemfile

@@ -1,15 +1,14 @@
 # -*- ruby -*-
 
-# DO NOT EDIT THIS FILE. Instead, edit Rakefile, and run `rake bundler:gemfile`.
-
 source "https://rubygems.org/"
 
-gem "connection_pool", "~>2.2"
+gemspec
 
-gem "minitest", "~>5.11", :group => [:development, :test]
-gem "hoe-bundler", "~>1.5", :group => [:development, :test]
-gem "hoe-travis", "~>1.4", ">=1.4.1", :group => [:development, :test]
+gem "rake", "~>13.0"
+gem "minitest", "~>5.15", :group => [:development, :test]
 gem "rdoc", ">=4.0", "<7", :group => [:development, :test]
-gem "hoe", "~>3.17", :group => [:development, :test]
+gem "rake-manifest", "~>0.2"
+
+gem 'net-http-pipeline', '~> 1.0' if ENV['CI_MATRIX'] == 'pipeline'
 
 # vim: syntax=ruby

data/History.txt

@@ -1,3 +1,27 @@
+=== 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:
+
+* Fix compatibility with `connection_pool 2.4+`
+
 === 4.0.1 / 2021-01-12
 
 Bug fixes:

data/Manifest.txt

@@ -1,6 +1,5 @@
 .autotest
 .gemtest
-.travis.yml
 Gemfile
 History.txt
 Manifest.txt

data/README.rdoc

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

data/Rakefile

@@ -1,31 +1,25 @@
 # -*- ruby -*-
 
-require 'hoe'
-
-Hoe.plugin :bundler
-Hoe.plugin :git
-Hoe.plugin :minitest
-Hoe.plugin :travis
-
-Hoe.spec 'net-http-persistent' do
-  developer 'Eric Hodel', 'drbrain@segment7.net'
-
-  self.readme_file      = 'README.rdoc'
-  self.extra_rdoc_files += Dir['*.rdoc']
-
-  self.require_ruby_version '>= 2.3'
-
-  license 'MIT'
-
-  rdoc_locations <<
-    'docs-push.seattlerb.org:/data/www/docs.seattlerb.org/net-http-persistent/'
-
-  dependency 'connection_pool',   '~> 2.2'
-  dependency 'minitest',          '~> 5.2', :development
-  dependency 'hoe-bundler',       '~> 1.5', :development
-  dependency 'hoe-travis',        ['~> 1.4', '>= 1.4.1'], :development
-  dependency 'net-http-pipeline', '~> 1.0' if
-    ENV['TRAVIS_MATRIX'] == 'pipeline'
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new
+
+require "rake/manifest"
+
+Rake::Manifest::Task.new do |t|
+  t.patterns = [
+    ".autotest",
+    ".gemtest",
+    ".travis.yml",
+    "Gemfile",
+    "History.txt",
+    "Manifest.txt",
+    "README.rdoc",
+    "Rakefile",
+    "{test,lib}/**/*"
+  ]
 end
 
 # vim: syntax=Ruby

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

@@ -25,6 +25,7 @@ class Net::HTTP::Persistent::Connection # :nodoc:
   ensure
     reset
   end
+  alias_method :close, :finish
 
   def reset
     @last_use = Net::HTTP::Persistent::EPOCH

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

@@ -11,20 +11,32 @@ class Net::HTTP::Persistent::Pool < ConnectionPool # :nodoc:
   end
 
   def checkin net_http_args
-    stack = Thread.current[@key][net_http_args] ||= []
+    if net_http_args.is_a?(Hash) && net_http_args.size == 1 && net_http_args[:force]
+      # ConnectionPool 2.4+ calls `checkin(force: true)` after fork.
+      # When this happens, we should remove all connections from Thread.current
+      if stacks = Thread.current[@key]
+        stacks.each do |http_args, connections|
+          connections.each do |conn|
+            @available.push conn, connection_args: http_args
+          end
+          connections.clear
+        end
+      end
+    else
+      stack = Thread.current[@key][net_http_args] ||= []
 
-    raise ConnectionPool::Error, 'no connections are checked out' if
-      stack.empty?
+      raise ConnectionPool::Error, 'no connections are checked out' if
+        stack.empty?
 
-    conn = stack.pop
+      conn = stack.pop
 
-    if stack.empty?
-      @available.push conn, connection_args: net_http_args
+      if stack.empty?
+        @available.push conn, connection_args: net_http_args
 
-      Thread.current[@key].delete(net_http_args)
-      Thread.current[@key] = nil if Thread.current[@key].empty?
+        Thread.current[@key].delete(net_http_args)
+        Thread.current[@key] = nil if Thread.current[@key].empty?
+      end
     end
-
     nil
   end
 

data/lib/net/http/persistent.rb

@@ -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
 #
@@ -164,7 +167,14 @@ class Net::HTTP::Persistent
   # limits (typically windows).
 
   if Process.const_defined? :RLIMIT_NOFILE
-    DEFAULT_POOL_SIZE = Process.getrlimit(Process::RLIMIT_NOFILE).first / 4
+    open_file_limits = Process.getrlimit(Process::RLIMIT_NOFILE)
+
+    # Under JRuby on Windows Process responds to `getrlimit` but returns something that does not match docs
+    if open_file_limits.respond_to?(:first)
+      DEFAULT_POOL_SIZE = open_file_limits.first / 4
+    else
+      DEFAULT_POOL_SIZE = 256
+    end
   else
     DEFAULT_POOL_SIZE = 256
   end
@@ -172,7 +182,7 @@ class Net::HTTP::Persistent
   ##
   # The version of Net::HTTP::Persistent you are using
 
-  VERSION = '4.0.1'
+  VERSION = '4.0.5'
 
   ##
   # Error class for errors raised by Net::HTTP::Persistent.  Various
@@ -263,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.
   #
@@ -447,6 +462,21 @@ 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
+
   ##
   # Creates a new Net::HTTP::Persistent.
   #
@@ -506,6 +536,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
@@ -567,6 +598,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+
 
@@ -605,13 +651,23 @@ class Net::HTTP::Persistent
 
     return yield connection
   rescue Errno::ECONNREFUSED
-    address = http.proxy_address || http.address
-    port    = http.proxy_port    || http.port
+    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
+    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
@@ -710,7 +766,7 @@ class Net::HTTP::Persistent
   # block is given.  Returns all responses received.
   #
   # See
-  # Net::HTTP::Pipeline[http://docs.seattlerb.org/net-http-pipeline/Net/HTTP/Pipeline.html]
+  # Net::HTTP::Pipeline[https://rdoc.info/gems/net-http-pipeline/Net/HTTP/Pipeline]
   # for further details.
   #
   # Only if <tt>net-http-pipeline</tt> was required before
@@ -963,8 +1019,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
@@ -1006,6 +1064,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
@@ -1073,6 +1135,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.
 
@@ -1085,4 +1156,3 @@ end
 
 require_relative 'persistent/connection'
 require_relative 'persistent/pool'
-

data/test/test_net_http_persistent.rb

@@ -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
@@ -362,6 +373,7 @@ class TestNetHttpPersistent < Minitest::Test
   end
 
   def test_connection_for_finished_ssl
+    skip 'Broken on Windows' if Gem.win_platform?
     skip 'OpenSSL is missing' unless HAVE_OPENSSL
 
     uri = URI.parse 'https://example.com/path'
@@ -555,6 +567,7 @@ class TestNetHttpPersistent < Minitest::Test
   end
 
   def test_connection_for_ssl
+    skip 'Broken on Windows' if Gem.win_platform?
     skip 'OpenSSL is missing' unless HAVE_OPENSSL
 
     uri = URI.parse 'https://example.com/path'
@@ -595,6 +608,7 @@ class TestNetHttpPersistent < Minitest::Test
   end
 
   def test_connection_for_ssl_case
+    skip 'Broken on Windows' if Gem.win_platform?
     skip 'OpenSSL is missing' unless HAVE_OPENSSL
 
     uri = URI.parse 'HTTPS://example.com/path'
@@ -631,6 +645,7 @@ class TestNetHttpPersistent < Minitest::Test
   end
 
   def test_expired_eh
+    skip 'Broken on Windows' if Gem.win_platform?
     c = basic_connection
     c.requests = 0
     c.last_use = Time.now - 11
@@ -976,7 +991,10 @@ class TestNetHttpPersistent < Minitest::Test
     assert_equal 'keep-alive', req['connection']
     assert_equal '30',         req['keep-alive']
 
-    assert_in_delta Time.now, c.last_use
+    # There's some roounding issue on jruby preventing this from passing
+    unless RUBY_PLATFORM == "java"
+      assert_in_delta Time.now, c.last_use
+    end
 
     assert_equal 1, c.requests
   end
@@ -1249,6 +1267,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
@@ -1332,6 +1351,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
 
@@ -1437,5 +1499,14 @@ class TestNetHttpPersistent < Minitest::Test
     assert_equal 1, @http.ssl_generation
   end
 
-end
+  def test_connection_pool_after_fork
+    # ConnectionPool 2.4+ calls `checkin(force: true)` after fork
+    @http.pool.checkin(force: true)
 
+    @http.pool.checkout ['example.com', 80, nil, nil, nil, nil]
+    @http.pool.checkin(force: true)
+    @http.pool.reload do |connection|
+      connection.close
+    end
+  end
+end

data/test/test_net_http_persistent_timed_stack_multi.rb

@@ -57,7 +57,7 @@ class TestNetHttpPersistentTimedStackMulti < Minitest::Test
       @stack.pop timeout: 0
     end
 
-    assert_equal 'Waited 0 sec', e.message
+    assert_match 'Waited 0 sec', e.message
   end
 
   def test_pop_full

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-http-persistent
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.5
 platform: ruby
 authors:
 - Eric Hodel
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-12 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -24,88 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.14'
-- !ruby/object:Gem::Dependency
-  name: hoe-bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: hoe-travis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.1
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
-- !ruby/object:Gem::Dependency
-  name: hoe
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.22'
 description: |-
   Manages persistent connections using Net::HTTP including a thread pool for
   connecting to multiple hosts.
@@ -129,7 +47,6 @@ extra_rdoc_files:
 files:
 - ".autotest"
 - ".gemtest"
-- ".travis.yml"
 - Gemfile
 - History.txt
 - Manifest.txt
@@ -146,7 +63,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/drbrain/net-http-persistent
-post_install_message:
+post_install_message: 
 rdoc_options:
 - "--main"
 - README.rdoc
@@ -156,15 +73,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Manages persistent connections using Net::HTTP including a thread pool for
   connecting to multiple hosts

data/.travis.yml

@@ -1,23 +0,0 @@
----
-after_script:
-- rake travis:after -t
-before_script:
-- gem install hoe-travis --no-document
-- rake travis:before -t
-language: ruby
-notifications:
-  email:
-  - drbrain@segment7.net
-rvm:
-- 2.3
-- 2.4
-- 2.5
-- 2.6
-- 2.7
-script: rake travis
-install: "" # avoid running default bundler install
-
-matrix:
-  include:
-  - rvm: "2.7"
-    env: TRAVIS_MATRIX=pipeline