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::Session#get and ActionDispatch::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 < 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
# File lib/action_dispatch/http/response.rb, line 162 def self.create(status = 200, header = {}, body = [], default_headers: self.default_headers) header = merge_default_headers(header, default_headers) new status, header, body end
# File lib/action_dispatch/http/response.rb, line 167 def self.merge_default_headers(original, default) default.respond_to?(:merge) ? default.merge(original) : original end
# File lib/action_dispatch/http/response.rb, line 174 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
# File lib/action_dispatch/http/response.rb, line 95 def self.return_only_media_type_on_content_type ActiveSupport::Deprecation.warn( ".return_only_media_type_on_content_type is dreprecated with no replacement and will be removed in 6.2." ) end
# File lib/action_dispatch/http/response.rb, line 89 def self.return_only_media_type_on_content_type=(*) ActiveSupport::Deprecation.warn( ".return_only_media_type_on_content_type= is dreprecated with no replacement and will be removed in 6.2." ) end
Public Instance Methods
# File lib/action_dispatch/http/response.rb, line 383 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
# File lib/action_dispatch/http/response.rb, line 196 def await_commit synchronize do @cv.wait_until { @committed } end end
# File lib/action_dispatch/http/response.rb, line 202 def await_sent synchronize { @cv.wait_until { @sent } } end
Returns the content of the response as a string. This contains the contents of any calls to render
.
# File lib/action_dispatch/http/response.rb, line 317 def body @stream.body end
Allows you to manually set or override the response body.
# File lib/action_dispatch/http/response.rb, line 326 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
# File lib/action_dispatch/http/response.rb, line 370 def body_parts parts = [] @stream.each { |x| parts << x } parts 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.
# File lib/action_dispatch/http/response.rb, line 287 def charset header_info = parsed_content_type_header header_info.charset || self.class.default_charset 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'
# File lib/action_dispatch/http/response.rb, line 276 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
# File lib/action_dispatch/http/response.rb, line 379 def close stream.close if stream.respond_to?(:close) end
Returns a string to ensure compatibility with Net::HTTPResponse
.
# File lib/action_dispatch/http/response.rb, line 298 def code @status.to_s end
# File lib/action_dispatch/http/response.rb, line 206 def commit! synchronize do before_committed @committed = true @cv.broadcast end end
# File lib/action_dispatch/http/response.rb, line 230 def committed?; synchronize { @committed }; end
Content type of response.
# File lib/action_dispatch/http/response.rb, line 256 def content_type super.presence 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.
# File lib/action_dispatch/http/response.rb, line 246 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
# File lib/action_dispatch/http/response.rb, line 194 def delete_header(key); headers.delete key; end
# File lib/action_dispatch/http/response.rb, line 74 def each(&block) sending! x = @stream.each(&block) sent! x end
# File lib/action_dispatch/http/response.rb, line 192 def get_header(key); headers[key]; end
# File lib/action_dispatch/http/response.rb, line 191 def has_header?(key); headers.key? key; end
Media type of response.
# File lib/action_dispatch/http/response.rb, line 261 def media_type parsed_content_type_header.mime_type end
Returns the corresponding message for the current HTTP status code:
response.status = 200 response.message # => "OK" response.status = 404 response.message # => "Not Found"
# File lib/action_dispatch/http/response.rb, line 310 def message Rack::Utils::HTTP_STATUS_CODES[@status] end
# File lib/action_dispatch/http/response.rb, line 366 def reset_body! @stream = build_buffer(self, []) end
The response code of the request.
# File lib/action_dispatch/http/response.rb, line 293 def response_code @status end
Send the file stored at path
as the response body.
# File lib/action_dispatch/http/response.rb, line 361 def send_file(path) commit! @stream = FileBody.new(path) end
# File lib/action_dispatch/http/response.rb, line 214 def sending! synchronize do before_sending @sending = true @cv.broadcast end end
# File lib/action_dispatch/http/response.rb, line 229 def sending?; synchronize { @sending }; end
# File lib/action_dispatch/http/response.rb, line 265 def sending_file=(v) if true == v self.charset = false end end
# File lib/action_dispatch/http/response.rb, line 222 def sent! synchronize do @sent = true @cv.broadcast end end
# File lib/action_dispatch/http/response.rb, line 231 def sent?; synchronize { @sent }; end
# File lib/action_dispatch/http/response.rb, line 193 def set_header(key, v); headers[key] = v; end
Sets the HTTP status code.
# File lib/action_dispatch/http/response.rb, line 234 def status=(status) @status = Rack::Utils.status_code(status) end
Turns the Response
into a Rack-compatible array of the status, headers, and body. Allows explicit splatting:
status, headers, body = *response
# File lib/action_dispatch/http/response.rb, line 398 def to_a commit! rack_response @status, @header.to_hash end
# File lib/action_dispatch/http/response.rb, line 321 def write(string) @stream.write string end
Private Instance Methods
# File lib/action_dispatch/http/response.rb, line 479 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
# File lib/action_dispatch/http/response.rb, line 451 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
# File lib/action_dispatch/http/response.rb, line 459 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
# File lib/action_dispatch/http/response.rb, line 471 def build_buffer(response, body) Buffer.new response, body end
# File lib/action_dispatch/http/response.rb, line 523 def handle_no_content! if NO_CONTENT_CODES.include?(@status) @header.delete CONTENT_TYPE @header.delete "Content-Length" end end
# File lib/action_dispatch/http/response.rb, line 475 def munge_body_object(body) body.respond_to?(:each) ? body : [body] end
# File lib/action_dispatch/http/response.rb, line 431 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
Small internal convenience method to get the parsed version of the current content type header.
# File lib/action_dispatch/http/response.rb, line 441 def parsed_content_type_header parse_content_type(get_header(CONTENT_TYPE)) end
# File lib/action_dispatch/http/response.rb, line 530 def rack_response(status, header) if NO_CONTENT_CODES.include?(status) [status, header, []] else [status, header, RackBody.new(self)] end end
# File lib/action_dispatch/http/response.rb, line 445 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