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
Methods
A
B
C
D
L
M
N
P
R
S
T
Included Modules
Constants
CONTENT_TYPE = "Content-Type".freeze
 
SET_COOKIE = "Set-Cookie".freeze
 
LOCATION = "Location".freeze
 
NO_CONTENT_CODES = [204, 304]
 
EMPTY = " "
 
Attributes
[RW] charset

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.

[R] content_type
[RW] header
[RW] headers=
[RW] request
[W] sending_file
[R] status
[R] stream
Class Public methods
new(status = 200, header = {}, body = [])
# File actionpack/lib/action_dispatch/http/response.rb, line 98
def initialize(status = 200, header = {}, body = [])
  super()

  header = merge_default_headers(header, self.class.default_headers)

  self.body, self.header, self.status = body, header, status

  @sending_file = false
  @blank        = false
  @cv           = new_cond
  @committed    = false
  @content_type = nil
  @charset      = nil

  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
Instance Public methods
await_commit()
# File actionpack/lib/action_dispatch/http/response.rb, line 123
def await_commit
  synchronize do
    @cv.wait_until { @committed }
  end
end
body()

Returns the content of the response as a string. This contains the contents of any calls to render.

# File actionpack/lib/action_dispatch/http/response.rb, line 186
def body
  strings = []
  each { |part| strings << part.to_s }
  strings.join
end
body=(body)

Allows you to manually set or override the response body.

# File actionpack/lib/action_dispatch/http/response.rb, line 195
def body=(body)
  @blank = true if body == EMPTY

  if body.respond_to?(:to_path)
    @stream = body
  else
    synchronize do
      @stream = build_buffer self, munge_body_object(body)
    end
  end
end
body_parts()
# File actionpack/lib/action_dispatch/http/response.rb, line 207
def body_parts
  parts = []
  @stream.each { |x| parts << x }
  parts
end
close()
# File actionpack/lib/action_dispatch/http/response.rb, line 230
def close
  stream.close if stream.respond_to?(:close)
end
code()

Returns a string to ensure compatibility with Net::HTTPResponse.

# File actionpack/lib/action_dispatch/http/response.rb, line 155
def code
  @status.to_s
end
commit!()
# File actionpack/lib/action_dispatch/http/response.rb, line 129
def commit!
  synchronize do
    @committed = true
    @cv.broadcast
  end
end
committed?()
# File actionpack/lib/action_dispatch/http/response.rb, line 136
def committed?
  @committed
end
content_type=(content_type)
# File actionpack/lib/action_dispatch/http/response.rb, line 145
def content_type=(content_type)
  @content_type = content_type.to_s
end
cookies()

Returns the response cookies, converted to a Hash of (name => value) pairs

assert_equal 'AuthorOfNewPage', r.cookies['author']
# File actionpack/lib/action_dispatch/http/response.rb, line 243
def cookies
  cookies = {}
  if header = self[SET_COOKIE]
    header = header.split("\n") if header.respond_to?(:to_str)
    header.each do |cookie|
      if pair = cookie.split(';').first
        key, value = pair.split("=").map { |v| Rack::Utils.unescape(v) }
        cookies[key] = value
      end
    end
  end
  cookies
end
location()
Also aliased as: redirect_url
# File actionpack/lib/action_dispatch/http/response.rb, line 221
def location
  headers[LOCATION]
end
location=(url)
# File actionpack/lib/action_dispatch/http/response.rb, line 226
def location=(url)
  headers[LOCATION] = url
end
message()

Returns the corresponding message for the current HTTP status code:

response.status = 200
response.message # => "OK"

response.status = 404
response.message # => "Not Found"
Also aliased as: status_message
# File actionpack/lib/action_dispatch/http/response.rb, line 167
def message
  Rack::Utils::HTTP_STATUS_CODES[@status]
end
prepare!()
Alias for: to_a
redirect_url()
Alias for: location
respond_to?(method)
# File actionpack/lib/action_dispatch/http/response.rb, line 172
def respond_to?(method)
  if method.to_s == 'to_path'
    stream.respond_to?(:to_path)
  else
    super
  end
end
response_code()

The response code of the request.

# File actionpack/lib/action_dispatch/http/response.rb, line 150
def response_code
  @status
end
status=(status)

Sets the HTTP status code.

# File actionpack/lib/action_dispatch/http/response.rb, line 141
def status=(status)
  @status = Rack::Utils.status_code(status)
end
status_message()
Alias for: message
to_a()
Also aliased as: prepare!, to_ary
# File actionpack/lib/action_dispatch/http/response.rb, line 234
def to_a
  rack_response @status, @header.to_hash
end
to_ary()
Alias for: to_a
to_path()
# File actionpack/lib/action_dispatch/http/response.rb, line 180
def to_path
  stream.to_path
end