Class: HTTP::Message::Headers

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

Overview

Represents HTTP message header.

Constant Summary collapse

STATUS_CODE_MAP =

HTTP response status code to reason phrase mapping definition.

{
  Status::OK => 'OK',
  Status::CREATED => "Created",
  Status::NON_AUTHORITATIVE_INFORMATION => "Non-Authoritative Information",
  Status::NO_CONTENT => "No Content",
  Status::RESET_CONTENT => "Reset Content",
  Status::PARTIAL_CONTENT => "Partial Content",
  Status::MOVED_PERMANENTLY => 'Moved Permanently',
  Status::FOUND => 'Found',
  Status::SEE_OTHER => 'See Other',
  Status::TEMPORARY_REDIRECT => 'Temporary Redirect',
  Status::MOVED_TEMPORARILY => 'Temporary Redirect',
  Status::BAD_REQUEST => 'Bad Request',
  Status::INTERNAL => 'Internal Server Error',
}
CHARSET_MAP =

$KCODE to charset mapping definition.

{
  'NONE' => 'us-ascii',
  'EUC'  => 'euc-jp',
  'SJIS' => 'shift_jis',
  'UTF8' => 'utf-8',
}
NIL_URI =

Placeholder URI object for nil uri.

URI.parse('http://nil-uri-given/')

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeHeaders

Creates a Message::Headers. Use init_request, init_response, or init_connect_request for acutual initialize.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# File 'lib/httpclient/http.rb', line 156

def initialize
  @http_version = '1.1'
  @body_size = nil
  @chunked = false

  @request_method = nil
  @request_uri = nil
  @request_query = nil
  @request_absolute_uri = nil

  @status_code = nil
  @reason_phrase = nil

  @body_type = nil
  @body_charset = nil
  @body_date = nil
  @body_encoding = nil

  @is_request = nil
  @header_item = []
  @dumped = false
end

Instance Attribute Details

#body_charsetObject

Used for dumping response.



123
124
125
# File 'lib/httpclient/http.rb', line 123

def body_charset
  @body_charset
end

#body_dateObject

Used for dumping response.



125
126
127
# File 'lib/httpclient/http.rb', line 125

def body_date
  @body_date
end

#body_encodingObject (readonly)

Used for keeping content encoding.



127
128
129
# File 'lib/httpclient/http.rb', line 127

def body_encoding
  @body_encoding
end

#body_sizeObject

Size of body. nil when size is unknown (e.g. chunked response).



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

def body_size
  @body_size
end

#body_typeObject

Used for dumping response.



121
122
123
# File 'lib/httpclient/http.rb', line 121

def body_type
  @body_type
end

#chunkedObject

Request/Response is chunked or not.



104
105
106
# File 'lib/httpclient/http.rb', line 104

def chunked
  @chunked
end

#http_versionObject

HTTP version in a HTTP header. String.



100
101
102
# File 'lib/httpclient/http.rb', line 100

def http_version
  @http_version
end

#reason_phraseObject

Response only. HTTP status reason phrase.



118
119
120
# File 'lib/httpclient/http.rb', line 118

def reason_phrase
  @reason_phrase
end

#request_absolute_uriObject

Request only. Requested via proxy or not.



113
114
115
# File 'lib/httpclient/http.rb', line 113

def request_absolute_uri
  @request_absolute_uri
end

#request_methodObject (readonly)

Request only. Requested method.



107
108
109
# File 'lib/httpclient/http.rb', line 107

def request_method
  @request_method
end

#request_queryObject

Request only. Requested query.



111
112
113
# File 'lib/httpclient/http.rb', line 111

def request_query
  @request_query
end

#request_uriObject

Request only. Requested URI.



109
110
111
# File 'lib/httpclient/http.rb', line 109

def request_uri
  @request_uri
end

#status_codeObject

Response only. HTTP status



116
117
118
# File 'lib/httpclient/http.rb', line 116

def status_code
  @status_code
end

Instance Method Details

#[](key) ⇒ Object

Returns an Array of header values for the given key.



305
306
307
# File 'lib/httpclient/http.rb', line 305

def [](key)
  get(key).collect { |item| item[1] }
end

#[]=(key, value) ⇒ Object

Adds a header. See set.



300
301
302
# File 'lib/httpclient/http.rb', line 300

def []=(key, value)
  set(key, value)
end

#add(key, value) ⇒ Object

Adds a header. Addition order is preserved.



260
261
262
263
264
265
266
267
268
# File 'lib/httpclient/http.rb', line 260

def add(key, value)
  if value.is_a?(Array)
    value.each do |v|
      @header_item.push([key, v])
    end
  else
    @header_item.push([key, value])
  end
end

#allObject

Returns an Array of all headers.



289
290
291
# File 'lib/httpclient/http.rb', line 289

def all
  @header_item
end

#content_typeObject Also known as: contenttype

Returns ‘Content-Type’ header value.



212
213
214
# File 'lib/httpclient/http.rb', line 212

def content_type
  self['Content-Type'][0]
end

#content_type=(content_type) ⇒ Object Also known as: contenttype=

Sets ‘Content-Type’ header value. Overrides if already exists.



217
218
219
220
# File 'lib/httpclient/http.rb', line 217

def content_type=(content_type)
  delete('Content-Type')
  self['Content-Type'] = content_type
end

#create_query_partObject



328
329
330
331
332
333
334
335
336
337
338
339
340
341
# File 'lib/httpclient/http.rb', line 328

def create_query_part()
  query_str = nil
  if @request_uri.query
    query_str = @request_uri.query
  end
  if @request_query
    if query_str
      query_str += "&#{Message.create_query_part_str(@request_query)}"
    else
      query_str = Message.create_query_part_str(@request_query)
    end
  end
  query_str
end

#create_query_uriObject



316
317
318
319
320
321
322
323
324
325
326
# File 'lib/httpclient/http.rb', line 316

def create_query_uri()
  if @request_method == 'CONNECT'
    return "#{@request_uri.host}:#{@request_uri.port}"
  end
  path = @request_uri.path
  path = '/' if path.nil? or path.empty?
  if query_str = create_query_part()
    path += "?#{query_str}"
  end
  path
end

#delete(key) ⇒ Object

Deletes headers of the given key.



294
295
296
297
# File 'lib/httpclient/http.rb', line 294

def delete(key)
  key = key.upcase
  @header_item.delete_if { |k, v| k.upcase == key }
end

#dumpObject

Dumps message header part and returns a dumped String.



246
247
248
249
250
251
252
253
254
255
256
257
# File 'lib/httpclient/http.rb', line 246

def dump
  set_header
  str = nil
  if @is_request
    str = request_line
  else
    str = response_status_line
  end
  str + @header_item.collect { |key, value|
    "#{ key }: #{ value }#{ CRLF }"
  }.join
end

#get(key = nil) ⇒ Object

Returns an Array of headers for the given key. Each element is a pair of key and value. It returns an single element Array even if the only one header exists. If nil key given, it returns all headers.



279
280
281
282
283
284
285
286
# File 'lib/httpclient/http.rb', line 279

def get(key = nil)
  if key.nil?
    all
  else
    key = key.upcase
    @header_item.find_all { |k, v| k.upcase == key }
  end
end

#init_connect_request(uri) ⇒ Object

Initialize this instance as a CONNECT request.



180
181
182
183
184
185
186
# File 'lib/httpclient/http.rb', line 180

def init_connect_request(uri)
  @is_request = true
  @request_method = 'CONNECT'
  @request_uri = uri
  @request_query = nil
  @http_version = '1.0'
end

#init_request(method, uri, query = nil) ⇒ Object

Initialize this instance as a general request.



191
192
193
194
195
196
197
# File 'lib/httpclient/http.rb', line 191

def init_request(method, uri, query = nil)
  @is_request = true
  @request_method = method
  @request_uri = uri || NIL_URI
  @request_query = query
  @request_absolute_uri = false
end

#init_response(status_code) ⇒ Object

Initialize this instance as a response.



200
201
202
203
# File 'lib/httpclient/http.rb', line 200

def init_response(status_code)
  @is_request = false
  self.status_code = status_code
end

#set(key, value) ⇒ Object

Sets a header.



271
272
273
274
# File 'lib/httpclient/http.rb', line 271

def set(key, value)
  delete(key)
  add(key, value)
end

#set_body_encodingObject



226
227
228
229
230
231
232
# File 'lib/httpclient/http.rb', line 226

def set_body_encoding
  if type = self.content_type
    OpenURI::Meta.init(o = '')
    o.meta_add_field('content-type', type)
    @body_encoding = o.encoding
  end
end

#set_headers(headers) ⇒ Object



309
310
311
312
313
314
# File 'lib/httpclient/http.rb', line 309

def set_headers(headers)
  headers.each do |key, value|
    add(key, value)
  end
  set_body_encoding
end