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:


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

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.


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

def stream
  @stream
end

Class Method Details

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


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

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


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

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

Instance Method Details

#abortObject


371
372
373
374
375
376
377
378
379
380
# File 'actionpack/lib/action_dispatch/http/response.rb', line 371

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


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

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

#await_sentObject


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

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.


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

def body
  @stream.body
end

#body=(body) ⇒ Object

Allows you to manually set or override the response body.


314
315
316
317
318
319
320
321
322
# File 'actionpack/lib/action_dispatch/http/response.rb', line 314

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


358
359
360
361
362
# File 'actionpack/lib/action_dispatch/http/response.rb', line 358

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.


275
276
277
278
# File 'actionpack/lib/action_dispatch/http/response.rb', line 275

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'

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

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


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

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

#codeObject

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


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

def code
  @status.to_s
end

#commit!Object


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

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

#committed?Boolean

Returns:

  • (Boolean)

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

def committed?; synchronize { @committed }; end

#content_typeObject

Content type of response.


244
245
246
# File 'actionpack/lib/action_dispatch/http/response.rb', line 244

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.


234
235
236
237
238
239
240
241
# File 'actionpack/lib/action_dispatch/http/response.rb', line 234

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

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

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


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

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


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

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

#has_header?(key) ⇒ Boolean

Returns:

  • (Boolean)

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

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

#media_typeObject

Media type of response.


249
250
251
# File 'actionpack/lib/action_dispatch/http/response.rb', line 249

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"

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

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

#reset_body!Object


354
355
356
# File 'actionpack/lib/action_dispatch/http/response.rb', line 354

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

#response_codeObject

The response code of the request.


281
282
283
# File 'actionpack/lib/action_dispatch/http/response.rb', line 281

def response_code
  @status
end

#send_file(path) ⇒ Object

Send the file stored at path as the response body.


349
350
351
352
# File 'actionpack/lib/action_dispatch/http/response.rb', line 349

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

#sending!Object


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

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

#sending?Boolean

Returns:

  • (Boolean)

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

def sending?;   synchronize { @sending };   end

#sending_file=(v) ⇒ Object


253
254
255
256
257
# File 'actionpack/lib/action_dispatch/http/response.rb', line 253

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

#sent!Object


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

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

#sent?Boolean

Returns:

  • (Boolean)

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

def sent?;      synchronize { @sent };      end

#set_header(key, v) ⇒ Object


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

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

386
387
388
389
# File 'actionpack/lib/action_dispatch/http/response.rb', line 386

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

#write(string) ⇒ Object


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

def write(string)
  @stream.write string
end