Object
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
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.
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 65 65: def initialize(status = 200, header = {}, body = []) 66: self.body, self.header, self.status = body, header, status 67: 68: @sending_file = false 69: @blank = false 70: 71: if content_type = self[CONTENT_TYPE] 72: type, charset = content_type.split(/;\s*charset=/) 73: @content_type = Mime::Type.lookup(type) 74: @charset = charset || self.class.default_charset 75: end 76: 77: prepare_cache_control! 78: 79: yield self if block_given? 80: end
# File lib/action_dispatch/http/response.rb, line 113 113: def body 114: strings = [] 115: each { |part| strings << part.to_s } 116: strings.join 117: end
# File lib/action_dispatch/http/response.rb, line 121 121: def body=(body) 122: @blank = true if body == EMPTY 123: 124: # Explicitly check for strings. This is *wrong* theoretically 125: # but if we don't check this, the performance on string bodies 126: # is bad on Ruby 1.8 (because strings responds to each then). 127: @body = if body.respond_to?(:to_str) || !body.respond_to?(:each) 128: [body] 129: else 130: body 131: end 132: end
# File lib/action_dispatch/http/response.rb, line 134 134: def body_parts 135: @body 136: end
# File lib/action_dispatch/http/response.rb, line 155 155: def close 156: @body.close if @body.respond_to?(:close) 157: end
Returns a String to ensure compatibility with Net::HTTPResponse
# File lib/action_dispatch/http/response.rb, line 92 92: def code 93: @status.to_s 94: end
# File lib/action_dispatch/http/response.rb, line 146 146: def location 147: headers[LOCATION] 148: end
# File lib/action_dispatch/http/response.rb, line 151 151: def location=(url) 152: headers[LOCATION] = url 153: end
# File lib/action_dispatch/http/response.rb, line 96 96: def message 97: Rack::Utils::HTTP_STATUS_CODES[@status] 98: end
# File lib/action_dispatch/http/response.rb, line 101 101: def respond_to?(method) 102: if method.to_sym == :to_path 103: @body.respond_to?(:to_path) 104: else 105: super 106: end 107: end
The response code of the request
# File lib/action_dispatch/http/response.rb, line 87 87: def response_code 88: @status 89: end
# File lib/action_dispatch/http/response.rb, line 82 82: def status=(status) 83: @status = Rack::Utils.status_code(status) 84: end
# File lib/action_dispatch/http/response.rb, line 159 159: def to_a 160: assign_default_content_type_and_charset! 161: handle_conditional_get! 162: 163: @header[SET_COOKIE] = @header[SET_COOKIE].join("\n") if @header[SET_COOKIE].respond_to?(:join) 164: 165: if [204, 304].include?(@status) 166: @header.delete CONTENT_TYPE 167: [@status, @header, []] 168: else 169: [@status, @header, self] 170: end 171: end
# File lib/action_dispatch/http/response.rb, line 194 194: def assign_default_content_type_and_charset! 195: return if headers[CONTENT_TYPE].present? 196: 197: @content_type ||= Mime::HTML 198: @charset ||= self.class.default_charset 199: 200: type = @content_type.to_s.dup 201: type << "; charset=#{@charset}" unless @sending_file 202: 203: headers[CONTENT_TYPE] = type 204: end
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.