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, 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, header = {}, body = []) {|_self| ... } ⇒ Response

Returns a new instance of Response.

Yields:

  • (_self)

Yield Parameters:


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

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

#headerObject (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

#requestObject

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

#statusObject

The HTTP status code.


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

def status
  @status
end

#streamObject (readonly)

The underlying body, as a streamable object.


172
173
174
# File 'actionpack/lib/action_dispatch/http/response.rb', line 172

def stream
  @stream
end

Class Method Details

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


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

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


167
168
169
# File 'actionpack/lib/action_dispatch/http/response.rb', line 167

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

.return_only_media_type_on_content_typeObject


95
96
97
98
99
# File 'actionpack/lib/action_dispatch/http/response.rb', line 95

def self.return_only_media_type_on_content_type
  ActiveSupport::Deprecation.warn(
    ".return_only_media_type_on_content_type is deprecated with no replacement and will be removed in 7.0."
  )
end

.return_only_media_type_on_content_type=Object


89
90
91
92
93
# File 'actionpack/lib/action_dispatch/http/response.rb', line 89

def self.return_only_media_type_on_content_type=(*)
  ActiveSupport::Deprecation.warn(
    ".return_only_media_type_on_content_type= is deprecated with no replacement and will be removed in 7.0."
  )
end

Instance Method Details

#abortObject


383
384
385
386
387
388
389
390
391
392
# File 'actionpack/lib/action_dispatch/http/response.rb', line 383

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_commitObject


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

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

#await_sentObject


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

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

#bodyObject

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


317
318
319
# File 'actionpack/lib/action_dispatch/http/response.rb', line 317

def body
  @stream.body
end

#body=(body) ⇒ Object

Allows you to manually set or override the response body.


326
327
328
329
330
331
332
333
334
# File 'actionpack/lib/action_dispatch/http/response.rb', line 326

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_partsObject


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

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

#charsetObject

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.


287
288
289
290
# File 'actionpack/lib/action_dispatch/http/response.rb', line 287

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'

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

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

#closeObject


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

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

#codeObject

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


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

def code
  @status.to_s
end

#commit!Object


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

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

#committed?Boolean

Returns:

  • (Boolean)

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

def committed?; synchronize { @committed }; end

#content_typeObject

Content type of response.


256
257
258
# File 'actionpack/lib/action_dispatch/http/response.rb', line 256

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.


246
247
248
249
250
251
252
253
# File 'actionpack/lib/action_dispatch/http/response.rb', line 246

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

#cookiesObject

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

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

407
408
409
410
411
412
413
414
415
416
417
418
419
# File 'actionpack/lib/action_dispatch/http/response.rb', line 407

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


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

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


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

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

#has_header?(key) ⇒ Boolean

Returns:

  • (Boolean)

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

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

#media_typeObject

Media type of response.


261
262
263
# File 'actionpack/lib/action_dispatch/http/response.rb', line 261

def media_type
  parsed_content_type_header.mime_type
end

#messageObject 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"

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

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

#reset_body!Object


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

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

#response_codeObject

The response code of the request.


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

def response_code
  @status
end

#send_file(path) ⇒ Object

Send the file stored at path as the response body.


361
362
363
364
# File 'actionpack/lib/action_dispatch/http/response.rb', line 361

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

#sending!Object


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

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

#sending?Boolean

Returns:

  • (Boolean)

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

def sending?;   synchronize { @sending };   end

#sending_file=(v) ⇒ Object


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

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

#sent!Object


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

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

#sent?Boolean

Returns:

  • (Boolean)

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

def sent?;      synchronize { @sent };      end

#set_header(key, v) ⇒ Object


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

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

#to_aObject 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

398
399
400
401
# File 'actionpack/lib/action_dispatch/http/response.rb', line 398

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

#write(string) ⇒ Object


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

def write(string)
  @stream.write string
end