Represents an HTTP response generated by a controller action. Use it to retrieve the current state of the response, or customize the response. It can either represent a real HTTP response (i.e. one that is meant to be sent back to the web browser) or a TestResponse (i.e. one that is generated from integration tests).
Response is mostly a Ruby on Rails framework implementation detail, and should never be used directly in controllers. Controllers should use the methods defined in ActionController::Base instead. For example, if you want to set the HTTP response's content MIME type, then use ActionControllerBase#headers instead of Response#headers.
Nevertheless, integration tests may want to inspect controller responses in more detail, and that's when Response can be useful for application developers. Integration test methods such as ActionDispatch::Integration::RequestHelpers#get and ActionDispatch::Integration::RequestHelpers#post return objects of type TestResponse (which are of course also of type Response).
For example, the following demo integration test prints the body of the controller response to the console:
class DemoControllerTest < ActionDispatch::IntegrationTest
def test_print_root_path_to_console
get('/')
puts response.body
end
end
- A
- B
- C
- D
- L
- M
- N
- P
- R
- S
- T
- Rack::Response::Helpers
- ActionDispatch::Http::FilterRedirect
- ActionDispatch::Http::Cache::Response
- MonitorMixin
CONTENT_TYPE | = | "Content-Type".freeze |
SET_COOKIE | = | "Set-Cookie".freeze |
LOCATION | = | "Location".freeze |
NO_CONTENT_CODES | = | [204, 304] |
EMPTY | = | " " |
[RW] | charset | The charset of the response. HTML wants to know the encoding of the content you're giving them, so we need to send that along. |
[R] | content_type | Sets the HTTP response's content MIME type. For example, in the controller you could write this:
If a character set has been defined for this response (see charset=) then the character set information will also be included in the content type information. |
[RW] | header | Get and set headers for this response. |
[RW] | headers= | Get and set headers for this response. |
[RW] | request | The request that the response is responding to. |
[W] | sending_file | |
[R] | status | The HTTP status code. |
[R] | stream | The underlying body, as a streamable object. |
# File actionpack/lib/action_dispatch/http/response.rb, line 118 def initialize(status = 200, header = {}, body = [], options = {}) super() default_headers = options.fetch(:default_headers, self.class.default_headers) header = merge_default_headers(header, default_headers) self.body, self.header, self.status = body, header, status @sending_file = false @blank = false @cv = new_cond @committed = false @sending = false @sent = false @content_type = nil @charset = nil if content_type = self[CONTENT_TYPE] type, charset = content_type.split(/;\s*charset=/) @content_type = Mime::Type.lookup(type) @charset = charset || self.class.default_charset end prepare_cache_control! yield self if block_given? end
# File actionpack/lib/action_dispatch/http/response.rb, line 268 def abort if stream.respond_to?(:abort) stream.abort elsif stream.respond_to?(:close) # `stream.close` should really be reserved for a close from the # other direction, but we must fall back to it for # compatibility. stream.close end end
Returns the content of the response as a string. This contains the contents
of any calls to render
.
Allows you to manually set or override the response body.
Returns a string to ensure compatibility with
Net::HTTPResponse
.
Sets the HTTP content type.
Returns the response cookies, converted to a Hash of (name => value) pairs
assert_equal 'AuthorOfNewPage', r.cookies['author']
Sets the location header we'll be responding with.
Returns the corresponding message for the current HTTP status code:
response.status = 200
response.message # => "OK"
response.status = 404
response.message # => "Not Found"
The response code of the request.
Sets the HTTP status code.
Turns the Response into a Rack-compatible array of the status, headers, and body. Allows explict splatting:
status, headers, body = *response
Be super clear that a response object is not an Array. Defining this would make implicit splatting work, but it also makes adding responses as arrays work, and “flattening” responses, cascading to the rack body! Not sensible behavior.
# File actionpack/lib/action_dispatch/http/response.rb, line 292 def to_ary ActiveSupport::Deprecation.warn(" `ActionDispatch::Response#to_ary` no longer performs implicit conversion to an array. Please use `response.to_a` instead, or a splat like `status, headers, body = *response`. ".squish) to_a end