faraday 0.8.11 → 0.9.0

data/lib/faraday/connection.rb

@@ -1,24 +1,49 @@
-require 'cgi'
-require 'set'
-require 'forwardable'
-require 'uri'
-
-Faraday.require_libs 'builder', 'request', 'response', 'utils'
-
 module Faraday
+  # Public: Connection objects manage the default properties and the middleware
+  # stack for fulfilling an HTTP request.
+  #
+  # Examples
+  #
+  #   conn = Faraday::Connection.new 'http://sushi.com'
+  #
+  #   # GET http://sushi.com/nigiri
+  #   conn.get 'nigiri'
+  #   # => #<Faraday::Response>
+  #
   class Connection
+    # A Set of allowed HTTP verbs.
     METHODS = Set.new [:get, :post, :put, :delete, :head, :patch, :options]
-    METHODS_WITH_BODIES = Set.new [:post, :put, :patch, :options]
 
-    attr_reader :params, :headers, :url_prefix, :builder, :options, :ssl, :parallel_manager
+    # Public: Returns a Hash of URI query unencoded key/value pairs.
+    attr_reader :params
+
+    # Public: Returns a Hash of unencoded HTTP header key/value pairs.
+    attr_reader :headers
+
+    # Public: Returns a URI with the prefix used for all requests from this
+    # Connection.  This includes a default host name, scheme, port, and path.
+    attr_reader :url_prefix
+
+    # Public: Returns the Faraday::Builder for this Connection.
+    attr_reader :builder
+
+    # Public: Returns a Hash of the request options.
+    attr_reader :options
+
+    # Public: Returns a Hash of the SSL options.
+    attr_reader :ssl
+
+    # Public: Returns the parallel manager for this Connection.
+    attr_reader :parallel_manager
+
+    # Public: Sets the default parallel manager for this connection.
     attr_writer :default_parallel_manager
 
     # Public: Initializes a new Faraday::Connection.
     #
     # url     - URI or String base URL to use as a prefix for all
     #           requests (optional).
-    # options - Hash of settings that will be applied to every request made
-    #           from this Connection (default: {}).
+    # options - Hash or Faraday::ConnectionOptions.
     #           :url     - URI or String base URL (default: "http:/").
     #           :params  - Hash of URI query unencoded key/value pairs.
     #           :headers - Hash of unencoded HTTP header key/value pairs.
@@ -29,29 +54,30 @@ module Faraday
     #                     :uri      - URI or String
     #                     :user     - String (optional)
     #                     :password - String (optional)
-    def initialize(url = nil, options = {})
+    def initialize(url = nil, options = nil)
       if url.is_a?(Hash)
-        options = url
-        url     = options[:url]
+        options = ConnectionOptions.from(url)
+        url     = options.url
+      else
+        options = ConnectionOptions.from(options)
       end
-      @headers = Utils::Headers.new
-      @params  = Utils::ParamsHash.new
-      @options = options[:request] || {}
-      @ssl     = options[:ssl]     || {}
 
       @parallel_manager = nil
-      @default_parallel_manager = options[:parallel_manager]
+      @headers = Utils::Headers.new
+      @params  = Utils::ParamsHash.new
+      @options = options.request
+      @ssl = options.ssl
+      @default_parallel_manager = options.parallel_manager
 
-      @builder = options[:builder] || begin
+      @builder = options.builder || begin
         # pass an empty block to Builder so it doesn't assume default middleware
-        block = block_given?? Proc.new {|b| } : nil
-        Builder.new(&block)
+        options.new_builder(block_given? ? Proc.new { |b| } : nil)
       end
 
       self.url_prefix = url || 'http:/'
 
-      @params.update options[:params]   if options[:params]
-      @headers.update options[:headers] if options[:headers]
+      @params.update(options.params)   if options.params
+      @headers.update(options.headers) if options.headers
 
       @proxy = nil
       proxy(options.fetch(:proxy) {
@@ -62,56 +88,89 @@ module Faraday
         end
       })
 
-      yield self if block_given?
+      yield(self) if block_given?
 
       @headers[:user_agent] ||= "Faraday v#{VERSION}"
     end
 
-    # Public: Replace default query parameters.
+    # Public: Sets the Hash of URI query unencoded key/value pairs.
     def params=(hash)
       @params.replace hash
     end
 
-    # Public: Replace default request headers.
+    # Public: Sets the Hash of unencoded HTTP header key/value pairs.
     def headers=(hash)
       @headers.replace hash
     end
 
     extend Forwardable
-    def_delegators :builder, :build, :use, :request, :response, :adapter
-
-    # The "rack app" wrapped in middleware. All requests are sent here.
-    #
-    # The builder is responsible for creating the app object. After this,
-    # the builder gets locked to ensure no further modifications are made
-    # to the middleware stack.
-    #
-    # Returns an object that responds to `call` and returns a Response.
-    def app
-      @app ||= begin
-        builder.lock!
-        builder.to_app(lambda { |env|
-          # the inner app that creates and returns the Response object
-          response = Response.new
-          response.finish(env) unless env[:parallel_manager]
-          env[:response] = response
-        })
-      end
-    end
 
-    # get/head/delete(url, params, headers)
+    def_delegators :builder, :build, :use, :request, :response, :adapter, :app
+
+    # Public: Makes an HTTP request without a body.
+    #
+    # url     - The optional String base URL to use as a prefix for all
+    #           requests.  Can also be the options Hash.
+    # params  - Hash of URI query unencoded key/value pairs.
+    # headers - Hash of unencoded HTTP header key/value pairs.
+    #
+    # Examples
+    #
+    #   conn.get '/items', {:page => 1}, :accept => 'application/json'
+    #   conn.head '/items/1'
+    #
+    #   # ElasticSearch example sending a body with GET.
+    #   conn.get '/twitter/tweet/_search' do |req|
+    #     req.headers[:content_type] = 'application/json'
+    #     req.params[:routing] = 'kimchy'
+    #     req.body = JSON.generate(:query => {...})
+    #   end
+    #
+    # Yields a Faraday::Response for further request customizations.
+    # Returns a Faraday::Response.
+    #
+    # Signature
+    #
+    #   <verb>(url = nil, params = nil, headers = nil)
+    #
+    # verb - An HTTP verb: get, head, or delete.
     %w[get head delete].each do |method|
       class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{method}(url = nil, params = nil, headers = nil)
           run_request(:#{method}, url, nil, headers) { |request|
             request.params.update(params) if params
-            yield request if block_given?
+            yield(request) if block_given?
           }
         end
       RUBY
     end
 
-    # post/put/patch(url, body, headers)
+    # Public: Makes an HTTP request with a body.
+    #
+    # url     - The optional String base URL to use as a prefix for all
+    #           requests.  Can also be the options Hash.
+    # body    - The String body for the request.
+    # headers - Hash of unencoded HTTP header key/value pairs.
+    #
+    # Examples
+    #
+    #   conn.post '/items', data, :content_type => 'application/json'
+    #
+    #   # Simple ElasticSearch indexing sample.
+    #   conn.post '/twitter/tweet' do |req|
+    #     req.headers[:content_type] = 'application/json'
+    #     req.params[:routing] = 'kimchy'
+    #     req.body = JSON.generate(:user => 'kimchy', ...)
+    #   end
+    #
+    # Yields a Faraday::Response for further request customizations.
+    # Returns a Faraday::Response.
+    #
+    # Signature
+    #
+    #   <verb>(url = nil, body = nil, headers = nil)
+    #
+    # verb - An HTTP verb: post, put, or patch.
     %w[post put patch].each do |method|
       class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{method}(url = nil, body = nil, headers = nil, &block)
@@ -120,19 +179,60 @@ module Faraday
       RUBY
     end
 
+    # Public: Sets up the Authorization header with these credentials, encoded
+    # with base64.
+    #
+    # login - The authentication login.
+    # pass  - The authentication password.
+    #
+    # Examples
+    #
+    #   conn.basic_auth 'Aladdin', 'open sesame'
+    #   conn.headers['Authorization']
+    #   # => "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="
+    #
+    # Returns nothing.
     def basic_auth(login, pass)
-      headers[Faraday::Request::Authorization::KEY] =
-        Faraday::Request::BasicAuthentication.header(login, pass)
+      set_authorization_header(:basic_auth, login, pass)
     end
 
+    # Public: Sets up the Authorization header with the given token.
+    #
+    # token   - The String token.
+    # options - Optional Hash of extra token options.
+    #
+    # Examples
+    #
+    #   conn.token_auth 'abcdef', :foo => 'bar'
+    #   conn.headers['Authorization']
+    #   # => "Token token=\"abcdef\",
+    #               foo=\"bar\""
+    #
+    # Returns nothing.
     def token_auth(token, options = nil)
-      headers[Faraday::Request::Authorization::KEY] =
-        Faraday::Request::TokenAuthentication.header(token, options)
+      set_authorization_header(:token_auth, token, options)
     end
 
+    # Public: Sets up a custom Authorization header.
+    #
+    # type  - The String authorization type.
+    # token - The String or Hash token.  A String value is taken literally, and
+    #         a Hash is encoded into comma separated key/value pairs.
+    #
+    # Examples
+    #
+    #   conn.authorization :Bearer, 'mF_9.B5f-4.1JqM'
+    #   conn.headers['Authorization']
+    #   # => "Bearer mF_9.B5f-4.1JqM"
+    #
+    #   conn.authorization :Token, :token => 'abcdef', :foo => 'bar'
+    #   conn.headers['Authorization']
+    #   # => "Token token=\"abcdef\",
+    #               foo=\"bar\""
+    #
+    # Returns nothing.
     def authorization(type, token)
-      headers[Faraday::Request::Authorization::KEY] =
-        Faraday::Request::Authorization.header(type, token)
+      set_authorization_header(:authorization, type, token)
     end
 
     # Internal: Traverse the middleware stack in search of a
@@ -147,16 +247,27 @@ module Faraday
           h.klass.respond_to?(:supports_parallel?) and h.klass.supports_parallel?
         end
 
-        if handler then handler.klass.setup_parallel_manager
-        elsif block_given? then yield
+        if handler
+          handler.klass.setup_parallel_manager
+        elsif block_given?
+          yield
         end
       end
     end
 
+    # Public: Determine if this Faraday::Connection can make parallel requests.
+    #
+    # Returns true or false.
     def in_parallel?
       !!@parallel_manager
     end
 
+    # Public: Sets up the parallel manager to make a set of requests.
+    #
+    # manager - The parallel manager that this Connection's Adapter uses.
+    #
+    # Yields a block to execute multiple requests.
+    # Returns nothing.
     def in_parallel(manager = nil)
       @parallel_manager = manager || default_parallel_manager {
         warn "Warning: `in_parallel` called but no parallel-capable adapter on Faraday stack"
@@ -169,43 +280,23 @@ module Faraday
       @parallel_manager = nil
     end
 
+    # Public: Gets or Sets the Hash proxy options.
     def proxy(arg = nil)
       return @proxy if arg.nil?
-
-      @proxy = if arg.is_a? Hash
-        uri = self.class.URI arg.fetch(:uri) { raise ArgumentError, "missing :uri" }
-        arg.merge :uri => uri
-      else
-        uri = self.class.URI(arg)
-        {:uri => uri}
-      end
-
-      with_uri_credentials(uri) do |user, password|
-        @proxy[:user]     ||= user
-        @proxy[:password] ||= password
-      end
-
-      @proxy
-    end
-
-    # normalize URI() behavior across Ruby versions
-    def self.URI(url)
-      if url.respond_to?(:host)
-        url
-      elsif url.respond_to?(:to_str)
-        Kernel.URI(url)
-      else
-        raise ArgumentError, "bad argument (expected URI object or URI string)"
-      end
+      @proxy = ProxyOptions.from(arg)
     end
 
     def_delegators :url_prefix, :scheme, :scheme=, :host, :host=, :port, :port=
     def_delegator :url_prefix, :path, :path_prefix
 
-    # Parses the giving url with URI and stores the individual
+    # Public: Parses the giving url with URI and stores the individual
     # components in this connection.  These components serve as defaults for
     # requests made by this connection.
     #
+    # url - A String or URI.
+    #
+    # Examples
+    #
     #   conn = Faraday::Connection.new { ... }
     #   conn.url_prefix = "https://sushi.com/api"
     #   conn.scheme      # => https
@@ -213,11 +304,12 @@ module Faraday
     #
     #   conn.get("nigiri?page=2") # accesses https://sushi.com/api/nigiri
     #
-    def url_prefix=(url)
-      uri = @url_prefix = self.class.URI(url)
+    # Returns the parsed URI from teh given input..
+    def url_prefix=(url, encoder = nil)
+      uri = @url_prefix = Utils.URI(url)
       self.path_prefix = uri.path
 
-      params.merge_query(uri.query)
+      params.merge_query(uri.query, encoder)
       uri.query = nil
 
       with_uri_credentials(uri) do |user, password|
@@ -228,15 +320,48 @@ module Faraday
       uri
     end
 
-    # Ensures that the path prefix always has a leading but no trailing slash
+    # Public: Sets the path prefix and ensures that it always has a leading
+    # slash.
+    #
+    # value - A String.
+    #
+    # Returns the new String path prefix.
     def path_prefix=(value)
       url_prefix.path = if value
-        value = value.chomp '/'
         value = '/' + value unless value[0,1] == '/'
         value
       end
     end
 
+    # Public: Takes a relative url for a request and combines it with the defaults
+    # set on the connection instance.
+    #
+    #   conn = Faraday::Connection.new { ... }
+    #   conn.url_prefix = "https://sushi.com/api?token=abc"
+    #   conn.scheme      # => https
+    #   conn.path_prefix # => "/api"
+    #
+    #   conn.build_url("nigiri?page=2")      # => https://sushi.com/api/nigiri?token=abc&page=2
+    #   conn.build_url("nigiri", :page => 2) # => https://sushi.com/api/nigiri?token=abc&page=2
+    #
+    def build_url(url = nil, extra_params = nil)
+      uri = build_exclusive_url(url)
+
+      query_values = params.dup.merge_query(uri.query, options.params_encoder)
+      query_values.update extra_params if extra_params
+      uri.query = query_values.empty? ? nil : query_values.to_query(options.params_encoder)
+
+      uri
+    end
+
+    # Builds and runs the Faraday::Request.
+    #
+    # method  - The Symbol HTTP method.
+    # url     - The String or URI to access.
+    # body    - The String body
+    # headers - Hash of unencoded HTTP header key/value pairs.
+    #
+    # Returns a Faraday::Response.
     def run_request(method, url, body, headers)
       if !METHODS.include?(method)
         raise ArgumentError, "unknown http method: #{method}"
@@ -246,14 +371,13 @@ module Faraday
         req.url(url)                if url
         req.headers.update(headers) if headers
         req.body = body             if body
-        yield req if block_given?
+        yield(req) if block_given?
       end
 
-      env = request.to_env(self)
-      self.app.call(env)
+      builder.build_response(self, request)
     end
 
-    # Internal: Creates and configures the request object.
+    # Creates and configures the request object.
     #
     # Returns the new Request.
     def build_request(method)
@@ -261,31 +385,10 @@ module Faraday
         req.params  = self.params.dup
         req.headers = self.headers.dup
         req.options = self.options.merge(:proxy => self.proxy)
-        yield req if block_given?
+        yield(req) if block_given?
       end
     end
 
-    # Takes a relative url for a request and combines it with the defaults
-    # set on the connection instance.
-    #
-    #   conn = Faraday::Connection.new { ... }
-    #   conn.url_prefix = "https://sushi.com/api?token=abc"
-    #   conn.scheme      # => https
-    #   conn.path_prefix # => "/api"
-    #
-    #   conn.build_url("nigiri?page=2")      # => https://sushi.com/api/nigiri?token=abc&page=2
-    #   conn.build_url("nigiri", :page => 2) # => https://sushi.com/api/nigiri?token=abc&page=2
-    #
-    def build_url(url, extra_params = nil)
-      uri = build_exclusive_url(url)
-
-      query_values = self.params.dup.merge_query(uri.query)
-      query_values.update extra_params if extra_params
-      uri.query = query_values.empty? ? nil : query_values.to_query
-
-      uri
-    end
-
     # Internal: Build an absolute URL based on url_prefix.
     #
     # url    - A String or URI-like object
@@ -293,7 +396,7 @@ module Faraday
     #          of the resulting url (default: nil).
     #
     # Returns the resulting URI instance.
-    def build_exclusive_url(url, params = nil)
+    def build_exclusive_url(url = nil, params = nil)
       url = nil if url.respond_to?(:empty?) and url.empty?
       base = url_prefix
       if url and base.path and base.path !~ /\/$/
@@ -301,25 +404,29 @@ module Faraday
         base.path = base.path + '/'  # ensure trailing slash
       end
       uri = url ? base + url : base
-      uri.query = params.to_query if params
+      uri.query = params.to_query(options.params_encoder) if params
       uri.query = nil if uri.query and uri.query.empty?
       uri
     end
 
+    # Internal: Creates a duplicate of this Faraday::Connection.
+    #
+    # Returns a Faraday::Connection.
     def dup
-      self.class.new(build_url(''),
-                     :headers => headers.dup,
-                     :params => params.dup,
-                     :builder => builder.dup,
-                     :ssl => ssl.dup,
-                     :request => options.dup)
+      self.class.new(build_exclusive_url, :headers => headers.dup, :params => params.dup, :builder => builder.dup, :ssl => ssl.dup)
     end
 
     # Internal: Yields username and password extracted from a URI if they both exist.
     def with_uri_credentials(uri)
       if uri.user and uri.password
-        yield Utils.unescape(uri.user), Utils.unescape(uri.password)
+        yield(Utils.unescape(uri.user), Utils.unescape(uri.password))
       end
     end
+
+    def set_authorization_header(header_type, *args)
+      header = Faraday::Request.lookup_middleware(header_type).
+        header(*args)
+      headers[Faraday::Request::Authorization::KEY] = header
+    end
   end
 end

data/lib/faraday/error.rb

@@ -1,45 +1,53 @@
 module Faraday
-  module Error
-    class ClientError < StandardError
-      attr_reader :response
-
-      def initialize(ex, response = nil)
-        @wrapped_exception = nil
-        @response = response
-
-        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(ex.to_s)
-        end
-      end
+  class Error < StandardError; end
+  class MissingDependency < Error; end
+
+  class ClientError < Error
+    attr_reader :response
+
+    def initialize(ex, response = nil)
+      @wrapped_exception = nil
+      @response = response
 
-      def backtrace
-        if @wrapped_exception
-          @wrapped_exception.backtrace
-        else
-          super
-        end
+      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(ex.to_s)
       end
+    end
 
-      def inspect
-        %(#<#{self.class}>)
+    def backtrace
+      if @wrapped_exception
+        @wrapped_exception.backtrace
+      else
+        super
       end
     end
 
-    class ConnectionFailed < ClientError;   end
-    class ResourceNotFound < ClientError;   end
-    class ParsingError     < ClientError;   end
-    class MissingDependency < StandardError; end
+    def inspect
+      %(#<#{self.class}>)
+    end
+  end
+
+  class ConnectionFailed < ClientError;   end
+  class ResourceNotFound < ClientError;   end
+  class ParsingError     < ClientError;   end
 
-    class TimeoutError < ClientError
-      def initialize(ex = nil)
-        super(ex || "timeout")
-      end
+  class TimeoutError < ClientError
+    def initialize(ex = nil)
+      super(ex || "timeout")
     end
   end
+
+  class SSLError < ClientError
+  end
+
+  [:MissingDependency, :ClientError, :ConnectionFailed, :ResourceNotFound,
+   :ParsingError, :TimeoutError, :SSLError].each do |const|
+    Error.const_set(const, Faraday.const_get(const))
+  end
 end