net-http-persistent 2.5.2 → 2.6

data.tar.gz.sig

@@ -1 +1,5 @@
-Z�G�a���C����*c�@��,���g��
�Y�&�G��>�^r�?F��0�׏ϙ�8^^�
+���!�}��e����q��]G��X_����.��ɝ�����1#7]/�
+�c���}�^��?�h��
+���Öf����e����Q��
+�1ˎh]_�q��С^�5��*���B�<����3�~s�nZ���%����Vil�
ʺ-fcټ+��0)P%	�N��|G�-�[h���|��E��@G�/<��{vW��Ȑq����۟'
+��]��+���=�o�i}%0Z4���\

data/History.txt

@@ -1,3 +1,9 @@
+=== 2.6 / 2010-03-26
+
+* Minor enhancement
+  * Net::HTTP::Persistent#idle_timeout may be set to nil to disable expiration
+    of connections.  Pull Request #21 by Aaron Stone
+
 === 2.5.2 / 2012-02-13
 
 * Bug fix

data/README.rdoc

@@ -45,8 +45,12 @@ connection is kept alive between requests:
     # perform the POST, the URI is always required
     response = http.request post_uri, post
 
-Please see the documentation for +Net::HTTP::Persistent+ for more information,
-including how to handle SSL connections.
+    # if you are done making http requests, or won't make requests for several
+    # minutes
+    http.shutdown
+
+Please see the documentation on Net::HTTP::Persistent for more information,
+including SSL connection verification, header handling and tunable options.
 
 == INSTALL:
 

data/Rakefile

@@ -5,6 +5,7 @@ require 'hoe'
 
 Hoe.plugin :git
 Hoe.plugin :minitest
+Hoe.plugin :travis
 
 Hoe.spec 'net-http-persistent' do |p|
   developer 'Eric Hodel', 'drbrain@segment7.net'

data/lib/net/http/persistent.rb

@@ -92,9 +92,9 @@ end
 #
 # === Idle Timeout
 #
-# If a connection hasn't been used for 5 seconds it will automatically be
+# If a connection hasn't been used for this number of seconds it will automatically be
 # reset upon the next use to avoid attempting to send to a closed connection.
-# This can be adjusted through idle_timeout.
+# The default value is 5 seconds. nil means no timeout. Set through #idle_timeout.
 #
 # Reducing this value may help avoid the "too many connection resets" error
 # when sending non-idempotent requests while increasing this value will cause
@@ -110,14 +110,6 @@ end
 # The amount of time to wait for a connection to be opened.  Set through
 # #open_timeout.
 #
-# === Idle Timeout
-#
-# If a connection has not been used in this many seconds it will be reset when
-# a request would use the connection.  The default idle timeout is unlimited.
-# If you know the server's idle timeout setting this value will eliminate
-# failures from attempting non-idempotent requests on closed connections.  Set
-# through #idle_timeout.
-#
 # === Socket Options
 #
 # Socket options may be set on newly-created connections.  See #socket_options
@@ -161,6 +153,18 @@ end
 # The method of determining if the resource was created or not is unique to
 # the particular service you are using.  Of course, you will want to add
 # protection from infinite looping.
+#
+# === Connection Termination
+#
+# If you are done using the Net::HTTP::Persistent instance you may shut down
+# all the connections in the current thread with #shutdown.  This is not
+# recommended for normal use, it should only be used when it will be several
+# minutes before you make another HTTP request.
+#
+# If you are using multiple threads, call #shutdown in each thread when the
+# thread is done making requests.  If you don't call shutdown, that's OK.
+# Ruby will automatically garbage collect and shutdown your HTTP connections
+# when the thread terminates.
 
 class Net::HTTP::Persistent
 
@@ -172,7 +176,7 @@ class Net::HTTP::Persistent
   ##
   # The version of Net::HTTP::Persistent you are using
 
-  VERSION = '2.5.2'
+  VERSION = '2.6'
 
   ##
   # Error class for errors raised by Net::HTTP::Persistent.  Various
@@ -496,8 +500,7 @@ class Net::HTTP::Persistent
       connection = connections[connection_id]
       ssl connection if use_ssl
     else
-      last_used = Thread.current[@timeout_key][connection.object_id]
-      reset connection unless last_used > max_age
+      reset connection if expired? connection
     end
 
     unless connection.started? then
@@ -544,6 +547,19 @@ class Net::HTTP::Persistent
     CGI.escape str if str
   end
 
+  ##
+  # Returns true if the connection should be reset due to an idle timeout,
+  # false otherwise.
+
+  def expired? connection
+    return false unless @idle_timeout
+    return true  if     @idle_timeout.zero?
+
+    last_used = Thread.current[@timeout_key][connection.object_id]
+
+    Time.now - last_used > @idle_timeout
+  end
+
   ##
   # Finishes the Net::HTTP +connection+
 
@@ -623,9 +639,11 @@ class Net::HTTP::Persistent
   end
 
   ##
-  # If a connection hasn't been used since max_age it will be reset and reused
+  # Deprecated in favor of #expired?
+
+  def max_age # :nodoc:
+    return Time.now + 1 unless @idle_timeout
 
-  def max_age
     Time.now - @idle_timeout
   end
 

data/test/test_net_http_persistent.rb

@@ -121,7 +121,7 @@ class TestNetHttpPersistent < MiniTest::Unit::TestCase
   end
 
   def reqs
-    Thread.current[@http.request_key] ||= {}
+    Thread.current[@http.request_key] ||= Hash.new 0
   end
 
   def ssl_conns
@@ -251,6 +251,60 @@ class TestNetHttpPersistent < MiniTest::Unit::TestCase
     assert_same c, conns[0]['example.com:80']
   end
 
+  def test_connection_for_cached_expire_always
+    cached = basic_connection
+    cached.start
+    conns[0]['example.com:80'] = cached
+    reqs[cached.object_id] = 10
+    touts[cached.object_id] = Time.now # last used right now
+
+    @http.idle_timeout = 0
+
+    c = @http.connection_for @uri
+
+    assert c.started?
+
+    assert_same cached, c
+
+    assert_equal 0, reqs[cached.object_id],
+                 'connection reset due to timeout'
+  end
+
+  def test_connection_for_cached_expire_never
+    cached = basic_connection
+    cached.start
+    conns[0]['example.com:80'] = cached
+    reqs[cached.object_id] = 10
+    touts[cached.object_id] = Time.now # last used right now
+
+    @http.idle_timeout = nil
+
+    c = @http.connection_for @uri
+
+    assert c.started?
+
+    assert_same cached, c
+
+    assert_equal 10, reqs[cached.object_id],
+                 'connection reset despite no timeout'
+  end
+
+  def test_connection_for_cached_expired
+    cached = basic_connection
+    cached.start
+    conns[0]['example.com:80'] = cached
+    reqs[cached.object_id] = 10
+    touts[cached.object_id] = Time.now - 3600
+
+    c = @http.connection_for @uri
+
+    assert c.started?
+
+    assert_same cached, c
+    assert_equal 0, reqs[cached.object_id],
+                 'connection not reset due to timeout'
+  end
+
   def test_connection_for_finished_ssl
     uri = URI.parse 'https://example.com/path'
     c = @http.connection_for uri
@@ -412,7 +466,7 @@ class TestNetHttpPersistent < MiniTest::Unit::TestCase
     c = @http.connection_for @uri
 
     assert c.started?
-    assert_nil reqs[c.object_id]
+    assert_equal 0, reqs[c.object_id]
 
     assert_same cached, c
   end
@@ -433,6 +487,26 @@ class TestNetHttpPersistent < MiniTest::Unit::TestCase
     assert_equal '+%3F', @http.escape(' ?')
   end
 
+  def test_expired_eh
+    c = basic_connection
+    touts[c.object_id] = Time.now - 11
+
+    @http.idle_timeout = 0
+    assert @http.expired? c
+
+    @http.idle_timeout = 10
+    assert @http.expired? c
+
+    @http.idle_timeout = 11
+    assert @http.expired? c
+
+    @http.idle_timeout = 12
+    refute @http.expired? c
+
+    @http.idle_timeout = nil
+    refute @http.expired? c
+  end
+
   def test_finish
     c = basic_connection
     reqs[c.object_id] = 5
@@ -441,7 +515,7 @@ class TestNetHttpPersistent < MiniTest::Unit::TestCase
 
     refute c.started?
     assert c.finished?
-    assert_nil reqs[c.object_id]
+    assert_equal 0, reqs[c.object_id]
   end
 
   def test_finish_io_error
@@ -478,6 +552,10 @@ class TestNetHttpPersistent < MiniTest::Unit::TestCase
 
   def test_max_age
     assert_in_delta Time.now - 5, @http.max_age
+
+    @http.idle_timeout = nil
+
+    assert_in_delta Time.now + 1, @http.max_age
   end
 
   def test_normalize_uri
@@ -693,6 +771,10 @@ class TestNetHttpPersistent < MiniTest::Unit::TestCase
   def test_request_close_1_0
     c = connection
 
+    class << c
+      remove_method :request
+    end
+
     def c.request req
       @req = req
       r = Net::HTTPResponse.allocate
@@ -740,6 +822,10 @@ class TestNetHttpPersistent < MiniTest::Unit::TestCase
   def test_request_connection_close_response
     c = connection
 
+    class << c
+      remove_method :request
+    end
+
     def c.request req
       @req = req
       r = Net::HTTPResponse.allocate
@@ -887,7 +973,7 @@ class TestNetHttpPersistent < MiniTest::Unit::TestCase
     assert c.started?
     assert c.finished?
     assert c.reset?
-    assert_nil reqs[c.object_id]
+    assert_equal 0, reqs[c.object_id]
     assert_equal Net::HTTP::Persistent::EPOCH, touts[c.object_id]
   end
 
@@ -948,7 +1034,6 @@ class TestNetHttpPersistent < MiniTest::Unit::TestCase
   def test_shutdown
     ssl_conns
     c = connection
-    cs = conns
     rs = reqs
     ts = touts
 
@@ -1177,7 +1262,6 @@ class TestNetHttpPersistent < MiniTest::Unit::TestCase
 
   def test_ssl_cleanup
     uri1 = URI.parse 'https://one.example'
-    uri2 = URI.parse 'https://two.example'
 
     c1 = @http.connection_for uri1
 

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: net-http-persistent
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 15
   prerelease: 
   segments: 
   - 2
-  - 5
-  - 2
-  version: 2.5.2
+  - 6
+  version: "2.6"
 platform: ruby
 authors: 
 - Eric Hodel
@@ -16,9 +15,9 @@ bindir: bin
 cert_chain: 
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDVzCCAj+gAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
+  MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
   YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
-  ZXQwHhcNMTIwMTMxMDEwMzUyWhcNMTMwMTMwMDEwMzUyWjBBMRAwDgYDVQQDDAdk
+  ZXQwHhcNMTIwMjI4MTc1NDI1WhcNMTMwMjI3MTc1NDI1WjBBMRAwDgYDVQQDDAdk
   cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
   FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
   LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
@@ -26,17 +25,18 @@ cert_chain:
   Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
   mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
   g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
-  sCANiQ8BAgMBAAGjWjBYMAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  sCANiQ8BAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
   BBS5k4Z75VSpdM0AclG2UvzFA/VW5DAfBgNVHREEGDAWgRRkcmJyYWluQHNlZ21l
-  bnQ3Lm5ldDANBgkqhkiG9w0BAQUFAAOCAQEAge3LmAU2QbrS2/grAEmRu3bCCHrQ
-  NSc6j+p53VJ1DraNWEMY3D90F/SKzsI0SYgZb71i49k+pNA2CVXzEJAY7agZbjWJ
-  UbgGKN8u9SGbIoQPBPIl97JPIGlR7AoEdmlWyFySaZD4o6+Q0onUXIV+P/KrYTVb
-  Zj/NEjHGrvskpDzlYI2LvG71DFp1o0hfIZzdvfWLAMVqtuEjJ6QrUm9FttR06rNo
-  itgEKl/tNI4M9oKJT0faQ5PvJ70ualcLnwkBLyJVd2r8qwxfjUAjKF8iMpBSb98s
-  YJY7T/W2n+eWy8WuPhzVUkyzguj0bQe27NDeabgCh2mHd4Hynk2AkYh8MQ==
+  bnQ3Lm5ldDAfBgNVHRIEGDAWgRRkcmJyYWluQHNlZ21lbnQ3Lm5ldDANBgkqhkiG
+  9w0BAQUFAAOCAQEAPeWzFnrcvC6eVzdlhmjUub2s6qieBkongKRDHQz5MEeQv4LS
+  SARnoHY+uCAVL/1xGAhmpzqQ3fJGWK9eBacW/e8E5GF9xQcV3mE1bA0WNaiDlX5j
+  U2aI+ZGSblqvHUCxKBHR1s7UMHsbz1saOmgdRTyPx0juJs68ocbUTeYBLWu9V4KP
+  zdGAG2JXO2gONg3b4tYDvpBLbry+KOX27iAJulUaH9TiTOULL4ITJVFsK0mYVqmR
+  Q8Tno9S3e4XGGP1ZWfLrTWEJbavFfhGHut2iMRwfC7s/YILAHNATopaJdH9DNpd1
+  U81zGHMUBOvz/VGT6wJwYJ3emS2nfA2NOHFfgA==
   -----END CERTIFICATE-----
 
-date: 2012-02-13 00:00:00 Z
+date: 2012-03-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: minitest
@@ -46,11 +46,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 21
         segments: 
         - 2
-        - 10
-        version: "2.10"
+        - 11
+        version: "2.11"
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -76,11 +76,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 25
+        hash: 35
         segments: 
         - 2
-        - 13
-        version: "2.13"
+        - 16
+        version: "2.16"
   type: :development
   version_requirements: *id003
 description: |-
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: net-http-persistent
-rubygems_version: 1.8.12
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Manages persistent connections using Net::HTTP plus a speed fix for Ruby 1.8