faraday 0.16.0 → 0.17.0

data/lib/faraday/error.rb

@@ -1,22 +1,21 @@
-# frozen_string_literal: true
-
 module Faraday
-  # Faraday error base class.
-  class Error < StandardError
+  class Error < StandardError; end
+
+  class ClientError < Error
     attr_reader :response, :wrapped_exception
 
-    def initialize(exc, response = nil)
+    def initialize(ex, response = nil)
       @wrapped_exception = nil
       @response = response
 
-      if exc.respond_to?(:backtrace)
-        super(exc.message)
-        @wrapped_exception = exc
-      elsif exc.respond_to?(:each_key)
-        super("the server responded with status #{exc[:status]}")
-        @response = exc
+      if ex.respond_to?(:backtrace)
+        super(ex.message)
+        @wrapped_exception = ex
+      elsif ex.respond_to?(:each_key)
+        super("the server responded with status #{ex[:status]}")
+        @response = ex
       else
-        super(exc.to_s)
+        super(ex.to_s)
       end
     end
 
@@ -29,72 +28,39 @@ module Faraday
     end
 
     def inspect
-      inner = +''
-      inner << " wrapped=#{@wrapped_exception.inspect}" if @wrapped_exception
-      inner << " response=#{@response.inspect}" if @response
-      inner << " #{super}" if inner.empty?
+      inner = ''
+      if @wrapped_exception
+        inner << " wrapped=#{@wrapped_exception.inspect}"
+      end
+      if @response
+        inner << " response=#{@response.inspect}"
+      end
+      if inner.empty?
+        inner << " #{super}"
+      end
       %(#<#{self.class}#{inner}>)
     end
   end
 
-  # Faraday client error class. Represents 4xx status responses.
-  class ClientError < Error
-  end
-
-  # Raised by Faraday::Response::RaiseError in case of a 400 response.
-  class BadRequestError < ClientError
-  end
-
-  # Raised by Faraday::Response::RaiseError in case of a 401 response.
-  class UnauthorizedError < ClientError
-  end
-
-  # Raised by Faraday::Response::RaiseError in case of a 403 response.
-  class ForbiddenError < ClientError
-  end
-
-  # Raised by Faraday::Response::RaiseError in case of a 404 response.
-  class ResourceNotFound < ClientError
-  end
-
-  # Raised by Faraday::Response::RaiseError in case of a 407 response.
-  class ProxyAuthError < ClientError
-  end
-
-  # Raised by Faraday::Response::RaiseError in case of a 409 response.
-  class ConflictError < ClientError
-  end
+  class ConnectionFailed < ClientError;   end
+  class ResourceNotFound < ClientError;   end
+  class ParsingError     < ClientError;   end
 
-  # Raised by Faraday::Response::RaiseError in case of a 422 response.
-  class UnprocessableEntityError < ClientError
-  end
-
-  # Faraday server error class. Represents 5xx status responses.
-  class ServerError < Error
-  end
-
-  # A unified client error for timeouts.
-  class TimeoutError < ServerError
-    def initialize(exc = 'timeout', response = nil)
-      super(exc, response)
+  class TimeoutError < ClientError
+    def initialize(ex = nil)
+      super(ex || "timeout")
     end
   end
 
-  # A unified error for failed connections.
-  class ConnectionFailed < Error
+  class SSLError < ClientError
   end
 
-  # A unified client error for SSL errors.
-  class SSLError < Error
-  end
+  class RetriableResponse < ClientError; end
 
-  # Raised by FaradayMiddleware::ResponseMiddleware
-  class ParsingError < Error
+  [:ClientError, :ConnectionFailed, :ResourceNotFound,
+   :ParsingError, :TimeoutError, :SSLError, :RetriableResponse].each do |const|
+    Error.const_set(const, Faraday.const_get(const))
   end
 
-  # Exception used to control the Retry middleware.
-  #
-  # @see Faraday::Request::Retry
-  class RetriableResponse < Error
-  end
+
 end

data/lib/faraday/middleware.rb

@@ -1,10 +1,34 @@
-# 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
+
+    def self.new(*)
+      raise "missing dependency for #{self}: #{load_error.message}" unless loaded?
+      super
+    end
+
+    def self.loaded?
+      load_error.nil?
+    end
+
+    def self.inherited(subclass)
+      super
+      subclass.send(:load_error=, self.load_error)
+    end
 
     def initialize(app = nil)
       @app = app

data/lib/faraday/options.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Faraday
   # Subclasses Struct with some special helpers for converting from a Hash to
   # a Struct.
@@ -12,7 +10,6 @@ module Faraday
     # Public
     def each
       return to_enum(:each) unless block_given?
-
       members.each do |key|
         yield(key.to_sym, send(key))
       end
@@ -30,7 +27,7 @@ module Faraday
           new_value = value
         end
 
-        send("#{key}=", new_value) unless new_value.nil?
+        self.send("#{key}=", new_value) unless new_value.nil?
       end
       self
     end
@@ -50,14 +47,10 @@ module Faraday
     # Public
     def merge!(other)
       other.each do |key, other_value|
-        self_value = send(key)
+        self_value = self.send(key)
         sub_options = self.class.options_for(key)
-        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?
+        new_value = (self_value && sub_options && other_value) ? self_value.merge(other_value) : other_value
+        self.send("#{key}=", new_value) unless new_value.nil?
       end
       self
     end
@@ -76,10 +69,10 @@ module Faraday
     def fetch(key, *args)
       unless symbolized_key_set.include?(key.to_sym)
         key_setter = "#{key}="
-        if !args.empty?
+        if args.size > 0
           send(key_setter, args.first)
         elsif block_given?
-          send(key_setter, yield(key))
+          send(key_setter, Proc.new.call(key))
         else
           raise self.class.fetch_error_class, "key not found: #{key.inspect}"
         end
@@ -105,7 +98,6 @@ module Faraday
     # Public
     def each_key
       return to_enum(:each_key) unless block_given?
-
       keys.each do |key|
         yield(key)
       end
@@ -121,7 +113,6 @@ module Faraday
     # Public
     def each_value
       return to_enum(:each_value) unless block_given?
-
       values.each do |value|
         yield(value)
       end
@@ -151,9 +142,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
@@ -171,12 +162,8 @@ module Faraday
       @attribute_options ||= {}
     end
 
-    def self.memoized(key, &block)
-      unless block_given?
-        raise ArgumentError, '#memoized must be called with a block'
-      end
-
-      memoized_attributes[key.to_sym] = block
+    def self.memoized(key)
+      memoized_attributes[key.to_sym] = Proc.new
       class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{key}() self[:#{key}]; end
       RUBY
@@ -188,7 +175,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
@@ -196,7 +183,7 @@ module Faraday
     end
 
     def symbolized_key_set
-      @symbolized_key_set ||= Set.new(keys.map(&:to_sym))
+      @symbolized_key_set ||= Set.new(keys.map { |k| k.to_sym })
     end
 
     def self.inherited(subclass)
@@ -207,16 +194,180 @@ module Faraday
 
     def self.fetch_error_class
       @fetch_error_class ||= if Object.const_defined?(:KeyError)
-                               ::KeyError
-                             else
-                               ::IndexError
-                             end
+        ::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'
+  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)
+    end
+  end
+end

data/lib/faraday/parameters.rb

@@ -1,5 +1,198 @@
-# frozen_string_literal: true
+require "forwardable"
 
-require 'forwardable'
-require 'faraday/encoders/nested_params_encoder'
-require 'faraday/encoders/flat_params_encoder'
+module Faraday
+  module NestedParamsEncoder
+    class << self
+      extend Forwardable
+      def_delegators :'Faraday::Utils', :escape, :unescape
+    end
+
+    def self.encode(params)
+      return nil if params == nil
+
+      if !params.is_a?(Array)
+        if !params.respond_to?(:to_hash)
+          raise TypeError,
+            "Can't convert #{params.class} into Hash."
+        end
+        params = params.to_hash
+        params = params.map do |key, value|
+          key = key.to_s if key.kind_of?(Symbol)
+          [key, value]
+        end
+        # Useful default for OAuth and caching.
+        # Only to be used for non-Array inputs. Arrays should preserve order.
+        params.sort!
+      end
+
+      # Helper lambda
+      to_query = lambda do |parent, value|
+        if value.is_a?(Hash)
+          value = value.map do |key, val|
+            key = escape(key)
+            [key, val]
+          end
+          value.sort!
+          buffer = ""
+          value.each do |key, val|
+            new_parent = "#{parent}%5B#{key}%5D"
+            buffer << "#{to_query.call(new_parent, val)}&"
+          end
+          return buffer.chop
+        elsif value.is_a?(Array)
+          new_parent = "#{parent}%5B%5D"
+          return new_parent if value.empty?
+          buffer = ""
+          value.each_with_index do |val, i|
+            buffer << "#{to_query.call(new_parent, val)}&"
+          end
+          return buffer.chop
+        elsif value.nil?
+          return parent
+        else
+          encoded_value = escape(value)
+          return "#{parent}=#{encoded_value}"
+        end
+      end
+
+      # The params have form [['key1', 'value1'], ['key2', 'value2']].
+      buffer = ''
+      params.each do |parent, value|
+        encoded_parent = escape(parent)
+        buffer << "#{to_query.call(encoded_parent, value)}&"
+      end
+      return buffer.chop
+    end
+
+    def self.decode(query)
+      return nil if query == nil
+
+      params = {}
+      query.split("&").each do |pair|
+        next if pair.empty?
+        key, value = pair.split("=", 2)
+        key = unescape(key)
+        value = unescape(value.gsub(/\+/, ' ')) if value
+
+        subkeys = key.scan(/[^\[\]]+(?:\]?\[\])?/)
+        context = params
+        subkeys.each_with_index do |subkey, i|
+          is_array = subkey =~ /[\[\]]+\Z/
+          subkey = $` if is_array
+          last_subkey = i == subkeys.length - 1
+
+          if !last_subkey || is_array
+            value_type = is_array ? Array : Hash
+            if context[subkey] && !context[subkey].is_a?(value_type)
+              raise TypeError, "expected %s (got %s) for param `%s'" % [
+                value_type.name,
+                context[subkey].class.name,
+                subkey
+              ]
+            end
+            context = (context[subkey] ||= value_type.new)
+          end
+
+          if context.is_a?(Array) && !is_array
+            if !context.last.is_a?(Hash) || context.last.has_key?(subkey)
+              context << {}
+            end
+            context = context.last
+          end
+
+          if last_subkey
+            if is_array
+              context << value
+            else
+              context[subkey] = value
+            end
+          end
+        end
+      end
+
+      dehash(params, 0)
+    end
+
+    # Internal: convert a nested hash with purely numeric keys into an array.
+    # FIXME: this is not compatible with Rack::Utils.parse_nested_query
+    def self.dehash(hash, depth)
+      hash.each do |key, value|
+        hash[key] = dehash(value, depth + 1) if value.kind_of?(Hash)
+      end
+
+      if depth > 0 && !hash.empty? && hash.keys.all? { |k| k =~ /^\d+$/ }
+        hash.keys.sort.inject([]) { |all, key| all << hash[key] }
+      else
+        hash
+      end
+    end
+  end
+
+  module FlatParamsEncoder
+    class << self
+      extend Forwardable
+      def_delegators :'Faraday::Utils', :escape, :unescape
+    end
+
+    def self.encode(params)
+      return nil if params == nil
+
+      if !params.is_a?(Array)
+        if !params.respond_to?(:to_hash)
+          raise TypeError,
+            "Can't convert #{params.class} into Hash."
+        end
+        params = params.to_hash
+        params = params.map do |key, value|
+          key = key.to_s if key.kind_of?(Symbol)
+          [key, value]
+        end
+        # Useful default for OAuth and caching.
+        # Only to be used for non-Array inputs. Arrays should preserve order.
+        params.sort!
+      end
+
+      # The params have form [['key1', 'value1'], ['key2', 'value2']].
+      buffer = ''
+      params.each do |key, value|
+        encoded_key = escape(key)
+        value = value.to_s if value == true || value == false
+        if value == nil
+          buffer << "#{encoded_key}&"
+        elsif value.kind_of?(Array)
+          value.each do |sub_value|
+            encoded_value = escape(sub_value)
+            buffer << "#{encoded_key}=#{encoded_value}&"
+          end
+        else
+          encoded_value = escape(value)
+          buffer << "#{encoded_key}=#{encoded_value}&"
+        end
+      end
+      return buffer.chop
+    end
+
+    def self.decode(query)
+      empty_accumulator = {}
+      return nil if query == nil
+      split_query = (query.split('&').map do |pair|
+        pair.split('=', 2) if pair && !pair.empty?
+      end).compact
+      return split_query.inject(empty_accumulator.dup) do |accu, pair|
+        pair[0] = unescape(pair[0])
+        pair[1] = true if pair[1].nil?
+        if pair[1].respond_to?(:to_str)
+          pair[1] = unescape(pair[1].to_str.gsub(/\+/, " "))
+        end
+        if accu[pair[0]].kind_of?(Array)
+          accu[pair[0]] << pair[1]
+        elsif accu[pair[0]]
+          accu[pair[0]] = [accu[pair[0]], pair[1]]
+        else
+          accu[pair[0]] = pair[1]
+        end
+        accu
+      end
+    end
+  end
+end