faraday 1.0.1 → 1.10.3

data/lib/faraday/adapter/net_http.rb

@@ -1,219 +0,0 @@
-# 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'
-  require 'net/http'
-end
-require 'zlib'
-
-module Faraday
-  class Adapter
-    # Net::HTTP adapter.
-    class NetHttp < Faraday::Adapter
-      exceptions = [
-        IOError,
-        Errno::EADDRNOTAVAIL,
-        Errno::ECONNABORTED,
-        Errno::ECONNREFUSED,
-        Errno::ECONNRESET,
-        Errno::EHOSTUNREACH,
-        Errno::EINVAL,
-        Errno::ENETUNREACH,
-        Errno::EPIPE,
-        Net::HTTPBadResponse,
-        Net::HTTPHeaderSyntaxError,
-        Net::ProtocolError,
-        SocketError,
-        Zlib::GzipFile::Error
-      ]
-
-      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)
-        @ssl_cert_store = nil
-        super(app, opts, &block)
-      end
-
-      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
-            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
-        end
-
-        @app.call env
-      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
-          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]
-        else
-          request.body = env[:body]
-        end
-        request
-      end
-
-      def perform_request(http, env)
-        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)
-          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)
-        # 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 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)
-        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]
-      end
-
-      def configure_request(http, req)
-        if (sec = request_timeout(:read, req))
-          http.read_timeout = sec
-        end
-
-        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]
-
-        @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)
-        ssl[:verify_mode] || begin
-          if ssl.fetch(:verify, true)
-            OpenSSL::SSL::VERIFY_PEER
-          else
-            OpenSSL::SSL::VERIFY_NONE
-          end
-        end
-      end
-    end
-  end
-end

data/lib/faraday/adapter/net_http_persistent.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module Faraday
-  class Adapter
-    # Net::HTTP::Persistent adapter.
-    class NetHttpPersistent < NetHttp
-      dependency 'net/http/persistent'
-
-      private
-
-      def net_http_connection(env)
-        @cached_connection ||=
-          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)
-        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 = 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
-          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 => 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))
-
-        SSL_CONFIGURATIONS
-          .select { |_, key| ssl[key] }
-          .each { |target, key| http_set(http, target, ssl[key]) }
-      end
-
-      def http_set(http, attr, value)
-        http.send("#{attr}=", value) if http.send(attr) != value
-      end
-    end
-  end
-end

data/lib/faraday/adapter/patron.rb

@@ -1,132 +0,0 @@
-# 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
-
-        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
-
-        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)
-
-        @app.call env
-      rescue ::Patron::TimeoutError => e
-        if connection_timed_out_message?(e.message)
-          raise Faraday::ConnectionFailed, e
-        end
-
-        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)
-        # HAX: helps but doesn't work completely
-        # https://github.com/toland/patron/issues/34
-        ::Patron::Request::VALID_ACTIONS.tap do |actions|
-          if actions[0].is_a?(Symbol)
-            actions << :patch unless actions.include? :patch
-            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'
-          end
-        end
-      end
-
-      def configure_ssl(session, ssl)
-        if ssl.fetch(:verify, true)
-          session.cacert = ssl[:ca_file]
-        else
-          session.insecure = true
-        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
-
-      def connection_timed_out_message?(message)
-        CURL_TIMEOUT_MESSAGES.any? do |curl_message|
-          message.include?(curl_message)
-        end
-      end
-    end
-  end
-end

data/lib/faraday/adapter/rack.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-module Faraday
-  class Adapter
-    # Sends requests to a Rack app.
-    #
-    # @example
-    #
-    #   class MyRackApp
-    #     def call(env)
-    #       [200, {'Content-Type' => 'text/html'}, ["hello world"]]
-    #     end
-    #   end
-    #
-    #   Faraday.new do |conn|
-    #     conn.adapter :rack, MyRackApp.new
-    #   end
-    class Rack < Faraday::Adapter
-      dependency 'rack/test'
-
-      # not prefixed with "HTTP_"
-      SPECIAL_HEADERS = %w[CONTENT_LENGTH CONTENT_TYPE].freeze
-
-      def initialize(faraday_app, rack_app)
-        super(faraday_app)
-        mock_session = ::Rack::MockSession.new(rack_app)
-        @session     = ::Rack::Test::Session.new(mock_session)
-      end
-
-      def call(env)
-        super
-        rack_env = build_rack_env(env)
-
-        env[:request_headers]&.each do |name, value|
-          name = name.upcase.tr('-', '_')
-          name = "HTTP_#{name}" unless SPECIAL_HEADERS.include? name
-          rack_env[name] = value
-        end
-
-        timeout = request_timeout(:open, env[:request])
-        timeout ||= request_timeout(:read, env[:request])
-        response = if timeout
-                     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

data/lib/faraday/file_part.rb

@@ -1,128 +0,0 @@
-# frozen_string_literal: true
-
-require 'stringio'
-
-# multipart-post gem
-require 'composite_io'
-require 'parts'
-
-module Faraday
-  # Multipart value used to POST a binary data from a file or
-  #
-  # @example
-  #   payload = { file: Faraday::FilePart.new("file_name.ext", "content/type") }
-  #   http.post("/upload", payload)
-  #
-
-  # @!method initialize(filename_or_io, content_type, filename = nil, opts = {})
-  #
-  #   @param filename_or_io [String, IO] Either a String filename to a local
-  #     file or an open IO object.
-  #   @param content_type [String] String content type of the file data.
-  #   @param filename [String] Optional String filename, usually to add context
-  #     to a given IO object.
-  #   @param opts [Hash] Optional Hash of String key/value pairs to describethis
-  #     this uploaded file. Expected Header keys include:
-  #     * Content-Transfer-Encoding - Defaults to "binary"
-  #     * Content-Disposition - Defaults to "form-data"
-  #     * Content-Type - Defaults to the content_type argument.
-  #     * Content-ID - Optional.
-  #
-  # @return [Faraday::FilePart]
-  #
-  # @!attribute [r] content_type
-  # The uploaded binary data's content type.
-  #
-  # @return [String]
-  #
-  # @!attribute [r] original_filename
-  # The base filename, taken either from the filename_or_io or filename
-  # arguments in #initialize.
-  #
-  # @return [String]
-  #
-  # @!attribute [r] opts
-  # Extra String key/value pairs to make up the header for this uploaded file.
-  #
-  # @return [Hash]
-  #
-  # @!attribute [r] io
-  # The open IO object for the uploaded file.
-  #
-  # @return [IO]
-  FilePart = ::UploadIO
-
-  # Multipart value used to POST a file.
-  #
-  # @deprecated Use FilePart instead of this class. It behaves identically, with
-  #   a matching name to ParamPart.
-  UploadIO = ::UploadIO
-
-  Parts = ::Parts
-
-  # Similar to, but not compatible with CompositeReadIO provided by the
-  # multipart-post gem.
-  # https://github.com/nicksieger/multipart-post/blob/master/lib/composite_io.rb
-  class CompositeReadIO
-    def initialize(*parts)
-      @parts = parts.flatten
-      @ios = @parts.map(&:to_io)
-      @index = 0
-    end
-
-    # @return [Integer] sum of the lengths of all the parts
-    def length
-      @parts.inject(0) { |sum, part| sum + part.length }
-    end
-
-    # Rewind each of the IOs and reset the index to 0.
-    #
-    # @return [void]
-    def rewind
-      @ios.each(&:rewind)
-      @index = 0
-    end
-
-    # Read from IOs in order until `length` bytes have been received.
-    #
-    # @param length [Integer, nil]
-    # @param outbuf [String, nil]
-    def read(length = nil, outbuf = nil)
-      got_result = false
-      outbuf = outbuf ? (+outbuf).replace('') : +''
-
-      while (io = current_io)
-        if (result = io.read(length))
-          got_result ||= !result.nil?
-          result.force_encoding('BINARY') if result.respond_to?(:force_encoding)
-          outbuf << result
-          length -= result.length if length
-          break if length&.zero?
-        end
-        advance_io
-      end
-      !got_result && length ? nil : outbuf
-    end
-
-    # Close each of the IOs.
-    #
-    # @return [void]
-    def close
-      @ios.each(&:close)
-    end
-
-    def ensure_open_and_readable
-      # Rubinius compatibility
-    end
-
-    private
-
-    def current_io
-      @ios[@index]
-    end
-
-    def advance_io
-      @index += 1
-    end
-  end
-end

data/lib/faraday/param_part.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module Faraday
-  # Multipart value used to POST data with a content type.
-  class ParamPart
-    # @param value [String] Uploaded content as a String.
-    # @param content_type [String] String content type of the value.
-    # @param content_id [String] Optional String of this value's Content-ID.
-    #
-    # @return [Faraday::ParamPart]
-    def initialize(value, content_type, content_id = nil)
-      @value = value
-      @content_type = content_type
-      @content_id = content_id
-    end
-
-    # Converts this value to a form part.
-    #
-    # @param boundary [String] String multipart boundary that must not exist in
-    #   the content exactly.
-    # @param key [String] String key name for this value.
-    #
-    # @return [Faraday::Parts::Part]
-    def to_part(boundary, key)
-      Faraday::Parts::Part.new(boundary, key, value, headers)
-    end
-
-    # Returns a Hash of String key/value pairs.
-    #
-    # @return [Hash]
-    def headers
-      {
-        'Content-Type' => content_type,
-        'Content-ID' => content_id
-      }
-    end
-
-    # The content to upload.
-    #
-    # @return [String]
-    attr_reader :value
-
-    # The value's content type.
-    #
-    # @return [String]
-    attr_reader :content_type
-
-    # The value's content ID, if given.
-    #
-    # @return [String, nil]
-    attr_reader :content_id
-  end
-end