Class: ActionController::Response

Inherits:
Rack::Response show all
Defined in:
lib/action_controller/response.rb

Overview

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

Direct Known Subclasses

TestResponse

Constant Summary collapse

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

Instance Attribute Summary collapse

Attributes inherited from Rack::Response

#body, #header, #length, #status

Attributes included from Rack::Response::Helpers

#headers, #original_headers

Instance Method Summary collapse

Methods inherited from Rack::Response

#[], #[]=, #close, #delete_cookie, #empty?, #finish

Methods included from Rack::Response::Helpers

#client_error?, #content_length, #empty?, #forbidden?, #include?, #informational?, #invalid?, #not_found?, #ok?, #redirect?, #redirection?, #server_error?, #successful?

Constructor Details

#initialize ⇒ Response

Returns a new instance of Response.



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/action_controller/response.rb', line 42

def initialize
  @status = 200
  @header = Rack::Utils::HeaderHash.new(DEFAULT_HEADERS)

  @writer = lambda { |x| @body << x }
  @block = nil

  @body = "",
  @session, @assigns = [], []
end

Instance Attribute Details

#assigns ⇒ Object

Returns the value of attribute assigns.



37
38
39
 
# File 'lib/action_controller/response.rb', line 37

def assigns
  @assigns
end

#layout ⇒ Object

Returns the value of attribute layout.



37
38
39
 
# File 'lib/action_controller/response.rb', line 37

def layout
  @layout
end

#redirected_to ⇒ Object

Returns the value of attribute redirected_to.



38
39
40
 
# File 'lib/action_controller/response.rb', line 38

def redirected_to
  @redirected_to
end

#redirected_to_method_params ⇒ Object

Returns the value of attribute redirected_to_method_params.



38
39
40
 
# File 'lib/action_controller/response.rb', line 38

def redirected_to_method_params
  @redirected_to_method_params
end

#request ⇒ Object

Returns the value of attribute request.



35
36
37
 
# File 'lib/action_controller/response.rb', line 35

def request
  @request
end

#session ⇒ Object

Returns the value of attribute session.



37
38
39
 
# File 'lib/action_controller/response.rb', line 37

def session
  @session
end

#template ⇒ Object

Returns the value of attribute template.



37
38
39
 
# File 'lib/action_controller/response.rb', line 37

def template
  @template
end

Instance Method Details

#assign_default_content_type_and_charset! ⇒ Object 



136
137
138
139
 
# File 'lib/action_controller/response.rb', line 136

def assign_default_content_type_and_charset!
  self.content_type ||= Mime::HTML
  self.charset ||= default_charset unless sending_file?
end

#charset ⇒ Object 



91
92
93
94
 
# File 'lib/action_controller/response.rb', line 91

def charset
  charset = String(headers["Content-Type"] || headers["type"]).split(";")[1]
  charset.blank? ? nil : charset.strip.split("=")[1]
end

#charset=(charset) ⇒ Object

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



82
83
84
85
86
87
88
89
 
# File 'lib/action_controller/response.rb', line 82

def charset=(charset)
  headers["Content-Type"] =
    if charset
      "#{content_type || Mime::HTML}; charset=#{charset}"
    else
      content_type || Mime::HTML.to_s
    end
end

#content_type ⇒ Object

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



75
76
77
78
 
# File 'lib/action_controller/response.rb', line 75

def content_type
  content_type = String(headers["Content-Type"] || headers["type"]).split(";")[0]
  content_type.blank? ? nil : content_type
end

#content_type=(mime_type) ⇒ Object

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.



65
66
67
68
69
70
71
72
 
# File 'lib/action_controller/response.rb', line 65

def content_type=(mime_type)
  self.headers["Content-Type"] =
    if mime_type =~ /charset/ || (c = charset).nil?
      mime_type.to_s
    else
      "#{mime_type}; charset=#{c}"
    end
end

#each(&callback) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/action_controller/response.rb', line 150

def each(&callback)
  if @body.respond_to?(:call)
    @writer = lambda { |x| callback.call(x) }
    @body.call(self, self)
  elsif @body.is_a?(String)
    @body.each_line(&callback)
  else
    @body.each(&callback)
  end

  @writer = callback
  @block.call(self) if @block
end

#etag ⇒ Object 



110
111
112
 
# File 'lib/action_controller/response.rb', line 110

def etag
  headers['ETag']
end

#etag=(etag) ⇒ Object 



118
119
120
121
122
123
124
 
# File 'lib/action_controller/response.rb', line 118

def etag=(etag)
  if etag.blank?
    headers.delete('ETag')
  else
    headers['ETag'] = %("#{Digest::MD5.hexdigest(ActiveSupport::Cache.expand_cache_key(etag))}")
  end
end

#etag? ⇒ Boolean

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/action_controller/response.rb', line 114

def etag?
  headers.include?('ETag')
end

#last_modified ⇒ Object 



96
97
98
99
100
 
# File 'lib/action_controller/response.rb', line 96

def last_modified
  if last = headers['Last-Modified']
    Time.httpdate(last)
  end
end

#last_modified=(utc_time) ⇒ Object 



106
107
108
 
# File 'lib/action_controller/response.rb', line 106

def last_modified=(utc_time)
  headers['Last-Modified'] = utc_time.httpdate
end

#last_modified? ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/action_controller/response.rb', line 102

def last_modified?
  headers.include?('Last-Modified')
end

#location ⇒ Object 



53
 
# File 'lib/action_controller/response.rb', line 53

def location; headers['Location'] end

#location=(url) ⇒ Object 



54
 
# File 'lib/action_controller/response.rb', line 54

def location=(url) headers['Location'] = url end

#prepare! ⇒ Object 



141
142
143
144
145
146
147
148
 
# File 'lib/action_controller/response.rb', line 141

def prepare!
  assign_default_content_type_and_charset!
  handle_conditional_get!
  set_content_length!
  convert_content_type!
  convert_language!
  convert_cookies!
end

#redirect(url, status) ⇒ Object 



126
127
128
129
130
 
# File 'lib/action_controller/response.rb', line 126

def redirect(url, status)
  self.status = status
  self.location = url.gsub(/[\r\n]/, '')
  self.body = "<html><body>You are being <a href=\"#{CGI.escapeHTML(url)}\">redirected</a>.</body></html>"
end

#sending_file? ⇒ Boolean

Returns:

  • (Boolean) 


132
133
134
 
# File 'lib/action_controller/response.rb', line 132

def sending_file?
  headers["Content-Transfer-Encoding"] == "binary"
end

#set_cookie(key, value) ⇒ Object 



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/action_controller/response.rb', line 169

def set_cookie(key, value)
  if value.has_key?(:http_only)
    ActiveSupport::Deprecation.warn(
      "The :http_only option in ActionController::Response#set_cookie " +
      "has been renamed. Please use :httponly instead.", caller)
    value[:httponly] ||= value.delete(:http_only)
  end

  super(key, value)
end

#write(str) ⇒ Object 



164
165
166
167
 
# File 'lib/action_controller/response.rb', line 164

def write(str)
  @writer.call str.to_s
  str
end