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
Methods
A
C
E
L
N
P
R
S
W
Constants
DEFAULT_HEADERS = { "Cache-Control" => "no-cache" }
 
Attributes
[RW] assigns
[RW] layout
[RW] redirected_to
[RW] redirected_to_method_params
[RW] request
[RW] session
[RW] template
Class Public methods
new()
# File actionpack/lib/action_controller/response.rb, line 42
def initialize
  @status = 200
  @header = Rack::Utils::HeaderHash.new(DEFAULT_HEADERS)
  @writer = lambda { |x| @body << x }
  @block = nil
  @body = "",
  @session = []
  @assigns = []
end
Instance Public methods
assign_default_content_type_and_charset!()
# File actionpack/lib/action_controller/response.rb, line 134
def assign_default_content_type_and_charset!
  self.content_type ||= Mime::HTML
  self.charset ||= default_charset unless sending_file?
end
charset()
# File actionpack/lib/action_controller/response.rb, line 93
def charset
  charset = String(headers["Content-Type"] || headers["type"]).split(";")[1]
  charset.blank? ? nil : charset.strip.split("=")[1]
end
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.

# File actionpack/lib/action_controller/response.rb, line 84
def charset=(charset)
  headers["Content-Type"] =
    if charset
      "#{content_type || Mime::HTML}; charset=#{charset}"
    else
      content_type || Mime::HTML.to_s
    end
end
content_type()

Returns the response's content MIME type, or nil if content type has been set.

# File actionpack/lib/action_controller/response.rb, line 77
def content_type
  content_type = String(headers["Content-Type"] || headers["type"]).split(";")[0]
  content_type.blank? ? nil : content_type
end
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.

# File actionpack/lib/action_controller/response.rb, line 66
def content_type=(mime_type)
  new_content_type =
    if mime_type =~ /charset/ || (c = charset).nil?
      mime_type.to_s
    else
      "#{mime_type}; charset=#{c}"
    end
  self.headers["Content-Type"] = URI.escape(new_content_type, "\r\n")
end
each(&callback)
# File actionpack/lib/action_controller/response.rb, line 148
def each(&callback)
  if @body.respond_to?(:call)
    @writer = lambda { |x| callback.call(x) }
    @body.call(self, self)
  elsif @body.respond_to?(:to_str)
    yield @body
  else
    @body.each(&callback)
  end
  @writer = callback
  @block.call(self) if @block
end
etag()
# File actionpack/lib/action_controller/response.rb, line 112
def etag
  headers['ETag']
end
etag=(etag)
# File actionpack/lib/action_controller/response.rb, line 120
def etag=(etag)
  headers['ETag'] = %Q("#{Digest::MD5.hexdigest(ActiveSupport::Cache.expand_cache_key(etag))}")
end
etag?()
# File actionpack/lib/action_controller/response.rb, line 116
def etag?
  headers.include?('ETag')
end
last_modified()
# File actionpack/lib/action_controller/response.rb, line 98
def last_modified
  if last = headers['Last-Modified']
    Time.httpdate(last)
  end
end
last_modified=(utc_time)
# File actionpack/lib/action_controller/response.rb, line 108
def last_modified=(utc_time)
  headers['Last-Modified'] = utc_time.httpdate
end
last_modified?()
# File actionpack/lib/action_controller/response.rb, line 104
def last_modified?
  headers.include?('Last-Modified')
end
location()
# File actionpack/lib/action_controller/response.rb, line 54
def location; headers['Location'] end
location=(url)
# File actionpack/lib/action_controller/response.rb, line 55
def location=(url) headers['Location'] = url end
prepare!()
# File actionpack/lib/action_controller/response.rb, line 139
def prepare!
  assign_default_content_type_and_charset!
  handle_conditional_get!
  set_content_length!
  convert_content_type!
  convert_language!
  convert_cookies!
end
redirect(url, status)
# File actionpack/lib/action_controller/response.rb, line 124
def redirect(url, status)
  self.status = status
  self.location = url.gsub(/[\r\n]/, '')
  self.body = "<html><body>You are being <a href=\"#{CGI.escapeHTML(url)}\">redirected</a>.</body></html>"
end
sending_file?()
# File actionpack/lib/action_controller/response.rb, line 130
def sending_file?
  headers["Content-Transfer-Encoding"] == "binary"
end
write(str)
# File actionpack/lib/action_controller/response.rb, line 162
def write(str)
  @writer.call str.to_s
  str
end