Class ActionController::Response
In: vendor/rails/actionpack/lib/action_controller/response.rb
Parent: Rack::Response

Represents an HTTP response generated by a controller action. One can use an ActionController::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 ActionController::Integration::Session#get and ActionController::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 < ActionController::IntegrationTest
   def test_print_root_path_to_console
     get('/')
     puts @response.body
   end
 end

Methods

Constants

DEFAULT_HEADERS = { "Cache-Control" => "no-cache" }

Attributes

assigns  [RW] 
layout  [RW] 
redirected_to  [RW] 
redirected_to_method_params  [RW] 
request  [RW] 
session  [RW] 
template  [RW] 

Public Class methods

[Source]

    # File vendor/rails/actionpack/lib/action_controller/response.rb, line 42
42:     def initialize
43:       @status = 200
44:       @header = Rack::Utils::HeaderHash.new(DEFAULT_HEADERS)
45: 
46:       @writer = lambda { |x| @body << x }
47:       @block = nil
48: 
49:       @body = "",
50:       @session = []
51:       @assigns = []
52:     end

Public Instance methods

[Source]

     # File vendor/rails/actionpack/lib/action_controller/response.rb, line 137
137:     def assign_default_content_type_and_charset!
138:       self.content_type ||= Mime::HTML
139:       self.charset ||= default_charset unless sending_file?
140:     end

[Source]

    # File vendor/rails/actionpack/lib/action_controller/response.rb, line 92
92:     def charset
93:       charset = String(headers["Content-Type"] || headers["type"]).split(";")[1]
94:       charset.blank? ? nil : charset.strip.split("=")[1]
95:     end

Set the charset of the Content-Type header. Set to nil to remove it. If no content type is set, it defaults to HTML.

[Source]

    # File vendor/rails/actionpack/lib/action_controller/response.rb, line 83
83:     def charset=(charset)
84:       headers["Content-Type"] =
85:         if charset
86:           "#{content_type || Mime::HTML}; charset=#{charset}"
87:         else
88:           content_type || Mime::HTML.to_s
89:         end
90:     end

Returns the response‘s content MIME type, or nil if content type has been set.

[Source]

    # File vendor/rails/actionpack/lib/action_controller/response.rb, line 76
76:     def content_type
77:       content_type = String(headers["Content-Type"] || headers["type"]).split(";")[0]
78:       content_type.blank? ? nil : content_type
79:     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 vendor/rails/actionpack/lib/action_controller/response.rb, line 66
66:     def content_type=(mime_type)
67:       self.headers["Content-Type"] =
68:         if mime_type =~ /charset/ || (c = charset).nil?
69:           mime_type.to_s
70:         else
71:           "#{mime_type}; charset=#{c}"
72:         end
73:     end

[Source]

     # File vendor/rails/actionpack/lib/action_controller/response.rb, line 151
151:     def each(&callback)
152:       if @body.respond_to?(:call)
153:         @writer = lambda { |x| callback.call(x) }
154:         @body.call(self, self)
155:       elsif @body.respond_to?(:to_str)
156:         yield @body
157:       else
158:         @body.each(&callback)
159:       end
160: 
161:       @writer = callback
162:       @block.call(self) if @block
163:     end

[Source]

     # File vendor/rails/actionpack/lib/action_controller/response.rb, line 111
111:     def etag
112:       headers['ETag']
113:     end

[Source]

     # File vendor/rails/actionpack/lib/action_controller/response.rb, line 119
119:     def etag=(etag)
120:       if etag.blank?
121:         headers.delete('ETag')
122:       else
123:         headers['ETag'] = %("#{Digest::MD5.hexdigest(ActiveSupport::Cache.expand_cache_key(etag))}")
124:       end
125:     end

[Source]

     # File vendor/rails/actionpack/lib/action_controller/response.rb, line 115
115:     def etag?
116:       headers.include?('ETag')
117:     end

[Source]

     # File vendor/rails/actionpack/lib/action_controller/response.rb, line 97
 97:     def last_modified
 98:       if last = headers['Last-Modified']
 99:         Time.httpdate(last)
100:       end
101:     end

[Source]

     # File vendor/rails/actionpack/lib/action_controller/response.rb, line 107
107:     def last_modified=(utc_time)
108:       headers['Last-Modified'] = utc_time.httpdate
109:     end

[Source]

     # File vendor/rails/actionpack/lib/action_controller/response.rb, line 103
103:     def last_modified?
104:       headers.include?('Last-Modified')
105:     end

[Source]

    # File vendor/rails/actionpack/lib/action_controller/response.rb, line 54
54:     def location; headers['Location'] end

[Source]

    # File vendor/rails/actionpack/lib/action_controller/response.rb, line 55
55:     def location=(url) headers['Location'] = url end

[Source]

     # File vendor/rails/actionpack/lib/action_controller/response.rb, line 142
142:     def prepare!
143:       assign_default_content_type_and_charset!
144:       handle_conditional_get!
145:       set_content_length!
146:       convert_content_type!
147:       convert_language!
148:       convert_cookies!
149:     end

[Source]

     # File vendor/rails/actionpack/lib/action_controller/response.rb, line 127
127:     def redirect(url, status)
128:       self.status = status
129:       self.location = url.gsub(/[\r\n]/, '')
130:       self.body = "<html><body>You are being <a href=\"#{CGI.escapeHTML(url)}\">redirected</a>.</body></html>"
131:     end

[Source]

     # File vendor/rails/actionpack/lib/action_controller/response.rb, line 133
133:     def sending_file?
134:       headers["Content-Transfer-Encoding"] == "binary"
135:     end

[Source]

     # File vendor/rails/actionpack/lib/action_controller/response.rb, line 176
176:     def set_cookie(key, value)
177:       if value.has_key?(:http_only)
178:         ActiveSupport::Deprecation.warn(
179:           "The :http_only option in ActionController::Response#set_cookie " +
180:           "has been renamed. Please use :httponly instead.", caller)
181:         value[:httponly] ||= value.delete(:http_only)
182:       end
183: 
184:       super(key, value)
185:     end

[Source]

     # File vendor/rails/actionpack/lib/action_controller/response.rb, line 165
165:     def write(str)
166:       @writer.call str.to_s
167:       str
168:     end

[Validate]