net-http-persistent 1.0

data/.autotest

@@ -0,0 +1,7 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = 'minitest/unit'
+end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2010-05-04
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/net/http/faster.rb
+lib/net/http/persistent.rb
+test/test_net_http_persistent.rb

data/README.txt

@@ -0,0 +1,44 @@
+= net_http_persistent
+
+* http://seattlerb.rubyforge.org/net-http-persistent
+
+== DESCRIPTION:
+
+Persistent connections using Net::HTTP plus a speed fix for 1.8.  It's
+thread-safe too!
+
+== FEATURES/PROBLEMS:
+
+* Supports SSL
+* Thread-safe
+* Pure ruby
+* Timeout-less speed boost for 1.8 (by Aaron Patterson)
+
+== INSTALL:
+
+  gem install net-http-persistent
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 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
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :git
+
+Hoe.spec 'net-http-persistent' do |p|
+  self.rubyforge_name = 'seattlerb'
+  developer 'Eric Hodel', 'drbrain@segment7.net'
+end
+
+# vim: syntax=Ruby

data/lib/net/http/faster.rb

@@ -0,0 +1,27 @@
+require 'net/protocol'
+
+##
+# Aaron Patterson's monkeypatch (accepted into 1.9.1) to fix Net::HTTP's speed
+# problems.
+#
+# http://gist.github.com/251244
+
+class Net::BufferedIO #:nodoc:
+  alias :old_rbuf_fill :rbuf_fill
+
+  def rbuf_fill
+    if @io.respond_to? :read_nonblock then
+      begin
+        @rbuf << @io.read_nonblock(65536)
+      rescue Errno::EWOULDBLOCK => e
+        retry if IO.select [@io], nil, nil, @read_timeout
+        raise Timeout::Error, e.message
+      end
+    else # SSL sockets do not have read_nonblock
+      timeout @read_timeout do
+        @rbuf << @io.sysread(65536)
+      end
+    end
+  end
+end
+

data/lib/net/http/persistent.rb

@@ -0,0 +1,215 @@
+require 'net/http'
+require 'net/http/faster'
+require 'uri'
+
+##
+# Persistent connections for Net::HTTP
+#
+# Net::HTTP::Persistent maintains persistent connections across all the
+# servers you wish to talk to.  For each host:port you communicate with a
+# single persistent connection is created.
+#
+# Multiple Net::HTTP::Persistent objects will share the same set of
+# connections.
+#
+# Example:
+#
+#   uri = URI.parse 'http://example.com/awesome/web/service'
+#   http = Net::HTTP::Persistent
+#   stuff = http.request uri # performs a GET
+#
+#   # perform a POST
+#   post_uri = uri + 'create'
+#   post = Net::HTTP::Post.new uri.path
+#   post.set_form_data 'some' => 'cool data'
+#   http.request post_uri, post # URI is always required
+
+class Net::HTTP::Persistent
+
+  ##
+  # The version of Net::HTTP::Persistent use are using
+
+  VERSION = '1.0'
+
+  ##
+  # Error class for errors raised by Net::HTTP::Persistent.  Various
+  # SystemCallErrors are re-raised with a human-readable message under this
+  # class.
+
+  class Error < StandardError; end
+
+  ##
+  # This client's OpenSSL::X509::Certificate
+
+  attr_accessor :certificate
+
+  ##
+  # An SSL certificate authority.  Setting this will set verify_mode to
+  # VERIFY_PEER.
+
+  attr_accessor :ca_file
+
+  ##
+  # Headers that are added to every request
+
+  attr_reader :headers
+
+  ##
+  # The value sent in the Keep-Alive header.  Defaults to 30 seconds
+
+  attr_accessor :keep_alive
+
+  ##
+  # This client's SSL private key
+
+  attr_accessor :private_key
+
+  ##
+  # SSL verification callback.  Used when ca_file is set.
+
+  attr_accessor :verify_callback
+
+  ##
+  # HTTPS verify mode.  Set to OpenSSL::SSL::VERIFY_NONE to ignore certificate
+  # problems.
+  #
+  # You can use +verify_mode+ to override any default values.
+
+  attr_accessor :verify_mode
+
+  def initialize # :nodoc:
+    @keep_alive = 30
+    @headers = {}
+
+    @certificate     = nil
+    @ca_file         = nil
+    @private_key     = nil
+    @verify_callback = nil
+    @verify_mode     = nil
+  end
+
+  ##
+  # Creates a new connection for +uri+
+
+  def connection_for uri
+    Thread.current[:net_http_persistent_connections] ||= {}
+    connections = Thread.current[:net_http_persistent_connections]
+
+    connection_id = [uri.host, uri.port].join ':'
+
+    connections[connection_id] ||= Net::HTTP.new uri.host, uri.port
+    connection = connections[connection_id]
+
+    ssl connection if uri.scheme == 'https' and not connection.started?
+
+    connection.start unless connection.started?
+
+    connection
+  rescue Errno::ECONNREFUSED
+    raise Error, "connection refused: #{connection.address}:#{connection.port}"
+  end
+
+  ##
+  # Returns an error message containing the number of requests performed on
+  # this connection
+
+  def error_message connection
+    requests =
+      Thread.current[:net_http_persistent_requests][connection.object_id]
+
+    "after #{requests} requests on #{connection.object_id}"
+  end
+
+  ##
+  # Finishes then restarts the Net::HTTP +connection+
+
+  def reset connection
+    Thread.current[:net_http_persistent_requests].delete connection.object_id
+
+    begin
+      connection.finish
+    rescue IOError
+    end
+
+    connection.start
+  rescue Errno::ECONNREFUSED
+    raise Error, "connection refused: #{connection.address}:#{connection.port}"
+  rescue Errno::EHOSTDOWN
+    raise Error, "host down: #{connection.address}:#{connection.port}"
+  end
+
+  ##
+  # Makes a request on +uri+.  If +req+ is nil a Net::HTTP::Get is performed
+  # against +uri+.
+  #
+  # +req+ must be a Net::HTTPRequest subclass (see Net::HTTP for a list).
+
+  def request uri, req = nil
+    Thread.current[:net_http_persistent_requests] ||= Hash.new 0
+    retried      = false
+    bad_response = false
+
+    req = Net::HTTP::Get.new uri.request_uri unless req
+
+    headers.each do |pair|
+      req.add_field(*pair)
+    end
+
+    req.add_field 'Connection', 'keep-alive'
+    req.add_field 'Keep-Alive', @keep_alive
+
+    connection = connection_for uri
+    connection_id = connection.object_id
+
+    begin
+      count = Thread.current[:net_http_persistent_requests][connection_id] += 1
+      response = connection.request req
+
+    rescue Net::HTTPBadResponse => e
+      message = error_message connection
+
+      reset connection
+
+      raise Error, "too many bad responses #{message}" if bad_response
+
+      bad_response = true
+      retry
+    rescue IOError, EOFError, Timeout::Error,
+           Errno::ECONNABORTED, Errno::ECONNRESET, Errno::EPIPE => e
+      due_to = "(due to #{e.message} - #{e.class})"
+      message = error_message connection
+
+      reset connection
+
+      raise Error, "too many connection resets #{due_to} #{message}" if retried
+
+      retried = true
+      retry
+    end
+
+    response
+  end
+
+  ##
+  # Enables SSL on +connection+
+
+  def ssl connection
+    require 'net/https'
+    connection.use_ssl = true
+
+    if @ca_file then
+      connection.ca_file = @ca_file
+      connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      connection.verify_callback = @verify_callback if @verify_callback
+    end
+
+    if @certificate and @private_key then
+      connection.cert = @certificate
+      connection.key  = @private_key
+    end
+
+    connection.verify_mode = @verify_mode if @verify_mode
+  end
+
+end
+

data/test/test_net_http_persistent.rb

@@ -0,0 +1,244 @@
+require 'minitest/autorun'
+require 'net/http/persistent'
+require 'openssl'
+
+class TestNetHttpPersistent < MiniTest::Unit::TestCase
+
+  def setup
+    @http = Net::HTTP::Persistent.new
+    @uri  = URI.parse 'http://example.com/path'
+  end
+
+  def teardown
+    Thread.current[:net_http_persistent_connections] = nil
+    Thread.current[:net_http_persistent_requests] = nil
+  end
+
+  def connection
+    c = Object.new
+    # Net::HTTP
+    def c.finish; @finish = true end
+    def c.request(req) @req = req; :response end
+    def c.reset; @reset = true end
+    def c.start; end
+
+    # util
+    def c.req() @req; end
+    def c.reset?; @reset end
+    def c.started?; true end
+    conns["#{@uri.host}:#{@uri.port}"] = c
+    c
+  end
+
+  def conns
+    Thread.current[:net_http_persistent_connections] ||= {}
+  end
+
+  def reqs
+    Thread.current[:net_http_persistent_requests] ||= {}
+  end
+
+  def test_connection_for
+    c = @http.connection_for @uri
+
+    assert c.started?
+
+    assert_includes conns.keys, 'example.com:80'
+    assert_same c, conns['example.com:80']
+  end
+
+  def test_connection_for_cached
+    cached = Object.new
+    def cached.started?; true end
+    conns['example.com:80'] = cached
+
+    c = @http.connection_for @uri
+
+    assert c.started?
+
+    assert_same cached, c
+  end
+
+  def test_connection_for_refused
+    cached = Object.new
+    def cached.address; 'example.com' end
+    def cached.port; 80 end
+    def cached.start; raise Errno::ECONNREFUSED end
+    def cached.started?; false end
+    conns['example.com:80'] = cached
+
+    e = assert_raises Net::HTTP::Persistent::Error do
+      @http.connection_for @uri
+    end
+
+    assert_match %r%connection refused%, e
+  end
+
+  def test_error_message
+    c = Object.new
+    reqs[c.object_id] = 5
+
+    assert_equal "after 5 requests on #{c.object_id}", @http.error_message(c)
+  end
+
+  def test_reset
+    c = Object.new
+    def c.finish; @finished = true end
+    def c.finished?; @finished end
+    def c.start; @started = true end
+    def c.started?; @started end
+    reqs[c.object_id] = 5
+
+    @http.reset c
+
+    assert c.started?
+    assert c.finished?
+    assert_nil reqs[c.object_id]
+  end
+
+  def test_reset_io_error
+    c = Object.new
+    def c.finish; @finished = true; raise IOError end
+    def c.finished?; @finished end
+    def c.start; @started = true end
+    def c.started?; @started end
+    reqs[c.object_id] = 5
+
+    @http.reset c
+
+    assert c.started?
+    assert c.finished?
+  end
+
+  def test_reset_host_down
+    c = Object.new
+    def c.address; 'example.com' end
+    def c.finish; end
+    def c.port; 80 end
+    def c.start; raise Errno::EHOSTDOWN end
+    reqs[c.object_id] = 5
+
+    e = assert_raises Net::HTTP::Persistent::Error do
+      @http.reset c
+    end
+
+    assert_match %r%host down%, e
+  end
+
+  def test_reset_refused
+    c = Object.new
+    def c.address; 'example.com' end
+    def c.finish; end
+    def c.port; 80 end
+    def c.start; raise Errno::ECONNREFUSED end
+    reqs[c.object_id] = 5
+
+    e = assert_raises Net::HTTP::Persistent::Error do
+      @http.reset c
+    end
+
+    assert_match %r%connection refused%, e
+  end
+
+  def test_request
+    @http.headers['user-agent'] = 'test ua'
+    c = connection
+
+    res = @http.request @uri
+    req = c.req
+
+    assert_equal :response, res
+
+    assert_kind_of Net::HTTP::Get, req
+    assert_equal '/path',      req.path
+    assert_equal 'keep-alive', req['connection']
+    assert_equal '30',         req['keep-alive']
+    assert_equal 'test ua',    req['user-agent']
+
+    assert_equal 1, reqs[c.object_id]
+  end
+
+  def test_request_bad_response
+    c = connection
+    def c.request(*a) raise Net::HTTPBadResponse end
+
+    e = assert_raises Net::HTTP::Persistent::Error do
+      @http.request @uri
+    end
+
+    assert_equal 0, reqs[c.object_id]
+    assert_match %r%too many bad responses%, e.message
+  end
+
+  def test_request_reset
+    c = connection
+    def c.request(*a) raise Errno::ECONNRESET end
+
+    e = assert_raises Net::HTTP::Persistent::Error do
+      @http.request @uri
+    end
+
+    assert_equal 0, reqs[c.object_id]
+    assert_match %r%too many connection resets%, e.message
+  end
+
+  def test_request_post
+    c = connection
+
+    post = Net::HTTP::Post.new @uri.path
+
+    res = @http.request @uri, post
+    req = c.req
+
+    assert_equal :response, res
+
+    assert_same post, req
+  end
+
+  def test_ssl
+    @http.verify_callback = :callback
+    c = Net::HTTP.new 'localhost', 80
+
+    @http.ssl c
+
+    assert c.use_ssl?
+    assert_nil c.verify_mode
+    assert_nil c.verify_callback
+  end
+
+  def test_ssl_ca_file
+    @http.ca_file = 'ca_file'
+    @http.verify_callback = :callback
+    c = Net::HTTP.new 'localhost', 80
+
+    @http.ssl c
+
+    assert c.use_ssl?
+    assert_equal OpenSSL::SSL::VERIFY_PEER, c.verify_mode
+    assert_equal :callback, c.verify_callback
+  end
+
+  def test_ssl_certificate
+    @http.certificate = :cert
+    @http.private_key = :key
+    c = Net::HTTP.new 'localhost', 80
+
+    @http.ssl c
+
+    assert c.use_ssl?
+    assert_equal :cert, c.cert
+    assert_equal :key,  c.key
+  end
+
+  def test_ssl_verify_mode
+    @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    c = Net::HTTP.new 'localhost', 80
+
+    @http.ssl c
+
+    assert c.use_ssl?
+    assert_equal OpenSSL::SSL::VERIFY_NONE, c.verify_mode
+  end
+
+end
+

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification 
+name: net-http-persistent
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Eric Hodel
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
+  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
+  ZXQwHhcNMDcxMjIxMDIwNDE0WhcNMDgxMjIwMDIwNDE0WjBBMRAwDgYDVQQDDAdk
+  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
+  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
+  LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
+  U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
+  Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
+  mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
+  g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
+  sCANiQ8BAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  BBS5k4Z75VSpdM0AclG2UvzFA/VW5DANBgkqhkiG9w0BAQUFAAOCAQEAHagT4lfX
+  kP/hDaiwGct7XPuVGbrOsKRVD59FF5kETBxEc9UQ1clKWngf8JoVuEoKD774dW19
+  bU0GOVWO+J6FMmT/Cp7nuFJ79egMf/gy4gfUfQMuvfcr6DvZUPIs9P/TlK59iMYF
+  DIOQ3DxdF3rMzztNUCizN4taVscEsjCcgW6WkUJnGdqlu3OHWpQxZBJkBTjPCoc6
+  UW6on70SFPmAy/5Cq0OJNGEWBfgD9q7rrs/X8GGwUWqXb85RXnUVi/P8Up75E0ag
+  14jEc90kN+C7oI/AGCBN0j6JnEtYIEJZibjjDJTSMWlUKKkj30kq7hlUC2CepJ4v
+  x52qPcexcYZR7w==
+  -----END CERTIFICATE-----
+
+date: 2010-05-04 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 0
+        - 3
+        version: 2.0.3
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id003
+description: |-
+  Persistent connections using Net::HTTP plus a speed fix for 1.8.  It's
+  thread-safe too!
+email: 
+- drbrain@segment7.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/net/http/faster.rb
+- lib/net/http/persistent.rb
+- test/test_net_http_persistent.rb
+has_rdoc: true
+homepage: http://seattlerb.rubyforge.org/net-http-persistent
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: seattlerb
+rubygems_version: 1.3.7.pre.1
+signing_key: 
+specification_version: 3
+summary: Persistent connections using Net::HTTP plus a speed fix for 1.8
+test_files: 
+- test/test_net_http_persistent.rb