faraday 0.9.2 → 1.0.0

data/lib/faraday/adapter/em_synchrony.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require 'uri'
 
 module Faraday
   class Adapter
+    # EventMachine Synchrony adapter.
     class EMSynchrony < Faraday::Adapter
       include EMHttp::Options
 
@@ -13,77 +16,121 @@ module Faraday
 
       self.supports_parallel = true
 
-      def self.setup_parallel_manager(options = {})
+      # @return [ParallelManager]
+      def self.setup_parallel_manager(_options = nil)
         ParallelManager.new
       end
 
       def call(env)
         super
-        request = EventMachine::HttpRequest.new(Utils::URI(env[:url].to_s), connection_config(env))
+        request = create_request(env)
 
         http_method = env[:method].to_s.downcase.to_sym
 
-        # Queue requests for parallel execution.
         if env[:parallel_manager]
-          env[:parallel_manager].add(request, http_method, request_config(env)) do |resp|
-            save_response(env, resp.response_header.status, resp.response) do |resp_headers|
-              resp.response_header.each do |name, value|
-                resp_headers[name.to_sym] = value
-              end
-            end
+          # Queue requests for parallel execution.
+          execute_parallel_request(env, request, http_method)
+        else
+          # Execute single request.
+          execute_single_request(env, request, http_method)
+        end
 
-            # Finalize the response object with values from `env`.
-            env[:response].finish(env)
-          end
+        @app.call env
+      rescue Errno::ECONNREFUSED
+        raise Faraday::ConnectionFailed, $ERROR_INFO
+      rescue EventMachine::Connectify::CONNECTError => e
+        if e.message.include?('Proxy Authentication Required')
+          raise Faraday::ConnectionFailed,
+                %(407 "Proxy Authentication Required")
+        end
 
-        # Execute single request.
-        else
-          client = nil
-          block = lambda { request.send(http_method, request_config(env)) }
-
-          if !EM.reactor_running?
-            EM.run do
-              Fiber.new {
-                client = block.call
-                EM.stop
-              }.resume
-            end
-          else
-            client = block.call
-          end
+        raise Faraday::ConnectionFailed, e
+      rescue Errno::ETIMEDOUT => e
+        raise Faraday::TimeoutError, e
+      rescue RuntimeError => e
+        if e.message == 'connection closed by server'
+          raise Faraday::ConnectionFailed, e
+        end
+
+        raise Faraday::TimeoutError, e if e.message.include?('timeout error')
+
+        raise
+      rescue StandardError => e
+        if defined?(OpenSSL) && e.is_a?(OpenSSL::SSL::SSLError)
+          raise Faraday::SSLError, e
+        end
+
+        raise
+      end
+
+      def create_request(env)
+        EventMachine::HttpRequest.new(
+          Utils::URI(env[:url].to_s),
+          connection_config(env).merge(@connection_options)
+        )
+      end
 
-          raise client.error if client.error
+      private
 
-          save_response(env, client.response_header.status, client.response) do |resp_headers|
-            client.response_header.each do |name, value|
+      def execute_parallel_request(env, request, http_method)
+        env[:parallel_manager].add(request, http_method,
+                                   request_config(env)) do |resp|
+          if (req = env[:request]).stream_response?
+            warn "Streaming downloads for #{self.class.name} " \
+                'are not yet implemented.'
+            req.on_data.call(resp.response, resp.response.bytesize)
+          end
+
+          save_response(env, resp.response_header.status,
+                        resp.response) do |resp_headers|
+            resp.response_header.each do |name, value|
               resp_headers[name.to_sym] = value
             end
           end
+
+          # Finalize the response object with values from `env`.
+          env[:response].finish(env)
         end
+      end
 
-        @app.call env
-      rescue Errno::ECONNREFUSED
-        raise Error::ConnectionFailed, $!
-      rescue EventMachine::Connectify::CONNECTError => err
-        if err.message.include?("Proxy Authentication Required")
-          raise Error::ConnectionFailed, %{407 "Proxy Authentication Required "}
-        else
-          raise Error::ConnectionFailed, err
+      def execute_single_request(env, request, http_method)
+        block = -> { request.send(http_method, request_config(env)) }
+        client = call_block(block)
+
+        raise client.error if client&.error
+
+        if env[:request].stream_response?
+          warn "Streaming downloads for #{self.class.name} " \
+              'are not yet implemented.'
+          env[:request].on_data.call(
+            client.response,
+            client.response.bytesize
+          )
         end
-      rescue Errno::ETIMEDOUT => err
-        raise Error::TimeoutError, err
-      rescue RuntimeError => err
-        if err.message == "connection closed by server"
-          raise Error::ConnectionFailed, err
-        else
-          raise
+        status = client.response_header.status
+        reason = client.response_header.http_reason
+        save_response(env, status, client.response, nil, reason) do |headers|
+          client.response_header.each do |name, value|
+            headers[name.to_sym] = value
+          end
         end
-      rescue => err
-        if defined?(OpenSSL) && OpenSSL::SSL::SSLError === err
-          raise Faraday::SSLError, err
+      end
+
+      def call_block(block)
+        client = nil
+
+        if EM.reactor_running?
+          client = block.call
         else
-          raise
+          EM.run do
+            Fiber.new do
+              client = block.call
+              EM.stop
+            end.resume
+          end
         end
+
+        client
       end
     end
   end
@@ -91,10 +138,13 @@ end
 
 require 'faraday/adapter/em_synchrony/parallel_manager'
 
-begin
-  require 'openssl'
-rescue LoadError
-  warn "Warning: no such file to load -- openssl. Make sure it is installed if you want HTTPS support"
-else
-  require 'faraday/adapter/em_http_ssl_patch'
-end if Faraday::Adapter::EMSynchrony.loaded?
+if Faraday::Adapter::EMSynchrony.loaded?
+  begin
+    require 'openssl'
+  rescue LoadError
+    warn 'Warning: no such file to load -- openssl. ' \
+      'Make sure it is installed if you want HTTPS support'
+  else
+    require 'faraday/adapter/em_http_ssl_patch'
+  end
+end

data/lib/faraday/adapter/excon.rb

@@ -1,81 +1,124 @@
+# frozen_string_literal: true
+
 module Faraday
   class Adapter
+    # Excon adapter.
     class Excon < Faraday::Adapter
       dependency 'excon'
 
-      def initialize(app, connection_options = {})
-        @connection_options = connection_options
-        super(app)
+      def build_connection(env)
+        opts = opts_from_env(env)
+        ::Excon.new(env[:url].to_s, opts.merge(@connection_options))
       end
 
       def call(env)
         super
 
-        opts = {}
-        if env[:url].scheme == 'https' && ssl = env[:ssl]
-          opts[:ssl_verify_peer] = !!ssl.fetch(:verify, true)
-          opts[:ssl_ca_path] = ssl[:ca_path] if ssl[:ca_path]
-          opts[:ssl_ca_file] = ssl[:ca_file] if ssl[:ca_file]
-          opts[:client_cert] = ssl[:client_cert] if ssl[:client_cert]
-          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]
-
-          # https://github.com/geemus/excon/issues/106
-          # https://github.com/jruby/jruby-ossl/issues/19
-          opts[:nonblock] = false
-        end
-
-        if ( req = env[:request] )
-          if req[:timeout]
-            opts[:read_timeout]      = req[:timeout]
-            opts[:connect_timeout]   = req[:timeout]
-            opts[:write_timeout]     = req[:timeout]
-          end
+        req_opts = {
+          method: env[:method].to_s.upcase,
+          headers: env[:request_headers],
+          body: read_body(env)
+        }
 
-          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],
-              :password => req[:proxy][:password]
-            }
+        req = env[:request]
+        if req&.stream_response?
+          total = 0
+          req_opts[:response_block] = lambda do |chunk, _remain, _total|
+            req.on_data.call(chunk, total += chunk.size)
           end
         end
 
-        conn = ::Excon.new(env[:url].to_s, opts.merge(@connection_options))
+        resp = connection(env) { |http| http.request(req_opts) }
+        save_response(env, resp.status.to_i, resp.body, resp.headers,
+                      resp.reason_phrase)
 
-        resp = conn.request \
-          :method  => env[:method].to_s.upcase,
-          :headers => env[:request_headers],
-          :body    => read_body(env)
+        @app.call(env)
+      rescue ::Excon::Errors::SocketError => e
+        raise Faraday::TimeoutError, e if e.message =~ /\btimeout\b/
 
-        save_response(env, resp.status.to_i, resp.body, resp.headers)
+        raise Faraday::SSLError, e if e.message =~ /\bcertificate\b/
 
-        @app.call env
-      rescue ::Excon::Errors::SocketError => err
-        if err.message =~ /\btimeout\b/
-          raise Error::TimeoutError, err
-        elsif err.message =~ /\bcertificate\b/
-          raise Faraday::SSLError, err
-        else
-          raise Error::ConnectionFailed, err
-        end
-      rescue ::Excon::Errors::Timeout => err
-        raise Error::TimeoutError, err
+        raise Faraday::ConnectionFailed, e
+      rescue ::Excon::Errors::Timeout => e
+        raise Faraday::TimeoutError, e
       end
 
       # TODO: support streaming requests
       def read_body(env)
         env[:body].respond_to?(:read) ? env[:body].read : env[:body]
       end
+
+      private
+
+      def opts_from_env(env)
+        opts = {}
+        amend_opts_with_ssl!(opts, env[:ssl]) if needs_ssl_settings?(env)
+
+        if (req = env[:request])
+          amend_opts_with_timeouts!(opts, req)
+          amend_opts_with_proxy_settings!(opts, req)
+        end
+
+        opts
+      end
+
+      def needs_ssl_settings?(env)
+        env[:url].scheme == 'https' && env[:ssl]
+      end
+
+      OPTS_KEYS = [
+        %i[client_cert client_cert],
+        %i[client_key client_key],
+        %i[certificate certificate],
+        %i[private_key private_key],
+        %i[ssl_ca_path ca_path],
+        %i[ssl_ca_file ca_file],
+        %i[ssl_version version],
+        %i[ssl_min_version min_version],
+        %i[ssl_max_version max_version]
+      ].freeze
+
+      def amend_opts_with_ssl!(opts, ssl)
+        opts[:ssl_verify_peer] = !!ssl.fetch(:verify, true)
+        # https://github.com/geemus/excon/issues/106
+        # https://github.com/jruby/jruby-ossl/issues/19
+        opts[:nonblock] = false
+
+        OPTS_KEYS.each do |(key_in_opts, key_in_ssl)|
+          next unless ssl[key_in_ssl]
+
+          opts[key_in_opts] = ssl[key_in_ssl]
+        end
+      end
+
+      def amend_opts_with_timeouts!(opts, req)
+        if (sec = request_timeout(:read, req))
+          opts[:read_timeout] = sec
+        end
+
+        if (sec = request_timeout(:write, req))
+          opts[:write_timeout] = sec
+        end
+
+        return unless (sec = request_timeout(:open, req))
+
+        opts[:connect_timeout] = sec
+      end
+
+      def amend_opts_with_proxy_settings!(opts, req)
+        opts[:proxy] = proxy_settings_for_opts(req[:proxy]) if req[:proxy]
+      end
+
+      def proxy_settings_for_opts(proxy)
+        {
+          host: proxy[:uri].host,
+          hostname: proxy[:uri].hostname,
+          port: proxy[:uri].port,
+          scheme: proxy[:uri].scheme,
+          user: proxy[:user],
+          password: proxy[:password]
+        }
+      end
     end
   end
 end

data/lib/faraday/adapter/httpclient.rb

@@ -1,76 +1,96 @@
+# 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
 
-        # TODO Don't stream yet.
+        configure_client @client
+
+        @client
+      end
+
+      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
+          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, EOFError
-        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) && 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)
@@ -82,31 +102,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(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]
-        # 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
+
+        # Memoize the cert store so that the same one is passed to
+        # HTTPClient each time, to avoid resyncing SSL sessions when
+        # it's changed
+        @ssl_cert_store ||= begin
+          # Use the default cert store by default, i.e. system ca certs
+          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