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/inflater.rb,
lib/http/response/status/reasons.rb

Defined Under Namespace

Classes: Body, Inflater, Parser, Status

Instance Attribute Summary collapse

Attributes included from Headers::Mixin

#headers

Instance Method Summary collapse

Methods included from Headers::Mixin

#[], #[]=

Constructor Details

#initialize(opts) ⇒ Response

Inits a new instance

Parameters:

  • opts (Hash) —

    a customizable set of options

Options Hash (opts):

  • :status (Integer) —

    Status code

  • :version (String) —

    HTTP version

  • :headers (Hash)
  • :proxy_headers (Hash)
  • :connection (HTTP::Connection)
  • :encoding (String) —

    Encoding to use when reading body

  • :body (String)
  • :uri (String) 


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/http/response.rb', line 41

def initialize(opts)
  @version       = opts.fetch(:version)
  @uri           = HTTP::URI.parse(opts.fetch(:uri)) if opts.include? :uri
  @status        = HTTP::Response::Status.new(opts.fetch(:status))
  @headers       = HTTP::Headers.coerce(opts[:headers] || {})
  @proxy_headers = HTTP::Headers.coerce(opts[:proxy_headers] || {})

  if opts.include?(:connection)
    connection = opts.fetch(:connection)
    encoding   = opts[:encoding] || charset || Encoding::BINARY
    stream     = body_stream_for(connection, opts)

    @body = Response::Body.new(stream, encoding)
  else
    @body = opts.fetch(:body)
  end
end

Instance Attribute Details

#body ⇒ Body (readonly)

Returns:



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

def body
  @body
end

#proxy_headers ⇒ Hash (readonly)

Returns:

  • (Hash) 


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

def proxy_headers
  @proxy_headers
end

#status ⇒ Status (readonly)

Returns:



20
21
22
 
# File 'lib/http/response.rb', line 20

def status
  @status
end

#uri ⇒ URI? (readonly)

Returns:



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

def uri
  @uri
end

Instance Method Details

#charset ⇒ String?

Charset of response (if any)

Returns:

  • (String, nil) 


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

def_delegator :content_type, :charset

#code ⇒ Fixnum

Returns status code.

Returns:

  • (Fixnum) —

    status code



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

def_delegator :status, :code

#connection ⇒ HTTP::Connection

The connection object used to make the corresponding request.

Returns:



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

def_delegator :body, :connection

#content_length ⇒ nil, Integer

Value of the Content-Length header.

Returns:

  • (nil) —

    if Content-Length was not given, or it's value was invalid (not an integer, e.g. empty string or string with non-digits).

  • (Integer) —

    otherwise



100
101
102
103
104
105
106
107
108
109
 
# File 'lib/http/response.rb', line 100

def content_length
  value = @headers[Headers::CONTENT_LENGTH]
  return unless value

  begin
    Integer(value)
  rescue ArgumentError
    nil
  end
end

#content_type ⇒ HTTP::ContentType

Parsed Content-Type header

Returns:



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

def content_type
  @content_type ||= ContentType.parse headers[Headers::CONTENT_TYPE]
end

#cookies ⇒ Object 



128
129
130
131
132
 
# File 'lib/http/response.rb', line 128

def cookies
  @cookies ||= headers.each_with_object CookieJar.new do |(k, v), jar|
    jar.parse(v, uri) if k == Headers::SET_COOKIE
  end
end

#flush ⇒ Response

Flushes body and returns self-reference

Returns:



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

def flush
  body.to_s
  self
end

#inspect ⇒ Object

Inspect a response



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

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

#mime_type ⇒ String?

MIME type of response (if any)

Returns:

  • (String, nil) 


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

def_delegator :content_type, :mime_type

#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:



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

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

#readpartial ⇒ Object 



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

def_delegator :body, :readpartial

#reason ⇒ String?

Returns status message.

Returns:

  • (String, nil) —

    status message



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

def_delegator :status, :reason

#to_a ⇒ Array(Fixnum, Hash, String)

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

Returns:

  • (Array(Fixnum, Hash, String)) 


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

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



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

def_delegator :body, :to_s