Ruby on Rails latest stable (v7.1.3.2) - 0 notes - Superclass: Object

Class deprecated or moved

This class is deprecated or moved on the latest stable version. The last existing version (v2.2.1) is shown here.

Represents an HTTP response generated by a controller action. One can use an ActionController::AbstractResponse object to retrieve the current state of the response, or customize the response. An AbstractResponse 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 <a href="/rails/ActionController/CgiResponse">CgiResponse</a> and TestResponse, respectively.

AbstractResponse 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 AbstractResponse#headers.

Nevertheless, integration tests may want to inspect controller responses in more detail, and that’s when AbstractResponse 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 AbstractResponse).

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

DEFAULT_HEADERS = { "Cache-Control" => "no-cache" }

Attributes

[RW] request
[RW] body

The body content (e.g. HTML) of the response, as a String.

[RW] headers

The headers of the response, as a Hash. It maps header names to header values.

[RW] session
[RW] cookies
[RW] assigns
[RW] template
[RW] layout
[RW] redirected_to
[RW] redirected_to_method_params
Show files where this class is defined (1 file)
Register or log in to add new notes.