faraday 0.8.11 → 0.9.0

data/lib/faraday/request/instrumentation.rb

@@ -0,0 +1,36 @@
+module Faraday
+  class Request::Instrumentation < Faraday::Middleware
+    class Options < Faraday::Options.new(:name, :instrumenter)
+      def name
+        self[:name] ||= 'request.faraday'
+      end
+
+      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
+
+    def call(env)
+      @instrumenter.instrument(@name, env) do
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/faraday/request/multipart.rb

@@ -1,22 +1,23 @@
+require File.expand_path("../url_encoded", __FILE__)
+
 module Faraday
   class Request::Multipart < Request::UrlEncoded
     self.mime_type = 'multipart/form-data'.freeze
-    DEFAULT_BOUNDARY = "-----------RubyMultipartPost".freeze
+    DEFAULT_BOUNDARY = "-----------RubyMultipartPost".freeze unless defined? DEFAULT_BOUNDARY
 
     def call(env)
       match_content_type(env) do |params|
-        env[:request] ||= {}
-        env[:request][:boundary] ||= DEFAULT_BOUNDARY
-        env[:request_headers][CONTENT_TYPE] += "; boundary=#{env[:request][:boundary]}"
-        env[:body] = create_multipart(env, params)
+        env.request.boundary ||= DEFAULT_BOUNDARY
+        env.request_headers[CONTENT_TYPE] += "; boundary=#{env.request.boundary}"
+        env.body = create_multipart(env, params)
       end
       @app.call env
     end
 
     def process_request?(env)
       type = request_type(env)
-      env[:body].respond_to?(:each_key) and !env[:body].empty? and (
-        (type.empty? and has_multipart?(env[:body])) or
+      env.body.respond_to?(:each_key) and !env.body.empty? and (
+        (type.empty? and has_multipart?(env.body)) or
         type == self.class.mime_type
       )
     end
@@ -32,14 +33,14 @@ module Faraday
     end
 
     def create_multipart(env, params)
-      boundary = env[:request][:boundary]
+      boundary = env.request.boundary
       parts = process_params(params) do |key, value|
         Faraday::Parts::Part.new(boundary, key, value)
       end
       parts << Faraday::Parts::EpiloguePart.new(boundary)
 
       body = Faraday::CompositeReadIO.new(parts)
-      env[:request_headers]['Content-Length'] = body.length.to_s
+      env.request_headers[Faraday::Env::ContentLength] = body.length.to_s
       return body
     end
 

data/lib/faraday/request/retry.rb

@@ -1,23 +1,118 @@
 module Faraday
+  # Catches exceptions and retries each request a limited number of times.
+  #
+  # By default, it retries 2 times and handles only timeout exceptions. It can
+  # be configured with an arbitrary number of retries, a list of exceptions to
+  # handle, a retry interval, a percentage of randomness to add to the retry
+  # interval, and a backoff factor.
+  #
+  # Examples
+  #
+  #   Faraday.new do |conn|
+  #     conn.request :retry, max: 2, interval: 0.05,
+  #                          interval_randomness: 0.5, backoff_factor: 2
+  #                          exceptions: [CustomException, 'Timeout::Error']
+  #     conn.adapter ...
+  #   end
+  #
+  # This example will result in a first interval that is random between 0.05 and 0.075 and a second
+  # interval that is random between 0.1 and 0.15
+  #
   class Request::Retry < Faraday::Middleware
-    def initialize(app, retries = 2)
-      @retries = retries
+    class Options < Faraday::Options.new(:max, :interval, :interval_randomness, :backoff_factor, :exceptions)
+      def self.from(value)
+        if Fixnum === value
+          new(value)
+        else
+          super(value)
+        end
+      end
+
+      def max
+        (self[:max] ||= 2).to_i
+      end
+
+      def interval
+        (self[:interval] ||= 0).to_f
+      end
+
+      def interval_randomness
+        (self[:interval_randomness] ||= 0).to_i
+      end
+
+      def backoff_factor
+        (self[:backoff_factor] ||= 1).to_f
+      end
+
+      def exceptions
+        Array(self[:exceptions] ||= [Errno::ETIMEDOUT, 'Timeout::Error',
+                                     Error::TimeoutError])
+      end
+
+    end
+
+    # Public: Initialize middleware
+    #
+    # Options:
+    # max                 - Maximum number of retries (default: 2)
+    # interval            - Pause in seconds between retries (default: 0)
+    # interval_randomness - The maximum random interval amount expressed
+    #                       as a float between 0 and 1 to use in addition to the
+    #                       interval. (default: 0)
+    # backoff_factor      - The amount to multiple each successive retry's
+    #                       interval amount by in order to provide backoff
+    #                       (default: 1)
+    # exceptions          - The list of exceptions to handle. Exceptions can be
+    #                       given as Class, Module, or String. (default:
+    #                       [Errno::ETIMEDOUT, Timeout::Error,
+    #                       Error::TimeoutError])
+    def initialize(app, options = nil)
       super(app)
+      @options = Options.from(options)
+      @errmatch = build_exception_matcher(@options.exceptions)
+    end
+
+    def sleep_amount(retries)
+      retry_index = @options.max - retries
+      current_interval = @options.interval * (@options.backoff_factor ** retry_index)
+      random_interval  = rand * @options.interval_randomness.to_f * @options.interval
+      current_interval + random_interval
     end
 
     def call(env)
-      retries = @retries
+      retries = @options.max
       request_body = env[:body]
       begin
         env[:body] = request_body # after failure env[:body] is set to the response body
         @app.call(env)
-      rescue StandardError, Timeout::Error
+      rescue @errmatch
         if retries > 0
           retries -= 1
+          sleep sleep_amount(retries + 1)
           retry
         end
         raise
       end
     end
+
+    # Private: construct an exception matcher object.
+    #
+    # An exception matcher for the rescue clause can usually be any object that
+    # responds to `===`, but for Ruby 1.8 it has to be a Class or Module.
+    def build_exception_matcher(exceptions)
+      matcher = Module.new
+      (class << matcher; self; end).class_eval do
+        define_method(:===) do |error|
+          exceptions.any? do |ex|
+            if ex.is_a? Module
+              error.is_a? ex
+            else
+              error.class.to_s == ex.to_s
+            end
+          end
+        end
+      end
+      matcher
+    end
   end
 end

data/lib/faraday/request/token_authentication.rb

@@ -1,10 +1,10 @@
 module Faraday
-  class Request::TokenAuthentication < Request::Authorization
+  class Request::TokenAuthentication < Request.load_middleware(:authorization)
     # Public
     def self.header(token, options = nil)
       options ||= {}
       options[:token] = token
-      super :Token, options
+      super(:Token, options)
     end
 
     def initialize(app, token, options = nil)

data/lib/faraday/request/url_encoded.rb

@@ -1,6 +1,6 @@
 module Faraday
   class Request::UrlEncoded < Faraday::Middleware
-    CONTENT_TYPE = 'Content-Type'.freeze
+    CONTENT_TYPE = 'Content-Type'.freeze unless defined? CONTENT_TYPE
 
     class << self
       attr_accessor :mime_type
@@ -9,25 +9,26 @@ module Faraday
 
     def call(env)
       match_content_type(env) do |data|
-        env[:body] = Faraday::Utils.build_nested_query data
+        params = Faraday::Utils::ParamsHash[data]
+        env.body = params.to_query(env.params_encoder)
       end
       @app.call env
     end
 
     def match_content_type(env)
       if process_request?(env)
-        env[:request_headers][CONTENT_TYPE] ||= self.class.mime_type
-        yield env[:body] unless env[:body].respond_to?(:to_str)
+        env.request_headers[CONTENT_TYPE] ||= self.class.mime_type
+        yield(env.body) unless env.body.respond_to?(:to_str)
       end
     end
 
     def process_request?(env)
       type = request_type(env)
-      env[:body] and (type.empty? or type == self.class.mime_type)
+      env.body and (type.empty? or type == self.class.mime_type)
     end
 
     def request_type(env)
-      type = env[:request_headers][CONTENT_TYPE].to_s
+      type = env.request_headers[CONTENT_TYPE].to_s
       type = type.split(';', 2).first if type.index(';')
       type
     end

data/lib/faraday/request.rb

@@ -10,43 +10,38 @@ module Faraday
   #   end
   #
   class Request < Struct.new(:method, :path, :params, :headers, :body, :options)
-    extend AutoloadHelper
     extend MiddlewareRegistry
 
-    autoload_all 'faraday/request',
-      :UrlEncoded => 'url_encoded',
-      :Multipart => 'multipart',
-      :Retry => 'retry',
-      :Timeout => 'timeout',
-      :Authorization => 'authorization',
-      :BasicAuthentication => 'basic_authentication',
-      :TokenAuthentication => 'token_authentication'
-
-    register_middleware \
-      :url_encoded => :UrlEncoded,
-      :multipart => :Multipart,
-      :retry => :Retry,
-      :authorization => :Authorization,
-      :basic_auth => :BasicAuthentication,
-      :token_auth => :TokenAuthentication
+    register_middleware File.expand_path('../request', __FILE__),
+      :url_encoded => [:UrlEncoded, 'url_encoded'],
+      :multipart => [:Multipart, 'multipart'],
+      :retry => [:Retry, 'retry'],
+      :authorization => [:Authorization, 'authorization'],
+      :basic_auth => [:BasicAuthentication, 'basic_authentication'],
+      :token_auth => [:TokenAuthentication, 'token_authentication'],
+      :instrumentation => [:Instrumentation, 'instrumentation']
 
     def self.create(request_method)
       new(request_method).tap do |request|
-        yield request if block_given?
+        yield(request) if block_given?
       end
     end
 
     # Public: Replace params, preserving the existing hash type
     def params=(hash)
-      if params then params.replace hash
-      else super
+      if params
+        params.replace hash
+      else
+        super
       end
     end
 
     # Public: Replace request headers, preserving the existing hash type
     def headers=(hash)
-      if headers then headers.replace hash
-      else super
+      if headers
+        headers.replace hash
+      else
+        super
       end
     end
 
@@ -60,7 +55,7 @@ module Faraday
         path, query = path.split('?', 2)
       end
       self.path = path
-      self.params.merge_query query
+      self.params.merge_query query, options.params_encoder
       self.params.update(params) if params
     end
 
@@ -89,13 +84,9 @@ module Faraday
     #     :password   - Proxy server password
     # :ssl - Hash of options for configuring SSL requests.
     def to_env(connection)
-      { :method           => method,
-        :body             => body,
-        :url              => connection.build_exclusive_url(path, params),
-        :request_headers  => headers,
-        :parallel_manager => connection.parallel_manager,
-        :request          => options,
-        :ssl              => connection.ssl}
+      Env.new(method, body, connection.build_exclusive_url(path, params),
+        options, headers, connection.ssl, connection.parallel_manager)
     end
   end
 end
+

data/lib/faraday/response/logger.rb

@@ -15,14 +15,14 @@ module Faraday
     def_delegators :@logger, :debug, :info, :warn, :error, :fatal
 
     def call(env)
-      info "#{env[:method]} #{env[:url].to_s}"
-      debug('request') { dump_headers env[:request_headers] }
+      info "#{env.method} #{env.url.to_s}"
+      debug('request') { dump_headers env.request_headers }
       super
     end
 
     def on_complete(env)
-      info('Status') { env[:status].to_s }
-      debug('response') { dump_headers env[:response_headers] }
+      info('Status') { env.status.to_s }
+      debug('response') { dump_headers env.response_headers }
     end
 
     private

data/lib/faraday/response/raise_error.rb

@@ -1,5 +1,7 @@
 module Faraday
   class Response::RaiseError < Response::Middleware
+    ClientErrorStatuses = 400...600
+
     def on_complete(env)
       case env[:status]
       when 404
@@ -7,13 +9,13 @@ module Faraday
       when 407
         # mimic the behavior that we get with proxy requests with HTTPS
         raise Faraday::Error::ConnectionFailed, %{407 "Proxy Authentication Required "}
-      when 400...600
+      when ClientErrorStatuses
         raise Faraday::Error::ClientError, response_values(env)
       end
     end
 
     def response_values(env)
-      {:status => env[:status], :headers => env[:response_headers], :body => env[:body]}
+      {:status => env.status, :headers => env.response_headers, :body => env.body}
     end
   end
 end

data/lib/faraday/response.rb

@@ -13,43 +13,37 @@ module Faraday
       # Override this to modify the environment after the response has finished.
       # Calls the `parse` method if defined
       def on_complete(env)
-        if respond_to? :parse
-          env[:body] = parse(env[:body]) unless [204,304].index env[:status]
-        end
+        env.body = parse(env.body) if respond_to?(:parse) && env.parse_body?
       end
     end
 
     extend Forwardable
-    extend AutoloadHelper
     extend MiddlewareRegistry
 
-    autoload_all 'faraday/response',
-      :RaiseError => 'raise_error',
-      :Logger     => 'logger'
-
-    register_middleware \
-      :raise_error => :RaiseError,
-      :logger      => :Logger
+    register_middleware File.expand_path('../response', __FILE__),
+      :raise_error => [:RaiseError, 'raise_error'],
+      :logger => [:Logger, 'logger']
 
     def initialize(env = nil)
-      @env = env
+      @env = Env.from(env) if env
       @on_complete_callbacks = []
     end
 
     attr_reader :env
-    alias_method :to_hash, :env
+
+    def_delegators :env, :to_hash
 
     def status
-      finished? ? env[:status] : nil
+      finished? ? env.status : nil
     end
 
     def headers
-      finished? ? env[:response_headers] : {}
+      finished? ? env.response_headers : {}
     end
     def_delegator :headers, :[]
 
     def body
-      finished? ? env[:body] : nil
+      finished? ? env.body : nil
     end
 
     def finished?
@@ -60,39 +54,39 @@ module Faraday
       if not finished?
         @on_complete_callbacks << Proc.new
       else
-        yield env
+        yield(env)
       end
       return self
     end
 
     def finish(env)
       raise "response already finished" if finished?
-      @env = env
+      @env = Env.from(env)
       @on_complete_callbacks.each { |callback| callback.call(env) }
       return self
     end
 
     def success?
-      (200..299).include?(status)
+      finished? && env.success?
     end
 
     # because @on_complete_callbacks cannot be marshalled
     def marshal_dump
       !finished? ? nil : {
-        :status => @env[:status], :body => @env[:body],
-        :response_headers => @env[:response_headers]
+        :status => @env.status, :body => @env.body,
+        :response_headers => @env.response_headers
       }
     end
 
     def marshal_load(env)
-      @env = env
+      @env = Env.from(env)
     end
 
     # Expand the env with more properties, without overriding existing ones.
     # Useful for applying request params after restoring a marshalled Response.
     def apply_request(request_env)
       raise "response didn't finish yet" unless finished?
-      @env = request_env.merge @env
+      @env = Env.from(request_env).update(@env)
       return self
     end
   end