| Class | ActionController::AbstractResponse |
| In: |
vendor/rails/actionpack/lib/action_controller/response.rb
|
| Parent: | Object |
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 CgiResponse 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
| DEFAULT_HEADERS | = | { "Cache-Control" => "no-cache" } |
| assigns | [RW] | |
| body | [RW] | The body content (e.g. HTML) of the response, as a String. |
| cookies | [RW] | |
| headers | [RW] | The headers of the response, as a Hash. It maps header names to header values. |
| layout | [RW] | |
| redirected_to | [RW] | |
| redirected_to_method_params | [RW] | |
| request | [RW] | |
| session | [RW] | |
| template | [RW] |
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 45
45: def initialize
46: @body, @headers, @session, @assigns = "", DEFAULT_HEADERS.merge("cookie" => []), [], []
47: end
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 132
132: def assign_default_content_type_and_charset!
133: self.content_type ||= Mime::HTML
134: self.charset ||= default_charset unless sending_file?
135: end
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 91
91: def charset
92: charset = String(headers["Content-Type"] || headers["type"]).split(";")[1]
93: charset.blank? ? nil : charset.strip.split("=")[1]
94: end
Set the charset of the Content-Type header. Set to nil to remove it. If no content type is set, it defaults to HTML.
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 82
82: def charset=(charset)
83: headers["Content-Type"] =
84: if charset
85: "#{content_type || Mime::HTML}; charset=#{charset}"
86: else
87: content_type || Mime::HTML.to_s
88: end
89: end
Returns the response‘s content MIME type, or nil if content type has been set.
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 75
75: def content_type
76: content_type = String(headers["Content-Type"] || headers["type"]).split(";")[0]
77: content_type.blank? ? nil : content_type
78: end
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 vendor/rails/actionpack/lib/action_controller/response.rb, line 64
64: def content_type=(mime_type)
65: new_content_type =
66: if mime_type =~ /charset/ || (c = charset).nil?
67: mime_type.to_s
68: else
69: "#{mime_type}; charset=#{c}"
70: end
71: self.headers["Content-Type"] = URI.escape(new_content_type, "\r\n")
72: end
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 110
110: def etag
111: headers['ETag']
112: end
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 118
118: def etag=(etag)
119: headers['ETag'] = %("#{Digest::MD5.hexdigest(ActiveSupport::Cache.expand_cache_key(etag))}")
120: end
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 114
114: def etag?
115: headers.include?('ETag')
116: end
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 96
96: def last_modified
97: if last = headers['Last-Modified']
98: Time.httpdate(last)
99: end
100: end
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 106
106: def last_modified=(utc_time)
107: headers['Last-Modified'] = utc_time.httpdate
108: end
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 102
102: def last_modified?
103: headers.include?('Last-Modified')
104: end
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 52
52: def location; headers['Location'] end
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 53
53: def location=(url) headers['Location'] = url end
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 137
137: def prepare!
138: assign_default_content_type_and_charset!
139: handle_conditional_get!
140: set_content_length!
141: convert_content_type!
142: end
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 122
122: def redirect(url, status)
123: self.status = status
124: self.location = url.gsub(/[\r\n]/, '')
125: self.body = "<html><body>You are being <a href=\"#{CGI.escapeHTML(url)}\">redirected</a>.</body></html>"
126: end
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 128
128: def sending_file?
129: headers["Content-Transfer-Encoding"] == "binary"
130: end
# File vendor/rails/actionpack/lib/action_controller/response.rb, line 49
49: def status; headers['Status'] end