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 Integration::RequestHelpers#get
and 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
- ContentTypeHeader
- LOCATION
- NO_CONTENT_CODES
- NullContentTypeHeader
- SET_COOKIE
Attributes
Get headers for this response.
Get headers for this response.
The request that the response is responding to.
The HTTP status code.
The underlying body, as a streamable object.
Public Class Methods
Source
# File lib/action_dispatch/http/response.rb, line 149 def self.create(status = 200, header = {}, body = [], default_headers: self.default_headers) header = merge_default_headers(header, default_headers) new status, header, body end
Source
# File lib/action_dispatch/http/response.rb, line 154 def self.merge_default_headers(original, default) default.respond_to?(:merge) ? default.merge(original) : original end
Source
# File lib/action_dispatch/http/response.rb, line 161 def initialize(status = 200, header = {}, body = []) super() @header = Header.new(self, header) self.body, self.status = body, status @cv = new_cond @committed = false @sending = false @sent = false prepare_cache_control! yield self if block_given? end
Public Instance Methods
Source
# File lib/action_dispatch/http/response.rb, line 370 def abort if stream.respond_to?(:abort) stream.abort elsif stream.respond_to?(:close) # `stream.close` should really be reserved for a close from the # other direction, but we must fall back to it for # compatibility. stream.close end end
Source
# File lib/action_dispatch/http/response.rb, line 183 def await_commit synchronize do @cv.wait_until { @committed } end end
Source
# File lib/action_dispatch/http/response.rb, line 189 def await_sent synchronize { @cv.wait_until { @sent } } end
Source
# File lib/action_dispatch/http/response.rb, line 304 def body @stream.body end
Returns the content of the response as a string. This contains the contents of any calls to render
.
Source
# File lib/action_dispatch/http/response.rb, line 313 def body=(body) if body.respond_to?(:to_path) @stream = body else synchronize do @stream = build_buffer self, munge_body_object(body) end end end
Allows you to manually set or override the response body.
Source
# File lib/action_dispatch/http/response.rb, line 357 def body_parts parts = [] @stream.each { |x| parts << x } parts end
Source
# File lib/action_dispatch/http/response.rb, line 274 def charset header_info = parsed_content_type_header header_info.charset || self.class.default_charset end
The charset of the response. HTML wants to know the encoding of the content you’re giving them, so we need to send that along.
Source
# File lib/action_dispatch/http/response.rb, line 263 def charset=(charset) content_type = parsed_content_type_header.mime_type if false == charset set_content_type content_type, nil else set_content_type content_type, charset || self.class.default_charset end end
Sets the HTTP character set. In case of nil
parameter it sets the charset to default_charset
.
response.charset = 'utf-16' # => 'utf-16' response.charset = nil # => 'utf-8'
Source
# File lib/action_dispatch/http/response.rb, line 366 def close stream.close if stream.respond_to?(:close) end
Source
# File lib/action_dispatch/http/response.rb, line 285 def code @status.to_s end
Returns a string to ensure compatibility with Net::HTTPResponse
.
Source
# File lib/action_dispatch/http/response.rb, line 193 def commit! synchronize do before_committed @committed = true @cv.broadcast end end
Source
# File lib/action_dispatch/http/response.rb, line 217 def committed?; synchronize { @committed }; end
Source
# File lib/action_dispatch/http/response.rb, line 243 def content_type super.presence end
Content type of response.
Source
# File lib/action_dispatch/http/response.rb, line 233 def content_type=(content_type) return unless content_type new_header_info = parse_content_type(content_type.to_s) prev_header_info = parsed_content_type_header charset = new_header_info.charset || prev_header_info.charset charset ||= self.class.default_charset unless prev_header_info.mime_type set_content_type new_header_info.mime_type, charset end
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.
Source
# File lib/action_dispatch/http/response.rb, line 181 def delete_header(key); headers.delete key; end
Source
# File lib/action_dispatch/http/response.rb, line 73 def each(&block) sending! x = @stream.each(&block) sent! x end
Source
# File lib/action_dispatch/http/response.rb, line 179 def get_header(key); headers[key]; end
Source
# File lib/action_dispatch/http/response.rb, line 178 def has_header?(key); headers.key? key; end
Source
# File lib/action_dispatch/http/response.rb, line 248 def media_type parsed_content_type_header.mime_type end
Media type of response.
Source
# File lib/action_dispatch/http/response.rb, line 297 def message Rack::Utils::HTTP_STATUS_CODES[@status] end
Returns the corresponding message for the current HTTP status code:
response.status = 200 response.message # => "OK" response.status = 404 response.message # => "Not Found"
Source
# File lib/action_dispatch/http/response.rb, line 353 def reset_body! @stream = build_buffer(self, []) end
Source
# File lib/action_dispatch/http/response.rb, line 280 def response_code @status end
The response code of the request.
Source
# File lib/action_dispatch/http/response.rb, line 348 def send_file(path) commit! @stream = FileBody.new(path) end
Send the file stored at path
as the response body.
Source
# File lib/action_dispatch/http/response.rb, line 201 def sending! synchronize do before_sending @sending = true @cv.broadcast end end
Source
# File lib/action_dispatch/http/response.rb, line 216 def sending?; synchronize { @sending }; end
Source
# File lib/action_dispatch/http/response.rb, line 252 def sending_file=(v) if true == v self.charset = false end end
Source
# File lib/action_dispatch/http/response.rb, line 209 def sent! synchronize do @sent = true @cv.broadcast end end
Source
# File lib/action_dispatch/http/response.rb, line 218 def sent?; synchronize { @sent }; end
Source
# File lib/action_dispatch/http/response.rb, line 180 def set_header(key, v); headers[key] = v; end
Source
# File lib/action_dispatch/http/response.rb, line 221 def status=(status) @status = Rack::Utils.status_code(status) end
Sets the HTTP status code.
Source
# File lib/action_dispatch/http/response.rb, line 385 def to_a commit! rack_response @status, @header.to_hash end
Turns the Response
into a Rack-compatible array of the status, headers, and body. Allows explicit splatting:
status, headers, body = *response
Source
# File lib/action_dispatch/http/response.rb, line 308 def write(string) @stream.write string end
Private Instance Methods
Source
# File lib/action_dispatch/http/response.rb, line 466 def assign_default_content_type_and_charset! return if media_type ct = parsed_content_type_header set_content_type(ct.mime_type || Mime[:html].to_s, ct.charset || self.class.default_charset) end
Source
# File lib/action_dispatch/http/response.rb, line 438 def before_committed return if committed? assign_default_content_type_and_charset! merge_and_normalize_cache_control!(@cache_control) handle_conditional_get! handle_no_content! end
Source
# File lib/action_dispatch/http/response.rb, line 446 def before_sending # Normally we've already committed by now, but it's possible # (e.g., if the controller action tries to read back its own # response) to get here before that. In that case, we must force # an "early" commit: we're about to freeze the headers, so this is # our last chance. commit! unless committed? headers.freeze request.commit_cookie_jar! unless committed? end
Source
# File lib/action_dispatch/http/response.rb, line 458 def build_buffer(response, body) Buffer.new response, body end
Source
# File lib/action_dispatch/http/response.rb, line 506 def handle_no_content! if NO_CONTENT_CODES.include?(@status) @header.delete CONTENT_TYPE @header.delete "Content-Length" end end
Source
# File lib/action_dispatch/http/response.rb, line 462 def munge_body_object(body) body.respond_to?(:each) ? body : [body] end
Source
# File lib/action_dispatch/http/response.rb, line 418 def parse_content_type(content_type) if content_type && match = CONTENT_TYPE_PARSER.match(content_type) ContentTypeHeader.new(match[:mime_type], match[:charset]) else NullContentTypeHeader end end
Source
# File lib/action_dispatch/http/response.rb, line 428 def parsed_content_type_header parse_content_type(get_header(CONTENT_TYPE)) end
Small internal convenience method to get the parsed version of the current content type header.
Source
# File lib/action_dispatch/http/response.rb, line 513 def rack_response(status, header) if NO_CONTENT_CODES.include?(status) [status, header, []] else [status, header, RackBody.new(self)] end end
Source
# File lib/action_dispatch/http/response.rb, line 432 def set_content_type(content_type, charset) type = content_type || "" type = "#{type}; charset=#{charset.to_s.downcase}" if charset set_header CONTENT_TYPE, type end