Class: Protocol::HTTP::Headers

Inherits:
Object
  • Object
show all
Defined in:
lib/protocol/http/headers.rb

Overview

Headers are an array of key-value pairs. Some header keys represent multiple values.

Defined Under Namespace

Classes: Merged

Constant Summary collapse

Split = 
Header::Split
Multiple = 
Header::Multiple
TRAILER = 
'trailer'
POLICY = 
{
	# Headers which may only be specified once.
	'content-type' => false,
	'content-disposition' => false,
	'content-length' => false,
	'user-agent' => false,
	'referer' => false,
	'host' => false,
	'if-modified-since' => false,
	'if-unmodified-since' => false,
	'from' => false,
	'location' => false,
	'max-forwards' => false,
	
	# Custom headers:
	'connection' => Header::Connection,
	'cache-control' => Header::CacheControl,
	'vary' => Header::Vary,
	
	# Headers specifically for proxies:
	'via' => Split,
	'x-forwarded-for' => Split,
	
	# Authorization headers:
	'authorization' => Header::Authorization,
	'proxy-authorization' => Header::Authorization,
	
	# Cache validations:
	'etag' => Header::ETag,
	'if-match' => Header::ETags,
	'if-none-match' => Header::ETags,
	
	# Headers which may be specified multiple times, but which can't be concatenated:
	'www-authenticate' => Multiple,
	'proxy-authenticate' => Multiple,
	
	# Custom headers:
	'set-cookie' => Header::SetCookie,
	'cookie' => Header::Cookie,
}.tap{|hash| hash.default = Split}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(fields = [], indexed = nil) ⇒ Headers

Returns a new instance of Headers.



66
67
68
69
70
71
72
 
# File 'lib/protocol/http/headers.rb', line 66

def initialize(fields = [], indexed = nil)
	@fields = fields
	@indexed = indexed
	
	# Marks where trailer start in the @fields array.
	@tail = nil
end

Instance Attribute Details

#fields ⇒ Object (readonly)

An array of ‘[key, value]` pairs.



102
103
104
 
# File 'lib/protocol/http/headers.rb', line 102

def fields
  @fields
end

Class Method Details

.[](headers) ⇒ Headers

Construct an instance from a headers Array or Hash. No-op if already an instance of ‘Headers`. If the underlying array is frozen, it will be duped.

Returns:

  • (Headers) —

    an instance of headers.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/protocol/http/headers.rb', line 44

def self.[] headers
	if headers.nil?
		return self.new
	end
	
	if headers.is_a?(self)
		if headers.frozen?
			return headers.dup
		else
			return headers
		end
	end
	
	fields = headers.to_a
	
	if fields.frozen?
		fields = fields.dup
	end
	
	return self.new(fields)
end

Instance Method Details

#==(other) ⇒ Object 



307
308
309
310
311
312
313
314
315
316
 
# File 'lib/protocol/http/headers.rb', line 307

def == other
	case other
	when Hash
		to_h == other
	when Headers
		@fields == other.fields
	else
		@fields == other
	end
end

#[](key) ⇒ Object 



290
291
292
 
# File 'lib/protocol/http/headers.rb', line 290

def [] key
	to_h[key]
end

#[]=(key, value) ⇒ Object

Append the value to the given key. Some values can be appended multiple times, others can only be set once.

Parameters:

  • key (String) —

    The header key.

  • value —

    The header value.



203
204
205
206
207
208
209
 
# File 'lib/protocol/http/headers.rb', line 203

def []= key, value
	if @indexed
		merge_into(@indexed, key.downcase, value)
	end
	
	@fields << [key, value]
end

#add(key, value) ⇒ Object

Add the specified header key value pair.

Parameters:

  • key (String) —

    the header key.

  • value (String) —

    the header value to assign.



175
176
177
 
# File 'lib/protocol/http/headers.rb', line 175

def add(key, value)
	self[key] = value
end

#clear ⇒ Object 



81
82
83
84
85
 
# File 'lib/protocol/http/headers.rb', line 81

def clear
	@fields.clear
	@indexed = nil
	@tail = nil
end

#delete(key) ⇒ Object

Delete all headers with the given key, and return the merged value.



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/protocol/http/headers.rb', line 253

def delete(key)
	deleted, @fields = @fields.partition do |field|
		field.first.downcase == key
	end
	
	if deleted.empty?
		return nil
	end
	
	if @indexed
		return @indexed.delete(key)
	elsif policy = POLICY[key]
		(key, value), *tail = deleted
		merged = policy.new(value)
		
		tail.each{|k,v| merged << v}
		
		return merged
	else
		key, value = deleted.last
		return value
	end
end

#each(&block) ⇒ Object 



145
146
147
 
# File 'lib/protocol/http/headers.rb', line 145

def each(&block)
	@fields.each(&block)
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


141
142
143
 
# File 'lib/protocol/http/headers.rb', line 141

def empty?
	@fields.empty?
end

#extract(keys) ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/protocol/http/headers.rb', line 157

def extract(keys)
	deleted, @fields = @fields.partition do |field|
		keys.include?(field.first.downcase)
	end
	
	if @indexed
		keys.each do |key|
			@indexed.delete(key)
		end
	end
	
	return deleted
end

#flatten ⇒ Object 



97
98
99
 
# File 'lib/protocol/http/headers.rb', line 97

def flatten
	self.dup.flatten!
end

#flatten! ⇒ Object

Flatten trailer into the headers.



88
89
90
91
92
93
94
95
 
# File 'lib/protocol/http/headers.rb', line 88

def flatten!
	if @tail
		self.delete(TRAILER)
		@tail = nil
	end
	
	return self
end

#freeze ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/protocol/http/headers.rb', line 129

def freeze
	return if frozen?
	
	# Ensure @indexed is generated:
	self.to_h
	
	@fields.freeze
	@indexed.freeze
	
	super
end

#include?(key) ⇒ Boolean

Returns:

  • (Boolean) 


149
150
151
 
# File 'lib/protocol/http/headers.rb', line 149

def include? key
	self[key] != nil
end

#initialize_dup(other) ⇒ Object 



74
75
76
77
78
79
 
# File 'lib/protocol/http/headers.rb', line 74

def initialize_dup(other)
	super
	
	@fields = @fields.dup
	@indexed = @indexed.dup
end

#inspect ⇒ Object 



303
304
305
 
# File 'lib/protocol/http/headers.rb', line 303

def inspect
	"#<#{self.class} #{@fields.inspect}>"
end

#keys ⇒ Object 



153
154
155
 
# File 'lib/protocol/http/headers.rb', line 153

def keys
	self.to_h.keys
end

#merge(headers) ⇒ Object 



196
197
198
 
# File 'lib/protocol/http/headers.rb', line 196

def merge(headers)
	self.dup.merge!(headers)
end

#merge!(headers) ⇒ Object 



188
189
190
191
192
193
194
 
# File 'lib/protocol/http/headers.rb', line 188

def merge!(headers)
	headers.each do |key, value|
		self[key] = value
	end
	
	return self
end

#set(key, value) ⇒ Object

Set the specified header key to the specified value, replacing any existing header keys with the same name.

Parameters:

  • key (String) —

    the header key to replace.

  • value (String) —

    the header value to assign.



182
183
184
185
186
 
# File 'lib/protocol/http/headers.rb', line 182

def set(key, value)
	# TODO This could be a bit more efficient:
	self.delete(key)
	self.add(key, value)
end

#to_h ⇒ Object

A hash table of ‘policy.map(values)`



295
296
297
298
299
300
301
 
# File 'lib/protocol/http/headers.rb', line 295

def to_h
	@indexed ||= @fields.inject({}) do |hash, (key, value)|
		merge_into(hash, key.downcase, value)
		
		hash
	end
end

#trailer(&block) ⇒ Object

Enumerate all headers in the trailer, if there are any.



121
122
123
124
125
126
127
 
# File 'lib/protocol/http/headers.rb', line 121

def trailer(&block)
	return to_enum(:trailer) unless block_given?
	
	if @tail
		@fields.drop(@tail).each(&block)
	end
end

#trailer!(&block) ⇒ Object

Record the current headers, and prepare to receive trailer.



110
111
112
113
114
115
116
117
118
 
# File 'lib/protocol/http/headers.rb', line 110

def trailer!(&block)
	@tail ||= @fields.size
	
	return to_enum(:trailer) unless block_given?
	
	if @tail
		@fields.drop(@tail).each(&block)
	end
end

#trailer? ⇒ Boolean

Returns the trailer if there are any.

Returns:

  • (Boolean) —

    the trailer if there are any.



105
106
107
 
# File 'lib/protocol/http/headers.rb', line 105

def trailer?
	@tail != nil
end