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:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 113

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
  @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

#charset ⇒ Object

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.



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

def charset
  @charset
end

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



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

def content_type
  @content_type
end

#header ⇒ Object Also known as: headers

Get and set headers for this response.



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

def header
  @header
end

#request ⇒ Object

The request that the response is responding to.



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

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.



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

def sending_file=(value)
  @sending_file = value
end

#status ⇒ Object

The HTTP status code.



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

def status
  @status
end

#stream ⇒ Object (readonly)

The underlying body, as a streamable object.



111
112
113
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 111

def stream
  @stream
end

Instance Method Details

#_status_code ⇒ Object 



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

def _status_code
  @status
end

#await_commit ⇒ Object 



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

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

#await_sent ⇒ Object 



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

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

#body ⇒ Object

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



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

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.



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

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_parts ⇒ Object 



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

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

#close ⇒ Object 



270
271
272
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 270

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

#code ⇒ Object

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



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

def code
  @status.to_s
end

#commit! ⇒ Object 



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

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

#committed? ⇒ Boolean

Returns:

  • (Boolean) 


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

def committed?; synchronize { @committed }; end

#cookies ⇒ Object

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

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'actionpack/lib/action_dispatch/http/response.rb', line 285

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

#delete_cookie(key, value = {}) ⇒ Object 



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

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

#location ⇒ Object Also known as: redirect_url

The location header we’ll be responding with.



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

def location
  headers[LOCATION]
end

#location=(url) ⇒ Object

Sets the location header we’ll be responding with.



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

def location=(url)
  headers[LOCATION] = url
end

#message ⇒ Object 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"



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

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

#respond_to?(method, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#response_code ⇒ Object

The response code of the request.



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

def response_code
  @status
end

#sending! ⇒ Object 



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

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

#sending? ⇒ Boolean

Returns:

  • (Boolean) 


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

def sending?;   synchronize { @sending };   end

#sent! ⇒ Object 



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

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

#sent? ⇒ Boolean

Returns:

  • (Boolean) 


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

def sent?;      synchronize { @sent };      end

#set_cookie(key, value) ⇒ Object 



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

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

#to_a ⇒ Object Also known as: prepare!, to_ary

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



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

def to_a
  rack_response @status, @header.to_hash
end

#to_path ⇒ Object 



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

def to_path
  stream.to_path
end