faraday 0.16.0 → 0.17.4

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

data/lib/faraday/rack_builder.rb

@@ -1,20 +1,12 @@
-# frozen_string_literal: true
-
-require 'faraday/adapter_registry'
-
 module Faraday
   # A Builder that processes requests into responses by passing through an inner
   # middleware stack (heavily inspired by Rack).
   #
-  # @example
-  #   Faraday::Connection.new(url: 'http://sushi.com') do |builder|
+  #   Faraday::Connection.new(:url => 'http://sushi.com') do |builder|
   #     builder.request  :url_encoded  # Faraday::Request::UrlEncoded
   #     builder.adapter  :net_http     # Faraday::Adapter::NetHttp
   #   end
   class RackBuilder
-    # Used to detect missing arguments
-    NO_ARGUMENT = Object.new
-
     attr_accessor :handlers
 
     # Error raised when trying to modify the stack after calling `lock!`
@@ -23,28 +15,28 @@ module Faraday
     # borrowed from ActiveSupport::Dependencies::Reference &
     # ActionDispatch::MiddlewareStack::Middleware
     class Handler
-      REGISTRY = Faraday::AdapterRegistry.new
+      @@constants_mutex = Mutex.new
+      @@constants = Hash.new { |h, k|
+        value = k.respond_to?(:constantize) ? k.constantize : Object.const_get(k)
+        @@constants_mutex.synchronize { h[k] = value }
+      }
 
       attr_reader :name
 
       def initialize(klass, *args, &block)
         @name = klass.to_s
-        REGISTRY.set(klass) if klass.respond_to?(:name)
-        @args = args
-        @block = block
-      end
-
-      def klass
-        REGISTRY.get(@name)
+        if klass.respond_to?(:name)
+          @@constants_mutex.synchronize { @@constants[@name] = klass }
+        end
+        @args, @block = args, block
       end
 
-      def inspect
-        @name
-      end
+      def klass() @@constants[@name] end
+      def inspect() @name end
 
       def ==(other)
         if other.is_a? Handler
-          name == other.name
+          self.name == other.name
         elsif other.respond_to? :name
           klass == other
         else
@@ -52,19 +44,18 @@ module Faraday
         end
       end
 
-      def build(app = nil)
+      def build(app)
         klass.new(app, *@args, &@block)
       end
     end
 
-    def initialize(handlers = [], adapter = nil, &block)
-      @adapter = adapter
+    def initialize(handlers = [], &block)
       @handlers = handlers
       if block_given?
         build(&block)
       elsif @handlers.empty?
         # default stack, if nothing else is configured
-        request :url_encoded
+        self.request :url_encoded
         self.adapter Faraday.default_adapter
       end
     end
@@ -73,14 +64,13 @@ module Faraday
       raise_if_locked
       @handlers.clear unless options[:keep]
       yield(self) if block_given?
-      adapter(Faraday.default_adapter) unless @adapter
     end
 
     def [](idx)
       @handlers[idx]
     end
 
-    # Locks the middleware stack to ensure no further modifications are made.
+    # Locks the middleware stack to ensure no further modifications are possible.
     def lock!
       @handlers.freeze
     end
@@ -94,7 +84,7 @@ module Faraday
         use_symbol(Faraday::Middleware, klass, *args, &block)
       else
         raise_if_locked
-        raise_if_adapter(klass)
+        warn_middleware_after_adapter if adapter_set?
         @handlers << self.class::Handler.new(klass, *args, &block)
       end
     end
@@ -107,11 +97,8 @@ module Faraday
       use_symbol(Faraday::Response, key, *args, &block)
     end
 
-    def adapter(klass = NO_ARGUMENT, *args, &block)
-      return @adapter if klass == NO_ARGUMENT
-
-      klass = Faraday::Adapter.lookup_middleware(klass) if klass.is_a?(Symbol)
-      @adapter = self.class::Handler.new(klass, *args, &block)
+    def adapter(key, *args, &block)
+      use_symbol(Faraday::Adapter, key, *args, &block)
     end
 
     ## methods to push onto the various positions in the stack:
@@ -119,11 +106,12 @@ module Faraday
     def insert(index, *args, &block)
       raise_if_locked
       index = assert_index(index)
+      warn_middleware_after_adapter if inserting_after_adapter?(index)
       handler = self.class::Handler.new(*args, &block)
       @handlers.insert(index, handler)
     end
 
-    alias insert_before insert
+    alias_method :insert_before, :insert
 
     def insert_after(index, *args, &block)
       index = assert_index(index)
@@ -145,11 +133,13 @@ module Faraday
     # Processes a Request into a Response by passing it through this Builder's
     # middleware stack.
     #
-    # @param connection [Faraday::Connection]
-    # @param request [Faraday::Request]
+    # connection - Faraday::Connection
+    # request    - Faraday::Request
     #
-    # @return [Faraday::Response]
+    # Returns a Faraday::Response.
     def build_response(connection, request)
+      warn 'WARNING: No adapter was configured for this request' unless adapter_set?
+
       app.call(build_env(connection, request))
     end
 
@@ -163,26 +153,26 @@ module Faraday
     def app
       @app ||= begin
         lock!
-        to_app
+        to_app(lambda { |env|
+          response = Response.new
+          env.response = response
+          response.finish(env) unless env.parallel?
+          response
+        })
       end
     end
 
-    def to_app
+    def to_app(inner_app)
       # last added handler is the deepest and thus closest to the inner app
-      # adapter is always the last one
-      @handlers.reverse.inject(@adapter.build) do |app, handler|
-        handler.build(app)
-      end
+      @handlers.reverse.inject(inner_app) { |app, handler| handler.build(app) }
     end
 
     def ==(other)
-      other.is_a?(self.class) &&
-        @handlers == other.handlers &&
-        @adapter == other.adapter
+      other.is_a?(self.class) && @handlers == other.handlers
     end
 
     def dup
-      self.class.new(@handlers.dup, @adapter.dup)
+      self.class.new(@handlers.dup)
     end
 
     # ENV Keys
@@ -202,36 +192,36 @@ module Faraday
     #     :password   - Proxy server password
     # :ssl - Hash of options for configuring SSL requests.
     def build_env(connection, request)
-      exclusive_url = connection.build_exclusive_url(
-        request.path, request.params,
-        request.options.params_encoder
-      )
-
-      Env.new(request.method, request.body, exclusive_url,
-              request.options, request.headers, connection.ssl,
-              connection.parallel_manager)
+      Env.new(request.method, request.body,
+        connection.build_exclusive_url(request.path, request.params, request.options.params_encoder),
+        request.options, request.headers, connection.ssl,
+        connection.parallel_manager)
     end
 
     private
 
-    LOCK_ERR = "can't modify middleware stack after making a request"
-
     def raise_if_locked
-      raise StackLocked, LOCK_ERR if locked?
+      raise StackLocked, "can't modify middleware stack after making a request" if locked?
     end
 
-    def raise_if_adapter(klass)
-      return unless is_adapter?(klass)
-
-      raise 'Adapter should be set using the `adapter` method, not `use`'
+    def warn_middleware_after_adapter
+      warn "WARNING: Unexpected middleware set after the adapter. " \
+        "This won't be supported from Faraday 1.0."
     end
 
     def adapter_set?
-      !@adapter.nil?
+      @handlers.any? { |handler| is_adapter?(handler) }
     end
 
-    def is_adapter?(klass) # rubocop:disable Naming/PredicateName
-      klass.ancestors.include?(Faraday::Adapter)
+    def inserting_after_adapter?(index)
+      adapter_index = @handlers.find_index { |handler| is_adapter?(handler) }
+      return false if adapter_index.nil?
+
+      index > adapter_index
+    end
+
+    def is_adapter?(handler)
+      handler.klass.ancestors.include? Faraday::Adapter
     end
 
     def use_symbol(mod, key, *args, &block)
@@ -241,7 +231,6 @@ module Faraday
     def assert_index(index)
       idx = index.is_a?(Integer) ? index : @handlers.index(index)
       raise "No such handler: #{index.inspect}" unless idx
-
       idx
     end
   end

data/lib/faraday/request/authorization.rb

@@ -1,53 +1,41 @@
-# frozen_string_literal: true
-
 module Faraday
-  class Request
-    # Request middleware for the Authorization HTTP header
-    class Authorization < Faraday::Middleware
-      KEY = 'Authorization' unless defined? KEY
+  class Request::Authorization < Faraday::Middleware
+    KEY = "Authorization".freeze unless defined? KEY
 
-      # @param type [String, Symbol]
-      # @param token [String, Symbol, Hash]
-      # @return [String] a header value
-      def self.header(type, token)
-        case token
-        when String, Symbol
-          "#{type} #{token}"
-        when Hash
-          build_hash(type.to_s, token)
-        else
-          raise ArgumentError,
-                "Can't build an Authorization #{type}" \
-                  "header from #{token.inspect}"
-        end
+    # Public
+    def self.header(type, token)
+      case token
+      when String, Symbol
+        "#{type} #{token}"
+      when Hash
+        build_hash(type.to_s, token)
+      else
+        raise ArgumentError, "Can't build an Authorization #{type} header from #{token.inspect}"
       end
+    end
 
-      # @param type [String]
-      # @param hash [Hash]
-      # @return [String] type followed by comma-separated key=value pairs
-      # @api private
-      def self.build_hash(type, hash)
-        comma = ', '
-        values = []
-        hash.each do |key, value|
-          values << "#{key}=#{value.to_s.inspect}"
-        end
-        "#{type} #{values * comma}"
+    # Internal
+    def self.build_hash(type, hash)
+      comma = ", "
+      values = []
+      hash.each do |key, value|
+        values << "#{key}=#{value.to_s.inspect}"
       end
+      "#{type} #{values * comma}"
+    end
 
-      # @param app [#call]
-      # @param type [String, Symbol] Type of Authorization
-      # @param token [String, Symbol, Hash] Token value for the Authorization
-      def initialize(app, type, token)
-        @header_value = self.class.header(type, token)
-        super(app)
-      end
+    def initialize(app, type, token)
+      @header_value = self.class.header(type, token)
+      super(app)
+    end
 
-      # @param env [Faraday::Env]
-      def call(env)
-        env.request_headers[KEY] = @header_value unless env.request_headers[KEY]
-        @app.call(env)
+    # Public
+    def call(env)
+      unless env.request_headers[KEY]
+        env.request_headers[KEY] = @header_value
       end
+      @app.call(env)
     end
   end
 end
+

data/lib/faraday/request/basic_authentication.rb

@@ -1,20 +1,13 @@
-# frozen_string_literal: true
-
 require 'base64'
 
 module Faraday
-  class Request
-    # Authorization middleware for Basic Authentication.
-    class BasicAuthentication < load_middleware(:authorization)
-      # @param login [String]
-      # @param pass [String]
-      #
-      # @return [String] a Basic Authentication header line
-      def self.header(login, pass)
-        value = Base64.encode64([login, pass].join(':'))
-        value.delete!("\n")
-        super(:Basic, value)
-      end
+  class Request::BasicAuthentication < Request.load_middleware(:authorization)
+    # Public
+    def self.header(login, pass)
+      value = Base64.encode64([login, pass].join(':'))
+      value.gsub!("\n", '')
+      super(:Basic, value)
     end
   end
 end
+

data/lib/faraday/request/instrumentation.rb

@@ -1,53 +1,35 @@
-# frozen_string_literal: true
-
 module Faraday
-  class Request
-    # Middleware for instrumenting Requests.
-    class Instrumentation < Faraday::Middleware
-      # Options class used in Request::Instrumentation class.
-      class Options < Faraday::Options.new(:name, :instrumenter)
-        # @return [String]
-        def name
-          self[:name] ||= 'request.faraday'
-        end
-
-        # @return [Class]
-        def instrumenter
-          self[:instrumenter] ||= ActiveSupport::Notifications
-        end
+  class Request::Instrumentation < Faraday::Middleware
+    class Options < Faraday::Options.new(:name, :instrumenter)
+      def name
+        self[:name] ||= 'request.faraday'
       end
 
-      # Instruments requests using Active Support.
-      #
-      # Measures time spent only for synchronous requests.
-      #
-      # @example Using ActiveSupport::Notifications to measure time spent
-      #   for Faraday requests.
-      #   ActiveSupport::Notifications
-      #     .subscribe('request.faraday') do |name, starts, ends, _, env|
-      #     url = env[:url]
-      #     http_method = env[:method].to_s.upcase
-      #     duration = ends - starts
-      #     $stderr.puts '[%s] %s %s (%.3f s)' %
-      #       [url.host, http_method, url.request_uri, duration]
-      #   end
-      # @param app [#call]
-      # @param options [nil, Hash] Options hash
-      # @option options [String] :name ('request.faraday')
-      #   Name of the instrumenter
-      # @option options [Class] :instrumenter (ActiveSupport::Notifications)
-      #   Active Support instrumenter class.
-      def initialize(app, options = nil)
-        super(app)
-        @name, @instrumenter = Options.from(options)
-                                      .values_at(:name, :instrumenter)
+      def instrumenter
+        self[:instrumenter] ||= ActiveSupport::Notifications
       end
+    end
+
+    # Public: Instruments requests using Active Support.
+    #
+    # Measures time spent only for synchronous requests.
+    #
+    # Examples
+    #
+    #   ActiveSupport::Notifications.subscribe('request.faraday') do |name, starts, ends, _, env|
+    #     url = env[:url]
+    #     http_method = env[:method].to_s.upcase
+    #     duration = ends - starts
+    #     $stderr.puts '[%s] %s %s (%.3f s)' % [url.host, http_method, url.request_uri, duration]
+    #   end
+    def initialize(app, options = nil)
+      super(app)
+      @name, @instrumenter = Options.from(options).values_at(:name, :instrumenter)
+    end
 
-      # @param env [Faraday::Env]
-      def call(env)
-        @instrumenter.instrument(@name, env) do
-          @app.call(env)
-        end
+    def call(env)
+      @instrumenter.instrument(@name, env) do
+        @app.call(env)
       end
     end
   end