faraday 0.12.2 → 1.3.0

data/lib/faraday/options/connection_options.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Faraday
+  # ConnectionOptions contains the configurable properties for a Faraday
+  # connection object.
+  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
+end

data/lib/faraday/options/env.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+module Faraday
+  # @!attribute method
+  #   @return [Symbol] HTTP method (`:get`, `:post`)
+  #
+  # @!attribute body
+  #   @return [String] The request body that will eventually be converted to a
+  #   string.
+  #
+  # @!attribute url
+  #   @return [URI] URI instance for the current request.
+  #
+  # @!attribute request
+  #   @return [Hash] options for configuring the request.
+  #   Options for configuring the request.
+  #
+  #   - `:timeout`  open/read timeout Integer in seconds
+  #   - `:open_timeout` - read timeout Integer in seconds
+  #   - `:on_data`      - Proc for streaming
+  #   - `:proxy`        - Hash of proxy options
+  #       - `:uri`        - Proxy Server URI
+  #       - `:user`       - Proxy server username
+  #       - `:password`   - Proxy server password
+  #
+  # @!attribute request_headers
+  #   @return [Hash] HTTP Headers to be sent to the server.
+  #
+  # @!attribute ssl
+  #   @return [Hash] options for configuring SSL requests
+  #
+  # @!attribute parallel_manager
+  #   @return [Object] sent if the connection is in parallel mode
+  #
+  # @!attribute params
+  #   @return [Hash]
+  #
+  # @!attribute response
+  #   @return [Response]
+  #
+  # @!attribute response_headers
+  #   @return [Hash] HTTP headers from the server
+  #
+  # @!attribute status
+  #   @return [Integer] HTTP response status code
+  #
+  # @!attribute reason_phrase
+  #   @return [String]
+  class Env < Options.new(:method, :request_body, :url, :request,
+                          :request_headers, :ssl, :parallel_manager, :params,
+                          :response, :response_headers, :status,
+                          :reason_phrase, :response_body)
+
+    # rubocop:disable Naming/ConstantName
+    ContentLength = 'Content-Length'
+    StatusesWithoutBody = Set.new [204, 304]
+    SuccessfulStatuses = (200..299).freeze
+    # rubocop:enable Naming/ConstantName
+
+    # 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(Faraday::METHODS_WITH_BODY.map(&:to_sym))
+
+    options request: RequestOptions,
+            request_headers: Utils::Headers, response_headers: Utils::Headers
+
+    extend Forwardable
+
+    def_delegators :request, :params_encoder
+
+    # Build a new Env from given value. Respects and updates `custom_members`.
+    #
+    # @param value [Object] a value fitting Option.from(v).
+    # @return [Env] from given value
+    def self.from(value)
+      env = super(value)
+      if value.respond_to?(:custom_members)
+        env.custom_members.update(value.custom_members)
+      end
+      env
+    end
+
+    # @param key [Object]
+    def [](key)
+      return self[current_body] if key == :body
+
+      if in_member_set?(key)
+        super(key)
+      else
+        custom_members[key]
+      end
+    end
+
+    # @param key [Object]
+    # @param value [Object]
+    def []=(key, value)
+      if key == :body
+        super(current_body, value)
+        return
+      end
+
+      if in_member_set?(key)
+        super(key, value)
+      else
+        custom_members[key] = value
+      end
+    end
+
+    def current_body
+      !!status ? :response_body : :request_body
+    end
+
+    def body
+      self[:body]
+    end
+
+    def body=(value)
+      self[:body] = value
+    end
+
+    # @return [Boolean] true if status is in the set of {SuccessfulStatuses}.
+    def success?
+      SuccessfulStatuses.include?(status)
+    end
+
+    # @return [Boolean] true if there's no body yet, and the method is in the
+    # set of {MethodsWithBodies}.
+    def needs_body?
+      !body && MethodsWithBodies.include?(method)
+    end
+
+    # Sets content length to zero and the body to the empty string.
+    def clear_body
+      request_headers[ContentLength] = '0'
+      self.body = +''
+    end
+
+    # @return [Boolean] true if the status isn't in the set of
+    # {StatusesWithoutBody}.
+    def parse_body?
+      !StatusesWithoutBody.include?(status)
+    end
+
+    # @return [Boolean] true if there is a parallel_manager
+    def parallel?
+      !!parallel_manager
+    end
+
+    def inspect
+      attrs = [nil]
+      members.each do |mem|
+        if (value = send(mem))
+          attrs << "@#{mem}=#{value.inspect}"
+        end
+      end
+      attrs << "@custom=#{custom_members.inspect}" unless custom_members.empty?
+      %(#<#{self.class}#{attrs.join(' ')}>)
+    end
+
+    # @private
+    def custom_members
+      @custom_members ||= {}
+    end
+
+    # @private
+    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
+
+    # @private
+    def self.member_set
+      @member_set ||= Set.new(members)
+    end
+  end
+end

data/lib/faraday/options/proxy_options.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Faraday
+  # ProxyOptions contains the configurable properties for the proxy
+  # configuration used when making an HTTP request.
+  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
+end

data/lib/faraday/options/request_options.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Faraday
+  # RequestOptions contains the configurable properties for a Faraday request.
+  class RequestOptions < Options.new(:params_encoder, :proxy, :bind,
+                                     :timeout, :open_timeout, :read_timeout,
+                                     :write_timeout, :boundary, :oauth,
+                                     :context, :on_data)
+
+    def []=(key, value)
+      if key && key.to_sym == :proxy
+        super(key, value ? ProxyOptions.from(value) : nil)
+      else
+        super(key, value)
+      end
+    end
+
+    def stream_response?
+      on_data.is_a?(Proc)
+    end
+  end
+end

data/lib/faraday/options/ssl_options.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Faraday
+  # SSL-related options.
+  #
+  # @!attribute verify
+  #   @return [Boolean] whether to verify SSL certificates or not
+  #
+  # @!attribute ca_file
+  #   @return [String] CA file
+  #
+  # @!attribute ca_path
+  #   @return [String] CA path
+  #
+  # @!attribute verify_mode
+  #   @return [Integer] Any `OpenSSL::SSL::` constant (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL.html)
+  #
+  # @!attribute cert_store
+  #   @return [OpenSSL::X509::Store] certificate store
+  #
+  # @!attribute client_cert
+  #   @return [String, OpenSSL::X509::Certificate] client certificate
+  #
+  # @!attribute client_key
+  #   @return [String, OpenSSL::PKey::RSA, OpenSSL::PKey::DSA] client key
+  #
+  # @!attribute certificate
+  #   @return [OpenSSL::X509::Certificate] certificate (Excon only)
+  #
+  # @!attribute private_key
+  #   @return [OpenSSL::PKey::RSA, OpenSSL::PKey::DSA] private key (Excon only)
+  #
+  # @!attribute verify_depth
+  #   @return [Integer] maximum depth for the certificate chain verification
+  #
+  # @!attribute version
+  #   @return [String, Symbol] SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-ssl_version-3D)
+  #
+  # @!attribute min_version
+  #   @return [String, Symbol] minimum SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-min_version-3D)
+  #
+  # @!attribute max_version
+  #   @return [String, Symbol] maximum SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-max_version-3D)
+  class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode,
+                                 :cert_store, :client_cert, :client_key,
+                                 :certificate, :private_key, :verify_depth,
+                                 :version, :min_version, :max_version)
+
+    # @return [Boolean] true if should verify
+    def verify?
+      verify != false
+    end
+
+    # @return [Boolean] true if should not verify
+    def disable?
+      !verify?
+    end
+  end
+end

data/lib/faraday/param_part.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Faraday
+  # Multipart value used to POST data with a content type.
+  class ParamPart
+    # @param value [String] Uploaded content as a String.
+    # @param content_type [String] String content type of the value.
+    # @param content_id [String] Optional String of this value's Content-ID.
+    #
+    # @return [Faraday::ParamPart]
+    def initialize(value, content_type, content_id = nil)
+      @value = value
+      @content_type = content_type
+      @content_id = content_id
+    end
+
+    # Converts this value to a form part.
+    #
+    # @param boundary [String] String multipart boundary that must not exist in
+    #   the content exactly.
+    # @param key [String] String key name for this value.
+    #
+    # @return [Faraday::Parts::Part]
+    def to_part(boundary, key)
+      Faraday::Parts::Part.new(boundary, key, value, headers)
+    end
+
+    # Returns a Hash of String key/value pairs.
+    #
+    # @return [Hash]
+    def headers
+      {
+        'Content-Type' => content_type,
+        'Content-ID' => content_id
+      }
+    end
+
+    # The content to upload.
+    #
+    # @return [String]
+    attr_reader :value
+
+    # The value's content type.
+    #
+    # @return [String]
+    attr_reader :content_type
+
+    # The value's content ID, if given.
+    #
+    # @return [String, nil]
+    attr_reader :content_id
+  end
+end

data/lib/faraday/parameters.rb

@@ -1,197 +1,5 @@
-require "forwardable"
+# frozen_string_literal: true
 
-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)
-          buffer = ""
-          value.each_with_index do |val, i|
-            new_parent = "#{parent}%5B%5D"
-            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
+require 'forwardable'
+require 'faraday/encoders/nested_params_encoder'
+require 'faraday/encoders/flat_params_encoder'