Class: Net::HTTPResponse

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

Overview

reopen

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

Class Method Summary collapse

Instance Method Summary collapse

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



2057
2058
2059
2060
2061
2062
2063
2064
 
# File 'lib/net/http.rb', line 2057

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.



2072
2073
2074
 
# File 'lib/net/http.rb', line 2072

def code
  @code
end

#http_version ⇒ Object (readonly)

The HTTP version supported by the server.



2067
2068
2069
 
# File 'lib/net/http.rb', line 2067

def http_version
  @http_version
end

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

HTTP result message. For example, 'Not Found'.



2075
2076
2077
 
# File 'lib/net/http.rb', line 2075

def message
  @message
end

Class Method Details

.body_permitted? ⇒ Boolean

true if the response has body.

Returns:

  • (Boolean) 


1792
1793
1794
 
# File 'lib/net/http.rb', line 1792

def HTTPResponse.body_permitted?
  self::HAS_BODY
end

.exception_type ⇒ Object

:nodoc: internal use only



1796
1797
1798
 
# File 'lib/net/http.rb', line 1796

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

.read_new(sock) ⇒ Object

:nodoc: internal use only



2016
2017
2018
2019
2020
2021
2022
2023
 
# File 'lib/net/http.rb', line 2016

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
}



2205
2206
2207
 
# File 'lib/net/http.rb', line 2205

def body
  read_body()
end

#code_type ⇒ Object

response <-> exception relationship



2100
2101
2102
 
# File 'lib/net/http.rb', line 2100

def code_type   #:nodoc:
  self.class
end

#error! ⇒ Object

:nodoc:

Raises:



2104
2105
2106
 
# File 'lib/net/http.rb', line 2104

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

#error_type ⇒ Object

:nodoc:



2108
2109
2110
 
# File 'lib/net/http.rb', line 2108

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

#header ⇒ Object

:nodoc:



2126
2127
2128
2129
 
# File 'lib/net/http.rb', line 2126

def header   #:nodoc:
  warn "#{caller(1)[0]}: warning: HTTPResponse#header is obsolete" if $VERBOSE
  self
end

#inspect ⇒ Object 



2078
2079
2080
 
# File 'lib/net/http.rb', line 2078

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
}



2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/net/http.rb', line 2173

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:



2131
2132
2133
2134
 
# File 'lib/net/http.rb', line 2131

def read_header   #:nodoc:
  warn "#{caller(1)[0]}: warning: HTTPResponse#read_header is obsolete" if $VERBOSE
  self
end

#reading_body(sock, reqmethodallowbody) ⇒ Object

body



2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
 
# File 'lib/net/http.rb', line 2140

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)



2121
2122
2123
2124
 
# File 'lib/net/http.rb', line 2121

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(....)



2087
2088
2089
2090
2091
2092
2093
2094
 
# File 'lib/net/http.rb', line 2087

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.



2113
2114
2115
 
# File 'lib/net/http.rb', line 2113

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