Class: ActionDispatch::Response

Inherits:
Object
  • Object
show all
Includes:
Http::Cache::Response, Http::FilterRedirect, MonitorMixin, Rack::Response::Helpers
Defined in:
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:


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/action_dispatch/http/response.rb', line 98

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

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.


52
53
54
# File 'lib/action_dispatch/http/response.rb', line 52

def charset
  @charset
end

#content_typeObject

Returns the value of attribute content_type


53
54
55
# File 'lib/action_dispatch/http/response.rb', line 53

def content_type
  @content_type
end

#headerObject Also known as: headers

Returns the value of attribute header


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

def header
  @header
end

#requestObject

Returns the value of attribute request


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

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.


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

def sending_file=(value)
  @sending_file = value
end

#statusObject

Returns the value of attribute status


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

def status
  @status
end

#streamObject (readonly)

Returns the value of attribute stream


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

def stream
  @stream
end

Instance Method Details

#await_commitObject


123
124
125
126
127
# File 'lib/action_dispatch/http/response.rb', line 123

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.


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

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.


195
196
197
198
199
200
201
202
203
204
205
# File 'lib/action_dispatch/http/response.rb', line 195

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


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

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

#closeObject


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

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

#codeObject

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


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

def code
  @status.to_s
end

#commit!Object


129
130
131
132
133
134
# File 'lib/action_dispatch/http/response.rb', line 129

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

#committed?Boolean

Returns:

  • (Boolean)

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

def committed?
  @committed
end

#cookiesObject

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

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

243
244
245
246
247
248
249
250
251
252
253
254
255
# File 'lib/action_dispatch/http/response.rb', line 243

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

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

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

#locationObject Also known as: redirect_url


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

def location
  headers[LOCATION]
end

#location=(url) ⇒ Object


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

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"

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

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

#respond_to?(method) ⇒ Boolean

Returns:

  • (Boolean)

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

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.


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

def response_code
  @status
end

213
214
215
# File 'lib/action_dispatch/http/response.rb', line 213

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

#to_aObject Also known as: prepare!, to_ary


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

def to_a
  rack_response @status, @header.to_hash
end

#to_pathObject


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

def to_path
  stream.to_path
end