faraday-net_http_persistent 1.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b05db120e4bfe54ba8aac6765a61332ec277fec5ef9b51329adee5b9f59bb0f
-  data.tar.gz: cdc170d7512ff9abe24ef22da6fccc9847a400464fab5cefe62b5e67db36c2c2
+  metadata.gz: f0b25e05ab410cbcbabe4c2ffef6bdebbf17b816ab0585299ccfc2ab6e84a6f2
+  data.tar.gz: 633f9198253455e34c773e4fc9c1bd0de5f19c464b57fe49181ea422c8e77cad
 SHA512:
-  metadata.gz: 48155794e2df01a3920d67e7d0b4a07c5992be88d51dfa76fc7d83a75d20bc44710f8c583523e65fc7ea6f27edd949848a8880d9c87b826ed90df9b07ba0d344
-  data.tar.gz: 9c38ab8831b88851c36efcc839e170ea2e62612a1d6f70cd669b36e282fd38241f553a1839046c5522d85fc4eb810b316a35e94aec7a02975f504356331fe668
+  metadata.gz: de8e7458abed9d8503ba67b4241d64a4b02baa528b316e0e10394dbfe40cfdb0a8a9ba9b71c5dd204c2a8a7c89aed6a529013aa52ee158335962fb46cadb3b01
+  data.tar.gz: bed233f50fd228cac2044a5a57892f368d76f779c29b41514abbd3190a10d89ccc08968aa85a9c7b40f8cf44bb014cb1ef7a83a1c1d018b0479538d7307731be

data/README.md

@@ -7,36 +7,29 @@ This gem is a [Faraday][faraday] adapter for the [Net::HTTP::Persistent gem][net
 
 ## Installation
 
-Add these lines to your application's Gemfile:
+Add this to your application's Gemfile:
 
 ```ruby
-gem 'faraday-net_http_persistent'
-gem 'net-http-persistent', '>= 3.1'
+gem 'faraday-net_http_persistent', '~> 2.0'
 ```
 
 And then execute:
 
     $ bundle
 
-Or install them yourself as:
-
-    $ gem install net_http_persistent -v '>= 3.1'
-    $ gem install faraday-net_http_persistent
-
 ## Usage
 
-Configure your Faraday connection to use this adapter instead of the default one:
-
 ```ruby
-connection = Faraday.new(url, conn_options) do |conn|
-  # Your other middleware goes here...
-  conn.adapter :net_http_persistent
+require 'faraday/net_http_persistent'
+
+conn = Faraday.new(...) do |f|
+  f.adapter :net_http_persistent, pool_size: 5 do |http|
+    # yields Net::HTTP::Persistent
+    http.idle_timeout = 100
+  end
 end
 ```
 
-For more information on how to setup your Faraday connection and adapters usage,
-please refer to the [Faraday Website][faraday-website].
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
@@ -62,9 +55,9 @@ The gem is available as open source under the terms of the [MIT License][mit-lic
 
 This project is intended to be a safe, welcoming space for collaboration.
 Everyone interacting in the Faraday::Http project’s codebases, issue trackers,
-chat rooms and mailing lists is expected to follow the [code of conduct].
+chat rooms and mailing lists is expected to follow the [code of conduct][code-of-conduct].
 
-[code-of-conduct]:     https://github.com/lostisland/faraday-http/blob/master/.github/CODE_OF_CONDUCT.md
+[code-of-conduct]:     https://github.com/lostisland/faraday-http/blob/main/CODE_OF_CONDUCT.md
 [covenant]:            http://contributor-covenant.org
 [faraday]:             https://github.com/lostisland/faraday
 [faraday-website]:     https://lostisland.github.io/faraday

data/lib/faraday/adapter/net_http_persistent.rb

@@ -1,33 +1,143 @@
 # frozen_string_literal: true
 
+require "net/http/persistent"
+
 module Faraday
   class Adapter
     # Net::HTTP::Persistent adapter.
-    class NetHttpPersistent < NetHttp
-      dependency "net/http/persistent"
+    class NetHttpPersistent < Faraday::Adapter
+      exceptions = [
+        IOError,
+        Errno::EADDRNOTAVAIL,
+        Errno::EALREADY,
+        Errno::ECONNABORTED,
+        Errno::ECONNREFUSED,
+        Errno::ECONNRESET,
+        Errno::EHOSTUNREACH,
+        Errno::EINVAL,
+        Errno::ENETUNREACH,
+        Errno::EPIPE,
+        Net::HTTPBadResponse,
+        Net::HTTPHeaderSyntaxError,
+        Net::ProtocolError,
+        SocketError,
+        Zlib::GzipFile::Error
+      ]
+
+      exceptions << ::OpenSSL::SSL::SSLError if defined?(::OpenSSL::SSL::SSLError)
+      # TODO (breaking): Enable this to make it consistent with net_http adapter.
+      #   See https://github.com/lostisland/faraday/issues/718#issuecomment-344549382
+      # exceptions << ::Net::OpenTimeout if defined?(::Net::OpenTimeout)
+
+      NET_HTTP_EXCEPTIONS = exceptions.freeze
+
+      def initialize(app = nil, opts = {}, &block)
+        @ssl_cert_store = nil
+        super(app, opts, &block)
+      end
+
+      def call(env)
+        super
+        connection(env) do |http|
+          perform_request(http, env)
+        rescue Net::HTTP::Persistent::Error => e
+          raise Faraday::TimeoutError, e if e.message.include?("Timeout")
+
+          raise Faraday::ConnectionFailed, e if e.message.include?("connection refused")
+
+          raise
+        rescue *NET_HTTP_EXCEPTIONS => e
+          raise Faraday::SSLError, e if defined?(OpenSSL) && e.is_a?(OpenSSL::SSL::SSLError)
+
+          raise Faraday::ConnectionFailed, e
+        end
+        @app.call env
+      rescue Timeout::Error, Errno::ETIMEDOUT => e
+        raise Faraday::TimeoutError, e
+      end
+
+      def close
+        @cached_connection&.shutdown
+      end
 
       private
 
-      def net_http_connection(env)
-        @cached_connection ||=
-          if Net::HTTP::Persistent.instance_method(:initialize)
-              .parameters.first == %i[key name]
-            options = {name: "Faraday"}
-            if @connection_options.key?(:pool_size)
-              options[:pool_size] = @connection_options[:pool_size]
-            end
-            Net::HTTP::Persistent.new(**options)
-          else
-            Net::HTTP::Persistent.new("Faraday")
+      def build_connection(env)
+        net_http_connection(env).tap do |http|
+          http.use_ssl = env[:url].scheme == "https" if http.respond_to?(:use_ssl=)
+          configure_ssl(http, env[:ssl])
+          configure_request(http, env[:request])
+        end
+      end
+
+      def create_request(env)
+        request = Net::HTTPGenericRequest.new \
+          env[:method].to_s.upcase, # request method
+          !!env[:body], # is there request body
+          env[:method] != :head, # is there response body
+          env[:url].request_uri, # request uri path
+          env[:request_headers] # request headers
+
+        if env[:body].respond_to?(:read)
+          request.body_stream = env[:body]
+        else
+          request.body = env[:body]
+        end
+        request
+      end
+
+      def save_http_response(env, http_response)
+        save_response(
+          env, http_response.code.to_i, nil, nil, http_response.message, finished: false
+        ) do |response_headers|
+          http_response.each_header do |key, value|
+            response_headers[key] = value
           end
+        end
+      end
 
-        proxy_uri = proxy_uri(env)
-        if @cached_connection.proxy_uri != proxy_uri
-          @cached_connection.proxy = proxy_uri
+      def configure_request(http, req)
+        if (sec = request_timeout(:read, req))
+          http.read_timeout = sec
+        end
+
+        if (sec = http.respond_to?(:write_timeout=) &&
+          request_timeout(:write, req))
+          http.write_timeout = sec
+        end
+
+        if (sec = request_timeout(:open, req))
+          http.open_timeout = sec
         end
+
+        # Only set if Net::Http supports it, since Ruby 2.5.
+        http.max_retries = 0 if http.respond_to?(:max_retries=)
+
+        @config_block&.call(http)
+      end
+
+      def ssl_cert_store(ssl)
+        return ssl[:cert_store] if ssl[:cert_store]
+
+        # Use the default cert store by default, i.e. system ca certs
+        @ssl_cert_store ||= OpenSSL::X509::Store.new.tap(&:set_default_paths)
+      end
+
+      def net_http_connection(env)
+        @cached_connection ||= Net::HTTP::Persistent.new(**init_options)
+
+        proxy_uri = proxy_uri(env)
+        @cached_connection.proxy = proxy_uri if @cached_connection.proxy_uri != proxy_uri
         @cached_connection
       end
 
+      def init_options
+        options = {}
+        options[:name] = @connection_options.fetch(:name, "Faraday")
+        options[:pool_size] = @connection_options[:pool_size] if @connection_options.key?(:pool_size)
+        options
+      end
+
       def proxy_uri(env)
         proxy_uri = nil
         if (proxy = env[:request][:proxy])
@@ -36,31 +146,36 @@ module Faraday
           else
             ::URI.parse(proxy[:uri].to_s)
           end
-          proxy_uri.user = proxy_uri.password = nil
-          # awful patch for net-http-persistent 2.8
-          # not unescaping user/password
-          if proxy[:user]
-            (class << proxy_uri; self; end).class_eval do
-              define_method(:user) { proxy[:user] }
-              define_method(:password) { proxy[:password] }
-            end
-          end
+          proxy_uri.user = proxy[:user] if proxy[:user]
+          proxy_uri.password = proxy[:password] if proxy[:password]
         end
         proxy_uri
       end
 
       def perform_request(http, env)
-        http.request env[:url], create_request(env)
-      rescue Errno::ETIMEDOUT, Net::OpenTimeout => e
-        raise Faraday::TimeoutError, e
-      rescue Net::HTTP::Persistent::Error => e
-        raise Faraday::TimeoutError, e if e.message.include? "Timeout"
-
-        if e.message.include? "connection refused"
-          raise Faraday::ConnectionFailed, e
+        if env.stream_response?
+          http_response = env.stream_response do |&on_data|
+            request_with_wrapped_block(http, env, &on_data)
+          end
+          http_response.body = nil
+        else
+          http_response = request_with_wrapped_block(http, env)
         end
+        env.response_body = encoded_body(http_response)
+        env.response.finish(env)
+        http_response
+      end
 
-        raise
+      def request_with_wrapped_block(http, env)
+        http.request(env[:url], create_request(env)) do |response|
+          save_http_response(env, response)
+
+          if block_given?
+            response.read_body do |chunk|
+              yield(chunk)
+            end
+          end
+        end
       end
 
       SSL_CONFIGURATIONS = {
@@ -69,8 +184,15 @@ module Faraday
         ca_file: :ca_file,
         ssl_version: :version,
         min_version: :min_version,
-        max_version: :max_version
-      }.freeze
+        max_version: :max_version,
+        verify_hostname: :verify_hostname
+      }
+
+      if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new("2.11.0")
+        SSL_CONFIGURATIONS[:ciphers] = :ciphers
+      end
+
+      SSL_CONFIGURATIONS.freeze
 
       def configure_ssl(http, ssl)
         return unless ssl
@@ -79,13 +201,34 @@ module Faraday
         http_set(http, :cert_store, ssl_cert_store(ssl))
 
         SSL_CONFIGURATIONS
-          .select { |_, key| ssl[key] }
+          .select { |_, key| !ssl[key].nil? }
           .each { |target, key| http_set(http, target, ssl[key]) }
       end
 
       def http_set(http, attr, value)
         http.send("#{attr}=", value) if http.send(attr) != value
       end
+
+      def ssl_verify_mode(ssl)
+        ssl[:verify_mode] ||
+          if ssl.fetch(:verify, true)
+            OpenSSL::SSL::VERIFY_PEER
+          else
+            OpenSSL::SSL::VERIFY_NONE
+          end
+      end
+
+      def encoded_body(http_response)
+        body = http_response.body || +""
+        /\bcharset=\s*(.+?)\s*(;|$)/.match(http_response["Content-Type"]) do |match|
+          content_charset = ::Encoding.find(match.captures.first)
+          body = body.dup if body.frozen?
+          body.force_encoding(content_charset)
+        rescue ArgumentError
+          nil
+        end
+        body
+      end
     end
   end
 end

data/lib/faraday/net_http_persistent/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module NetHttpPersistent
-    VERSION = "1.1.0"
+    VERSION = "2.3.0"
   end
 end

data/lib/faraday/net_http_persistent.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "adapter/net_http_persistent"
-require_relative "net_http_persistent/version"
+require "faraday"
+require "faraday/adapter/net_http_persistent"
+require "faraday/net_http_persistent/version"
 
 module Faraday
   module NetHttpPersistent

metadata

@@ -1,141 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: faraday-net_http_persistent
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Mike Rogers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-18 00:00:00.000000000 Z
+date: 2024-10-07 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: net-http-persistent
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: '2.5'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.19.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.19.0
-- !ruby/object:Gem::Dependency
-  name: standardrb
+  name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: multipart-parser
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: 4.0.4
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.1.1
-  type: :development
+        version: '5'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: 4.0.4
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '5'
 description: Faraday adapter for NetHttpPersistent
 email:
 - me@mikerogers.io
@@ -154,7 +62,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/lostisland/faraday-net_http_persistent
   source_code_uri: https://github.com/lostisland/faraday-net_http_persistent
-  changelog_uri: https://github.com/lostisland/faraday-net_http_persistent
+  changelog_uri: https://github.com/lostisland/faraday-net_http_persistent/releases/tag/v2.3.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -163,7 +71,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="