Class: Net::HTTPResponse
- Inherits:
-
Object
- Object
- Net::HTTPResponse
- Includes:
- HTTPHeader
- Defined in:
- lib/net/http.rb,
lib/net/http.rb
Overview
reopen
Direct Known Subclasses
HTTPClientError, HTTPInformation, HTTPRedirection, HTTPServerError, HTTPSuccess, HTTPUnknownResponse
Constant Summary collapse
- CODE_CLASS_TO_OBJ =
{ '1' => HTTPInformation, '2' => HTTPSuccess, '3' => HTTPRedirection, '4' => HTTPClientError, '5' => HTTPServerError }
- CODE_TO_OBJ =
{ '100' => HTTPContinue, '101' => HTTPSwitchProtocol, '200' => HTTPOK, '201' => HTTPCreated, '202' => HTTPAccepted, '203' => HTTPNonAuthoritativeInformation, '204' => HTTPNoContent, '205' => HTTPResetContent, '206' => HTTPPartialContent, '300' => HTTPMultipleChoice, '301' => HTTPMovedPermanently, '302' => HTTPFound, '303' => HTTPSeeOther, '304' => HTTPNotModified, '305' => HTTPUseProxy, '307' => HTTPTemporaryRedirect, '400' => HTTPBadRequest, '401' => HTTPUnauthorized, '402' => HTTPPaymentRequired, '403' => HTTPForbidden, '404' => HTTPNotFound, '405' => HTTPMethodNotAllowed, '406' => HTTPNotAcceptable, '407' => HTTPProxyAuthenticationRequired, '408' => HTTPRequestTimeOut, '409' => HTTPConflict, '410' => HTTPGone, '411' => HTTPLengthRequired, '412' => HTTPPreconditionFailed, '413' => HTTPRequestEntityTooLarge, '414' => HTTPRequestURITooLong, '415' => HTTPUnsupportedMediaType, '416' => HTTPRequestedRangeNotSatisfiable, '417' => HTTPExpectationFailed, '500' => HTTPInternalServerError, '501' => HTTPNotImplemented, '502' => HTTPBadGateway, '503' => HTTPServiceUnavailable, '504' => HTTPGatewayTimeOut, '505' => HTTPVersionNotSupported }
Instance Attribute Summary collapse
-
#code ⇒ Object
readonly
HTTP result code string.
-
#http_version ⇒ Object
readonly
The HTTP version supported by the server.
-
#message ⇒ Object
(also: #msg)
readonly
HTTP result message.
Class Method Summary collapse
-
.body_permitted? ⇒ Boolean
true if the response has body.
-
.exception_type ⇒ Object
:nodoc: internal use only.
-
.read_new(sock) ⇒ Object
:nodoc: internal use only.
Instance Method Summary collapse
-
#body ⇒ Object
(also: #entity)
Returns the entity body.
-
#code_type ⇒ Object
response <-> exception relationship.
-
#error! ⇒ Object
:nodoc:.
-
#error_type ⇒ Object
:nodoc:.
-
#header ⇒ Object
:nodoc:.
-
#initialize(httpv, code, msg) ⇒ HTTPResponse
constructor
:nodoc: internal use only.
- #inspect ⇒ Object
-
#read_body(dest = nil, &block) ⇒ Object
Gets entity body.
-
#read_header ⇒ Object
:nodoc:.
-
#reading_body(sock, reqmethodallowbody) ⇒ Object
body.
-
#response ⇒ Object
header (for backward compatibility only; DO NOT USE).
-
#to_ary ⇒ Object
For backward compatibility.
-
#value ⇒ Object
Raises HTTP error if the response is not 2xx.
Methods included from HTTPHeader
#[], #[]=, #add_field, #basic_auth, #chunked?, #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_data, #set_range, #size, #sub_type, #to_hash, #type_params
Constructor Details
#initialize(httpv, code, msg) ⇒ HTTPResponse
:nodoc: internal use only
2051 2052 2053 2054 2055 2056 2057 2058 |
# File 'lib/net/http.rb', line 2051 def initialize(httpv, code, msg) #:nodoc: internal use only @http_version = httpv @code = code @message = msg initialize_http_header nil @body = nil @read = false end |
Instance Attribute Details
#code ⇒ Object (readonly)
HTTP result code string. For example, '302'. You can also determine the response type by which response subclass the response object is an instance of.
2066 2067 2068 |
# File 'lib/net/http.rb', line 2066 def code @code end |
#http_version ⇒ Object (readonly)
The HTTP version supported by the server.
2061 2062 2063 |
# File 'lib/net/http.rb', line 2061 def http_version @http_version end |
#message ⇒ Object (readonly) Also known as: msg
HTTP result message. For example, 'Not Found'.
2069 2070 2071 |
# File 'lib/net/http.rb', line 2069 def @message end |
Class Method Details
.body_permitted? ⇒ Boolean
true if the response has body.
1786 1787 1788 |
# File 'lib/net/http.rb', line 1786 def HTTPResponse.body_permitted? self::HAS_BODY end |
.exception_type ⇒ Object
:nodoc: internal use only
1790 1791 1792 |
# File 'lib/net/http.rb', line 1790 def HTTPResponse.exception_type # :nodoc: internal use only self::EXCEPTION_TYPE end |
.read_new(sock) ⇒ Object
:nodoc: internal use only
2010 2011 2012 2013 2014 2015 2016 2017 |
# File 'lib/net/http.rb', line 2010 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 entity body.
Calling this method a second or subsequent time will return the already read string.
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
}
2199 2200 2201 |
# File 'lib/net/http.rb', line 2199 def body read_body() end |
#code_type ⇒ Object
response <-> exception relationship
2094 2095 2096 |
# File 'lib/net/http.rb', line 2094 def code_type #:nodoc: self.class end |
#error! ⇒ Object
:nodoc:
2098 2099 2100 |
# File 'lib/net/http.rb', line 2098 def error! #:nodoc: raise error_type().new(@code + ' ' + @message.dump, self) end |
#error_type ⇒ Object
:nodoc:
2102 2103 2104 |
# File 'lib/net/http.rb', line 2102 def error_type #:nodoc: self.class::EXCEPTION_TYPE end |
#header ⇒ Object
:nodoc:
2120 2121 2122 2123 |
# File 'lib/net/http.rb', line 2120 def header #:nodoc: warn "#{caller(1)[0]}: warning: HTTPResponse#header is obsolete" if $VERBOSE self end |
#inspect ⇒ Object
2072 2073 2074 |
# File 'lib/net/http.rb', line 2072 def inspect "#<#{self.class} #{@code} #{@message} readbody=#{@read}>" end |
#read_body(dest = nil, &block) ⇒ Object
Gets entity body. If the block given, yields it to block
. The body is provided in fragments, as it is read in from the socket.
Calling this method a second or subsequent time will return the already read string.
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
}
2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 |
# File 'lib/net/http.rb', line 2167 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 @body end |
#read_header ⇒ Object
:nodoc:
2125 2126 2127 2128 |
# File 'lib/net/http.rb', line 2125 def read_header #:nodoc: warn "#{caller(1)[0]}: warning: HTTPResponse#read_header is obsolete" if $VERBOSE self end |
#reading_body(sock, reqmethodallowbody) ⇒ Object
body
2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 |
# File 'lib/net/http.rb', line 2134 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)
2115 2116 2117 2118 |
# File 'lib/net/http.rb', line 2115 def response #:nodoc: warn "#{caller(1)[0]}: warning: HTTPResponse#response is obsolete" if $VERBOSE self end |
#to_ary ⇒ Object
For backward compatibility. To allow Net::HTTP 1.1 style assignment e.g.
response, body = Net::HTTP.get(....)
2081 2082 2083 2084 2085 2086 2087 2088 |
# File 'lib/net/http.rb', line 2081 def to_ary warn "net/http.rb: warning: Net::HTTP v1.1 style assignment found at #{caller(1)[0]}; use `response = http.get(...)' instead." if $VERBOSE res = self.dup class << res undef to_ary end [res, res.body] end |
#value ⇒ Object
Raises HTTP error if the response is not 2xx.
2107 2108 2109 |
# File 'lib/net/http.rb', line 2107 def value error! unless self.kind_of?(HTTPSuccess) end |