faraday 0.16.0 → 0.17.4

data/lib/faraday/deprecate.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Faraday
+  # @param new_klass [Class] new Klass to use
+  #
+  # @return [Class] A modified version of new_klass that warns on
+  #   usage about deprecation.
+  # @see Faraday::Deprecate
+  module DeprecatedClass
+    def self.proxy_class(origclass, ver = '1.0')
+      proxy = Class.new(origclass) do
+        const_set("ORIG_CLASS", origclass)
+
+        class << self
+          extend Faraday::Deprecate
+
+          def ===(other)
+            (superclass == const_get("ORIG_CLASS") && other.is_a?(superclass)) || super
+          end
+        end
+      end
+      proxy.singleton_class.send(:deprecate, :new, "#{origclass}.new", ver)
+      proxy.singleton_class.send(:deprecate, :inherited, origclass.name, ver)
+      proxy
+    end
+  end
+
+  # Deprecation using semver instead of date, based on Gem::Deprecate
+  # Provides a single method +deprecate+ to be used to declare when
+  # something is going away.
+  #
+  #     class Legacy
+  #       def self.klass_method
+  #         # ...
+  #       end
+  #
+  #       def instance_method
+  #         # ...
+  #       end
+  #
+  #       extend Faraday::Deprecate
+  #       deprecate :instance_method, "X.z", '1.0'
+  #
+  #       class << self
+  #         extend Faraday::Deprecate
+  #         deprecate :klass_method, :none, '1.0'
+  #       end
+  #     end
+  module Deprecate
+    def self.skip # :nodoc:
+      @skip ||= begin
+        case ENV['FARADAY_DEPRECATE'].to_s.downcase
+        when '1', 'warn' then :warn
+        else :skip
+        end
+      end
+      @skip == :skip
+    end
+
+    def self.skip=(value) # :nodoc:
+      @skip = value ? :skip : :warn
+    end
+
+    # Temporarily turn off warnings. Intended for tests only.
+    def skip_during
+      original = Faraday::Deprecate.skip
+      Faraday::Deprecate.skip, = true
+      yield
+    ensure
+      Faraday::Deprecate.skip = original
+    end
+
+    # Simple deprecation method that deprecates +name+ by wrapping it up
+    # in a dummy method. It warns on each call to the dummy method
+    # telling the user of +repl+ (unless +repl+ is :none) and the
+    # semver that it is planned to go away.
+    # @param name [Symbol] the method symbol to deprecate
+    # @param repl [#to_s, :none] the replacement to use, when `:none` it will
+    #   alert the user that no replacemtent is present.
+    # @param ver [String] the semver the method will be removed.
+    def deprecate(name, repl, ver)
+      class_eval do
+        gem_ver = Gem::Version.new(ver)
+        old = "_deprecated_#{name}"
+        alias_method old, name
+        define_method name do |*args, &block|
+          mod = is_a? Module
+          target = mod ? "#{self}." : "#{self.class}#"
+          target_message = if name == :inherited
+                             "Inheriting #{self}"
+                           else
+                             "#{target}#{name}"
+                           end
+
+          msg = [
+            "NOTE: #{target_message} is deprecated",
+            repl == :none ? ' with no replacement' : "; use #{repl} instead. ",
+            "It will be removed in or after version #{gem_ver}",
+            "\n#{target}#{name} called from #{Gem.location_of_caller.join(':')}"
+          ]
+          warn "#{msg.join}." unless Faraday::Deprecate.skip
+          send old, *args, &block
+        end
+      end
+    end
+
+    module_function :deprecate, :skip_during
+  end
+end

data/lib/faraday/error.rb

@@ -1,23 +1,17 @@
 # frozen_string_literal: true
 
+require 'faraday/deprecate'
+
+# Faraday namespace.
 module Faraday
   # Faraday error base class.
   class Error < StandardError
     attr_reader :response, :wrapped_exception
 
     def initialize(exc, 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
-      else
-        super(exc.to_s)
-      end
+      @wrapped_exception = nil unless defined?(@wrapped_exception)
+      @response = nil unless defined?(@response)
+      super(exc_msg_and_response!(exc, response))
     end
 
     def backtrace
@@ -29,12 +23,44 @@ 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 = ''
+      inner += " wrapped=#{@wrapped_exception.inspect}" if @wrapped_exception
+      inner += " response=#{@response.inspect}" if @response
+      inner += " #{super}" if inner.empty?
       %(#<#{self.class}#{inner}>)
     end
+
+    protected
+
+    # Pulls out potential parent exception and response hash, storing them in
+    # instance variables.
+    # exc      - Either an Exception, a string message, or a response hash.
+    # response - Hash
+    #              :status  - Optional integer HTTP response status
+    #              :headers - String key/value hash of HTTP response header
+    #                         values.
+    #              :body    - Optional string HTTP response body.
+    #
+    # If a subclass has to call this, then it should pass a string message
+    # to `super`. See NilStatusError.
+    def exc_msg_and_response!(exc, response = nil)
+      if @response.nil? && @wrapped_exception.nil?
+        @wrapped_exception, msg, @response = exc_msg_and_response(exc, response)
+        return msg
+      end
+
+      exc.to_s
+    end
+
+    # Pulls out potential parent exception and response hash.
+    def exc_msg_and_response(exc, response = nil)
+      return [exc, exc.message, response] if exc.respond_to?(:backtrace)
+
+      return [nil, "the server responded with status #{exc[:status]}", exc] \
+        if exc.respond_to?(:each_key)
+
+      [nil, exc.to_s, response]
+    end
   end
 
   # Faraday client error class. Represents 4xx status responses.
@@ -74,27 +100,59 @@ module Faraday
   end
 
   # A unified client error for timeouts.
-  class TimeoutError < ServerError
+  class TimeoutError < ClientError
     def initialize(exc = 'timeout', response = nil)
       super(exc, response)
     end
   end
 
+  # Raised by Faraday::Response::RaiseError in case of a nil status in response.
+  class NilStatusError < ServerError
+    def initialize(exc, response = nil)
+      exc_msg_and_response!(exc, response)
+      @response = unwrap_resp!(@response)
+      super('http status could not be derived from the server response')
+    end
+
+    private
+
+    extend Faraday::Deprecate
+
+    def unwrap_resp(resp)
+      if inner = (resp.keys.size == 1 && resp[:response])
+        return unwrap_resp(inner)
+      end
+
+      resp
+    end
+
+    alias_method :unwrap_resp!, :unwrap_resp
+    deprecate('unwrap_resp', nil, '1.0')
+  end
+
   # A unified error for failed connections.
-  class ConnectionFailed < Error
+  class ConnectionFailed < ClientError
   end
 
   # A unified client error for SSL errors.
-  class SSLError < Error
+  class SSLError < ClientError
   end
 
   # Raised by FaradayMiddleware::ResponseMiddleware
-  class ParsingError < Error
+  class ParsingError < ClientError
   end
 
   # Exception used to control the Retry middleware.
   #
   # @see Faraday::Request::Retry
-  class RetriableResponse < Error
+  class RetriableResponse < ClientError
+  end
+
+  [:ClientError, :ConnectionFailed, :ResourceNotFound,
+    :ParsingError, :TimeoutError, :SSLError, :RetriableResponse].each do |const|
+    Error.const_set(
+      const,
+      DeprecatedClass.proxy_class(Faraday.const_get(const))
+    )
   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,7 +69,7 @@ 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))
@@ -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
@@ -172,10 +163,6 @@ module Faraday
     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
       class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{key}() self[:#{key}]; end
@@ -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