faraday_persistent_excon 0.2.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bcf8b17c5b371de5744c937229974e5e2b68881d
-  data.tar.gz: 4cb644e52301a7d938fb2b56bf21c2e36930320c
+SHA256:
+  metadata.gz: c1f85714b132f22e4e9fe9852dbfc6780b6c00f95f5e36e6b77b7f0a9be7de70
+  data.tar.gz: 8946a5d751ef31a98636799191c0563530be3c4ffeb3347c38adc954d294f7a9
 SHA512:
-  metadata.gz: 8b9303432e6dcb300b0a47aad3db9b8ebbf63b319f3ac1a16401937cb8f629700d8e884e1e3e1583643e9a1a47307326e04e15c26558de159088b6675fc0c0ad
-  data.tar.gz: 393aeef700b32f7e47bd035e122be9777e234fd08d74ec6061092f209e57c61776fbf1add05bf8209fe47c29a5c665db3f6c462cd96526258c2e9d72c2b83676
+  metadata.gz: 80df392684a609ed27fc0f4da85f73e1f5675c9a98369ffc0ee34c7310961a6052163af813d94df1986cf65f36288e1d395c2ec5b37399c0a4feaf7359f493eb
+  data.tar.gz: 8e111c4143ae990cf9e5bb201bd8f2360003768ea70a6e4ddaf9704efb7b22a6d609f5d58002b967790e9945162e074d127dbcac02df264d6974ff91b35e4b32

data/.dockerignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Dockerfile

@@ -0,0 +1,34 @@
+FROM ruby:2.6.5-alpine
+MAINTAINER Ryan Schlesinger <ryan@outstand.com>
+
+RUN addgroup -g 1000 -S gem && \
+    adduser -u 1000 -S -s /bin/ash -G gem gem && \
+    apk add --no-cache \
+      ca-certificates \
+      tini \
+      su-exec \
+      build-base \
+      git \
+      openssh
+
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US:en
+ENV LC_ALL en_US.UTF-8
+
+ENV BUNDLER_VERSION 2.1.4
+RUN gem install bundler -v ${BUNDLER_VERSION} -i /usr/local/lib/ruby/gems/$(ls /usr/local/lib/ruby/gems) --force
+
+WORKDIR /srv
+RUN chown -R gem:gem /srv
+USER gem
+
+COPY --chown=gem:gem Gemfile faraday_persistent_excon.gemspec /srv/
+COPY --chown=gem:gem lib/faraday_persistent_excon/version.rb /srv/lib/faraday_persistent_excon/
+RUN git config --global push.default simple
+COPY --chown=gem:gem . /srv/
+
+USER root
+COPY docker-entrypoint.sh /docker-entrypoint.sh
+
+ENTRYPOINT ["/sbin/tini", "-g", "--", "/docker-entrypoint.sh"]
+CMD ["rspec", "spec"]

data/README.md

@@ -1,12 +1,14 @@
 # FaradayPersistentExcon
 
+[![Code Climate](https://codeclimate.com/github/aceofsales/faraday_persistent_excon/badges/gpa.svg)](https://codeclimate.com/github/aceofsales/faraday_persistent_excon)
+
 Adds configurable connection pools per host for persistent http connections
 
 ## Status
 
-**Alpha**
+**Beta**
 
-All testing for this gem is currently in the form of bench testing.  We're evaulating this gem in our production stack.
+All testing for this gem is currently in the form of bench testing.  We're using this gem in our production stack.
 
 ## Installation
 
@@ -33,15 +35,19 @@ Excon.defaults[:tcp_nodelay] = true
 Faraday.default_adapter = :persistent_excon
 FaradayPersistentExcon.connection_pools = {
   'https://search.example.com' => { size: 5 },
-  'http://localhost:9200' => { size: 10, timeout: 2 }
+  'http://localhost:9200' => { size: 10, timeout: 2, idle_timeout: 300 }
 }
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- `docker-compose build --pull`
+- `docker-compose run --rm faraday_persistent_excon` to run specs
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To release a new version:
+- Update the version number in `version.rb` and commit the result.
+- `docker-compose build --pull`
+- `docker-compose run --rm release`
 
 ## Contributing
 

data/docker-compose.yml

@@ -0,0 +1,24 @@
+version: '3.6'
+services:
+  faraday_persistent_excon:
+    build: .
+    image: outstand/faraday_persistent_excon:dev
+    stdin_open: true
+    tty: true
+    volumes:
+      - bundler-data:/usr/local/bundle
+      - .:/srv
+  release:
+    image: outstand/faraday_persistent_excon:dev
+    stdin_open: true
+    tty: true
+    command: rake release
+    volumes:
+      - bundler-data:/usr/local/bundle
+      - ~/.gitconfig:/home/gem/.gitconfig
+      - ~/.gitconfig.user:/home/gem/.gitconfig.user
+      - ~/.ssh/id_rsa:/home/gem/.ssh/id_rsa
+      - ~/.gem:/home/gem/.gem
+
+volumes:
+  bundler-data:

data/docker-entrypoint.sh

@@ -0,0 +1,20 @@
+#!/bin/sh
+set -e
+
+if [ "$(which "$1")" = '' ]; then
+  if [ "$(ls -A /usr/local/bundle/bin)" = '' ]; then
+    echo 'command not in path and bundler not initialized'
+    echo 'running bundle install'
+    su-exec gem bundle install
+  fi
+fi
+
+if [ "$1" = 'bundle' ]; then
+  set -- su-exec gem "$@"
+elif ls /usr/local/bundle/bin | grep -q "\b$1\b"; then
+  set -- su-exec gem bundle exec "$@"
+
+  su-exec gem ash -c 'bundle check || bundle install'
+fi
+
+exec "$@"

data/faraday_persistent_excon.gemspec

@@ -18,13 +18,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday"
+  spec.add_dependency "faraday", ">= 0.10.0"
   spec.add_dependency "excon"
   spec.add_dependency "connection_pool"
   spec.add_dependency "activesupport"
   spec.add_dependency "thread_safe"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec"
 end

data/lib/faraday_persistent_excon.rb

@@ -9,6 +9,7 @@ require 'faraday_persistent_excon/perform_request'
 require 'faraday_persistent_excon/adapter'
 require 'faraday_persistent_excon/request_options'
 require 'faraday_persistent_excon/connection_pools'
+require 'faraday_persistent_excon/connection'
 
 module FaradayPersistentExcon
   class << self
@@ -17,7 +18,7 @@ module FaradayPersistentExcon
     attr_accessor :connection_pools
     attr_accessor :idempotent_methods
     attr_accessor :retry_idempotent_methods
-    attr_accessor :retry_limit
+    attr_accessor :idle_timeout
   end
 
   self.excon_options = {}
@@ -25,7 +26,7 @@ module FaradayPersistentExcon
   self.connection_pools = {}
   self.idempotent_methods = %w[GET HEAD PUT DELETE OPTIONS TRACE]
   self.retry_idempotent_methods = true
-  self.retry_limit = 1
+  self.idle_timeout = 60
 end
 
 Faraday::Adapter.register_middleware persistent_excon: ->{ FaradayPersistentExcon::Adapter }

data/lib/faraday_persistent_excon/adapter.rb

@@ -12,7 +12,13 @@ module FaradayPersistentExcon
 
     def perform_request(env)
       response = FaradayPersistentExcon.perform_request_class.new.call env
-      save_response(env, response.status.to_i, response.body, response.headers)
+      save_response(
+        env,
+        response.status.to_i,
+        response.body,
+        response.headers,
+        response.reason_phrase
+      )
     end
   end
 end

data/lib/faraday_persistent_excon/connection.rb

@@ -0,0 +1,26 @@
+module FaradayPersistentExcon
+  class Connection
+    attr_accessor :excon
+    attr_accessor :last_use
+    attr_accessor :idle_timeout
+
+    def initialize(excon:, idle_timeout:)
+      @excon = excon
+      @idle_timeout = idle_timeout
+    end
+
+    def reset
+      excon.reset
+    end
+
+    def expired?
+      return false if last_use.nil? || idle_timeout == 0
+
+      Time.now.utc - last_use > idle_timeout
+    end
+
+    def used!
+      self.last_use = Time.now.utc
+    end
+  end
+end

data/lib/faraday_persistent_excon/connection_pools.rb

@@ -10,7 +10,14 @@ module FaradayPersistentExcon
         pool = self.connection_pool_for(url)
 
         if pool
-          pool.with(&block)
+          pool.with do |conn|
+            begin
+              conn.reset if conn.expired?
+              block.call(conn.excon)
+            ensure
+              conn.used!
+            end
+          end
         else
           # No pool configured.  Use normal connection
           block.call(::Excon.new(url, persistent: false))
@@ -23,7 +30,16 @@ module FaradayPersistentExcon
         if config
           self.__pools.fetch_or_store(url) do
             ::ConnectionPool.new(config) do
-              ::Excon.new(url, persistent: true, thread_safe_sockets: false)
+              Connection.new(
+                excon: ::Excon.new(
+                  url,
+                  {
+                    persistent: true,
+                    thread_safe_sockets: false
+                  }.merge(config.fetch(:connection_options, {}))
+                ),
+                idle_timeout: config.fetch(:idle_timeout, FaradayPersistentExcon.idle_timeout)
+              )
             end
           end
         end

data/lib/faraday_persistent_excon/perform_request.rb

@@ -11,15 +11,16 @@ module FaradayPersistentExcon
       end
 
     rescue ::Excon::Errors::SocketError => err
-      if err.message =~ /\btimeout\b/
-        raise Faraday::Error::TimeoutError, err
-      elsif err.message =~ /\bcertificate\b/
-        raise Faraday::Error::SSLError, err
+      case err.message
+      when /\btimeout\b/
+        raise Faraday::TimeoutError, err
+      when /\bcertificate\b/
+        raise Faraday::SSLError, err
       else
-        raise Faraday::Error::ConnectionFailed, err
+        raise Faraday::ConnectionFailed, err
       end
     rescue ::Excon::Errors::Timeout => err
-      raise Faraday::Error::TimeoutError, err
+      raise Faraday::TimeoutError, err
     end
 
     protected

data/lib/faraday_persistent_excon/request_options.rb

@@ -12,6 +12,9 @@ module FaradayPersistentExcon
         opts[:client_key]  = ssl[:client_key]  if ssl[:client_key]
         opts[:certificate] = ssl[:certificate] if ssl[:certificate]
         opts[:private_key] = ssl[:private_key] if ssl[:private_key]
+        opts[:ssl_version] = ssl[:version] if ssl[:version]
+        opts[:ssl_min_version] = ssl[:min_version] if ssl[:min_version]
+        opts[:ssl_max_version] = ssl[:max_version] if ssl[:max_version]
       end
 
       if ( req = env[:request] )
@@ -23,12 +26,12 @@ module FaradayPersistentExcon
 
         if req[:open_timeout]
           opts[:connect_timeout]   = req[:open_timeout]
-          opts[:write_timeout]     = req[:open_timeout]
         end
 
         if req[:proxy]
           opts[:proxy] = {
             host: req[:proxy][:uri].host,
+            hostname: req[:proxy][:uri].hostname,
             port: req[:proxy][:uri].port,
             scheme: req[:proxy][:uri].scheme,
             user: req[:proxy][:user],
@@ -39,7 +42,6 @@ module FaradayPersistentExcon
 
       if FaradayPersistentExcon.retry_idempotent_methods && FaradayPersistentExcon.idempotent_methods.include?(env[:method].to_s.upcase)
         opts[:idempotent] = true
-        opts[:retry_limit] = FaradayPersistentExcon.retry_limit
       end
 
       opts

data/lib/faraday_persistent_excon/version.rb

@@ -1,3 +1,3 @@
 module FaradayPersistentExcon
-  VERSION = "0.2.2"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday_persistent_excon
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Ryan Schlesinger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-24 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -129,18 +129,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Dockerfile
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
+- docker-entrypoint.sh
 - faraday_persistent_excon.gemspec
 - lib/faraday_persistent_excon.rb
 - lib/faraday_persistent_excon/adapter.rb
+- lib/faraday_persistent_excon/connection.rb
 - lib/faraday_persistent_excon/connection_pools.rb
 - lib/faraday_persistent_excon/perform_request.rb
 - lib/faraday_persistent_excon/request_options.rb
@@ -163,8 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Persistent connections with faraday and excon