Class: HTTP::Response
- Inherits:
-
Object
- Object
- HTTP::Response
- 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
- #body ⇒ Body readonly
- #proxy_headers ⇒ Hash readonly
- #status ⇒ Status readonly
- #uri ⇒ URI? readonly
- #version ⇒ String readonly
Attributes included from Headers::Mixin
Instance Method Summary collapse
-
#charset ⇒ String?
Charset of response (if any).
- #chunked? ⇒ Boolean
-
#code ⇒ Fixnum
Status code.
-
#connection ⇒ HTTP::Connection
The connection object used to make the corresponding request.
-
#content_length ⇒ nil, Integer
Value of the Content-Length header.
-
#content_type ⇒ HTTP::ContentType
Parsed Content-Type header.
- #cookies ⇒ Object
-
#flush ⇒ Response
Flushes body and returns self-reference.
-
#initialize(opts) ⇒ Response
constructor
Inits a new instance.
-
#inspect ⇒ Object
Inspect a response.
-
#mime_type ⇒ String?
MIME type of response (if any).
-
#parse(as = nil) ⇒ Object
Parse response body with corresponding MIME type adapter.
- #readpartial ⇒ Object
-
#reason ⇒ String?
Status message.
-
#to_a ⇒ Array(Fixnum, Hash, String)
Returns an Array ala Rack:
[status, headers, body]
. -
#to_s ⇒ String
(also: #to_str)
Eagerly consume the entire body as a string.
Methods included from Headers::Mixin
Constructor Details
#initialize(opts) ⇒ Response
Inits a new instance
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/http/response.rb', line 45 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?(:body) @body = opts.fetch(:body) else connection = opts.fetch(:connection) encoding = opts[:encoding] || charset || Encoding::BINARY @body = Response::Body.new(connection, :encoding => encoding) end end |
Instance Attribute Details
#proxy_headers ⇒ Hash (readonly)
33 34 35 |
# File 'lib/http/response.rb', line 33 def proxy_headers @proxy_headers end |
#version ⇒ String (readonly)
24 25 26 |
# File 'lib/http/response.rb', line 24 def version @version end |
Instance Method Details
#charset ⇒ String?
Charset of response (if any)
134 |
# File 'lib/http/response.rb', line 134 def_delegator :content_type, :charset |
#chunked? ⇒ Boolean
142 143 144 145 146 147 148 149 |
# File 'lib/http/response.rb', line 142 def chunked? return false unless @headers.include?(Headers::TRANSFER_ENCODING) encoding = @headers.get(Headers::TRANSFER_ENCODING) # TODO: "chunked" is frozen in the request writer. How about making it accessible? encoding.last == "chunked" end |
#code ⇒ Fixnum
Returns status code.
68 |
# File 'lib/http/response.rb', line 68 def_delegator :status, :code |
#connection ⇒ HTTP::Connection
The connection object used to make the corresponding request.
81 |
# File 'lib/http/response.rb', line 81 def_delegator :body, :connection |
#content_length ⇒ nil, Integer
Value of the Content-Length header.
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/http/response.rb', line 103 def content_length # http://greenbytes.de/tech/webdav/rfc7230.html#rfc.section.3.3.3 # Clause 3: "If a message is received with both a Transfer-Encoding # and a Content-Length header field, the Transfer-Encoding overrides the Content-Length. return nil if @headers.include?(Headers::TRANSFER_ENCODING) value = @headers[Headers::CONTENT_LENGTH] return nil unless value begin Integer(value) rescue ArgumentError nil end end |
#content_type ⇒ HTTP::ContentType
Parsed Content-Type header
122 123 124 |
# File 'lib/http/response.rb', line 122 def content_type @content_type ||= ContentType.parse headers[Headers::CONTENT_TYPE] end |
#cookies ⇒ Object
136 137 138 139 140 |
# File 'lib/http/response.rb', line 136 def @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
93 94 95 96 |
# File 'lib/http/response.rb', line 93 def flush body.to_s self end |
#inspect ⇒ Object
Inspect a response
162 163 164 |
# File 'lib/http/response.rb', line 162 def inspect "#<#{self.class}/#{@version} #{code} #{reason} #{headers.to_h.inspect}>" end |
#mime_type ⇒ String?
MIME type of response (if any)
129 |
# File 'lib/http/response.rb', line 129 def_delegator :content_type, :mime_type |
#parse(as = nil) ⇒ Object
Parse response body with corresponding MIME type adapter.
157 158 159 |
# File 'lib/http/response.rb', line 157 def parse(as = nil) MimeType[as || mime_type].decode to_s end |
#readpartial ⇒ Object
77 |
# File 'lib/http/response.rb', line 77 def_delegator :body, :readpartial |
#reason ⇒ String?
Returns status message.
64 |
# File 'lib/http/response.rb', line 64 def_delegator :status, :reason |
#to_a ⇒ Array(Fixnum, Hash, String)
Returns an Array ala Rack: [status, headers, body]
86 87 88 |
# File 'lib/http/response.rb', line 86 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.
72 |
# File 'lib/http/response.rb', line 72 def_delegator :body, :to_s |