- Inheritance
- < Rack::Response < Object
Represents an HTTP response generated by a controller action. One can use an ActionController::Response object to retrieve the current state of the response, or customize the response. An Response object can either represent a "real" HTTP response (i.e. one that is meant to be sent back to the web browser) or a test response (i.e. one that is generated from integration tests). See CgiResponse and TestResponse, respectively.
Response is mostly a Ruby on Rails framework implement 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 ActionController::Integration::Session#get and ActionController::Integration::Session#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 < ActionController::IntegrationTest
def test_print_root_path_to_console
get('/')
puts @response.body
end
end
Constants
| Name | Description | |
|---|---|---|
| DEFAULT_HEADERS | = { "Cache-Control" => "no-cache" } |
Attributes
| Name | Visibility | R/W | Description |
|---|---|---|---|
| assigns | public | RW | |
| layout | public | RW | |
| redirected_to | public | RW | |
| redirected_to_method_params | public | RW | |
| request | public | RW | |
| session | public | RW | |
| template | public | RW |
Methods
Class
| Visibility | Signature |
|---|---|
| public | new () |
Instance
| Visibility | Signature |
|---|---|
| public | assign_default_content_type_and_charset! () |
| public | charset () |
| public | charset= (charset) |
| public | content_type () |
| public | content_type= (mime_type) |
| public | each (&callback) |
| public | etag () |
| public | etag= (etag) |
| public | etag? () |
| public | last_modified () |
| public | last_modified= (utc_time) |
| public | last_modified? () |
| public | location () |
| public | location= (url) |
| public | prepare! () |
| public | redirect (url, status) |
| public | sending_file? () |
| public | set_cookie (key, value) |
| public | write (str) |
Class Method Detail
new()
Instance Method Detail
assign_default_content_type_and_charset!()
charset()
charset=(charset)
Set the charset of the Content-Type header. Set to nil to remove it. If no content type is set, it defaults to HTML.
content_type()
Returns the response‘s content MIME type, or nil if content type has been set.
content_type=(mime_type)
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.