faraday 0.17.3 → 1.0.0.pre.rc1

data/lib/faraday/middleware.rb

@@ -1,34 +1,10 @@
+# frozen_string_literal: true
+
 module Faraday
+  # Middleware is the basic base class of any Faraday middleware.
   class Middleware
     extend MiddlewareRegistry
-
-    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
+    extend DependencyLoader
 
     def initialize(app = nil)
       @app = app

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, yield(key))
+          send(key_setter, Proc.new.call(key))
         else
           raise self.class.fetch_error_class, "key not found: #{key.inspect}"
         end
@@ -98,6 +105,7 @@ module Faraday
     # Public
     def each_key
       return to_enum(:each_key) unless block_given?
+
       keys.each do |key|
         yield(key)
       end
@@ -113,6 +121,7 @@ module Faraday
     # Public
     def each_value
       return to_enum(:each_value) unless block_given?
+
       values.each do |value|
         yield(value)
       end
@@ -142,9 +151,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
@@ -163,6 +172,10 @@ 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
@@ -175,7 +188,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 +196,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 +207,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'