Class: ActionDispatch::Response

Inherits:
Object
  • Object
show all
Includes:
Http::Cache::Response, Http::FilterRedirect, MonitorMixin, Rack::Response::Helpers
Defined in:
lib/action_dispatch/http/response.rb

Overview

# Action Dispatch 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).

The Response object for the current request is exposed on controllers as ActionController::Metal#response. ActionController::Metal also provides a few additional methods that delegate to attributes of the Response such as ActionController::Metal#headers.

Integration tests will likely also want to inspect responses in more detail. Methods such as Integration::RequestHelpers#get and Integration::RequestHelpers#post return instances of TestResponse (which inherits from Response) for this purpose.

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

Defined Under Namespace

Classes: Buffer, ContentTypeHeader, FileBody, RackBody

Constant Summary collapse

Header =

To be deprecated:

Headers
CONTENT_TYPE = 
"Content-Type"
"Set-Cookie"
NO_CONTENT_CODES = 
[100, 101, 102, 103, 204, 205, 304]

Constants included from Http::FilterRedirect

Http::FilterRedirect::FILTERED

Instance Attribute Summary collapse

Attributes included from Http::Cache::Response

#cache_control

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Http::Cache::Response

#date, #date=, #date?, #etag=, #etag?, #last_modified, #last_modified=, #last_modified?, #strong_etag=, #strong_etag?, #weak_etag=, #weak_etag?

Methods included from Http::FilterRedirect

#filtered_location

Constructor Details

#initialize(status = 200, headers = nil, body = []) {|_self| ... } ⇒ Response

Returns a new instance of Response.

Yields:

  • (_self)

Yield Parameters:



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/action_dispatch/http/response.rb', line 171

def initialize(status = 200, headers = nil, body = [])
  super()

  @headers = Headers.new

  headers&.each do |key, value|
    @headers[key] = value
  end

  self.body, self.status = body, status

  @cv           = new_cond
  @committed    = false
  @sending      = false
  @sent         = false

  prepare_cache_control!

  yield self if block_given?
end

Instance Attribute Details

#headers ⇒ Object (readonly) Also known as: header

The headers for the response.

header["Content-Type"] # => "text/plain"
header["Content-Type"] = "application/json"
header["Content-Type"] # => "application/json"

Also aliased as ‘headers`.

headers["Content-Type"] # => "text/plain"
headers["Content-Type"] = "application/json"
headers["Content-Type"] # => "application/json"

Also aliased as ‘header` for compatibility.



71
72
73
 
# File 'lib/action_dispatch/http/response.rb', line 71

def headers
  @headers
end

#request ⇒ Object

The request that the response is responding to.



53
54
55
 
# File 'lib/action_dispatch/http/response.rb', line 53

def request
  @request
end

#status ⇒ Object

The HTTP status code.



56
57
58
 
# File 'lib/action_dispatch/http/response.rb', line 56

def status
  @status
end

#stream ⇒ Object (readonly)

The underlying body, as a streamable object.



169
170
171
 
# File 'lib/action_dispatch/http/response.rb', line 169

def stream
  @stream
end

Class Method Details

.create(status = 200, headers = {}, body = [], default_headers: self.default_headers) ⇒ Object 



159
160
161
162
 
# File 'lib/action_dispatch/http/response.rb', line 159

def self.create(status = 200, headers = {}, body = [], default_headers: self.default_headers)
  headers = merge_default_headers(headers, default_headers)
  new status, headers, body
end

.merge_default_headers(original, default) ⇒ Object 



164
165
166
 
# File 'lib/action_dispatch/http/response.rb', line 164

def self.merge_default_headers(original, default)
  default.respond_to?(:merge) ? default.merge(original) : original
end

Instance Method Details

#abort ⇒ Object 



396
397
398
399
400
401
402
403
404
 
# File 'lib/action_dispatch/http/response.rb', line 396

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

#await_commit ⇒ Object 



197
198
199
200
201
 
# File 'lib/action_dispatch/http/response.rb', line 197

def await_commit
  synchronize do
    @cv.wait_until { @committed }
  end
end

#await_sent ⇒ Object 



203
204
205
 
# File 'lib/action_dispatch/http/response.rb', line 203

def await_sent
  synchronize { @cv.wait_until { @sent } }
end

#body ⇒ Object

Returns the content of the response as a string. This contains the contents of any calls to ‘render`.



330
331
332
 
# File 'lib/action_dispatch/http/response.rb', line 330

def body
  @stream.body
end

#body=(body) ⇒ Object

Allows you to manually set or override the response body.



339
340
341
342
343
344
345
346
347
 
# File 'lib/action_dispatch/http/response.rb', line 339

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

#body_parts ⇒ Object 



383
384
385
386
387
 
# File 'lib/action_dispatch/http/response.rb', line 383

def body_parts
  parts = []
  @stream.each { |x| parts << x }
  parts
end

#charset ⇒ Object

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.



300
301
302
303
 
# File 'lib/action_dispatch/http/response.rb', line 300

def charset
  header_info = parsed_content_type_header
  header_info.charset || self.class.default_charset
end

#charset=(charset) ⇒ Object

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'



289
290
291
292
293
294
295
296
 
# File 'lib/action_dispatch/http/response.rb', line 289

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

#close ⇒ Object 



392
393
394
 
# File 'lib/action_dispatch/http/response.rb', line 392

def close
  stream.close if stream.respond_to?(:close)
end

#code ⇒ Object

Returns a string to ensure compatibility with ‘Net::HTTPResponse`.



311
312
313
 
# File 'lib/action_dispatch/http/response.rb', line 311

def code
  @status.to_s
end

#commit! ⇒ Object 



207
208
209
210
211
212
213
 
# File 'lib/action_dispatch/http/response.rb', line 207

def commit!
  synchronize do
    before_committed
    @committed = true
    @cv.broadcast
  end
end

#committed? ⇒ Boolean

Returns:

  • (Boolean) 


231
 
# File 'lib/action_dispatch/http/response.rb', line 231

def committed?; synchronize { @committed }; end

#content_type ⇒ Object

Content type of response.



269
270
271
 
# File 'lib/action_dispatch/http/response.rb', line 269

def content_type
  super.presence
end

#content_type=(content_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.



259
260
261
262
263
264
265
266
 
# File 'lib/action_dispatch/http/response.rb', line 259

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

#cookies ⇒ Object

Returns the response cookies, converted to a Hash of (name => value) pairs

assert_equal 'AuthorOfNewPage', r.cookies['author']



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/action_dispatch/http/response.rb', line 419

def cookies
  cookies = {}
  if header = get_header(SET_COOKIE)
    header = header.split("\n") if header.respond_to?(:to_str)
    header.each do |cookie|
      if pair = cookie.split(";").first
        key, value = pair.split("=").map { |v| Rack::Utils.unescape(v) }
        cookies[key] = value
      end
    end
  end
  cookies
end

#delete_header(key) ⇒ Object 



195
 
# File 'lib/action_dispatch/http/response.rb', line 195

def delete_header(key); @headers.delete key; end

#each(&block) ⇒ Object 



77
78
79
80
81
82
 
# File 'lib/action_dispatch/http/response.rb', line 77

def each(&block)
  sending!
  x = @stream.each(&block)
  sent!
  x
end

#get_header(key) ⇒ Object 



193
 
# File 'lib/action_dispatch/http/response.rb', line 193

def get_header(key);    @headers[key];       end

#has_header?(key) ⇒ Boolean

Returns:

  • (Boolean) 


192
 
# File 'lib/action_dispatch/http/response.rb', line 192

def has_header?(key);   @headers.key? key;   end

#media_type ⇒ Object

Media type of response.



274
275
276
 
# File 'lib/action_dispatch/http/response.rb', line 274

def media_type
  parsed_content_type_header.mime_type
end

#message ⇒ Object Also known as: status_message

Returns the corresponding message for the current HTTP status code:

response.status = 200
response.message # => "OK"

response.status = 404
response.message # => "Not Found"



323
324
325
 
# File 'lib/action_dispatch/http/response.rb', line 323

def message
  Rack::Utils::HTTP_STATUS_CODES[@status]
end

#reset_body! ⇒ Object 



379
380
381
 
# File 'lib/action_dispatch/http/response.rb', line 379

def reset_body!
  @stream = build_buffer(self, [])
end

#response_code ⇒ Object

The response code of the request.



306
307
308
 
# File 'lib/action_dispatch/http/response.rb', line 306

def response_code
  @status
end

#send_file(path) ⇒ Object

Send the file stored at ‘path` as the response body.



374
375
376
377
 
# File 'lib/action_dispatch/http/response.rb', line 374

def send_file(path)
  commit!
  @stream = FileBody.new(path)
end

#sending! ⇒ Object 



215
216
217
218
219
220
221
 
# File 'lib/action_dispatch/http/response.rb', line 215

def sending!
  synchronize do
    before_sending
    @sending = true
    @cv.broadcast
  end
end

#sending? ⇒ Boolean

Returns:

  • (Boolean) 


230
 
# File 'lib/action_dispatch/http/response.rb', line 230

def sending?;   synchronize { @sending };   end

#sending_file=(v) ⇒ Object 



278
279
280
281
282
 
# File 'lib/action_dispatch/http/response.rb', line 278

def sending_file=(v)
  if true == v
    self.charset = false
  end
end

#sent! ⇒ Object 



223
224
225
226
227
228
 
# File 'lib/action_dispatch/http/response.rb', line 223

def sent!
  synchronize do
    @sent = true
    @cv.broadcast
  end
end

#sent? ⇒ Boolean

Returns:

  • (Boolean) 


232
 
# File 'lib/action_dispatch/http/response.rb', line 232

def sent?;      synchronize { @sent };      end

#set_header(key, v) ⇒ Object 



194
 
# File 'lib/action_dispatch/http/response.rb', line 194

def set_header(key, v); @headers[key] = v;   end

#to_a ⇒ Object Also known as: prepare!

Turns the Response into a Rack-compatible array of the status, headers, and body. Allows explicit splatting:

status, headers, body = *response



410
411
412
413
 
# File 'lib/action_dispatch/http/response.rb', line 410

def to_a
  commit!
  rack_response @status, @headers.to_hash
end

#write(string) ⇒ Object 



334
335
336
 
# File 'lib/action_dispatch/http/response.rb', line 334

def write(string)
  @stream.write string
end