HTTP response class.

This class wraps together the response header and the response body (the entity requested).

It mixes in the HTTPHeader module, which provides access to response header values both via hash-like methods and via individual readers.

Note that each possible HTTP response code defines its own HTTPResponse subclass. All classes are defined under the Net module. Indentation indicates inheritance. For a list of the classes see Net::HTTP.

Correspondence HTTP code => class is stored in CODE_TO_OBJ constant:

Net::HTTPResponse::CODE_TO_OBJ['404'] #=> Net::HTTPNotFound
Constants
No documentation available
No documentation available
Attributes
Read

The HTTP result code string. For example, ‘302’. You can also determine the response type by examining which response subclass the response object is an instance of.

Read & Write

Set to true automatically when the request did not contain an Accept-Encoding header from the user.

The HTTP version supported by the server.

The HTTP result message sent by the server. For example, ‘Not Found’.

Read

The HTTP result message sent by the server. For example, ‘Not Found’.

Read

The URI used to fetch this response. The response URI is only available if a URI was used to create the request.

Class Methods

true if the response has a body.

No documentation available
No documentation available
No documentation available
Instance Methods

Returns the full entity body.

Calling this method a second or subsequent time will return the string already read.

http.request_get('/index.html') {|res|
  puts res.body
}

http.request_get('/index.html') {|res|
  p res.body.object_id   # 538149362
  p res.body.object_id   # 538149362
}

Because it may be necessary to modify the body, Eg, decompression this method facilitates that.

An alias for body
No documentation available
No documentation available

Gets the entity body returned by the remote HTTP server.

If a block is given, the body is passed to the block, and the body is provided in fragments, as it is read in from the socket.

If dest argument is given, response is read into that variable, with dest#<< method (it could be String or IO, or any other object responding to <<).

Calling this method a second or subsequent time for the same HTTPResponse object will return the value already read.

http.request_get('/index.html') {|res|
  puts res.read_body
}

http.request_get('/index.html') {|res|
  p res.read_body.object_id   # 538149362
  p res.read_body.object_id   # 538149362
}

# using iterator
http.request_get('/index.html') {|res|
  res.read_body do |segment|
    print segment
  end
}
No documentation available
No documentation available

Raises an HTTP error if the response is not 2xx (success).