faraday 0.15.4 → 1.6.0

data/lib/faraday/file_part.rb

@@ -0,0 +1,128 @@
+# 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/logging/formatter.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'pp'
+module Faraday
+  module Logging
+    # Serves as an integration point to customize logging
+    class Formatter
+      extend Forwardable
+
+      DEFAULT_OPTIONS = { headers: true, bodies: false,
+                          log_level: :info }.freeze
+
+      def initialize(logger:, options:)
+        @logger = logger
+        @filter = []
+        @options = DEFAULT_OPTIONS.merge(options)
+      end
+
+      def_delegators :@logger, :debug, :info, :warn, :error, :fatal
+
+      def request(env)
+        request_log = proc do
+          "#{env.method.upcase} #{apply_filters(env.url.to_s)}"
+        end
+        public_send(log_level, 'request', &request_log)
+
+        log_headers('request', env.request_headers) if log_headers?(:request)
+        log_body('request', env[:body]) if env[:body] && log_body?(:request)
+      end
+
+      def response(env)
+        status = proc { "Status #{env.status}" }
+        public_send(log_level, 'response', &status)
+
+        log_headers('response', env.response_headers) if log_headers?(:response)
+        log_body('response', env[:body]) if env[:body] && log_body?(:response)
+      end
+
+      def filter(filter_word, filter_replacement)
+        @filter.push([filter_word, filter_replacement])
+      end
+
+      private
+
+      def dump_headers(headers)
+        headers.map { |k, v| "#{k}: #{v.inspect}" }.join("\n")
+      end
+
+      def dump_body(body)
+        if body.respond_to?(:to_str)
+          body.to_str
+        else
+          pretty_inspect(body)
+        end
+      end
+
+      def pretty_inspect(body)
+        body.pretty_inspect
+      end
+
+      def log_headers?(type)
+        case @options[:headers]
+        when Hash
+          @options[:headers][type]
+        else
+          @options[:headers]
+        end
+      end
+
+      def log_body?(type)
+        case @options[:bodies]
+        when Hash
+          @options[:bodies][type]
+        else
+          @options[:bodies]
+        end
+      end
+
+      def apply_filters(output)
+        @filter.each do |pattern, replacement|
+          output = output.to_s.gsub(pattern, replacement)
+        end
+        output
+      end
+
+      def log_level
+        unless %i[debug info warn error fatal].include?(@options[:log_level])
+          return :info
+        end
+
+        @options[:log_level]
+      end
+
+      def log_headers(type, headers)
+        headers_log = proc { apply_filters(dump_headers(headers)) }
+        public_send(log_level, type, &headers_log)
+      end
+
+      def log_body(type, body)
+        body_log = proc { apply_filters(dump_body(body)) }
+        public_send(log_level, type, &body_log)
+      end
+    end
+  end
+end

data/lib/faraday/methods.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Faraday
+  METHODS_WITH_QUERY = %w[get head delete trace].freeze
+  METHODS_WITH_BODY = %w[post put patch].freeze
+end

data/lib/faraday/middleware.rb

@@ -1,37 +1,31 @@
+# frozen_string_literal: true
+
 module Faraday
+  # Middleware is the basic base class of any Faraday middleware.
   class Middleware
     extend MiddlewareRegistry
+    extend DependencyLoader
 
-    class << self
-      attr_accessor :load_error
-      private :load_error=
-    end
-
-    self.load_error = nil
-
-    # Executes a block which should try to require and reference dependent libraries
-    def self.dependency(lib = nil)
-      lib ? require(lib) : yield
-    rescue LoadError, NameError => error
-      self.load_error = error
-    end
+    attr_reader :app, :options
 
-    def self.new(*)
-      raise "missing dependency for #{self}: #{load_error.message}" unless loaded?
-      super
-    end
-
-    def self.loaded?
-      load_error.nil?
+    def initialize(app = nil, options = {})
+      @app = app
+      @options = options
     end
 
-    def self.inherited(subclass)
-      super
-      subclass.send(:load_error=, self.load_error)
+    def call(env)
+      on_request(env) if respond_to?(:on_request)
+      app.call(env).on_complete do |environment|
+        on_complete(environment) if respond_to?(:on_complete)
+      end
     end
 
-    def initialize(app = nil)
-      @app = app
+    def close
+      if app.respond_to?(:close)
+        app.close
+      else
+        warn "#{app} does not implement \#close!"
+      end
     end
   end
 end

data/lib/faraday/middleware_registry.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'monitor'
+
+module Faraday
+  # Adds the ability for other modules to register and lookup
+  # middleware classes.
+  module MiddlewareRegistry
+    # Register middleware class(es) on the current module.
+    #
+    # @param autoload_path [String] Middleware autoload path
+    # @param mapping [Hash{
+    #          Symbol => Module,
+    #          Symbol => Array<Module, Symbol, String>,
+    #        }] Middleware mapping from a lookup symbol to a reference to the
+    #        middleware.
+    #        Classes can be expressed as:
+    #          - a fully qualified constant
+    #          - a Symbol
+    #          - a Proc that will be lazily called to return the former
+    #          - an array is given, its first element is the constant or symbol,
+    #            and its second is a file to `require`.
+    # @return [void]
+    #
+    # @example Lookup by a constant
+    #
+    #   module Faraday
+    #     class Whatever
+    #       # Middleware looked up by :foo returns Faraday::Whatever::Foo.
+    #       register_middleware foo: Foo
+    #     end
+    #   end
+    #
+    # @example Lookup by a symbol
+    #
+    #   module Faraday
+    #     class Whatever
+    #       # Middleware looked up by :bar returns
+    #       # Faraday::Whatever.const_get(:Bar)
+    #       register_middleware bar: :Bar
+    #     end
+    #   end
+    #
+    # @example Lookup by a symbol and string in an array
+    #
+    #   module Faraday
+    #     class Whatever
+    #       # Middleware looked up by :baz requires 'baz' and returns
+    #       # Faraday::Whatever.const_get(:Baz)
+    #       register_middleware baz: [:Baz, 'baz']
+    #     end
+    #   end
+    #
+    def register_middleware(autoload_path = nil, mapping = nil)
+      if mapping.nil?
+        mapping = autoload_path
+        autoload_path = nil
+      end
+      middleware_mutex do
+        @middleware_autoload_path = autoload_path if autoload_path
+        (@registered_middleware ||= {}).update(mapping)
+      end
+    end
+
+    # Unregister a previously registered middleware class.
+    #
+    # @param key [Symbol] key for the registered middleware.
+    def unregister_middleware(key)
+      @registered_middleware.delete(key)
+    end
+
+    # Lookup middleware class with a registered Symbol shortcut.
+    #
+    # @param key [Symbol] key for the registered middleware.
+    # @return [Class] a middleware Class.
+    # @raise [Faraday::Error] if given key is not registered
+    #
+    # @example
+    #
+    #   module Faraday
+    #     class Whatever
+    #       register_middleware foo: Foo
+    #     end
+    #   end
+    #
+    #   Faraday::Whatever.lookup_middleware(:foo)
+    #   # => Faraday::Whatever::Foo
+    #
+    def lookup_middleware(key)
+      load_middleware(key) ||
+        raise(Faraday::Error, "#{key.inspect} is not registered on #{self}")
+    end
+
+    def middleware_mutex(&block)
+      @middleware_mutex ||= Monitor.new
+      @middleware_mutex.synchronize(&block)
+    end
+
+    def fetch_middleware(key)
+      defined?(@registered_middleware) && @registered_middleware[key]
+    end
+
+    def load_middleware(key)
+      value = fetch_middleware(key)
+      case value
+      when Module
+        value
+      when Symbol, String
+        middleware_mutex do
+          @registered_middleware[key] = const_get(value)
+        end
+      when Proc
+        middleware_mutex do
+          @registered_middleware[key] = value.call
+        end
+      when Array
+        middleware_mutex do
+          const, path = value
+          if (root = @middleware_autoload_path)
+            path = "#{root}/#{path}"
+          end
+          require(path)
+          @registered_middleware[key] = const
+        end
+        load_middleware(key)
+      end
+    end
+  end
+end

data/lib/faraday/options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Faraday
   # Subclasses Struct with some special helpers for converting from a Hash to
   # a Struct.
@@ -10,6 +12,7 @@ module Faraday
     # Public
     def each
       return to_enum(:each) unless block_given?
+
       members.each do |key|
         yield(key.to_sym, send(key))
       end
@@ -27,7 +30,7 @@ module Faraday
           new_value = value
         end
 
-        self.send("#{key}=", new_value) unless new_value.nil?
+        send("#{key}=", new_value) unless new_value.nil?
       end
       self
     end
@@ -47,10 +50,14 @@ module Faraday
     # Public
     def merge!(other)
       other.each do |key, other_value|
-        self_value = self.send(key)
+        self_value = send(key)
         sub_options = self.class.options_for(key)
-        new_value = (self_value && sub_options && other_value) ? self_value.merge(other_value) : other_value
-        self.send("#{key}=", new_value) unless new_value.nil?
+        new_value = if self_value && sub_options && other_value
+                      self_value.merge(other_value)
+                    else
+                      other_value
+                    end
+        send("#{key}=", new_value) unless new_value.nil?
       end
       self
     end
@@ -69,10 +76,10 @@ module Faraday
     def fetch(key, *args)
       unless symbolized_key_set.include?(key.to_sym)
         key_setter = "#{key}="
-        if args.size > 0
+        if !args.empty?
           send(key_setter, args.first)
         elsif block_given?
-          send(key_setter, Proc.new.call(key))
+          send(key_setter, yield(key))
         else
           raise self.class.fetch_error_class, "key not found: #{key.inspect}"
         end
@@ -96,11 +103,10 @@ module Faraday
     end
 
     # Public
-    def each_key
+    def each_key(&block)
       return to_enum(:each_key) unless block_given?
-      keys.each do |key|
-        yield(key)
-      end
+
+      keys.each(&block)
     end
 
     # Public
@@ -111,11 +117,10 @@ module Faraday
     alias has_key? key?
 
     # Public
-    def each_value
+    def each_value(&block)
       return to_enum(:each_value) unless block_given?
-      values.each do |value|
-        yield(value)
-      end
+
+      values.each(&block)
     end
 
     # Public
@@ -142,9 +147,9 @@ module Faraday
         value = send(member)
         values << "#{member}=#{value.inspect}" if value
       end
-      values = values.empty? ? ' (empty)' : (' ' << values.join(", "))
+      values = values.empty? ? '(empty)' : values.join(', ')
 
-      %(#<#{self.class}#{values}>)
+      %(#<#{self.class} #{values}>)
     end
 
     # Internal
@@ -162,8 +167,12 @@ module Faraday
       @attribute_options ||= {}
     end
 
-    def self.memoized(key)
-      memoized_attributes[key.to_sym] = Proc.new
+    def self.memoized(key, &block)
+      unless block_given?
+        raise ArgumentError, '#memoized must be called with a block'
+      end
+
+      memoized_attributes[key.to_sym] = block
       class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{key}() self[:#{key}]; end
       RUBY
@@ -175,7 +184,7 @@ module Faraday
 
     def [](key)
       key = key.to_sym
-      if method = self.class.memoized_attributes[key]
+      if (method = self.class.memoized_attributes[key])
         super(key) || (self[key] = instance_eval(&method))
       else
         super
@@ -183,7 +192,7 @@ module Faraday
     end
 
     def symbolized_key_set
-      @symbolized_key_set ||= Set.new(keys.map { |k| k.to_sym })
+      @symbolized_key_set ||= Set.new(keys.map(&:to_sym))
     end
 
     def self.inherited(subclass)
@@ -194,180 +203,16 @@ module Faraday
 
     def self.fetch_error_class
       @fetch_error_class ||= if Object.const_defined?(:KeyError)
-        ::KeyError
-      else
-        ::IndexError
-      end
-    end
-  end
-
-  class RequestOptions < Options.new(:params_encoder, :proxy, :bind,
-    :timeout, :open_timeout, :write_timeout, :boundary, :oauth, :context)
-
-    def []=(key, value)
-      if key && key.to_sym == :proxy
-        super(key, value ? ProxyOptions.from(value) : nil)
-      else
-        super(key, value)
-      end
-    end
-  end
-
-  class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode,
-    :cert_store, :client_cert, :client_key, :certificate, :private_key, :verify_depth,
-    :version, :min_version, :max_version)
-
-    def verify?
-      verify != false
-    end
-
-    def disable?
-      !verify?
-    end
-  end
-
-  class ProxyOptions < Options.new(:uri, :user, :password)
-    extend Forwardable
-    def_delegators :uri, :scheme, :scheme=, :host, :host=, :port, :port=, :path, :path=
-
-    def self.from(value)
-      case value
-      when String
-        value = {:uri => Utils.URI(value)}
-      when URI
-        value = {:uri => value}
-      when Hash, Options
-        if uri = value.delete(:uri)
-          value[:uri] = Utils.URI(uri)
-        end
-      end
-      super(value)
-    end
-
-    memoized(:user) { uri && uri.user && Utils.unescape(uri.user) }
-    memoized(:password) { uri && uri.password && Utils.unescape(uri.password) }
-  end
-
-  class ConnectionOptions < Options.new(:request, :proxy, :ssl, :builder, :url,
-    :parallel_manager, :params, :headers, :builder_class)
-
-    options :request => RequestOptions, :ssl => SSLOptions
-
-    memoized(:request) { self.class.options_for(:request).new }
-
-    memoized(:ssl) { self.class.options_for(:ssl).new }
-
-    memoized(:builder_class) { RackBuilder }
-
-    def new_builder(block)
-      builder_class.new(&block)
-    end
-  end
-
-  class Env < Options.new(:method, :body, :url, :request, :request_headers,
-    :ssl, :parallel_manager, :params, :response, :response_headers, :status,
-    :reason_phrase)
-
-    ContentLength = 'Content-Length'.freeze
-    StatusesWithoutBody = Set.new [204, 304]
-    SuccessfulStatuses = 200..299
-
-    # A Set of HTTP verbs that typically send a body.  If no body is set for
-    # these requests, the Content-Length header is set to 0.
-    MethodsWithBodies = Set.new [:post, :put, :patch, :options]
-
-    options :request => RequestOptions,
-      :request_headers => Utils::Headers, :response_headers => Utils::Headers
-
-    extend Forwardable
-
-    def_delegators :request, :params_encoder
-
-    # Public
-    def self.from(value)
-      env = super(value)
-      if value.respond_to?(:custom_members)
-        env.custom_members.update(value.custom_members)
-      end
-      env
-    end
-
-    # Public
-    def [](key)
-      if in_member_set?(key)
-        super(key)
-      else
-        custom_members[key]
-      end
-    end
-
-    # Public
-    def []=(key, value)
-      if in_member_set?(key)
-        super(key, value)
-      else
-        custom_members[key] = value
-      end
-    end
-
-    # Public
-    def success?
-      SuccessfulStatuses.include?(status)
-    end
-
-    # Public
-    def needs_body?
-      !body && MethodsWithBodies.include?(method)
-    end
-
-    # Public
-    def clear_body
-      request_headers[ContentLength] = '0'
-      self.body = ''
-    end
-
-    # Public
-    def parse_body?
-      !StatusesWithoutBody.include?(status)
-    end
-
-    # Public
-    def parallel?
-      !!parallel_manager
-    end
-
-    def inspect
-      attrs = [nil]
-      members.each do |mem|
-        if value = send(mem)
-          attrs << "@#{mem}=#{value.inspect}"
-        end
-      end
-      if !custom_members.empty?
-        attrs << "@custom=#{custom_members.inspect}"
-      end
-      %(#<#{self.class}#{attrs.join(" ")}>)
-    end
-
-    # Internal
-    def custom_members
-      @custom_members ||= {}
-    end
-
-    # Internal
-    if members.first.is_a?(Symbol)
-      def in_member_set?(key)
-        self.class.member_set.include?(key.to_sym)
-      end
-    else
-      def in_member_set?(key)
-        self.class.member_set.include?(key.to_s)
-      end
-    end
-
-    # Internal
-    def self.member_set
-      @member_set ||= Set.new(members)
+                               ::KeyError
+                             else
+                               ::IndexError
+                             end
     end
   end
 end
+
+require 'faraday/options/request_options'
+require 'faraday/options/ssl_options'
+require 'faraday/options/proxy_options'
+require 'faraday/options/connection_options'
+require 'faraday/options/env'