faraday 0.17.6 → 1.0.1

data/lib/faraday/adapter/net_http.rb

@@ -1,15 +1,19 @@
+# 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,
@@ -23,54 +27,78 @@ 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)
+      if defined?(::OpenSSL::SSL::SSLError)
+        exceptions << ::OpenSSL::SSL::SSLError
+      end
+      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]
+      def build_connection(env)
+        net_http_connection(env).tap do |http|
+          if http.respond_to?(:use_ssl=)
+            http.use_ssl = env[:url].scheme == 'https'
+          end
+          configure_ssl(http, env[:ssl])
           configure_request(http, env[:request])
+        end
+      end
 
+      def net_http_connection(env)
+        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 call(env)
+        super
+        http_response = connection(env) do |http|
           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 Faraday::ConnectionFailed, err
+            perform_request(http, env)
+          rescue *NET_HTTP_EXCEPTIONS => e
+            if defined?(OpenSSL) && e.is_a?(OpenSSL::SSL::SSLError)
+              raise Faraday::SSLError, e
             end
+
+            raise Faraday::ConnectionFailed, e
           end
+        end
 
-          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
+        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
         end
 
         @app.call env
-      rescue Timeout::Error, Errno::ETIMEDOUT => err
-        raise Faraday::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]
@@ -81,62 +109,100 @@ 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
-          http.request create_request(env)
+          request_via_request_method(http, env, &block)
         end
       end
 
-      def with_net_http_connection(env)
-        yield net_http_connection(env)
+      def request_via_get_method(http, env, &block)
+        # Must use Net::HTTP#start and pass it a block otherwise the server's
+        # TCP socket does not close correctly.
+        http.start do |opened_http|
+          opened_http.get env[:url].request_uri, env[:request_headers], &block
+        end
       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))
+      def request_via_request_method(http, env, &block)
+        # Must use Net::HTTP#start and pass it a block otherwise the server's
+        # TCP socket does not close correctly.
+        http.start do |opened_http|
+          if block_given?
+            opened_http.request create_request(env) do |response|
+              response.read_body(&block)
+            end
+          else
+            opened_http.request create_request(env)
+          end
+        end
       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]
+        return unless ssl
+
+        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=)
+        if (sec = request_timeout(:read, req))
+          http.read_timeout = sec
         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=)
 
-        @config_block.call(http) if @config_block
+        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]
-        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,81 @@ 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::TimeoutError, error
-      rescue Net::HTTP::Persistent::Error => error
-        if error.message.include? 'Timeout'
-          raise Faraday::TimeoutError, error
-        elsif error.message.include? 'connection refused'
-          raise Faraday::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)
+        return unless 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

data/lib/faraday/adapter/patron.rb

@@ -1,54 +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 = ::Patron::Session.new
-        @config_block.call(session) if @config_block
-        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 Faraday::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 connection_timed_out_message?(err.message)
-          raise Faraday::ConnectionFailed, err
-        else
-          raise Faraday::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 Faraday::ConnectionFailed, %{407 "Proxy Authentication Required "}
-        else
-          raise Faraday::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)
@@ -60,8 +72,8 @@ 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
@@ -74,22 +86,47 @@ module Faraday
         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
+      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? { |curl_message| message.include?(curl_message) }
+        CURL_TIMEOUT_MESSAGES.any? do |curl_message|
+          message.include?(curl_message)
+        end
       end
-
     end
   end
 end

data/lib/faraday/adapter/rack.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Faraday
   class Adapter
     # Sends requests to a Rack app.
     #
-    # Examples
+    # @example
     #
     #   class MyRackApp
     #     def call(env)
@@ -17,7 +19,7 @@ module Faraday
       dependency 'rack/test'
 
       # not prefixed with "HTTP_"
-      SPECIAL_HEADERS = %w[ CONTENT_LENGTH CONTENT_TYPE ]
+      SPECIAL_HEADERS = %w[CONTENT_LENGTH CONTENT_TYPE].freeze
 
       def initialize(faraday_app, rack_app)
         super(faraday_app)
@@ -27,32 +29,47 @@ module Faraday
 
       def call(env)
         super
-        rack_env = {
-          :method => env[:method],
-          :input  => env[:body].respond_to?(:read) ? env[:body].read : env[:body],
-          'rack.url_scheme' => env[:url].scheme
-        }
+        rack_env = build_rack_env(env)
 
-        env[:request_headers].each do |name, value|
+        env[:request_headers]&.each do |name, value|
           name = name.upcase.tr('-', '_')
           name = "HTTP_#{name}" unless SPECIAL_HEADERS.include? name
           rack_env[name] = value
-        end if env[:request_headers]
+        end
 
-        timeout  = env[:request][:timeout] || env[:request][:open_timeout]
+        timeout = request_timeout(:open, env[:request])
+        timeout ||= request_timeout(:read, env[:request])
         response = if timeout
-          Timer.timeout(timeout, Faraday::TimeoutError) { execute_request(env, rack_env) }
-        else
-          execute_request(env, rack_env)
+                     Timer.timeout(timeout, Faraday::TimeoutError) do
+                       execute_request(env, rack_env)
+                     end
+                   else
+                     execute_request(env, rack_env)
+                   end
+
+        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
 
         save_response(env, response.status, response.body, response.headers)
         @app.call env
       end
 
+      private
+
       def execute_request(env, rack_env)
         @session.request(env[:url].to_s, rack_env)
       end
+
+      def build_rack_env(env)
+        {
+          method: env[:method],
+          input: env[:body].respond_to?(:read) ? env[:body].read : env[:body],
+          'rack.url_scheme' => env[:url].scheme
+        }
+      end
     end
   end
 end