Class: Net::HTTPResponse

Inherits:

Object

• Object
• Net::HTTPResponse

show all

Includes:

HTTPHeader

Defined in:

lib/net/http.rb,
lib/net/http.rb

Overview

Constant Summary

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)

• - (Object) code readonly

  HTTP result code string.

• - (Object) http_version readonly

  The HTTP version supported by the server.

• - (Object) message (also: #msg) readonly

  HTTP result message.

Class Method Summary (collapse)

• + (Boolean) body_permitted?

  true if the response has body.

• + (Object) exception_type

  :nodoc: internal use only.

• + (Object) read_new(sock)

  :nodoc: internal use only.

Instance Method Summary (collapse)

• - (Object) body (also: #entity)

  Returns the entity body.

• - (Object) body=(value)

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

• - (Object) code_type

  response exception relationship.

• - (Object) error!

  :nodoc:.

• - (Object) error_type

  :nodoc:.

• - (Object) header

  :nodoc:.

• - (HTTPResponse) initialize(httpv, code, msg) constructor

  :nodoc: internal use only.

• - (Object) inspect
• - (Object) read_body(dest = nil, &block)

  Gets entity body.

• - (Object) read_header

  :nodoc:.

• - (Object) reading_body(sock, reqmethodallowbody)

  body.

• - (Object) response

  header (for backward compatibility only; DO NOT USE).

• - (Object) to_ary

  For backward compatibility.

• - (Object) value

  Raises HTTP error if the response is not 2xx.

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_data, #set_range, #size, #sub_type, #to_hash, #type_params

2249
2250
2251
2252
2253
2254
2255
2256

# File 'lib/net/http.rb', line 2249

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

2264
2265
2266

# File 'lib/net/http.rb', line 2264

def code
  @code
end

2259
2260
2261

# File 'lib/net/http.rb', line 2259

def http_version
  @http_version
end

2267
2268
2269

# File 'lib/net/http.rb', line 2267

def message
  @message
end

1977
1978
1979

# File 'lib/net/http.rb', line 1977

def HTTPResponse.body_permitted?
  self::HAS_BODY
end

1981
1982
1983

# File 'lib/net/http.rb', line 1981

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

2201
2202
2203
2204
2205
2206
2207
2208

# File 'lib/net/http.rb', line 2201

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

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
}

2397
2398
2399

# File 'lib/net/http.rb', line 2397

def body
  read_body()
end

2403
2404
2405

# File 'lib/net/http.rb', line 2403

def body=(value)
  @body = value
end

2292
2293
2294

# File 'lib/net/http.rb', line 2292

def code_type   #:nodoc:
  self.class
end

2296
2297
2298

# File 'lib/net/http.rb', line 2296

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

2300
2301
2302

# File 'lib/net/http.rb', line 2300

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

2318
2319
2320
2321

# File 'lib/net/http.rb', line 2318

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

2270
2271
2272

# File 'lib/net/http.rb', line 2270

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

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
}

2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381

# File 'lib/net/http.rb', line 2365

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

2323
2324
2325
2326

# File 'lib/net/http.rb', line 2323

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

2332
2333
2334
2335
2336
2337
2338
2339
2340
2341

# File 'lib/net/http.rb', line 2332

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

2313
2314
2315
2316

# File 'lib/net/http.rb', line 2313

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

response, body = Net::HTTP.get(....)

2279
2280
2281
2282
2283
2284
2285
2286

# File 'lib/net/http.rb', line 2279

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

2305
2306
2307

# File 'lib/net/http.rb', line 2305

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