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 Integration::RequestHelpers#get
and 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
- E
- G
- H
- M
- N
- P
- R
- S
- T
- W
- Rack::Response::Helpers
- ActionDispatch::Http::FilterRedirect
- ActionDispatch::Http::Cache::Response
- MonitorMixin
Constants
CONTENT_TYPE | = | "Content-Type" |
ContentTypeHeader | = | Struct.new :mime_type, :charset |
LOCATION | = | "Location" |
NO_CONTENT_CODES | = | [100, 101, 102, 103, 204, 205, 304] |
NullContentTypeHeader | = | ContentTypeHeader.new nil, nil |
SET_COOKIE | = | "Set-Cookie" |
Attributes
[R] | header | Get headers for this response. |
[R] | headers | Get headers for this response. |
[RW] | request | The request that the response is responding to. |
[R] | status | The HTTP status code. |
[R] | stream | The underlying body, as a streamable object. |
Class Public methods
create(status = 200, header = {}, body = [], default_headers: self.default_headers) Link
merge_default_headers(original, default) Link
new(status = 200, header = {}, body = []) Link
# File actionpack/lib/action_dispatch/http/response.rb, line 161 def initialize(status = 200, header = {}, body = []) super() @header = Header.new(self, header) self.body, self.status = body, status @cv = new_cond @committed = false @sending = false @sent = false prepare_cache_control! yield self if block_given? end
Instance Public methods
abort() Link
# File actionpack/lib/action_dispatch/http/response.rb, line 370 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
await_commit() Link
await_sent() Link
body() Link
Returns the content of the response as a string. This contains the contents of any calls to render
.
body=(body) Link
Allows you to manually set or override the response body.
body_parts() Link
charset() Link
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.
charset=(charset) Link
Sets the HTTP character set. In case of nil
parameter it sets the charset to default_charset
.
response.charset = 'utf-16' # => 'utf-16'
response.charset = nil # => 'utf-8'
# File actionpack/lib/action_dispatch/http/response.rb, line 263 def charset=(charset) content_type = parsed_content_type_header.mime_type if false == charset set_content_type content_type, nil else set_content_type content_type, charset || self.class.default_charset end end
close() Link
code() Link
Returns a string to ensure compatibility with Net::HTTPResponse
.
commit!() Link
committed?() Link
content_type() Link
Content type of response.
content_type=(content_type) Link
Sets the HTTP response's content MIME type. For example, in the controller you could write this:
response.content_type = "text/plain"
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.
# File actionpack/lib/action_dispatch/http/response.rb, line 233 def content_type=(content_type) return unless content_type new_header_info = parse_content_type(content_type.to_s) prev_header_info = parsed_content_type_header charset = new_header_info.charset || prev_header_info.charset charset ||= self.class.default_charset unless prev_header_info.mime_type set_content_type new_header_info.mime_type, charset end
cookies() Link
Returns the response cookies, converted to a Hash
of (name => value) pairs
assert_equal 'AuthorOfNewPage', r.cookies['author']
delete_header(key) Link
each(&block) Link
get_header(key) Link
has_header?(key) Link
media_type() Link
Media type of response.
message() Link
Returns the corresponding message for the current HTTP status code:
response.status = 200
response.message # => "OK"
response.status = 404
response.message # => "Not Found"
reset_body!() Link
response_code() Link
The response code of the request.
send_file(path) Link
Send the file stored at path
as the response body.
sending!() Link
sending?() Link
sending_file=(v) Link
sent!() Link
sent?() Link
set_header(key, v) Link
status=(status) Link
Sets the HTTP status code.