class Faraday::Utils::Headers

A case-insensitive Hash that preserves the original case of a header when set.

Adapted from Rack::Utils::HeaderHash

Constants

KeyMap

symbol -> string mapper + cache

Attributes

Public Class Methods

allocate ()
Calls superclass method 
# File lib/faraday/utils/headers.rb, line 14
def self.allocate
  new_self = super
  new_self.initialize_names
  new_self
end
from (value) 
# File lib/faraday/utils/headers.rb, line 10
def self.from(value)
  new(value)
end
new (hash = nil)
Calls superclass method 
# File lib/faraday/utils/headers.rb, line 20
def initialize(hash = nil)
  super()
  @names = {}
  update(hash || {})
end

Public Instance Methods

[] (key)
Calls superclass method 
# File lib/faraday/utils/headers.rb, line 52
def [](key)
  key = KeyMap[key]
  super(key) || super(@names[key.downcase])
end
[]= (key, val)
Calls superclass method 
# File lib/faraday/utils/headers.rb, line 57
def []=(key, val)
  key = KeyMap[key]
  key = (@names[key.downcase] ||= key)
  # join multiple values with a comma
  val = val.to_ary.join(', ') if val.respond_to?(:to_ary)
  super(key, val)
end
delete (key)
Calls superclass method 
# File lib/faraday/utils/headers.rb, line 71
def delete(key)
  key = KeyMap[key]
  key = @names[key.downcase]
  return unless key

  @names.delete key.downcase
  super(key)
end
dig (key, *rest)
Calls superclass method 
# File lib/faraday/utils/headers.rb, line 80
def dig(key, *rest)
  key = KeyMap[key]
  key = @names.fetch(key.downcase, key)
  super(key, *rest)
end
fetch (key, ...)
Calls superclass method 
# File lib/faraday/utils/headers.rb, line 65
def fetch(key, ...)
  key = KeyMap[key]
  key = @names.fetch(key.downcase, key)
  super(key, ...)
end
include? (key) 
# File lib/faraday/utils/headers.rb, line 86
def include?(key)
  @names.include? key.downcase
end
Also aliased as: has_key?, member?, key?
initialize_copy (other)

on dup/clone, we need to duplicate @names hash

Calls superclass method 
# File lib/faraday/utils/headers.rb, line 31
def initialize_copy(other)
  super
  @names = other.names.dup
end
initialize_names () 
# File lib/faraday/utils/headers.rb, line 26
def initialize_names
  @names = {}
end
merge (other) 
# File lib/faraday/utils/headers.rb, line 101
def merge(other)
  hash = dup
  hash.merge! other
end
merge! (other) 
# File lib/faraday/utils/headers.rb, line 94
def merge!(other)
  other.each { |k, v| self[k] = v }
  self
end
Also aliased as: update
parse (header_string) 
# File lib/faraday/utils/headers.rb, line 117
def parse(header_string)
  return unless header_string && !header_string.empty?

  headers = header_string.split("\r\n")

  # Find the last set of response headers.
  start_index = headers.rindex { |x| x.start_with?('HTTP/') } || 0
  last_response = headers.slice(start_index, headers.size)

  last_response
    .tap { |a| a.shift if a.first.start_with?('HTTP/') }
    .map { |h| h.split(/:\s*/, 2) } # split key and value
    .reject { |p| p[0].nil? } # ignore blank lines
    .each { |key, value| add_parsed(key, value) }
end
replace (other) 
# File lib/faraday/utils/headers.rb, line 106
def replace(other)
  clear
  @names.clear
  update other
  self
end
to_hash () 
# File lib/faraday/utils/headers.rb, line 113
def to_hash
  {}.update(self)
end