faraday 1.0.0 → 2.0.0

data/lib/faraday/adapter/em_http.rb

@@ -1,285 +0,0 @@
-# frozen_string_literal: true
-
-module Faraday
-  class Adapter
-    # EventMachine adapter. This adapter is useful for either asynchronous
-    # requests when in an EM reactor loop, or for making parallel requests in
-    # synchronous code.
-    class EMHttp < Faraday::Adapter
-      # Options is a module containing helpers to convert the Faraday env object
-      # into options hashes for EMHTTP method calls.
-      module Options
-        # @return [Hash]
-        def connection_config(env)
-          options = {}
-          configure_proxy(options, env)
-          configure_timeout(options, env)
-          configure_socket(options, env)
-          configure_ssl(options, env)
-          options
-        end
-
-        def request_config(env)
-          options = {
-            body: read_body(env),
-            head: env[:request_headers]
-            # keepalive: true,
-            # file: 'path/to/file', # stream data off disk
-          }
-          configure_compression(options, env)
-          options
-        end
-
-        def read_body(env)
-          body = env[:body]
-          body.respond_to?(:read) ? body.read : body
-        end
-
-        # Reads out proxy settings from env into options
-        def configure_proxy(options, env)
-          proxy = request_options(env)[:proxy]
-          return unless proxy
-
-          options[:proxy] = {
-            host: proxy[:uri].host,
-            port: proxy[:uri].port,
-            authorization: [proxy[:user], proxy[:password]]
-          }
-        end
-
-        # Reads out host and port settings from env into options
-        def configure_socket(options, env)
-          bind = request_options(env)[:bind]
-          return unless bind
-
-          options[:bind] = {
-            host: bind[:host],
-            port: bind[:port]
-          }
-        end
-
-        # Reads out SSL certificate settings from env into options
-        def configure_ssl(options, env)
-          return unless env[:url].scheme == 'https' && env[:ssl]
-
-          options[:ssl] = {
-            cert_chain_file: env[:ssl][:ca_file],
-            verify_peer: env[:ssl].fetch(:verify, true)
-          }
-        end
-
-        # Reads out timeout settings from env into options
-        def configure_timeout(options, env)
-          req = request_options(env)
-          options[:inactivity_timeout] = request_timeout(:read, req)
-          options[:connect_timeout] = request_timeout(:open, req)
-        end
-
-        # Reads out compression header settings from env into options
-        def configure_compression(options, env)
-          return unless (env[:method] == :get) &&
-                        !options[:head].key?('accept-encoding')
-
-          options[:head]['accept-encoding'] = 'gzip, compressed'
-        end
-
-        def request_options(env)
-          env[:request]
-        end
-      end
-
-      include Options
-
-      dependency 'em-http'
-
-      self.supports_parallel = true
-
-      # @return [Manager]
-      def self.setup_parallel_manager(_options = nil)
-        Manager.new
-      end
-
-      def call(env)
-        super
-        perform_request env
-        @app.call env
-      end
-
-      def perform_request(env)
-        if parallel?(env)
-          manager = env[:parallel_manager]
-          manager.add do
-            perform_single_request(env)
-              .callback { env[:response].finish(env) }
-          end
-        elsif EventMachine.reactor_running?
-          # EM is running: instruct upstream that this is an async request
-          env[:parallel_manager] = true
-          perform_single_request(env)
-            .callback { env[:response].finish(env) }
-            .errback do
-              # TODO: no way to communicate the error in async mode
-              raise NotImplementedError
-            end
-        else
-          error = nil
-          # start EM, block until request is completed
-          EventMachine.run do
-            perform_single_request(env)
-              .callback { EventMachine.stop }
-              .errback do |client|
-                error = error_message(client)
-                EventMachine.stop
-              end
-          end
-          raise_error(error) if error
-        end
-      rescue EventMachine::Connectify::CONNECTError => e
-        if e.message.include?('Proxy Authentication Required')
-          raise Faraday::ConnectionFailed,
-                %(407 "Proxy Authentication Required ")
-        end
-
-        raise Faraday::ConnectionFailed, e
-      rescue StandardError => e
-        if defined?(OpenSSL) && e.is_a?(OpenSSL::SSL::SSLError)
-          raise Faraday::SSLError, e
-        end
-
-        raise
-      end
-
-      # TODO: reuse the connection to support pipelining
-      def perform_single_request(env)
-        req = create_request(env)
-        req = req.setup_request(env[:method], request_config(env))
-        req.callback do |client|
-          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
-          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
-        end
-      end
-
-      def create_request(env)
-        EventMachine::HttpRequest.new(
-          env[:url], connection_config(env).merge(@connection_options)
-        )
-      end
-
-      def error_message(client)
-        client.error || 'request failed'
-      end
-
-      def raise_error(msg)
-        error_class = Faraday::ClientError
-        if timeout_message?(msg)
-          error_class = Faraday::TimeoutError
-          msg = 'request timed out'
-        elsif msg == Errno::ECONNREFUSED
-          error_class = Faraday::ConnectionFailed
-          msg = 'connection refused'
-        elsif msg == 'connection closed by server'
-          error_class = Faraday::ConnectionFailed
-        end
-        raise error_class, msg
-      end
-
-      def timeout_message?(msg)
-        msg == Errno::ETIMEDOUT ||
-          (msg.is_a?(String) && msg.include?('timeout error'))
-      end
-
-      # @return [Boolean]
-      def parallel?(env)
-        !!env[:parallel_manager]
-      end
-
-      # This parallel manager is designed to start an EventMachine loop
-      # and block until all registered requests have been completed.
-      class Manager
-        # @see reset
-        def initialize
-          reset
-        end
-
-        # Re-initializes instance variables
-        def reset
-          @registered_procs = []
-          @num_registered = 0
-          @num_succeeded = 0
-          @errors = []
-          @running = false
-        end
-
-        # @return [Boolean]
-        def running?
-          @running
-        end
-
-        def add(&block)
-          if running?
-            perform_request { yield }
-          else
-            @registered_procs << block
-          end
-          @num_registered += 1
-        end
-
-        def run
-          if @num_registered.positive?
-            @running = true
-            EventMachine.run do
-              @registered_procs.each do |proc|
-                perform_request(&proc)
-              end
-            end
-            unless @errors.empty?
-              raise Faraday::ClientError, @errors.first || 'connection failed'
-            end
-          end
-        ensure
-          reset
-        end
-
-        def perform_request
-          client = yield
-          client.callback do
-            @num_succeeded += 1
-            check_finished
-          end
-          client.errback do
-            @errors << client.error
-            check_finished
-          end
-        end
-
-        def check_finished
-          EventMachine.stop if @num_succeeded + @errors.size == @num_registered
-        end
-      end
-    end
-  end
-end
-
-if Faraday::Adapter::EMHttp.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_http_ssl_patch.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require 'openssl'
-require 'em-http'
-
-# EventMachine patch to make SSL work.
-module EmHttpSslPatch
-  def ssl_verify_peer(cert_string)
-    begin
-      @last_seen_cert = OpenSSL::X509::Certificate.new(cert_string)
-    rescue OpenSSL::X509::CertificateError
-      return false
-    end
-
-    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 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
-
-  def certificate_store
-    @certificate_store ||= begin
-      store = OpenSSL::X509::Store.new
-      store.set_default_paths
-      ca_file = parent.connopts.tls[:cert_chain_file]
-      store.add_file(ca_file) if ca_file
-      store
-    end
-  end
-end
-
-EventMachine::HttpStubConnection.include(EmHttpSslPatch)

data/lib/faraday/adapter/em_synchrony/parallel_manager.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module Faraday
-  class Adapter
-    class EMSynchrony < Faraday::Adapter
-      # A parallel manager for EMSynchrony.
-      class ParallelManager
-        # 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
-          }
-        end
-
-        # Run all requests on queue with `EM::Synchrony::Multi`, wrapping
-        # it in a reactor and fiber if needed.
-        def run
-          result = nil
-          if !EM.reactor_running?
-            EM.run do
-              Fiber.new do
-                result = perform
-                EM.stop
-              end.resume
-            end
-          else
-            result = perform
-          end
-          result
-        end
-
-        private
-
-        # The request queue.
-        def queue
-          @queue ||= []
-        end
-
-        # Main `EM::Synchrony::Multi` performer.
-        def perform
-          multi = ::EM::Synchrony::Multi.new
-
-          queue.each do |item|
-            method = "a#{item[:method]}".to_sym
-
-            req = item[:request].send(method, *item[:args])
-            req.callback(&item[:block])
-
-            req_name = "req_#{multi.requests.size}".to_sym
-            multi.add(req_name, req)
-          end
-
-          # Clear the queue, so parallel manager objects can be reused.
-          @queue = []
-
-          # Block fiber until all requests have returned.
-          multi.perform
-        end
-      end
-    end
-  end
-end

data/lib/faraday/adapter/em_synchrony.rb

@@ -1,150 +0,0 @@
-# frozen_string_literal: true
-
-require 'uri'
-
-module Faraday
-  class Adapter
-    # EventMachine Synchrony adapter.
-    class EMSynchrony < Faraday::Adapter
-      include EMHttp::Options
-
-      dependency do
-        require 'em-synchrony/em-http'
-        require 'em-synchrony/em-multi'
-        require 'fiber'
-      end
-
-      self.supports_parallel = true
-
-      # @return [ParallelManager]
-      def self.setup_parallel_manager(_options = nil)
-        ParallelManager.new
-      end
-
-      def call(env)
-        super
-        request = create_request(env)
-
-        http_method = env[:method].to_s.downcase.to_sym
-
-        if env[:parallel_manager]
-          # Queue requests for parallel execution.
-          execute_parallel_request(env, request, http_method)
-        else
-          # Execute single request.
-          execute_single_request(env, request, http_method)
-        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
-
-        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
-
-      private
-
-      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
-
-      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
-        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
-      end
-
-      def call_block(block)
-        client = nil
-
-        if EM.reactor_running?
-          client = block.call
-        else
-          EM.run do
-            Fiber.new do
-              client = block.call
-              EM.stop
-            end.resume
-          end
-        end
-
-        client
-      end
-    end
-  end
-end
-
-require 'faraday/adapter/em_synchrony/parallel_manager'
-
-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,124 +0,0 @@
-# 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
-
-        req_opts = {
-          method: env[:method].to_s.upcase,
-          headers: env[:request_headers],
-          body: read_body(env)
-        }
-
-        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
-
-        resp = connection(env) { |http| http.request(req_opts) }
-        save_response(env, resp.status.to_i, resp.body, resp.headers,
-                      resp.reason_phrase)
-
-        @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
-
-        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