module Faraday::Utils

Utils contains various static helper methods.

Constants

DEFAULT_SEP
ESCAPE_RE

Attributes

Public Instance Methods

Normalize URI() behavior across Ruby versions

url - A String or URI.

Returns a parsed URI.

# File lib/faraday/utils.rb, line 70
def URI(url) # rubocop:disable Naming/MethodName
  if url.respond_to?(:host)
    url
  elsif url.respond_to?(:to_str)
    default_uri_parser.call(url)
  else
    raise ArgumentError, 'bad argument (expected URI object or URI string)'
  end
end
# File lib/faraday/utils.rb, line 55
def basic_header_from(login, pass)
  value = ["#{login}:#{pass}"].pack('m') # Base64 encoding
  value.delete!("\n")
  "Basic #{value}"
end
# File lib/faraday/utils.rb, line 16
def build_nested_query(params)
  NestedParamsEncoder.encode(params)
end
# File lib/faraday/utils.rb, line 12
def build_query(params)
  FlatParamsEncoder.encode(params)
end

Recursive hash merge

# File lib/faraday/utils.rb, line 113
def deep_merge(source, hash)
  deep_merge!(source.dup, hash)
end

Recursive hash update

# File lib/faraday/utils.rb, line 101
def deep_merge!(target, hash)
  hash.each do |key, value|
    target[key] = if value.is_a?(Hash) && (target[key].is_a?(Hash) || target[key].is_a?(Options))
                    deep_merge(target[key], value)
                  else
                    value
                  end
  end
  target
end
# File lib/faraday/utils.rb, line 51
def default_params_encoder
  @default_params_encoder ||= NestedParamsEncoder
end
# File lib/faraday/utils.rb, line 20
def default_space_encoding
  @default_space_encoding ||= '+'
end
# File lib/faraday/utils.rb, line 80
def default_uri_parser
  @default_uri_parser ||= Kernel.method(:URI)
end
# File lib/faraday/utils.rb, line 84
def default_uri_parser=(parser)
  @default_uri_parser = if parser.respond_to?(:call) || parser.nil?
                          parser
                        else
                          parser.method(:parse)
                        end
end
# File lib/faraday/utils.rb, line 30
def escape(str)
  str.to_s.gsub(ESCAPE_RE) do |match|
    "%#{match.unpack('H2' * match.bytesize).join('%').upcase}"
  end.gsub(' ', default_space_encoding)
end

Receives a String or URI and returns just the path with the query string sorted.

# File lib/faraday/utils.rb, line 94
def normalize_path(url)
  url = URI(url)
  (url.path.start_with?('/') ? url.path : "/#{url.path}") +
    (url.query ? "?#{sort_query_params(url.query)}" : '')
end
# File lib/faraday/utils.rb, line 47
def parse_nested_query(query)
  NestedParamsEncoder.decode(query)
end

Adapted from Rack

# File lib/faraday/utils.rb, line 43
def parse_query(query)
  FlatParamsEncoder.decode(query)
end
# File lib/faraday/utils.rb, line 117
def sort_query_params(query)
  query.split('&').sort.join('&')
end
# File lib/faraday/utils.rb, line 36
def unescape(str)
  CGI.unescape str.to_s
end