faraday 0.8.11 → 0.9.0.rc1

data/lib/faraday/error.rb

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

data/lib/faraday/options.rb

@@ -0,0 +1,215 @@
+module Faraday
+  # Subclasses Struct with some special helpers for converting from a Hash to
+  # a Struct.
+  class Options < Struct
+    # Public
+    def self.from(value)
+      value ? new.update(value) : new
+    end
+
+    # Public
+    def each(&block)
+      members.each do |key|
+        block.call key.to_sym, send(key)
+      end
+    end
+
+    # Public
+    def update(obj)
+      obj.each do |key, value|
+        next unless value
+        sub_options = self.class.options_for(key)
+        if sub_options && value
+          value = sub_options.from(value)
+        elsif Hash === value
+          hash = {}
+          value.each do |hash_key, hash_value|
+            hash[hash_key] = hash_value
+          end
+          value = hash
+        end
+
+        self.send("#{key}=", value)
+      end
+      self
+    end
+
+    # Public
+    def delete(key)
+      value = send(key)
+      send("#{key}=", nil)
+      value
+    end
+
+    # Public
+    def merge(value)
+      dup.update(value)
+    end
+
+    # Public
+    def fetch(key, default = nil)
+      send(key) || send("#{key}=", default ||
+        (block_given? ? Proc.new.call : nil))
+    end
+
+    # Public
+    def values_at(*keys)
+      keys.map { |key| send(key) }
+    end
+
+    # Public
+    def keys
+      members.reject { |m| send(m).nil? }
+    end
+
+    # Public
+    def to_hash
+      hash = {}
+      members.each do |key|
+        value = send(key)
+        hash[key.to_sym] = value if value
+      end
+      hash
+    end
+
+    # Internal
+    def inspect
+      values = []
+      members.each do |m|
+        value = send(m)
+        values << "#{m}=#{value.inspect}" if value
+      end
+      values = values.empty? ? ' (empty)' : (' ' << values.join(", "))
+
+      %(#<#{self.class}#{values}>)
+    end
+
+    # Internal
+    def self.options(mapping)
+      attribute_options.update(mapping)
+    end
+
+    # Internal
+    def self.options_for(key)
+      attribute_options[key]
+    end
+
+    # Internal
+    def self.attribute_options
+      @attribute_options ||= {}
+    end
+  end
+
+  class RequestOptions < Options.new(:params_encoder, :proxy, :bind,
+    :timeout, :open_timeout, :boundary,
+    :oauth)
+
+    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, :verify_depth, :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 then value = {:uri => Utils.URI(value)}
+      when URI then value = {:uri => value}
+      when Hash, Options
+        if uri = value.delete(:uri)
+          value[:uri] = Utils.URI(uri)
+        end
+      end
+      super(value)
+    end
+
+    def user
+      self[:user] ||= Utils.unescape(uri.user)
+    end
+
+    def password
+      self[:password] ||= Utils.unescape(uri.password)
+    end
+  end
+
+  class ConnectionOptions < Options.new(:request, :proxy, :ssl, :builder, :url,
+    :parallel_manager, :params, :headers, :builder_class)
+
+    options :request => RequestOptions, :ssl => SSLOptions
+
+    def request
+      self[:request] ||= self.class.options_for(:request).new
+    end
+
+    def ssl
+      self[:ssl] ||= self.class.options_for(:ssl).new
+    end
+
+    def builder_class
+      self[:builder_class] ||= RackBuilder
+    end
+
+    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)
+
+    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
+
+    def success?
+      SuccessfulStatuses.include?(status)
+    end
+
+    def needs_body?
+      !body && MethodsWithBodies.include?(method)
+    end
+
+    def clear_body
+      request_headers[ContentLength] = '0'
+      self.body = ''
+    end
+
+    def parse_body?
+      !StatusesWithoutBody.include?(status)
+    end
+
+    def parallel?
+      !!parallel_manager
+    end
+  end
+end
+

data/lib/faraday/parameters.rb

@@ -0,0 +1,193 @@
+module Faraday
+  module NestedParamsEncoder
+    ESCAPE_RE = /[^a-zA-Z0-9 .~_-]/
+
+    def self.escape(s)
+      return s.to_s.gsub(ESCAPE_RE) {
+        '%' + $&.unpack('H2' * $&.bytesize).join('%').upcase
+      }.tr(' ', '+')
+    end
+
+    def self.unescape(s)
+      CGI.unescape(s.to_s)
+    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)
+          buffer = ""
+          value.each_with_index do |val, i|
+            new_parent = "#{parent}%5B%5D"
+            buffer << "#{to_query.call(new_parent, val)}&"
+          end
+          return buffer.chop
+        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
+      # Recursive helper lambda
+      dehash = lambda do |hash|
+        hash.each do |(key, value)|
+          if value.kind_of?(Hash)
+            hash[key] = dehash.call(value)
+          end
+        end
+        # Numeric keys implies an array
+        if hash != {} && hash.keys.all? { |key| key =~ /^\d+$/ }
+          hash.sort.inject([]) do |accu, (_, value)|
+            accu << value; accu
+          end
+        else
+          hash
+        end
+      end
+
+      empty_accumulator = {}
+      return ((query.split('&').map do |pair|
+        pair.split('=', 2) if pair && !pair.empty?
+      end).compact.inject(empty_accumulator.dup) do |accu, (key, value)|
+        key = unescape(key)
+        if value.kind_of?(String)
+          value = unescape(value.gsub(/\+/, ' '))
+        end
+
+        array_notation = !!(key =~ /\[\]$/)
+        subkeys = key.split(/[\[\]]+/)
+        current_hash = accu
+        for i in 0...(subkeys.size - 1)
+          subkey = subkeys[i]
+          current_hash[subkey] = {} unless current_hash[subkey]
+          current_hash = current_hash[subkey]
+        end
+        if array_notation
+          current_hash[subkeys.last] = [] unless current_hash[subkeys.last]
+          current_hash[subkeys.last] << value
+        else
+          current_hash[subkeys.last] = value
+        end
+        accu
+      end).inject(empty_accumulator.dup) do |accu, (key, value)|
+        accu[key] = value.kind_of?(Hash) ? dehash.call(value) : value
+        accu
+      end
+    end
+  end
+
+  module FlatParamsEncoder
+    ESCAPE_RE = /[^a-zA-Z0-9 .~_-]/
+
+    def self.escape(s)
+      return s.to_s.gsub(ESCAPE_RE) {
+        '%' + $&.unpack('H2' * $&.bytesize).join('%').upcase
+      }.tr(' ', '+')
+    end
+
+    def self.unescape(s)
+      CGI.unescape(s.to_s)
+    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