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

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

Returns a new instance of Response

Yields:

  • (_self)

Yield Parameters:


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# File 'actionpack/lib/action_dispatch/http/response.rb', line 109

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

  header = merge_default_headers(header, self.class.default_headers)

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

  @sending_file = false
  @blank        = false
  @cv           = new_cond
  @committed    = 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.


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

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.


59
60
61
# File 'actionpack/lib/action_dispatch/http/response.rb', line 59

def content_type
  @content_type
end

#headerObject Also known as: headers

Get and set headers for this response.


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

def header
  @header
end

#requestObject

The request that the response is responding to.


35
36
37
# File 'actionpack/lib/action_dispatch/http/response.rb', line 35

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.


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

def sending_file=(value)
  @sending_file = value
end

#statusObject

The HTTP status code.


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

def status
  @status
end

#streamObject (readonly)

The underlying body, as a streamable object.


107
108
109
# File 'actionpack/lib/action_dispatch/http/response.rb', line 107

def stream
  @stream
end

Instance Method Details

#await_commitObject


134
135
136
137
138
# File 'actionpack/lib/action_dispatch/http/response.rb', line 134

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

#bodyObject

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


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

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.


207
208
209
210
211
212
213
214
215
216
217
# File 'actionpack/lib/action_dispatch/http/response.rb', line 207

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


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

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

#closeObject


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

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

#codeObject

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


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

def code
  @status.to_s
end

#commit!Object


140
141
142
143
144
145
# File 'actionpack/lib/action_dispatch/http/response.rb', line 140

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

#committed?Boolean

Returns:

  • (Boolean)

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

def committed?
  @committed
end

#cookiesObject

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

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

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

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

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

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.


234
235
236
# File 'actionpack/lib/action_dispatch/http/response.rb', line 234

def location
  headers[LOCATION]
end

#location=(url) ⇒ Object

Sets the location header we'll be responding with.


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

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"

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

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

#respond_to?(method) ⇒ Boolean

Returns:

  • (Boolean)

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

def respond_to?(method)
  if method.to_s == 'to_path'
    stream.respond_to?(:to_path)
  else
    super
  end
end

#response_codeObject

The response code of the request.


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

def response_code
  @status
end

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

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

#to_aObject Also known as: prepare!, to_ary

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


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

def to_a
  rack_response @status, @header.to_hash
end

#to_pathObject


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

def to_path
  stream.to_path
end