class ActionDispatch::Response
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
Constants
- CONTENT_TYPE
- EMPTY
- LOCATION
- SET_COOKIE
Attributes
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.
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.
Public Class Methods
# File lib/action_dispatch/http/response.rb, line 65 def initialize(status = 200, header = {}, body = []) self.body, self.header, self.status = body, header, status @sending_file = false @blank = false 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
Public Instance Methods
# File lib/action_dispatch/http/response.rb, line 113 def body strings = [] each { |part| strings << part.to_s } strings.join end
# File lib/action_dispatch/http/response.rb, line 121 def body=(body) @blank = true if body == EMPTY # Explicitly check for strings. This is *wrong* theoretically # but if we don't check this, the performance on string bodies # is bad on Ruby 1.8 (because strings responds to each then). @body = if body.respond_to?(:to_str) || !body.respond_to?(:each) [body] else body end end
# File lib/action_dispatch/http/response.rb, line 134 def body_parts @body end
# File lib/action_dispatch/http/response.rb, line 155 def close @body.close if @body.respond_to?(:close) end
Returns a String to ensure compatibility with Net::HTTPResponse
# File lib/action_dispatch/http/response.rb, line 92 def code @status.to_s end
# File lib/action_dispatch/http/response.rb, line 146 def location headers[LOCATION] end
# File lib/action_dispatch/http/response.rb, line 151 def location=(url) headers[LOCATION] = url end
# File lib/action_dispatch/http/response.rb, line 96 def message Rack::Utils::HTTP_STATUS_CODES[@status] end
# File lib/action_dispatch/http/response.rb, line 101 def respond_to?(method) if method.to_sym == :to_path @body.respond_to?(:to_path) else super end end
The response code of the request
# File lib/action_dispatch/http/response.rb, line 87 def response_code @status end
# File lib/action_dispatch/http/response.rb, line 82 def status=(status) @status = Rack::Utils.status_code(status) end
# File lib/action_dispatch/http/response.rb, line 159 def to_a assign_default_content_type_and_charset! handle_conditional_get! @header[SET_COOKIE] = @header[SET_COOKIE].join("\n") if @header[SET_COOKIE].respond_to?(:join) if [204, 304].include?(@status) @header.delete CONTENT_TYPE [@status, @header, []] else [@status, @header, self] end end
# File lib/action_dispatch/http/response.rb, line 109 def to_path @body.to_path end
Private Instance Methods
# File lib/action_dispatch/http/response.rb, line 194 def assign_default_content_type_and_charset! return if headers[CONTENT_TYPE].present? @content_type ||= Mime::HTML @charset ||= self.class.default_charset type = @content_type.to_s.dup type << "; charset=#{@charset}" unless @sending_file headers[CONTENT_TYPE] = type end