Class: Net::HTTPResponse

Inherits:
Object
  • Object
show all
Includes:
HTTPHeader
Defined in:
lib/net/http/response.rb,
lib/net/http/responses.rb

Overview

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

Defined Under Namespace

Classes: Inflater

Constant Summary collapse

CODE_CLASS_TO_OBJ = 
{
  '1' => Net::HTTPInformation,
  '2' => Net::HTTPSuccess,
  '3' => Net::HTTPRedirection,
  '4' => Net::HTTPClientError,
  '5' => Net::HTTPServerError
}
CODE_TO_OBJ = 
{
  '100' => Net::HTTPContinue,
  '101' => Net::HTTPSwitchProtocol,
  '102' => Net::HTTPProcessing,
  '103' => Net::HTTPEarlyHints,

  '200' => Net::HTTPOK,
  '201' => Net::HTTPCreated,
  '202' => Net::HTTPAccepted,
  '203' => Net::HTTPNonAuthoritativeInformation,
  '204' => Net::HTTPNoContent,
  '205' => Net::HTTPResetContent,
  '206' => Net::HTTPPartialContent,
  '207' => Net::HTTPMultiStatus,
  '208' => Net::HTTPAlreadyReported,
  '226' => Net::HTTPIMUsed,

  '300' => Net::HTTPMultipleChoices,
  '301' => Net::HTTPMovedPermanently,
  '302' => Net::HTTPFound,
  '303' => Net::HTTPSeeOther,
  '304' => Net::HTTPNotModified,
  '305' => Net::HTTPUseProxy,
  '307' => Net::HTTPTemporaryRedirect,
  '308' => Net::HTTPPermanentRedirect,

  '400' => Net::HTTPBadRequest,
  '401' => Net::HTTPUnauthorized,
  '402' => Net::HTTPPaymentRequired,
  '403' => Net::HTTPForbidden,
  '404' => Net::HTTPNotFound,
  '405' => Net::HTTPMethodNotAllowed,
  '406' => Net::HTTPNotAcceptable,
  '407' => Net::HTTPProxyAuthenticationRequired,
  '408' => Net::HTTPRequestTimeout,
  '409' => Net::HTTPConflict,
  '410' => Net::HTTPGone,
  '411' => Net::HTTPLengthRequired,
  '412' => Net::HTTPPreconditionFailed,
  '413' => Net::HTTPPayloadTooLarge,
  '414' => Net::HTTPURITooLong,
  '415' => Net::HTTPUnsupportedMediaType,
  '416' => Net::HTTPRangeNotSatisfiable,
  '417' => Net::HTTPExpectationFailed,
  '421' => Net::HTTPMisdirectedRequest,
  '422' => Net::HTTPUnprocessableEntity,
  '423' => Net::HTTPLocked,
  '424' => Net::HTTPFailedDependency,
  '426' => Net::HTTPUpgradeRequired,
  '428' => Net::HTTPPreconditionRequired,
  '429' => Net::HTTPTooManyRequests,
  '431' => Net::HTTPRequestHeaderFieldsTooLarge,
  '451' => Net::HTTPUnavailableForLegalReasons,

  '500' => Net::HTTPInternalServerError,
  '501' => Net::HTTPNotImplemented,
  '502' => Net::HTTPBadGateway,
  '503' => Net::HTTPServiceUnavailable,
  '504' => Net::HTTPGatewayTimeout,
  '505' => Net::HTTPVersionNotSupported,
  '506' => Net::HTTPVariantAlsoNegotiates,
  '507' => Net::HTTPInsufficientStorage,
  '508' => Net::HTTPLoopDetected,
  '510' => Net::HTTPNotExtended,
  '511' => Net::HTTPNetworkAuthenticationRequired,
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from HTTPHeader

#[], #[]=, #add_field, #basic_auth, #chunked?, #connection_close?, #connection_keep_alive?, #content_length, #content_length=, #content_range, #content_type, #delete, #each_capitalized, #each_capitalized_name, #each_header, #each_name, #each_value, #fetch, #get_fields, #initialize_http_header, #key?, #main_type, #proxy_basic_auth, #range, #range_length, #set_content_type, #set_form, #set_form_data, #set_range, #size, #sub_type, #to_hash, #type_params

Constructor Details

#initialize(httpv, code, msg) ⇒ HTTPResponse

:nodoc: internal use only



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/net/http/response.rb', line 78

def initialize(httpv, code, msg)   #:nodoc: internal use only
  @http_version = httpv
  @code         = code
  @message      = msg
  initialize_http_header nil
  @body = nil
  @read = false
  @uri  = nil
  @decode_content = false
  @body_encoding = false
  @ignore_eof = true
end

Instance Attribute Details

#body_encoding ⇒ Object

The encoding to use for the response body. If Encoding, use that encoding. If other true value, attempt to detect the appropriate encoding, and use that.



114
115
116
 
# File 'lib/net/http/response.rb', line 114

def body_encoding
  @body_encoding
end

#code ⇒ Object (readonly)

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.



97
98
99
 
# File 'lib/net/http/response.rb', line 97

def code
  @code
end

#decode_content ⇒ Object

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



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

def decode_content
  @decode_content
end

#http_version ⇒ Object (readonly)

The HTTP version supported by the server.



92
93
94
 
# File 'lib/net/http/response.rb', line 92

def http_version
  @http_version
end

#ignore_eof ⇒ Object

Whether to ignore EOF when reading bodies with a specified Content-Length header.



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

def ignore_eof
  @ignore_eof
end

#message ⇒ Object (readonly) Also known as: msg

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



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

def message
  @message
end

#uri ⇒ Object

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



105
106
107
 
# File 'lib/net/http/response.rb', line 105

def uri
  @uri
end

Class Method Details

.body_permitted? ⇒ Boolean

true if the response has a body.

Returns:

  • (Boolean) 


22
23
24
 
# File 'lib/net/http/response.rb', line 22

def body_permitted?
  self::HAS_BODY
end

.exception_type ⇒ Object

:nodoc: internal use only



26
27
28
 
# File 'lib/net/http/response.rb', line 26

def exception_type   # :nodoc: internal use only
  self::EXCEPTION_TYPE
end

.read_new(sock) ⇒ Object

:nodoc: internal use only



30
31
32
33
34
35
36
37
 
# File 'lib/net/http/response.rb', line 30

def read_new(sock)   #:nodoc: internal use only
  httpv, code, msg = read_status_line(sock)
  res = response_class(code).new(httpv, code, msg)
  each_response_header(sock) do |k,v|
    res.add_field k, v
  end
  res
end

Instance Method Details

#body ⇒ Object Also known as: entity

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
}



263
264
265
 
# File 'lib/net/http/response.rb', line 263

def body
  read_body()
end

#body=(value) ⇒ Object

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



269
270
271
 
# File 'lib/net/http/response.rb', line 269

def body=(value)
  @body = value
end

#code_type ⇒ Object

response <-> exception relationship



135
136
137
 
# File 'lib/net/http/response.rb', line 135

def code_type   #:nodoc:
  self.class
end

#error! ⇒ Object

:nodoc:

Raises:



139
140
141
142
143
 
# File 'lib/net/http/response.rb', line 139

def error!   #:nodoc:
  message = @code
  message += ' ' + @message.dump if @message
  raise error_type().new(message, self)
end

#error_type ⇒ Object

:nodoc:



145
146
147
 
# File 'lib/net/http/response.rb', line 145

def error_type   #:nodoc:
  self.class::EXCEPTION_TYPE
end

#header ⇒ Object

:nodoc:



167
168
169
170
 
# File 'lib/net/http/response.rb', line 167

def header   #:nodoc:
  warn "Net::HTTPResponse#header is obsolete", uplevel: 1 if $VERBOSE
  self
end

#inspect ⇒ Object 



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

def inspect
  "#<#{self.class} #{@code} #{@message} readbody=#{@read}>"
end

#read_body(dest = nil, &block) ⇒ Object

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
}



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/net/http/response.rb', line 220

def read_body(dest = nil, &block)
  if @read
    raise IOError, "#{self.class}\#read_body called twice" if dest or block
    return @body
  end
  to = procdest(dest, block)
  stream_check
  if @body_exist
    read_body_0 to
    @body = to
  else
    @body = nil
  end
  @read = true

  case enc = @body_encoding
  when Encoding, false, nil
    # Encoding: force given encoding
    # false/nil: do not force encoding
  else
    # other value: detect encoding from body
    enc = detect_encoding(@body)
  end

  @body.force_encoding(enc) if enc

  @body
end

#read_header ⇒ Object

:nodoc:



172
173
174
175
 
# File 'lib/net/http/response.rb', line 172

def read_header   #:nodoc:
  warn "Net::HTTPResponse#read_header is obsolete", uplevel: 1 if $VERBOSE
  self
end

#reading_body(sock, reqmethodallowbody) ⇒ Object

body



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/net/http/response.rb', line 181

def reading_body(sock, reqmethodallowbody)  #:nodoc: internal use only
  @socket = sock
  @body_exist = reqmethodallowbody && self.class.body_permitted?
  begin
    yield
    self.body   # ensure to read body
  ensure
    @socket = nil
  end
end

#response ⇒ Object

header (for backward compatibility only; DO NOT USE)



162
163
164
165
 
# File 'lib/net/http/response.rb', line 162

def response   #:nodoc:
  warn "Net::HTTPResponse#response is obsolete", uplevel: 1 if $VERBOSE
  self
end

#value ⇒ Object

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



150
151
152
 
# File 'lib/net/http/response.rb', line 150

def value
  error! unless self.kind_of?(Net::HTTPSuccess)
end