Rack::Response
Represents an HTTP response generated by a controller action. One can use an ActionDispatch::Response object to retrieve the current state of the response, or customize the response. An Response object can either represent a “real” HTTP response (i.e. one that is meant to be sent back to the web browser) or a test response (i.e. one that is generated from integration tests). See CgiResponse and TestResponse, respectively.
Response is mostly a Ruby on Rails framework implement 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 100 100: def body 101: str = '' 102: each { |part| str << part.to_s } 103: str 104: end
# File lib/action_dispatch/http/response.rb, line 108 108: def body=(body) 109: @blank = true if body == EMPTY 110: @body = body.respond_to?(:to_str) ? [body] : body 111: end
# File lib/action_dispatch/http/response.rb, line 113 113: def body_parts 114: @body 115: end
Returns a String to ensure compatibility with Net::HTTPResponse
# File lib/action_dispatch/http/response.rb, line 79 79: def code 80: @status.to_s 81: end
# File lib/action_dispatch/http/response.rb, line 150 150: def each(&callback) 151: if @body.respond_to?(:call) 152: @writer = lambda { |x| callback.call(x) } 153: @body.call(self, self) 154: else 155: @body.each { |part| callback.call(part.to_s) } 156: end 157: 158: @writer = callback 159: @block.call(self) if @block 160: end
# File lib/action_dispatch/http/response.rb, line 117 117: def location 118: headers['Location'] 119: end
# File lib/action_dispatch/http/response.rb, line 122 122: def location=(url) 123: headers['Location'] = url 124: end
# File lib/action_dispatch/http/response.rb, line 83 83: def message 84: Rack::Utils::HTTP_STATUS_CODES[@status] 85: end
# File lib/action_dispatch/http/response.rb, line 88 88: def respond_to?(method) 89: if method.to_sym == :to_path 90: @body.respond_to?(:to_path) 91: else 92: super 93: end 94: end
The response code of the request
# File lib/action_dispatch/http/response.rb, line 74 74: def response_code 75: @status 76: end
# File lib/action_dispatch/http/response.rb, line 69 69: def status=(status) 70: @status = Rack::Utils.status_code(status) 71: end
# File lib/action_dispatch/http/response.rb, line 140 140: def to_a 141: assign_default_content_type_and_charset! 142: handle_conditional_get! 143: self["Set-Cookie"] = self["Set-Cookie"].join("\n") if self["Set-Cookie"].respond_to?(:join) 144: self["ETag"] = @_etag if @_etag 145: super 146: end
# File lib/action_dispatch/http/response.rb, line 186 186: def assign_default_content_type_and_charset! 187: return if headers[CONTENT_TYPE].present? 188: 189: @content_type ||= Mime::HTML 190: @charset ||= self.class.default_charset 191: 192: type = @content_type.to_s.dup 193: type << "; charset=#{@charset}" unless @sending_file 194: 195: headers[CONTENT_TYPE] = type 196: end
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.