net-http-persistent 2.9.4 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 21b9c2d72e25672250e7d4544bed635d05a583cd
-  data.tar.gz: 8baa746d3b463cc46282e93e1c95fea48ce34de7
+SHA256:
+  metadata.gz: 9123e98741595dbcc1c9a9713ecdcfb517597dc52791dc546bd868c31cbe88d0
+  data.tar.gz: 462f4ae1dd63c8776ac18e3eab2b8e4c43e65d906722086a670d5ae3b764eb2b
 SHA512:
-  metadata.gz: 34d31b4bb74a92791b8091bec2e098935440b522a22a00cf189a7d48652415a4729496758c30af51ce38cd1c227b3414040cb3396b348dcc355634f5fb1d012d
-  data.tar.gz: 6afc70cd26e21e4d7fbce7d5531543ba55df0da22dd2b4ac5f697b34290f567167afc3a76a98fd7faa351e539f94cf1d2dae0295f0840036d482a6537bd0271f
+  metadata.gz: 45e3ea77d23e8c9829bba490c61546b71a221194cf8106bbb32ad746408283df04923649aef952d7317f06475a0a5466b19376c7a38e8b62490d65f24b6031cf
+  data.tar.gz: e46564075c2d655e258c5fd9ff3c45843b48c5bd6d8c5f80fe84450a36e7ac5811d0f97b5e8223277c2b607e7259df70e1e331c372e12a4bd33efec0e555e743

data/Gemfile

@@ -0,0 +1,14 @@
+# -*- ruby -*-
+
+source "https://rubygems.org/"
+
+gemspec
+
+gem "rake", "~>13.0"
+gem "minitest", "~>5.15", :group => [:development, :test]
+gem "rdoc", ">=4.0", "<7", :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,110 @@
+=== 4.0.2 / 2023-03-29
+
+Bug fixes:
+
+* Fix compatibility with `connection_pool 2.4+`
+
+=== 4.0.1 / 2021-01-12
+
+Bug fixes:
+
+* Loosen Ruby version requirement so Ruby 3.0 will work.
+
+=== 4.0.0 / 2020-04-30
+
+Breaking changes:
+
+* Removed built-in support for retrying failed requests as Net::HTTP has this
+  built-in for all supported versions.  Pull request #100 by Michael Grosser.
+* Dropped support for EoL ruby versions (< 2.4).  Future feature releases may
+  drop support for ruby versions that are at end-of-life or in security-only
+  maintenance mode with any release.  Pull request #113 by David Rodríguez
+
+New features:
+
+* Added Net::HTTP::Persistent#max_retries= to configure the number of retries
+  performed on a request for ruby versions that support it (2.5+).
+* URI-ness is determined through #respond_to? to allow compatibility with
+  Addressable::URI.  Pull request #67 by Ryan McKern.
+* Use require_relative to reduce patch burden for vendored versions.  Pull
+  Request #106 by David Rodríguez
+
+Bug fixes:
+
+* Stop wasting a connection when the keep-alive timeout is less than the idle
+  timeout.  Pull request #115 by Yap Sok Ann.
+* Improved use of URI#hostname for IPv6 connections.  Pull request #76 by
+  Tomas Koutsky.
+* Improved check for Process::RLIMIT_NOFILE support.  Pull request #109 by Vít
+  Ondruch.
+* Fix namespace in comments for escape/unescape wrappers.  Pull request #114
+  by David Rodríguez.
+* Fix History.txt timestamp for 3.0.0 release.  Pull request #107 by Joe Van
+  Dyk.
+* Fix link to PR #98 in 3.1.0 release notes.  Pull request #110 by Justin
+  Reid.
+
+Other:
+
+* Updated Net::HTTP::Persistent#reconnect documentation to indicate that all
+  connections are reset.  Issue #117 by Taisuke Miyazaki.
+
+=== 3.1.0 / 2019-07-24
+
+New features:
+* Support ruby 2.6 Net::HTTP#write_timeout=.  Pull request #99 by Víctor
+  Roldán Betancort.
+* Support setting TLS min/max version.  Pull request #94 by Bart.
+
+Bug fixes:
+* Reduce potential for memory leak through Hash default proc bindings.  Pull
+  request #64 by Dominic Metzger.
+* Test proxy auto detection from no_proxy in ENV.  Pull request #60 by
+  HINOHARA Hiroshi.
+* Add missing timestamp for 3.0 release.  Pull request #78 by Joe Van Dyk.
+* Support IPv6 URLs in proxy checks.  Pull request #82 by Nicolás Sanguinetti.
+* Use Net::HTTPGenericRequest#method to check idempotence for improved
+  compatibility.  Pull request #83 by Fotos Georgiadis.
+* Run net-http-pipeline tests in travis.  Pull request #86 by T.J. Schuck.
+* Correct +no_proxy+ support to override Net::HTTP proxy fallback.  Pull
+  request #88 by Jared Kauppila.
+* Mitigate memory leak when combined with faraday.  Pull request #105 by Yohei
+  Kitamura.
+* Set default connection pool size for Windows.  Pull request #90 by Jared
+  Kauppila.
+* Fix missing +name:+ argument in documentation.  Pull requests #85 by T.J.
+  Schuck, #84 by James White.
+* Fix memory leak from connection pooling.  Pull request #98 by Aaron
+  Patterson.
+* Update tests for minitest assert_equal deprecation.  Pull request #92 by
+  Olle Jonsson.
+* Fix typo in Net::HTTP::Persistent#pipeline.  Pull request #91 by Kazuma
+  Furuhashi.
+
+Other:
+* Added bundler hoe plugin.  Pull request #103 by Michael Grosser.
+* Updated ruby versions in Travis CI.  Pull request #93 by Olle Jonsson.  Pull
+  request #103 by Michael Grosser.
+
+=== 3.0 / 2016-10-05
+
+Breaking changes:
+
+* No longer supports ruby 2.0 and earlier
+* Net::HTTP::Persistent::new now uses keyword arguments for +name+ and
+  +proxy+.
+* Removed #max_age, use #expired?
+
+New features:
+
+* Uses connection_pool to manage all connections for a Net::HTTP::Persistent
+  instance.
+
+Bug fixes:
+
+* Add missing SSL options ca_path, ciphers, ssl_timeout, verify_depth.
+  Issue #63 by Johnneylee Jack Rollins.
+
 === 2.9.4 / 2014-02-10
 
 * Bug fixes

data/Manifest.txt

@@ -1,11 +1,13 @@
 .autotest
 .gemtest
+Gemfile
 History.txt
 Manifest.txt
 README.rdoc
 Rakefile
-lib/net/http/faster.rb
 lib/net/http/persistent.rb
-lib/net/http/persistent/ssl_reuse.rb
+lib/net/http/persistent/connection.rb
+lib/net/http/persistent/pool.rb
+lib/net/http/persistent/timed_stack_multi.rb
 test/test_net_http_persistent.rb
-test/test_net_http_persistent_ssl_reuse.rb
+test/test_net_http_persistent_timed_stack_multi.rb

data/README.rdoc

@@ -1,27 +1,27 @@
 = net-http-persistent
 
-* http://docs.seattlerb.org/net-http-persistent
-* https://github.com/drbrain/net-http-persistent
+home :: https://github.com/drbrain/net-http-persistent
+rdoc :: https://rdoc.info/gems/net-http-persistent
 
 == DESCRIPTION:
 
-Manages persistent connections using Net::HTTP plus a speed fix for Ruby 1.8.
-It's thread-safe too!
+Manages persistent connections using Net::HTTP including a thread pool for
+connecting to multiple hosts.
 
 Using persistent HTTP connections can dramatically increase the speed of HTTP.
 Creating a new HTTP connection for every request involves an extra TCP
 round-trip and causes TCP congestion avoidance negotiation to start over.
 
 Net::HTTP supports persistent connections with some API methods but does not
-handle reconnection gracefully.  Net::HTTP::Persistent supports reconnection
-and retry according to RFC 2616.
+make setting up a single persistent connection or managing multiple
+connections easy.  Net::HTTP::Persistent wraps Net::HTTP and allows you to
+focus on how to make HTTP requests.
 
 == FEATURES/PROBLEMS:
 
-* Supports SSL
+* Supports TLS with secure defaults
 * Thread-safe
 * Pure ruby
-* Timeout-less speed boost for Ruby 1.8 (by Aaron Patterson)
 
 == SYNOPSIS
 
@@ -32,7 +32,7 @@ connection is kept alive between requests:
 
     uri = URI 'http://example.com/awesome/web/service'
 
-    http = Net::HTTP::Persistent.new 'my_app_name'
+    http = Net::HTTP::Persistent.new name: 'my_app_name'
 
     # perform a GET
     response = http.request uri
@@ -60,7 +60,7 @@ including SSL connection verification, header handling and tunable options.
 
 (The MIT License)
 
-Copyright (c) 2010 Eric Hodel, Aaron Patterson
+Copyright (c) Eric Hodel, Aaron Patterson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,24 +1,25 @@
 # -*- ruby -*-
 
-require 'rubygems'
-require 'hoe'
-
-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']
-
-  license 'MIT'
-
-  rdoc_locations <<
-    'docs.seattlerb.org:/data/www/docs.seattlerb.org/net-http-persistent/'
-
-  dependency 'minitest', '~> 5.2', :development
+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

@@ -0,0 +1,41 @@
+##
+# A Net::HTTP connection wrapper that holds extra information for managing the
+# connection's lifetime.
+
+class Net::HTTP::Persistent::Connection # :nodoc:
+
+  attr_accessor :http
+
+  attr_accessor :last_use
+
+  attr_accessor :requests
+
+  attr_accessor :ssl_generation
+
+  def initialize http_class, http_args, ssl_generation
+    @http           = http_class.new(*http_args)
+    @ssl_generation = ssl_generation
+
+    reset
+  end
+
+  def finish
+    @http.finish
+  rescue IOError
+  ensure
+    reset
+  end
+  alias_method :close, :finish
+
+  def reset
+    @last_use = Net::HTTP::Persistent::EPOCH
+    @requests = 0
+  end
+
+  def ressl ssl_generation
+    @ssl_generation = ssl_generation
+
+    finish
+  end
+
+end

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

@@ -0,0 +1,65 @@
+class Net::HTTP::Persistent::Pool < ConnectionPool # :nodoc:
+
+  attr_reader :available # :nodoc:
+  attr_reader :key # :nodoc:
+
+  def initialize(options = {}, &block)
+    super
+
+    @available = Net::HTTP::Persistent::TimedStackMulti.new(@size, &block)
+    @key = "current-#{@available.object_id}"
+  end
+
+  def checkin 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?
+
+      conn = stack.pop
+
+      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?
+      end
+    end
+    nil
+  end
+
+  def checkout net_http_args
+    stacks = Thread.current[@key] ||= {}
+    stack  = stacks[net_http_args] ||= []
+
+    if stack.empty? then
+      conn = @available.pop connection_args: net_http_args
+    else
+      conn = stack.last
+    end
+
+    stack.push conn
+
+    conn
+  end
+
+  def shutdown
+    Thread.current[@key] = nil
+    super
+  end
+end
+
+require_relative 'timed_stack_multi'
+

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

@@ -0,0 +1,79 @@
+class Net::HTTP::Persistent::TimedStackMulti < ConnectionPool::TimedStack # :nodoc:
+
+  ##
+  # Returns a new hash that has arrays for keys
+  #
+  # Using a class method to limit the bindings referenced by the hash's
+  # default_proc
+
+  def self.hash_of_arrays # :nodoc:
+    Hash.new { |h,k| h[k] = [] }
+  end
+
+  def initialize(size = 0, &block)
+    super
+
+    @enqueued = 0
+    @ques = self.class.hash_of_arrays
+    @lru = {}
+    @key = :"connection_args-#{object_id}"
+  end
+
+  def empty?
+    (@created - @enqueued) >= @max
+  end
+
+  def length
+    @max - @created + @enqueued
+  end
+
+  private
+
+  def connection_stored? options = {} # :nodoc:
+    !@ques[options[:connection_args]].empty?
+  end
+
+  def fetch_connection options = {} # :nodoc:
+    connection_args = options[:connection_args]
+
+    @enqueued -= 1
+    lru_update connection_args
+    @ques[connection_args].pop
+  end
+
+  def lru_update connection_args # :nodoc:
+    @lru.delete connection_args
+    @lru[connection_args] = true
+  end
+
+  def shutdown_connections # :nodoc:
+    @ques.each_key do |key|
+      super connection_args: key
+    end
+  end
+
+  def store_connection obj, options = {} # :nodoc:
+    @ques[options[:connection_args]].push obj
+    @enqueued += 1
+  end
+
+  def try_create options = {} # :nodoc:
+    connection_args = options[:connection_args]
+
+    if @created >= @max && @enqueued >= 1
+      oldest, = @lru.first
+      @lru.delete oldest
+      @ques[oldest].pop
+
+      @created -= 1
+    end
+
+    if @created < @max
+      @created += 1
+      lru_update connection_args
+      return @create_block.call(connection_args)
+    end
+  end
+
+end
+