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, RackBody

Constant Summary collapse

CONTENT_TYPE =
"Content-Type".freeze
"Set-Cookie".freeze
LOCATION =
"Location".freeze
NO_CONTENT_CODES =
[204, 304]
EMPTY =
" "

Constants included from Http::FilterRedirect

Http::FilterRedirect::FILTERED

Instance Attribute Summary collapse

Attributes included from Http::Cache::Response

#cache_control, #etag

Instance Method Summary collapse

Methods included from Http::Cache::Response

#date, #date=, #date?, #last_modified, #last_modified=, #last_modified?

Methods included from Http::FilterRedirect

#filtered_location

Constructor Details

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

Returns a new instance of Response.

Yields:

  • (_self)

Yield Parameters:


118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'actionpack/lib/action_dispatch/http/response.rb', line 118

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

  default_headers = options.fetch(:default_headers, self.class.default_headers)
  header = merge_default_headers(header, default_headers)

  self.body, self.header, self.status = body, header, status

  @sending_file = false
  @blank        = false
  @cv           = new_cond
  @committed    = false
  @sending      = false
  @sent         = false
  @content_type = nil
  @charset      = nil

  if content_type = self[CONTENT_TYPE]
    type, charset = content_type.split(/;\s*charset=/)
    @content_type = Mime::Type.lookup(type)
    @charset = charset || self.class.default_charset
  end

  prepare_cache_control!

  yield self if block_given?
end

Instance Attribute Details

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


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

def charset
  @charset
end

#content_typeObject

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.


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

def content_type
  @content_type
end

#headerObject Also known as: headers

Get and set headers for this response.


46
47
48
# File 'actionpack/lib/action_dispatch/http/response.rb', line 46

def header
  @header
end

#requestObject

The request that the response is responding to.


38
39
40
# File 'actionpack/lib/action_dispatch/http/response.rb', line 38

def request
  @request
end

#sending_file=(value) ⇒ Object (writeonly)

Sets the attribute sending_file

Parameters:

  • value

    the value to set the attribute sending_file to.


43
44
45
# File 'actionpack/lib/action_dispatch/http/response.rb', line 43

def sending_file=(value)
  @sending_file = value
end

#statusObject

The HTTP status code.


41
42
43
# File 'actionpack/lib/action_dispatch/http/response.rb', line 41

def status
  @status
end

#streamObject (readonly)

The underlying body, as a streamable object.


116
117
118
# File 'actionpack/lib/action_dispatch/http/response.rb', line 116

def stream
  @stream
end

Instance Method Details

#abortObject


268
269
270
271
272
273
274
275
276
277
# File 'actionpack/lib/action_dispatch/http/response.rb', line 268

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


146
147
148
149
150
# File 'actionpack/lib/action_dispatch/http/response.rb', line 146

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

#await_sentObject


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

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.


218
219
220
221
222
# File 'actionpack/lib/action_dispatch/http/response.rb', line 218

def body
  strings = []
  each { |part| strings << part.to_s }
  strings.join
end

#body=(body) ⇒ Object

Allows you to manually set or override the response body.


227
228
229
230
231
232
233
234
235
236
237
# File 'actionpack/lib/action_dispatch/http/response.rb', line 227

def body=(body)
  @blank = true if body == EMPTY

  if body.respond_to?(:to_path)
    @stream = body
  else
    synchronize do
      @stream = build_buffer self, munge_body_object(body)
    end
  end
end

#body_partsObject


239
240
241
242
243
# File 'actionpack/lib/action_dispatch/http/response.rb', line 239

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

#closeObject


264
265
266
# File 'actionpack/lib/action_dispatch/http/response.rb', line 264

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

#codeObject

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


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

def code
  @status.to_s
end

#commit!Object


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

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

#committed?Boolean

Returns:

  • (Boolean)

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

def committed?; synchronize { @committed }; end

#cookiesObject

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

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

305
306
307
308
309
310
311
312
313
314
315
316
317
# File 'actionpack/lib/action_dispatch/http/response.rb', line 305

def cookies
  cookies = {}
  if header = self[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

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

def delete_cookie(key, value={})
  ::Rack::Utils.delete_cookie_header!(header, key, value)
end

#locationObject Also known as: redirect_url

The location header we'll be responding with.


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

def location
  headers[LOCATION]
end

#location=(url) ⇒ Object

Sets the location header we'll be responding with.


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

def location=(url)
  headers[LOCATION] = url
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"

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

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

#response_codeObject

The response code of the request.


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

def response_code
  @status
end

#sending!Object


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

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

#sending?Boolean

Returns:

  • (Boolean)

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

def sending?;   synchronize { @sending };   end

#sent!Object


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

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

#sent?Boolean

Returns:

  • (Boolean)

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

def sent?;      synchronize { @sent };      end

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

def set_cookie(key, value)
  ::Rack::Utils.set_cookie_header!(header, key, value)
end

#to_aObject Also known as: prepare!

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

status, headers, body = *response

283
284
285
# File 'actionpack/lib/action_dispatch/http/response.rb', line 283

def to_a
  rack_response @status, @header.to_hash
end

#to_aryObject

Be super clear that a response object is not an Array. Defining this would make implicit splatting work, but it also makes adding responses as arrays work, and “flattening” responses, cascading to the rack body! Not sensible behavior.


292
293
294
295
296
297
298
299
300
# File 'actionpack/lib/action_dispatch/http/response.rb', line 292

def to_ary
  ActiveSupport::Deprecation.warn(<<-MSG.squish)
    `ActionDispatch::Response#to_ary` no longer performs implicit conversion
    to an array. Please use `response.to_a` instead, or a splat like `status,
    headers, body = *response`.
  MSG

  to_a
end