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
- B
- C
- D
- L
- M
- N
- P
- R
- S
- T
- Rack::Response::Helpers
- ActionDispatch::Http::Cache::Response
CONTENT_TYPE | = | "Content-Type" |
EMPTY | = | " " |
[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. |
[RW] | content_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. |
[RW] | header | |
[RW] | headers= | |
[RW] | request | |
[W] | sending_file | |
[RW] | status |
Source: show
# File actionpack/lib/action_dispatch/http/response.rb, line 62 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 || "UTF-8" end prepare_cache_control! yield self if block_given? end
Source: show
# File actionpack/lib/action_dispatch/http/response.rb, line 110 def body str = '' each { |part| str << part.to_s } str end
Source: show
# File actionpack/lib/action_dispatch/http/response.rb, line 135 def body=(body) @blank = true if body == EMPTY if body.respond_to?(:call) ActiveSupport::Deprecation.warn "Setting a Proc or an object that responds to call " "in response_body is no longer supported", caller body = BodyBuster.new(self).bust(body) end # 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
Source: show
# File actionpack/lib/action_dispatch/http/response.rb, line 154 def body_parts @body end
Source: show
# File actionpack/lib/action_dispatch/http/response.rb, line 175 def close @body.close if @body.respond_to?(:close) end
Returns a String to ensure compatibility with Net::HTTPResponse
Source: show
# File actionpack/lib/action_dispatch/http/response.rb, line 89 def code @status.to_s end
Returns the response cookies, converted to a Hash of (name => value) pairs
assert_equal 'AuthorOfNewPage', r.cookies['author']
Source: show
Source: show
# File actionpack/lib/action_dispatch/http/response.rb, line 166 def location headers['Location'] end
Source: show
# File actionpack/lib/action_dispatch/http/response.rb, line 171 def location=(url) headers['Location'] = url end
Source: show
# File actionpack/lib/action_dispatch/http/response.rb, line 93 def message Rack::Utils::HTTP_STATUS_CODES[@status] end
Source: show
# File actionpack/lib/action_dispatch/http/response.rb, line 98 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
Source: show
# File actionpack/lib/action_dispatch/http/response.rb, line 84 def response_code @status end
Source: show
# File actionpack/lib/action_dispatch/http/response.rb, line 79 def status=(status) @status = Rack::Utils.status_code(status) end
Source: show
# File actionpack/lib/action_dispatch/http/response.rb, line 179 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
Source: show
# File actionpack/lib/action_dispatch/http/response.rb, line 106 def to_path @body.to_path end