faraday 0.15.4 → 0.16.0

data/lib/faraday/adapter/httpclient.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Faraday
   class Adapter
+    # HTTPClient adapter.
     class HTTPClient < Faraday::Adapter
       dependency 'httpclient'
 
+      # @return [HTTPClient]
       def client
         @client ||= ::HTTPClient.new
       end
@@ -13,65 +17,76 @@ module Faraday
         # enable compression
         client.transparent_gzip_decompression = true
 
-        if req = env[:request]
-          if proxy = req[:proxy]
+        if (req = env[:request])
+          if (proxy = req[:proxy])
             configure_proxy proxy
           end
 
-          if bind = req[:bind]
+          if (bind = req[:bind])
             configure_socket bind
           end
 
           configure_timeouts req
         end
 
-        if env[:url].scheme == 'https' && ssl = env[:ssl]
+        if env[:url].scheme == 'https' && (ssl = env[:ssl])
           configure_ssl ssl
         end
 
         configure_client
 
-        # TODO Don't stream yet.
+        # 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]
+                              body: env[:body],
+                              header: env[:request_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
       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) && e.is_a?(OpenSSL::SSL::SSLError)
+          raise Faraday::SSLError, e
         end
+
+        raise
       end
 
+      # @param bind [Hash]
       def configure_socket(bind)
         client.socket_local.host = bind[:host]
         client.socket_local.port = bind[:port]
       end
 
+      # Configure proxy URI and any user credentials.
+      #
+      # @param proxy [Hash]
       def configure_proxy(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
 
+      # @param ssl [Hash]
       def configure_ssl(ssl)
         ssl_config = client.ssl_config
         ssl_config.verify_mode = ssl_verify_mode(ssl)
@@ -84,40 +99,47 @@ module Faraday
         ssl_config.verify_depth = ssl[:verify_depth] if ssl[:verify_depth]
       end
 
+      # @param req [Hash]
       def configure_timeouts(req)
-        if req[:timeout]
-          client.connect_timeout   = req[:timeout]
-          client.receive_timeout   = req[:timeout]
-          client.send_timeout      = req[:timeout]
-        end
+        configure_timeout(req) if req[:timeout]
+        configure_open_timeout(req) if req[:open_timeout]
+      end
 
-        if req[:open_timeout]
-          client.connect_timeout   = req[:open_timeout]
-          client.send_timeout      = req[:open_timeout]
-        end
+      def configure_timeout(req)
+        client.connect_timeout   = req[:timeout]
+        client.receive_timeout   = req[:timeout]
+        client.send_timeout      = req[:timeout]
+      end
+
+      def configure_open_timeout(req)
+        client.connect_timeout   = req[:open_timeout]
+        client.send_timeout      = req[:open_timeout]
       end
 
       def configure_client
-        @config_block.call(client) if @config_block
+        @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.rb

@@ -1,16 +1,21 @@
+# frozen_string_literal: true
+
 begin
   require 'net/https'
 rescue LoadError
-  warn "Warning: no such file to load -- net/https. Make sure openssl is installed if you want ssl support"
+  warn 'Warning: no such file to load -- net/https. ' \
+    'Make sure openssl is installed if you want ssl support'
   require 'net/http'
 end
 require 'zlib'
 
 module Faraday
   class Adapter
+    # Net::HTTP adapter.
     class NetHttp < Faraday::Adapter
-      NET_HTTP_EXCEPTIONS = [
+      exceptions = [
         IOError,
+        Errno::EADDRNOTAVAIL,
         Errno::ECONNABORTED,
         Errno::ECONNREFUSED,
         Errno::ECONNRESET,
@@ -22,34 +27,40 @@ module Faraday
         Net::HTTPHeaderSyntaxError,
         Net::ProtocolError,
         SocketError,
-        Zlib::GzipFile::Error,
+        Zlib::GzipFile::Error
       ]
 
-      NET_HTTP_EXCEPTIONS << OpenSSL::SSL::SSLError if defined?(OpenSSL)
-      NET_HTTP_EXCEPTIONS << Net::OpenTimeout if defined?(Net::OpenTimeout)
+      exceptions << OpenSSL::SSL::SSLError if defined?(OpenSSL)
+      exceptions << Net::OpenTimeout if defined?(Net::OpenTimeout)
+
+      NET_HTTP_EXCEPTIONS = exceptions.freeze
 
       def initialize(app = nil, opts = {}, &block)
-        @cert_store = nil
+        @ssl_cert_store = nil
         super(app, opts, &block)
       end
 
       def call(env)
         super
         with_net_http_connection(env) do |http|
-          configure_ssl(http, env[:ssl]) if env[:url].scheme == 'https' and env[:ssl]
+          if (env[:url].scheme == 'https') && env[:ssl]
+            configure_ssl(http, env[:ssl])
+          end
           configure_request(http, env[:request])
 
           begin
             http_response = perform_request(http, env)
-          rescue *NET_HTTP_EXCEPTIONS => err
-            if defined?(OpenSSL) && OpenSSL::SSL::SSLError === err
-              raise Faraday::SSLError, err
-            else
-              raise Error::ConnectionFailed, err
+          rescue *NET_HTTP_EXCEPTIONS => e
+            if defined?(OpenSSL) && e.is_a?(OpenSSL::SSL::SSLError)
+              raise Faraday::SSLError, e
             end
+
+            raise Faraday::ConnectionFailed, e
           end
 
-          save_response(env, http_response.code.to_i, http_response.body || '', nil, http_response.message) do |response_headers|
+          save_response(env, http_response.code.to_i,
+                        http_response.body || '', nil,
+                        http_response.message) do |response_headers|
             http_response.each_header do |key, value|
               response_headers[key] = value
             end
@@ -57,19 +68,19 @@ module Faraday
         end
 
         @app.call env
-      rescue Timeout::Error, Errno::ETIMEDOUT => err
-        raise Faraday::Error::TimeoutError, err
+      rescue Timeout::Error, Errno::ETIMEDOUT => e
+        raise Faraday::TimeoutError, e
       end
 
       private
 
       def create_request(env)
         request = Net::HTTPGenericRequest.new \
-          env[:method].to_s.upcase,    # request method
-          !!env[:body],                # is there request body
-          :head != env[:method],       # is there response body
-          env[:url].request_uri,       # request uri path
-          env[:request_headers]        # request headers
+          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]
@@ -80,9 +91,44 @@ module Faraday
       end
 
       def perform_request(http, env)
-        if :get == env[:method] and !env[:body]
+        if env[:request].stream_response?
+          size = 0
+          yielded = false
+          http_response = request_with_wrapped_block(http, env) do |chunk|
+            if chunk.bytesize.positive? || size.positive?
+              yielded = true
+              size += chunk.bytesize
+              env[:request].on_data.call(chunk, size)
+            end
+          end
+          env[:request].on_data.call('', 0) unless yielded
+          # Net::HTTP returns something,
+          # but it's not meaningful according to the docs.
+          http_response.body = nil
+          http_response
+        else
+          request_with_wrapped_block(http, env)
+        end
+      end
+
+      def request_with_wrapped_block(http, env, &block)
+        if (env[:method] == :get) && !env[:body]
           # prefer `get` to `request` because the former handles gzip (ruby 1.9)
-          http.get env[:url].request_uri, env[:request_headers]
+          request_via_get_method(http, env, &block)
+        else
+          request_via_request_method(http, env, &block)
+        end
+      end
+
+      def request_via_get_method(http, env, &block)
+        http.get env[:url].request_uri, env[:request_headers], &block
+      end
+
+      def request_via_request_method(http, env, &block)
+        if block_given?
+          http.request create_request(env) do |response|
+            response.read_body(&block)
+          end
         else
           http.request create_request(env)
         end
@@ -93,49 +139,56 @@ module Faraday
       end
 
       def net_http_connection(env)
-        if proxy = env[:request][:proxy]
-          Net::HTTP::Proxy(proxy[:uri].hostname, proxy[:uri].port, proxy[:user], proxy[:password])
-        else
-          Net::HTTP
-        end.new(env[:url].hostname, env[:url].port || (env[:url].scheme == 'https' ? 443 : 80))
+        klass = if (proxy = env[:request][:proxy])
+                  Net::HTTP::Proxy(proxy[:uri].hostname, proxy[:uri].port,
+                                   proxy[:user], proxy[:password])
+                else
+                  Net::HTTP
+                end
+        port = env[:url].port || (env[:url].scheme == 'https' ? 443 : 80)
+        klass.new(env[:url].hostname, port)
       end
 
       def configure_ssl(http, ssl)
-        http.use_ssl      = true
-        http.verify_mode  = ssl_verify_mode(ssl)
-        http.cert_store   = ssl_cert_store(ssl)
-
-        http.cert         = ssl[:client_cert]  if ssl[:client_cert]
-        http.key          = ssl[:client_key]   if ssl[:client_key]
-        http.ca_file      = ssl[:ca_file]      if ssl[:ca_file]
-        http.ca_path      = ssl[:ca_path]      if ssl[:ca_path]
+        http.use_ssl = true
+        http.verify_mode = ssl_verify_mode(ssl)
+        http.cert_store = ssl_cert_store(ssl)
+
+        http.cert = ssl[:client_cert] if ssl[:client_cert]
+        http.key = ssl[:client_key] if ssl[:client_key]
+        http.ca_file = ssl[:ca_file] if ssl[:ca_file]
+        http.ca_path = ssl[:ca_path] if ssl[:ca_path]
         http.verify_depth = ssl[:verify_depth] if ssl[:verify_depth]
-        http.ssl_version  = ssl[:version]      if ssl[:version]
-        http.min_version  = ssl[:min_version]  if ssl[:min_version]
-        http.max_version  = ssl[:max_version]  if ssl[:max_version]
+        http.ssl_version = ssl[:version] if ssl[:version]
+        http.min_version = ssl[:min_version] if ssl[:min_version]
+        http.max_version = ssl[:max_version] if ssl[:max_version]
       end
 
       def configure_request(http, req)
         if req[:timeout]
-          http.read_timeout  = req[:timeout]
-          http.open_timeout  = req[:timeout]
-          http.write_timeout = req[:timeout] if http.respond_to?(:write_timeout=)
+          http.read_timeout = req[:timeout]
+          http.open_timeout = req[:timeout]
+          if http.respond_to?(:write_timeout=)
+            http.write_timeout = req[:timeout]
+          end
+        end
+        http.open_timeout = req[:open_timeout] if req[:open_timeout]
+        if req[:write_timeout] && http.respond_to?(:write_timeout=)
+          http.write_timeout = req[:write_timeout]
         end
-        http.open_timeout  = req[:open_timeout]  if req[:open_timeout]
-        http.write_timeout = req[:write_timeout] if req[:write_timeout] && http.respond_to?(:write_timeout=)
-          # Only set if Net::Http supports it, since Ruby 2.5.
-        http.max_retries  = 0                    if http.respond_to?(:max_retries=)
+        # 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) if @config_block
+        @config_block&.call(http)
       end
 
       def ssl_cert_store(ssl)
         return ssl[:cert_store] if ssl[:cert_store]
-        return @cert_store if @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
+
+        @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
 
       def ssl_verify_mode(ssl)

data/lib/faraday/adapter/net_http_persistent.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Faraday
   class Adapter
+    # Net::HTTP::Persistent adapter.
     class NetHttpPersistent < NetHttp
       dependency 'net/http/persistent'
 
@@ -7,61 +10,79 @@ module Faraday
 
       def net_http_connection(env)
         @cached_connection ||=
-          if Net::HTTP::Persistent.instance_method(:initialize).parameters.first == [:key, :name]
-            options = {name: 'Faraday'}
-            options[:pool_size] = @connection_options[:pool_size] if @connection_options.key?(:pool_size)
+          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)
-        @cached_connection.proxy = proxy_uri if @cached_connection.proxy_uri != proxy_uri
+        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]
+          # 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
         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 => 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_set(http, :verify_mode, ssl_verify_mode(ssl))
-        http_set(http, :cert_store,  ssl_cert_store(ssl))
+        http_set(http, :cert_store, ssl_cert_store(ssl))
 
-        http_set(http, :certificate, ssl[:client_cert]) if ssl[:client_cert]
-        http_set(http, :private_key, ssl[:client_key])  if ssl[:client_key]
-        http_set(http, :ca_file,     ssl[:ca_file])     if ssl[:ca_file]
-        http_set(http, :ssl_version, ssl[:version])     if ssl[:version]
+        SSL_CONFIGURATIONS
+          .select { |_, key| ssl[key] }
+          .each { |target, key| http_set(http, target, ssl[key]) }
       end
 
       def http_set(http, attr, value)
-        if http.send(attr) != value
-          http.send("#{attr}=", value)
-        end
+        http.send("#{attr}=", value) if http.send(attr) != value
       end
     end
   end