faraday_connection_pool 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c8dc652b39beefa2f725ce45ce3023f49150b8a
+  data.tar.gz: 72034577546525481ec6ad29a66ea23f13d033c0
+SHA512:
+  metadata.gz: b497d71965dd9fe76005560d81cd3c320b128ebda5f78a37cd7303ec17a489cd9b1ee045c1c0749911bc17093880799a257f4fd7f95a3533fb85f7fa993d0964
+  data.tar.gz: dd89ee14b05f214f58ca007e7db0b5759f3477b87161e6f583dace1b5024a0c031093ed9b7493e63d0014f807a1e335f499244da4681792e744b0764c4a89811

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/*
+log/*

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# FaradayConnectionPool Changelog
+
+## v0.0.1
+
+* Initial commit (@Ben-M)

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faraday_connection_pool.gemspec
+gemspec
+
+group :test do
+  gem 'coveralls', :require => false
+  gem 'leftright', '>= 0.9', :require => false
+  gem 'mime-types', '~> 1.25', :platforms => [:jruby, :ruby_18]
+  gem 'minitest', '>= 5.0.5'
+  gem 'minitest-rspec_mocks'
+  gem 'rest-client', '~> 1.6.0', :platforms => [:jruby, :ruby_18]
+  gem 'simplecov'
+  gem 'sinatra', '~> 1.3'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ben Maraney
+
+MIT License
+
+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/README.md

@@ -0,0 +1,78 @@
+# FaradayConnectionPool
+
+FaradayConnectionPool provides a persistent Net::HTTP Faraday adapter.
+Unlike Net::HTTP::Persistent, which has a connection-per-thread, connections are pooled across all threads and you will always get the most recently used connection. This should mean that you are more likely to get an existing connection with a reduced chance of getting a connection reset
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'faraday_connection_pool'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faraday_connection_pool
+
+
+## Usage
+
+1. If necessary `require 'faraday_connection_pool'`
+
+2. Configure FaradayConnectionPool:
+
+```ruby
+FaradayConnectionPool.configure do |config|
+  config.size = 5 #The number of connections to held in the pool. There is a separate pool for each host/port.
+  config.pool_timeout = 5 #If no connection is available from the pool within :pool_timeout seconds the adapter will raise a Timeout::Error.
+  config.keep_alive_timeout = 30  #Connections which has been unused for :keep_alive_timeout seconds are not reused.
+end
+```
+
+3. Configure your Faraday connections to use the `:net_http_pooled` adapter provided by the gem:
+
+```ruby
+Faraday.new(:url => 'http://klarna.com') do |conn|
+  conn.adapter :net_http_pooled
+end
+```
+
+## Warning - Retries
+
+FaradayConnectionPool will not automatically try and repair broken connections, so you should configure Faraday to retry
+for you:
+
+```ruby
+Faraday.new do |conn|
+  conn.request :retry, max: 2, interval: 0.05,
+                       interval_randomness: 0.5, backoff_factor: 2
+                       exceptions: [ Faraday::Error::ConnectionFailed ]
+    conn.adapter :net_http_pooled
+end
+```
+
+## Warning - Proxy Support
+
+The `:net_http_pooled adapter` will not complain if you configure it to use a proxy server, but this code is entirely
+untested. Use this at your own risk and file an issue to tell us how it goes.
+
+## Tests
+
+Run tests with `script/test`.
+The test framework pulls in files from Faraday to save us setting up an integration test framework here.
+
+## Contributing
+
+1. Fork it ( `http://github.com/Ben-M/faraday_connection_pool/fork` )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write your tests and code. Run `script/test` to check that the tests are passing.
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Todo
+* [ ] Make Faraday::Error::ConnectionFailed less general, so we can retry only Errno::ECONNRESET
+* [ ] Allow host/port specific configuration
+* [ ] Test proxy support

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/faraday_connection_pool.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday_connection_pool/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faraday_connection_pool"
+  spec.version       = FaradayConnectionPool::VERSION
+  spec.authors       = ["Ben Maraney"]
+  spec.email         = ["ben@maraney.com"]
+  spec.summary       = "A persistent Net::Http adapter for Faraday with a connection pool shared across threads and fibres."
+  spec.homepage      = "https://github.com/Ben-M/faraday_connection_pool"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "faraday", ">= 0.9.1"
+  spec.add_dependency "connection_pool", "~> 2.1"
+end

data/lib/faraday_connection_pool.rb

@@ -0,0 +1,82 @@
+require 'monitor'
+require 'connection_pool'
+
+module FaradayConnectionPool
+
+  class Configuration
+    attr_writer :size
+    attr_writer :pool_timeout
+    attr_writer :keep_alive_timeout
+
+    def size
+      @size ||= 5
+    end
+
+    def pool_timeout
+      @pool_timeout ||= 5
+    end
+
+    def keep_alive_timeout
+      @keep_alive_timeout ||= 30
+    end
+
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+
+  def self.configuration
+    @configuration ||= FaradayConnectionPool::Configuration.new
+  end
+
+  class Adapter
+    class NetHttpPooled < Faraday::Adapter::NetHttp
+      extend MonitorMixin
+      @@connection_pools = {}
+
+      def call(env)
+        env[:request_headers] ||= {}
+        env[:request_headers]['Connection'] = 'Keep-Alive' unless env[:request_headers]['Connection']
+        super
+      end
+
+      def with_net_http_connection(env)
+        connection_pool_for(env).with do |connection|
+          yield connection
+         end
+      end
+
+      def self.purge_connection_pools
+        synchronize do
+          @@connection_pools = {}
+        end
+      end
+
+      private
+      def connection_pool_for(env)
+        self.class.synchronize do
+          keep_alive_timeout = FaradayConnectionPool.configuration.keep_alive_timeout
+          @@connection_pools[pool_key(env)] ||=
+            ConnectionPool.new(:size => FaradayConnectionPool.configuration.size,
+                               :timeout => FaradayConnectionPool.configuration.pool_timeout) do
+                                 net_http_connection(env).tap do |connection|
+                                   connection.keep_alive_timeout = keep_alive_timeout
+                                 end
+                               end
+        end
+      end
+
+      def pool_key(env)
+        "#{env[:url].host}:#{env[:url].port}:#{proxy_identifier(env)}"
+      end
+
+      def proxy_identifier(env)
+        env[:request][:proxy] ? "#{env[:request][:proxy][:uri]}" : ""
+      end
+
+    end
+  end
+end
+
+Faraday::Adapter.register_middleware :net_http_pooled => FaradayConnectionPool::Adapter::NetHttpPooled

data/lib/faraday_connection_pool/version.rb

@@ -0,0 +1,3 @@
+module FaradayConnectionPool
+  VERSION = "0.0.1"
+end

data/script/proxy-server

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+faraday_path=`bundle show faraday`
+$faraday_path/script/proxy-server "$@"

data/script/server

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+faraday_path=`bundle show faraday`
+$faraday_path/script/server $@

data/script/test

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+# Faraday has nice integrations tests built in, so we tap into them here.
+faraday_path=`bundle show faraday`
+$faraday_path/script/test $@
+pkill -f "faraday-0.9.1/script/server"
+pkill -f "faraday-0.9.1/script/proxy-server"

data/test/adapters/net_http_pooled_test.rb

@@ -0,0 +1,107 @@
+faraday_gem_location = Gem.loaded_specs['faraday'].gem_dir
+integration_location = File.join(faraday_gem_location, 'test', 'adapters', 'integration')
+require integration_location
+require 'minitest/rspec_mocks'
+require_relative('../../lib/faraday_connection_pool')
+
+module Adapters
+  class NetHttpPooledTest < Faraday::TestCase
+    include MiniTest::RSpecMocks
+
+    def adapter() :net_http_pooled end
+
+    behaviors = [:NonParallel]
+    behaviors << :Compression if RUBY_VERSION >= '1.9'
+
+    Integration.apply(self, *behaviors) do
+
+      def setup
+        FaradayConnectionPool::Adapter::NetHttpPooled.purge_connection_pools
+      end
+
+      def test_connection_pool_receives_size_and_pool_timeout
+        test_size = 10
+        test_pool_timeout = 0.5
+
+        FaradayConnectionPool.configure do |config|
+          config.size = test_size
+          config.pool_timeout = test_pool_timeout
+        end
+
+        expect(ConnectionPool).to receive(:new).with(:size => test_size, :timeout => test_pool_timeout).and_call_original
+
+        create_connection.get '/echo'
+      end
+
+      def test_connection_created_with_keep_alive_timeout
+        test_keep_alive_timeout = 18
+        FaradayConnectionPool.configure do |config|
+          config.keep_alive_timeout = test_keep_alive_timeout
+        end
+
+        expect_any_instance_of(Net::HTTP).to receive(:keep_alive_timeout=).with(test_keep_alive_timeout)
+        create_connection.get '/echo'
+      end
+
+      def test_connection_from_pool_used
+        connection = double('connection')
+        pool = ConnectionPool.new { connection }
+        allow(ConnectionPool).to receive(:new).and_return(pool)
+        response = double('response', :code => 200, :body => :ok, :each_header => true)
+
+        expect(connection).to receive(:get).and_return(response)
+
+        assert_equal :ok, create_connection.get('/echo').body
+      end
+
+      def test_connection_pools_reused
+        expect(ConnectionPool).to receive(:new).once.and_call_original
+
+        create_connection.get '/echo'
+        create_connection.get '/echo'
+      end
+
+      def test_one_pool_per_host
+        expect(ConnectionPool).to receive(:new).twice.and_return(test_pool)
+
+        conn = create_connection
+        conn.host = 'hello'
+        conn.get '/echo'
+
+        conn.host = 'world'
+        conn.get '/echo'
+      end
+
+      def test_one_pool_per_port
+        expect(ConnectionPool).to receive(:new).twice.and_return(test_pool)
+
+        conn = create_connection
+        conn.port = 1
+        conn.get '/echo'
+
+        conn.port = 2
+        conn.get '/echo'
+      end
+
+      def test_keep_alive_header_set
+        response = create_connection.get('echo_header', :name => 'connection')
+
+        assert_equal('Keep-Alive', response.body)
+      end
+
+      def test_keep_alive_header_not_overwritten
+        response = create_connection.get('echo_header', :name => 'connection') do |request|
+          request.headers['Connection'] = 'close'
+        end
+
+        assert_equal('close', response.body)
+      end
+
+      private
+      def test_pool
+        connection = Net::HTTP.new(self.class.live_server.host, self.class.live_server.port)
+        pool = ConnectionPool.new { connection }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: faraday_connection_pool
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Maraney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: 
+email:
+- ben@maraney.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faraday_connection_pool.gemspec
+- lib/faraday_connection_pool.rb
+- lib/faraday_connection_pool/version.rb
+- script/proxy-server
+- script/server
+- script/test
+- test/adapters/net_http_pooled_test.rb
+homepage: https://github.com/Ben-M/faraday_connection_pool
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A persistent Net::Http adapter for Faraday with a connection pool shared
+  across threads and fibres.
+test_files:
+- test/adapters/net_http_pooled_test.rb