Class: HTTP::Response

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Headers::Mixin
Defined in:
lib/http/response.rb,
lib/http/response/body.rb,
lib/http/response/parser.rb,
lib/http/response/status.rb,
lib/http/response/status/reasons.rb

Defined Under Namespace

Classes: Body, Parser, Status

Constant Summary collapse

STATUS_CODES =
Deprecated.

Will be removed in 1.0.0 Use Status::REASONS

Status::REASONS
SYMBOL_TO_STATUS_CODE =
Deprecated.

Will be removed in 1.0.0

Hash[STATUS_CODES.map { |k, v| [v.downcase.gsub(/\s|-/, '_').to_sym, k] }].freeze

Instance Attribute Summary collapse

Attributes included from Headers::Mixin

#headers

Instance Method Summary collapse

Methods included from Headers::Mixin

#[], #[]=

Constructor Details

#initialize(status, version, headers, body, uri = nil) ⇒ Response

rubocop:disable ParameterLists



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

def initialize(status, version, headers, body, uri = nil) # rubocop:disable ParameterLists
  @version, @body, @uri = version, body, uri

  @status  = HTTP::Response::Status.new status
  @headers = HTTP::Headers.coerce(headers || {})
end

Instance Attribute Details

#body ⇒ Body (readonly)

Returns:



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

def body
  @body
end

#status ⇒ Status (readonly)

Returns:



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

def status
  @status
end

#uri ⇒ URI? (readonly)

Returns:

  • (URI, nil) 


28
29
30
 
# File 'lib/http/response.rb', line 28

def uri
  @uri
end

Instance Method Details

#charset ⇒ String?

Charset of response (if any)

Returns:

  • (String, nil) 


89
90
91
 
# File 'lib/http/response.rb', line 89

def charset
  @charset ||= content_type.charset
end

#code ⇒ Fixnum Also known as: status_code

Returns status code.

Returns:

  • (Fixnum) —

    status code



43
 
# File 'lib/http/response.rb', line 43

def_delegator :status, :code

#content_type ⇒ HTTP::ContentType

Parsed Content-Type header

Returns:



75
76
77
 
# File 'lib/http/response.rb', line 75

def content_type
  @content_type ||= ContentType.parse headers['Content-Type']
end

#flush ⇒ Response

Flushes body and returns self-reference

Returns:



67
68
69
70
 
# File 'lib/http/response.rb', line 67

def flush
  body.to_s
  self
end

#inspect ⇒ Object

Inspect a response



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

def inspect
  "#<#{self.class}/#{@version} #{code} #{reason} #{headers.inspect}>"
end

#mime_type ⇒ String?

MIME type of response (if any)

Returns:

  • (String, nil) 


82
83
84
 
# File 'lib/http/response.rb', line 82

def mime_type
  @mime_type ||= content_type.mime_type
end

#parse(as = nil) ⇒ Object

Parse response body with corresponding MIME type adapter.

Parameters:

  • as (#to_s) (defaults to: nil) —

    Parse as given MIME type instead of the one determined from headers

Returns:

  • (Object)

Raises:

  • (Error) —

    if adapter not found



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

def parse(as = nil)
  MimeType[as || mime_type].decode to_s
end

#readpartial ⇒ String, Nil

Read a chunk of the body

Returns:

  • (String) —

    data chunk

  • (Nil) —

    when no more data left



55
 
# File 'lib/http/response.rb', line 55

def_delegator :body, :readpartial

#reason ⇒ String?

Returns status message.

Returns:

  • (String, nil) —

    status message



39
 
# File 'lib/http/response.rb', line 39

def_delegator :status, :reason

#to_a ⇒ Array(Fixnum, Hash, String)

Returns an Array ala Rack: [status, headers, body]

Returns:

  • (Array(Fixnum, Hash, String)) 


60
61
62
 
# File 'lib/http/response.rb', line 60

def to_a
  [status.to_i, headers.to_h, body.to_s]
end

#to_s ⇒ String Also known as: to_str

Returns eagerly consume the entire body as a string.

Returns:

  • (String) —

    eagerly consume the entire body as a string



50
 
# File 'lib/http/response.rb', line 50

def_delegator :body, :to_s