faraday 0.17.3 → 1.0.1

data/lib/faraday/adapter/em_http_ssl_patch.rb

@@ -1,43 +1,49 @@
+# frozen_string_literal: true
+
 require 'openssl'
 require 'em-http'
 
+# EventMachine patch to make SSL work.
 module EmHttpSslPatch
   def ssl_verify_peer(cert_string)
-    cert = nil
     begin
-      cert = OpenSSL::X509::Certificate.new(cert_string)
+      @last_seen_cert = OpenSSL::X509::Certificate.new(cert_string)
     rescue OpenSSL::X509::CertificateError
       return false
     end
 
-    @last_seen_cert = cert
-
-    if certificate_store.verify(@last_seen_cert)
-      begin
-        certificate_store.add_cert(@last_seen_cert)
-      rescue OpenSSL::X509::StoreError => e
-        raise e unless e.message == 'cert already in hash table'
-      end
-      true
-    else
-      raise OpenSSL::SSL::SSLError.new(%(unable to verify the server certificate for "#{host}"))
+    unless certificate_store.verify(@last_seen_cert)
+      raise OpenSSL::SSL::SSLError,
+            %(unable to verify the server certificate for "#{host}")
+    end
+
+    begin
+      certificate_store.add_cert(@last_seen_cert)
+    rescue OpenSSL::X509::StoreError => e
+      raise e unless e.message == 'cert already in hash table'
     end
+    true
   end
 
   def ssl_handshake_completed
     return true unless verify_peer?
 
-    unless OpenSSL::SSL.verify_certificate_identity(@last_seen_cert, host)
-      raise OpenSSL::SSL::SSLError.new(%(host "#{host}" does not match the server certificate))
-    else
-      true
+    unless verified_cert_identity?
+      raise OpenSSL::SSL::SSLError,
+            %(host "#{host}" does not match the server certificate)
     end
+
+    true
   end
 
   def verify_peer?
     parent.connopts.tls[:verify_peer]
   end
 
+  def verified_cert_identity?
+    OpenSSL::SSL.verify_certificate_identity(@last_seen_cert, host)
+  end
+
   def host
     parent.uri.host
   end
@@ -53,4 +59,4 @@ module EmHttpSslPatch
   end
 end
 
-EventMachine::HttpStubConnection.send(:include, EmHttpSslPatch)
+EventMachine::HttpStubConnection.include(EmHttpSslPatch)

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,7 +16,8 @@ module Faraday
 
       self.supports_parallel = true
 
-      def self.setup_parallel_manager(options = {})
+      # @return [ParallelManager]
+      def self.setup_parallel_manager(_options = nil)
         ParallelManager.new
       end
 
@@ -23,73 +27,110 @@ module Faraday
 
         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
 
-          status = client.response_header.status
-          reason = client.response_header.http_reason
-          save_response(env, status, client.response, nil, reason) 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 Faraday::ConnectionFailed, $!
-      rescue EventMachine::Connectify::CONNECTError => err
-        if err.message.include?("Proxy Authentication Required")
-          raise Faraday::ConnectionFailed, %{407 "Proxy Authentication Required "}
-        else
-          raise Faraday::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 Faraday::TimeoutError, err
-      rescue RuntimeError => err
-        if err.message == "connection closed by server"
-          raise Faraday::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
-      end
 
-      def create_request(env)
-        EventMachine::HttpRequest.new(Utils::URI(env[:url].to_s), connection_config(env).merge(@connection_options))
+        client
       end
     end
   end
@@ -97,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/em_synchrony/parallel_manager.rb

@@ -1,16 +1,21 @@
+# frozen_string_literal: true
+
 module Faraday
   class Adapter
     class EMSynchrony < Faraday::Adapter
+      # A parallel manager for EMSynchrony.
       class ParallelManager
-
-        # Add requests to queue. The `request` argument should be a
-        # `EM::HttpRequest` object.
+        # Add requests to queue.
+        #
+        # @param request [EM::HttpRequest]
+        # @param method [Symbol, String] HTTP method
+        # @param args [Array] the rest of the positional arguments
         def add(request, method, *args, &block)
           queue << {
-            :request => request,
-            :method => method,
-            :args => args,
-            :block => block
+            request: request,
+            method: method,
+            args: args,
+            block: block
           }
         end
 
@@ -19,19 +24,18 @@ module Faraday
         def run
           result = nil
           if !EM.reactor_running?
-            EM.run {
+            EM.run do
               Fiber.new do
                 result = perform
                 EM.stop
               end.resume
-            }
+            end
           else
             result = perform
           end
           result
         end
 
-
         private
 
         # The request queue.
@@ -59,8 +63,7 @@ module Faraday
           # Block fiber until all requests have returned.
           multi.perform
         end
-
-      end # ParallelManager
-    end # EMSynchrony
-  end # Adapter
-end # Faraday
+      end
+    end
+  end
+end

data/lib/faraday/adapter/excon.rb

@@ -1,81 +1,123 @@
+# frozen_string_literal: true
+
 module Faraday
   class Adapter
+    # Excon adapter.
     class Excon < Faraday::Adapter
       dependency 'excon'
 
+      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]
-          opts[:ssl_version] = ssl[:version] if ssl[:version]
-          opts[:ssl_min_version] = ssl[:min_version] if ssl[:min_version]
-          opts[:ssl_max_version] = ssl[:max_version] if ssl[:max_version]
-
-          # https://github.com/geemus/excon/issues/106
-          # https://github.com/jruby/jruby-ossl/issues/19
-          opts[:nonblock] = false
-        end
+        req_opts = {
+          method: env[:method].to_s.upcase,
+          headers: env[:request_headers],
+          body: read_body(env)
+        }
 
-        if ( req = env[:request] )
-          if req[:timeout]
-            opts[:read_timeout]      = req[:timeout]
-            opts[:connect_timeout]   = req[:timeout]
-            opts[:write_timeout]     = req[:timeout]
+        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
 
-          if req[:open_timeout]
-            opts[:connect_timeout]   = req[:open_timeout]
-          end
+        resp = connection(env) { |http| http.request(req_opts) }
+        save_response(env, resp.status.to_i, resp.body, resp.headers,
+                      resp.reason_phrase)
 
-          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]
-            }
-          end
+        @app.call(env)
+      rescue ::Excon::Errors::SocketError => e
+        raise Faraday::TimeoutError, e if e.message =~ /\btimeout\b/
+
+        raise Faraday::SSLError, e if e.message =~ /\bcertificate\b/
+
+        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
 
-        conn = create_connection(env, opts)
+        opts
+      end
 
-        resp = conn.request \
-          :method  => env[:method].to_s.upcase,
-          :headers => env[:request_headers],
-          :body    => read_body(env)
+      def needs_ssl_settings?(env)
+        env[:url].scheme == 'https' && env[:ssl]
+      end
 
-        save_response(env, resp.status.to_i, resp.body, resp.headers, resp.reason_phrase)
+      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
 
-        @app.call env
-      rescue ::Excon::Errors::SocketError => err
-        if err.message =~ /\btimeout\b/
-          raise Faraday::TimeoutError, err
-        elsif err.message =~ /\bcertificate\b/
-          raise Faraday::SSLError, err
-        else
-          raise Faraday::ConnectionFailed, err
+      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
-      rescue ::Excon::Errors::Timeout => err
-        raise Faraday::TimeoutError, err
       end
 
-      def create_connection(env, opts)
-        ::Excon.new(env[:url].to_s, opts.merge(@connection_options))
+      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
 
-      # TODO: support streaming requests
-      def read_body(env)
-        env[:body].respond_to?(:read) ? env[:body].read : env[:body]
+      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