Class: ActionDispatch::Response

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

Overview

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

Defined Under Namespace

Classes: Buffer, ContentTypeHeader, FileBody, Header, RackBody

Constant Summary collapse

CONTENT_TYPE = 
"Content-Type"
"Set-Cookie"
LOCATION = 
"Location"
NO_CONTENT_CODES = 
[100, 101, 102, 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, header = {}, body = []) {|_self| ... } ⇒ Response

Returns a new instance of Response.

Yields:

  • (_self)

Yield Parameters:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 163

def initialize(status = 200, header = {}, body = [])
  super()

  @header = Header.new(self, header)

  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

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

Get headers for this response.



68
69
70
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 68

def header
  @header
end

#request ⇒ Object

The request that the response is responding to.



62
63
64
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 62

def request
  @request
end

#status ⇒ Object

The HTTP status code.



65
66
67
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 65

def status
  @status
end

#stream ⇒ Object (readonly)

The underlying body, as a streamable object.



161
162
163
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 161

def stream
  @stream
end

Class Method Details

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



151
152
153
154
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 151

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

.merge_default_headers(original, default) ⇒ Object 



156
157
158
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 156

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

Instance Method Details

#abort ⇒ Object 



388
389
390
391
392
393
394
395
396
397
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 388

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 



185
186
187
188
189
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 185

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

#await_sent ⇒ Object 



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

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.



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

def body
  @stream.body
end

#body=(body) ⇒ Object

Allows you to manually set or override the response body.



331
332
333
334
335
336
337
338
339
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 331

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 



375
376
377
378
379
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 375

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.



292
293
294
295
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 292

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'



281
282
283
284
285
286
287
288
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 281

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 



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

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

#code ⇒ Object

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



303
304
305
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 303

def code
  @status.to_s
end

#commit! ⇒ Object 



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

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

#committed? ⇒ Boolean

Returns:

  • (Boolean) 


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

def committed?; synchronize { @committed }; end

#content_type ⇒ Object

Content type of response.



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 251

def content_type
  if self.class.return_only_media_type_on_content_type
    ActiveSupport::Deprecation.warn(
      "Rails 6.1 will return Content-Type header without modification." \
      " If you want just the MIME type, please use `#media_type` instead."
    )

    content_type = super
    content_type ? content_type.split(/;\s*charset=/)[0].presence : content_type
  else
    super.presence
  end
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.



241
242
243
244
245
246
247
248
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 241

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']



412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 412

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 



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

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

#each(&block) ⇒ Object 



74
75
76
77
78
79
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 74

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

#get_header(key) ⇒ Object 



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

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

#has_header?(key) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#media_type ⇒ Object

Media type of response.



266
267
268
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 266

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"



315
316
317
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 315

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

#reset_body! ⇒ Object 



371
372
373
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 371

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

#response_code ⇒ Object

The response code of the request.



298
299
300
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 298

def response_code
  @status
end

#send_file(path) ⇒ Object

Send the file stored at path as the response body.



366
367
368
369
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 366

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

#sending! ⇒ Object 



203
204
205
206
207
208
209
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 203

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

#sending? ⇒ Boolean

Returns:

  • (Boolean) 


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

def sending?;   synchronize { @sending };   end

#sending_file=(v) ⇒ Object 



270
271
272
273
274
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 270

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

#sent! ⇒ Object 



211
212
213
214
215
216
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 211

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

#sent? ⇒ Boolean

Returns:

  • (Boolean) 


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

def sent?;      synchronize { @sent };      end

#set_header(key, v) ⇒ Object 



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

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



403
404
405
406
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 403

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

#write(string) ⇒ Object 



326
327
328
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 326

def write(string)
  @stream.write string
end