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

Attributes

blank[RW]
charset[RW]

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.

content_type[RW]

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.

header[W]
headers=[W]
request[RW]
sending_file[W]

Public Instance Methods

body() click to toggle source
# File lib/action_dispatch/http/response.rb, line 99
def body
  str = ''
  each { |part| str << part.to_s }
  str
end
body=(body) click to toggle source
# File lib/action_dispatch/http/response.rb, line 107
def body=(body)
  @blank = true if body == EMPTY
  @body = body.respond_to?(:to_str) ? [body] : body
end
body_parts() click to toggle source
# File lib/action_dispatch/http/response.rb, line 112
def body_parts
  @body
end
code() click to toggle source

Returns a String to ensure compatibility with Net::HTTPResponse

# File lib/action_dispatch/http/response.rb, line 78
def code
  @status.to_s
end
cookies() click to toggle source

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

assert_equal 'AuthorOfNewPage', r.cookies['author']
# File lib/action_dispatch/http/response.rb, line 170
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
each(&callback) click to toggle source
# File lib/action_dispatch/http/response.rb, line 149
def each(&callback)
  if @body.respond_to?(:call)
    @writer = lambda { |x| callback.call(x) }
    @body.call(self, self)
  else
    @body.each { |part| callback.call(part.to_s) }
  end

  @writer = callback
  @block.call(self) if @block
end
location() click to toggle source
# File lib/action_dispatch/http/response.rb, line 116
def location
  headers['Location']
end
Also aliased as: redirect_url
location=(url) click to toggle source
# File lib/action_dispatch/http/response.rb, line 121
def location=(url)
  headers['Location'] = url
end
message() click to toggle source
# File lib/action_dispatch/http/response.rb, line 82
def message
  Rack::Utils::HTTP_STATUS_CODES[@status]
end
Also aliased as: status_message
prepare!() click to toggle source
Alias for: to_a
redirect_url() click to toggle source
Alias for: location
respond_to?(method) click to toggle source
# File lib/action_dispatch/http/response.rb, line 87
def respond_to?(method)
  if method.to_sym == :to_path
    @body.respond_to?(:to_path)
  else
    super
  end
end
response_code() click to toggle source

The response code of the request

# File lib/action_dispatch/http/response.rb, line 73
def response_code
  @status
end
status=(status) click to toggle source
# File lib/action_dispatch/http/response.rb, line 68
def status=(status)
  @status = Rack::Utils.status_code(status)
end
status_message() click to toggle source
Alias for: message
to_a() click to toggle source
# File lib/action_dispatch/http/response.rb, line 139
def to_a
  assign_default_content_type_and_charset!
  handle_conditional_get!
  self["Set-Cookie"] = self["Set-Cookie"].join("\n") if self["Set-Cookie"].respond_to?(:join)
  self["ETag"]       = @_etag if @_etag
  super
end
Also aliased as: prepare!
to_path() click to toggle source
# File lib/action_dispatch/http/response.rb, line 95
def to_path
  @body.to_path
end
write(str) click to toggle source
# File lib/action_dispatch/http/response.rb, line 161
def write(str)
  str = str.to_s
  @writer.call str
  str
end