Class: Faraday::Utils::Headers

Inherits:
Hash
  • Object
show all
Defined in:
lib/faraday/utils.rb

Overview

Adapted from Rack::Utils::HeaderHash

Constant Summary collapse

KeyMap =

symbol -> string mapper + cache

Hash.new do |map, key|
  value = if key.respond_to?(:to_str)
    key
  else
    key.to_s.split('_').            # :user_agent => %w(user agent)
      each { |w| w.capitalize! }.   # => %w(User Agent)
      join('-')                     # => "User-Agent"
  end
  keymap_mutex.synchronize { map[key] = value }
end

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hash = nil) ⇒ Headers

Returns a new instance of Headers.


14
15
16
17
18
# File 'lib/faraday/utils.rb', line 14

def initialize(hash = nil)
  super()
  @names = {}
  self.update(hash || {})
end

Class Method Details

.from(value) ⇒ Object


10
11
12
# File 'lib/faraday/utils.rb', line 10

def self.from(value)
  new(value)
end

Instance Method Details

#[](k) ⇒ Object


36
37
38
39
# File 'lib/faraday/utils.rb', line 36

def [](k)
  k = KeyMap[k]
  super(k) || super(@names[k.downcase])
end

#[]=(k, v) ⇒ Object


41
42
43
44
45
46
47
# File 'lib/faraday/utils.rb', line 41

def []=(k, v)
  k = KeyMap[k]
  k = (@names[k.downcase] ||= k)  # join multiple values with a comma

  v = v.to_ary.join(', ') if v.respond_to? :to_ary
  super(k, v)
end

#delete(k) ⇒ Object


55
56
57
58
59
60
61
# File 'lib/faraday/utils.rb', line 55

def delete(k)
  k = KeyMap[k]
  if k = @names[k.downcase]
    @names.delete k.downcase
    super(k)
  end
end

#fetch(k, *args, &block) ⇒ Object


49
50
51
52
53
# File 'lib/faraday/utils.rb', line 49

def fetch(k, *args, &block)
  k = KeyMap[k]
  key = @names.fetch(k.downcase, k)
  super(key, *args, &block)
end

#include?(k) ⇒ Boolean Also known as: has_key?, member?, key?

Returns:

  • (Boolean)

63
64
65
# File 'lib/faraday/utils.rb', line 63

def include?(k)
  @names.include? k.downcase
end

#merge(other) ⇒ Object


77
78
79
80
# File 'lib/faraday/utils.rb', line 77

def merge(other)
  hash = dup
  hash.merge! other
end

#merge!(other) ⇒ Object Also known as: update


71
72
73
74
# File 'lib/faraday/utils.rb', line 71

def merge!(other)
  other.each { |k, v| self[k] = v }
  self
end

#parse(header_string) ⇒ Object


90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/faraday/utils.rb', line 90

def parse(header_string)
  return unless header_string && !header_string.empty?
  header_string.split(/\r\n/).
    tap  { |a| a.shift if a.first.index('HTTP/') == 0 }. # drop the HTTP status line
    map  { |h| h.split(/:\s+/, 2) }.reject { |p| p[0].nil? }. # split key and value, ignore blank lines
    each { |key, value|
      # join multiple values with a comma
      if self[key]
        self[key] << ', ' << value
      else
        self[key] = value
      end
    }
end

#replace(other) ⇒ Object


82
83
84
85
86
# File 'lib/faraday/utils.rb', line 82

def replace(other)
  clear
  self.update other
  self
end

#to_hashObject


88
# File 'lib/faraday/utils.rb', line 88

def to_hash() ::Hash.new.update(self) end