faraday 0.12.2 → 1.3.0

data/lib/faraday/adapter/httpclient.rb

@@ -1,78 +1,97 @@
+# frozen_string_literal: true
+
 module Faraday
   class Adapter
+    # HTTPClient adapter.
     class HTTPClient < Faraday::Adapter
       dependency 'httpclient'
 
-      def client
-        @client ||= ::HTTPClient.new
-      end
-
-      def call(env)
-        super
-
-        # enable compression
-        client.transparent_gzip_decompression = true
+      def build_connection(env)
+        @client ||= ::HTTPClient.new.tap do |cli|
+          # enable compression
+          cli.transparent_gzip_decompression = true
+        end
 
-        if req = env[:request]
-          if proxy = req[:proxy]
-            configure_proxy proxy
+        if (req = env[:request])
+          if (proxy = req[:proxy])
+            configure_proxy @client, proxy
           end
 
-          if bind = req[:bind]
-            configure_socket bind
+          if (bind = req[:bind])
+            configure_socket @client, bind
           end
 
-          configure_timeouts req
+          configure_timeouts @client, req
         end
 
-        if env[:url].scheme == 'https' && ssl = env[:ssl]
-          configure_ssl ssl
+        if env[:url].scheme == 'https' && (ssl = env[:ssl])
+          configure_ssl @client, ssl
         end
 
-        configure_client
+        configure_client @client
+
+        @client
+      end
 
-        # TODO Don't stream yet.
+      def call(env)
+        super
+
+        # TODO: Don't stream yet.
         # https://github.com/nahi/httpclient/pull/90
         env[:body] = env[:body].read if env[:body].respond_to? :read
 
-        resp = client.request env[:method], env[:url],
-          :body   => env[:body],
-          :header => env[:request_headers]
+        connection(env) do |http|
+          resp = http.request env[:method], env[:url],
+                              body: env[:body],
+                              header: env[:request_headers]
 
-        save_response env, resp.status, resp.body, resp.headers, resp.reason
+          if (req = env[:request]).stream_response?
+            warn "Streaming downloads for #{self.class.name} " \
+              'are not yet implemented.'
+            req.on_data.call(resp.body, resp.body.bytesize)
+          end
+          save_response env, resp.status, resp.body, resp.headers, resp.reason
 
-        @app.call env
+          @app.call env
+        end
       rescue ::HTTPClient::TimeoutError, Errno::ETIMEDOUT
-        raise Faraday::Error::TimeoutError, $!
-      rescue ::HTTPClient::BadResponseError => err
-        if err.message.include?('status 407')
-          raise Faraday::Error::ConnectionFailed, %{407 "Proxy Authentication Required "}
-        else
-          raise Faraday::Error::ClientError, $!
+        raise Faraday::TimeoutError, $ERROR_INFO
+      rescue ::HTTPClient::BadResponseError => e
+        if e.message.include?('status 407')
+          raise Faraday::ConnectionFailed,
+                %(407 "Proxy Authentication Required ")
         end
-      rescue Errno::ECONNREFUSED, IOError, SocketError
-        raise Faraday::Error::ConnectionFailed, $!
-      rescue => err
-        if defined?(OpenSSL) && OpenSSL::SSL::SSLError === err
-          raise Faraday::SSLError, err
-        else
-          raise
+
+        raise Faraday::ClientError, $ERROR_INFO
+      rescue Errno::EADDRNOTAVAIL, Errno::ECONNREFUSED, IOError, SocketError
+        raise Faraday::ConnectionFailed, $ERROR_INFO
+      rescue StandardError => e
+        if defined?(::OpenSSL::SSL::SSLError) && \
+           e.is_a?(::OpenSSL::SSL::SSLError)
+          raise Faraday::SSLError, e
         end
+
+        raise
       end
 
-      def configure_socket(bind)
+      # @param bind [Hash]
+      def configure_socket(client, bind)
         client.socket_local.host = bind[:host]
         client.socket_local.port = bind[:port]
       end
 
-      def configure_proxy(proxy)
+      # Configure proxy URI and any user credentials.
+      #
+      # @param proxy [Hash]
+      def configure_proxy(client, proxy)
         client.proxy = proxy[:uri]
-        if proxy[:user] && proxy[:password]
-          client.set_proxy_auth proxy[:user], proxy[:password]
-        end
+        return unless proxy[:user] && proxy[:password]
+
+        client.set_proxy_auth(proxy[:user], proxy[:password])
       end
 
-      def configure_ssl(ssl)
+      # @param ssl [Hash]
+      def configure_ssl(client, ssl)
         ssl_config = client.ssl_config
         ssl_config.verify_mode = ssl_verify_mode(ssl)
         ssl_config.cert_store = ssl_cert_store(ssl)
@@ -84,40 +103,45 @@ module Faraday
         ssl_config.verify_depth = ssl[:verify_depth] if ssl[:verify_depth]
       end
 
-      def configure_timeouts(req)
-        if req[:timeout]
-          client.connect_timeout   = req[:timeout]
-          client.receive_timeout   = req[:timeout]
-          client.send_timeout      = req[:timeout]
+      # @param req [Hash]
+      def configure_timeouts(client, req)
+        if (sec = request_timeout(:open, req))
+          client.connect_timeout = sec
         end
 
-        if req[:open_timeout]
-          client.connect_timeout   = req[:open_timeout]
-          client.send_timeout      = req[:open_timeout]
+        if (sec = request_timeout(:write, req))
+          client.send_timeout = sec
         end
+
+        return unless (sec = request_timeout(:read, req))
+
+        client.receive_timeout = sec
       end
 
-      def configure_client
-        @config_block.call(client) if @config_block
+      def configure_client(client)
+        @config_block&.call(client)
       end
 
+      # @param ssl [Hash]
+      # @return [OpenSSL::X509::Store]
       def ssl_cert_store(ssl)
         return ssl[:cert_store] if ssl[:cert_store]
+
         # Memoize the cert store so that the same one is passed to
-        # HTTPClient each time, to avoid resyncing SSL sesions when
+        # HTTPClient each time, to avoid resyncing SSL sessions when
         # it's changed
-        @cert_store ||= begin
+        @ssl_cert_store ||= begin
           # Use the default cert store by default, i.e. system ca certs
-          cert_store = OpenSSL::X509::Store.new
-          cert_store.set_default_paths
-          cert_store
+          OpenSSL::X509::Store.new.tap(&:set_default_paths)
         end
       end
 
+      # @param ssl [Hash]
       def ssl_verify_mode(ssl)
         ssl[:verify_mode] || begin
           if ssl.fetch(:verify, true)
-            OpenSSL::SSL::VERIFY_PEER | OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
+            OpenSSL::SSL::VERIFY_PEER |
+              OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
           else
             OpenSSL::SSL::VERIFY_NONE
           end

data/lib/faraday/adapter/net_http_persistent.rb

@@ -1,49 +1,90 @@
-# Rely on autoloading instead of explicit require; helps avoid the "already
-# initialized constant" warning on Ruby 1.8.7 when NetHttp is refereced below.
-# require 'faraday/adapter/net_http'
+# frozen_string_literal: true
 
 module Faraday
   class Adapter
+    # Net::HTTP::Persistent adapter.
     class NetHttpPersistent < NetHttp
       dependency 'net/http/persistent'
 
+      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')
+          end
+
+        proxy_uri = proxy_uri(env)
+        if @cached_connection.proxy_uri != proxy_uri
+          @cached_connection.proxy = proxy_uri
+        end
+        @cached_connection
+      end
+
+      def proxy_uri(env)
+        proxy_uri = nil
         if (proxy = env[:request][:proxy])
-          proxy_uri = ::URI::HTTP === proxy[:uri] ? proxy[:uri].dup : ::URI.parse(proxy[:uri].to_s)
+          proxy_uri = if proxy[:uri].is_a?(::URI::HTTP)
+                        proxy[:uri].dup
+                      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
-          (class << proxy_uri; self; end).class_eval do
-            define_method(:user) { proxy[:user] }
-            define_method(:password) { proxy[:password] }
-          end if proxy[:user]
-          return Net::HTTP::Persistent.new 'Faraday', proxy_uri
+          # 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
         end
-
-        Net::HTTP::Persistent.new 'Faraday'
+        proxy_uri
       end
 
       def perform_request(http, env)
         http.request env[:url], create_request(env)
-      rescue Errno::ETIMEDOUT => error
-        raise Faraday::Error::TimeoutError, error
-      rescue Net::HTTP::Persistent::Error => error
-        if error.message.include? 'Timeout'
-          raise Faraday::Error::TimeoutError, error
-        elsif error.message.include? 'connection refused'
-          raise Faraday::Error::ConnectionFailed, error
-        else
-          raise
+      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
         end
+
+        raise
       end
 
+      SSL_CONFIGURATIONS = {
+        certificate: :client_cert,
+        private_key: :client_key,
+        ca_file: :ca_file,
+        ssl_version: :version,
+        min_version: :min_version,
+        max_version: :max_version
+      }.freeze
+
       def configure_ssl(http, ssl)
-        http.verify_mode  = ssl_verify_mode(ssl)
-        http.cert_store   = ssl_cert_store(ssl)
+        return unless ssl
+
+        http_set(http, :verify_mode, ssl_verify_mode(ssl))
+        http_set(http, :cert_store, ssl_cert_store(ssl))
+
+        SSL_CONFIGURATIONS
+          .select { |_, key| ssl[key] }
+          .each { |target, key| http_set(http, target, ssl[key]) }
+      end
 
-        http.certificate  = ssl[:client_cert]  if ssl[:client_cert]
-        http.private_key  = ssl[:client_key]   if ssl[:client_key]
-        http.ca_file      = ssl[:ca_file]      if ssl[:ca_file]
-        http.ssl_version  = ssl[:version]      if ssl[:version]
+      def http_set(http, attr, value)
+        http.send("#{attr}=", value) if http.send(attr) != value
       end
     end
   end

data/lib/faraday/adapter/patron.rb

@@ -1,53 +1,66 @@
+# frozen_string_literal: true
+
 module Faraday
   class Adapter
+    # Patron adapter.
     class Patron < Faraday::Adapter
       dependency 'patron'
 
+      def build_connection(env)
+        session = ::Patron::Session.new
+        @config_block&.call(session)
+        if (env[:url].scheme == 'https') && env[:ssl]
+          configure_ssl(session, env[:ssl])
+        end
+
+        if (req = env[:request])
+          configure_timeouts(session, req)
+          configure_proxy(session, req[:proxy])
+        end
+
+        session
+      end
+
       def call(env)
         super
         # TODO: support streaming requests
         env[:body] = env[:body].read if env[:body].respond_to? :read
 
-        session = @session ||= create_session
-        configure_ssl(session, env[:ssl]) if env[:url].scheme == 'https' and env[:ssl]
-
-        if req = env[:request]
-          session.timeout = session.connect_timeout = req[:timeout] if req[:timeout]
-          session.connect_timeout = req[:open_timeout]              if req[:open_timeout]
-
-          if proxy = req[:proxy]
-            proxy_uri = proxy[:uri].dup
-            proxy_uri.user = proxy[:user] && Utils.escape(proxy[:user]).gsub('+', '%20')
-            proxy_uri.password = proxy[:password] && Utils.escape(proxy[:password]).gsub('+', '%20')
-            session.proxy = proxy_uri.to_s
+        response = connection(env) do |session|
+          begin
+            data = env[:body] ? env[:body].to_s : nil
+            session.request(env[:method], env[:url].to_s,
+                            env[:request_headers], data: data)
+          rescue Errno::ECONNREFUSED, ::Patron::ConnectionFailed
+            raise Faraday::ConnectionFailed, $ERROR_INFO
           end
         end
 
-        response = begin
-          data = env[:body] ? env[:body].to_s : nil
-          session.request(env[:method], env[:url].to_s, env[:request_headers], :data => data)
-        rescue Errno::ECONNREFUSED, ::Patron::ConnectionFailed
-          raise Error::ConnectionFailed, $!
+        if (req = env[:request]).stream_response?
+          warn "Streaming downloads for #{self.class.name} " \
+            'are not yet implemented.'
+          req.on_data.call(response.body, response.body.bytesize)
         end
-
         # Remove the "HTTP/1.1 200", leaving just the reason phrase
         reason_phrase = response.status_line.gsub(/^.* \d{3} /, '')
 
-        save_response(env, response.status, response.body, response.headers, reason_phrase)
+        save_response(env, response.status, response.body,
+                      response.headers, reason_phrase)
 
         @app.call env
-      rescue ::Patron::TimeoutError => err
-        if err.message == "Connection time-out"
-          raise Faraday::Error::ConnectionFailed, err
-        else
-          raise Faraday::Error::TimeoutError, err
+      rescue ::Patron::TimeoutError => e
+        if connection_timed_out_message?(e.message)
+          raise Faraday::ConnectionFailed, e
         end
-      rescue ::Patron::Error => err
-        if err.message.include?("code 407")
-          raise Error::ConnectionFailed, %{407 "Proxy Authentication Required "}
-        else
-          raise Error::ConnectionFailed, err
+
+        raise Faraday::TimeoutError, e
+      rescue ::Patron::Error => e
+        if e.message.include?('code 407')
+          raise Faraday::ConnectionFailed,
+                %(407 "Proxy Authentication Required ")
         end
+
+        raise Faraday::ConnectionFailed, e
       end
 
       if loaded? && defined?(::Patron::Request::VALID_ACTIONS)
@@ -59,18 +72,12 @@ module Faraday
             actions << :options unless actions.include? :options
           else
             # Patron 0.4.20 and up
-            actions << "PATCH" unless actions.include? "PATCH"
-            actions << "OPTIONS" unless actions.include? "OPTIONS"
+            actions << 'PATCH' unless actions.include? 'PATCH'
+            actions << 'OPTIONS' unless actions.include? 'OPTIONS'
           end
         end
       end
 
-      def create_session
-        session = ::Patron::Session.new
-        @config_block.call(session) if @config_block
-        session
-      end
-
       def configure_ssl(session, ssl)
         if ssl.fetch(:verify, true)
           session.cacert = ssl[:ca_file]
@@ -78,6 +85,48 @@ module Faraday
           session.insecure = true
         end
       end
+
+      def configure_timeouts(session, req)
+        return unless req
+
+        if (sec = request_timeout(:read, req))
+          session.timeout = sec
+        end
+
+        return unless (sec = request_timeout(:open, req))
+
+        session.connect_timeout = sec
+      end
+
+      def configure_proxy(session, proxy)
+        return unless proxy
+
+        proxy_uri = proxy[:uri].dup
+        proxy_uri.user = proxy[:user] &&
+                         Utils.escape(proxy[:user]).gsub('+', '%20')
+        proxy_uri.password = proxy[:password] &&
+                             Utils.escape(proxy[:password]).gsub('+', '%20')
+        session.proxy = proxy_uri.to_s
+      end
+
+      private
+
+      CURL_TIMEOUT_MESSAGES = [
+        'Connection time-out',
+        'Connection timed out',
+        'Timed out before name resolve',
+        'server connect has timed out',
+        'Resolving timed out',
+        'name lookup timed out',
+        'timed out before SSL',
+        'connect() timed out'
+      ].freeze
+
+      def connection_timed_out_message?(message)
+        CURL_TIMEOUT_MESSAGES.any? do |curl_message|
+          message.include?(curl_message)
+        end
+      end
     end
   end
 end