faraday 0.6.0 → 0.9.0

data/lib/faraday/middleware.rb

@@ -1,16 +1,14 @@
 module Faraday
   class Middleware
-    class << self
-      attr_accessor :load_error, :supports_parallel_requests
-      alias supports_parallel_requests? supports_parallel_requests
+    extend MiddlewareRegistry
 
-      # valid parallel managers should respond to #run with no parameters.
-      # otherwise, return a short wrapper around it.
-      def setup_parallel_manager(options = {})
-        nil
-      end
+    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
@@ -18,12 +16,22 @@ module Faraday
       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?
+      load_error.nil?
+    end
+
+    def self.inherited(subclass)
+      super
+      subclass.send(:load_error=, self.load_error)
     end
 
     def initialize(app = nil)
       @app = app
     end
   end
-end
+end

data/lib/faraday/options.rb

@@ -0,0 +1,350 @@
+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
+      return to_enum(:each) unless block_given?
+      members.each do |key|
+        yield(key.to_sym, send(key))
+      end
+    end
+
+    # Public
+    def update(obj)
+      obj.each do |key, value|
+        if sub_options = self.class.options_for(key)
+          value = sub_options.from(value) if 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) unless value.nil?
+      end
+      self
+    end
+
+    alias merge! update
+
+    # Public
+    def delete(key)
+      value = send(key)
+      send("#{key}=", nil)
+      value
+    end
+
+    # Public
+    def clear
+      members.each { |member| delete(member) }
+    end
+
+    # Public
+    def merge(value)
+      dup.update(value)
+    end
+
+    # Public
+    def fetch(key, *args)
+      unless symbolized_key_set.include?(key.to_sym)
+        key_setter = "#{key}="
+        if args.size > 0
+          send(key_setter, args.first)
+        elsif block_given?
+          send(key_setter, Proc.new.call(key))
+        else
+          raise self.class.fetch_error_class, "key not found: #{key.inspect}"
+        end
+      end
+      send(key)
+    end
+
+    # Public
+    def values_at(*keys)
+      keys.map { |key| send(key) }
+    end
+
+    # Public
+    def keys
+      members.reject { |member| send(member).nil? }
+    end
+
+    # Public
+    def empty?
+      keys.empty?
+    end
+
+    # Public
+    def each_key
+      return to_enum(:each_key) unless block_given?
+      keys.each do |key|
+        yield(key)
+      end
+    end
+
+    # Public
+    def key?(key)
+      keys.include?(key)
+    end
+
+    alias has_key? key?
+
+    # Public
+    def each_value
+      return to_enum(:each_value) unless block_given?
+      values.each do |value|
+        yield(value)
+      end
+    end
+
+    # Public
+    def value?(value)
+      values.include?(value)
+    end
+
+    alias has_value? value?
+
+    # Public
+    def to_hash
+      hash = {}
+      members.each do |key|
+        value = send(key)
+        hash[key.to_sym] = value unless value.nil?
+      end
+      hash
+    end
+
+    # Internal
+    def inspect
+      values = []
+      members.each do |member|
+        value = send(member)
+        values << "#{member}=#{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
+
+    def self.memoized(key)
+      memoized_attributes[key.to_sym] = Proc.new
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{key}() self[:#{key}]; end
+      RUBY
+    end
+
+    def self.memoized_attributes
+      @memoized_attributes ||= {}
+    end
+
+    def [](key)
+      key = key.to_sym
+      if method = self.class.memoized_attributes[key]
+        super(key) || (self[key] = instance_eval(&method))
+      else
+        super
+      end
+    end
+
+    def symbolized_key_set
+      @symbolized_key_set ||= Set.new(keys.map { |k| k.to_sym })
+    end
+
+    def self.inherited(subclass)
+      super
+      subclass.attribute_options.update(attribute_options)
+      subclass.memoized_attributes.update(memoized_attributes)
+    end
+
+    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, :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, :certificate, :private_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
+        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.user && Utils.unescape(uri.user) }
+    memoized(:password) { 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)
+
+    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 [](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)
+    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