W3cubDocs

class ActionDispatch::Response

Parent:: Object
Included modules:: ActionDispatch::Http::FilterRedirect, ActionDispatch::Http::Cache::Response

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 #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::RequestHelpers#get and ActionDispatch::Integration::RequestHelpers#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

Constants

CONTENT_TYPE
ContentTypeHeader
LOCATION
NO_CONTENT_CODES
NullContentTypeHeader
SET_COOKIE

Attributes

header[R]

Get headers for this response.

headers[R]

Get headers for this response.

request[RW]

The request that the response is responding to.

status[R]

The HTTP status code.

stream[R]

The underlying body, as a streamable object.

Public Class Methods

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

# File actionpack/lib/action_dispatch/http/response.rb, line 153
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) Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 158
def self.merge_default_headers(original, default)
  default.respond_to?(:merge) ? default.merge(original) : original
end

new(status = 200, header = {}, body = []) { |self| ... } Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 165
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

Calls superclass method

Public Instance Methods

abort() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 384
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_commit() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 187
def await_commit
  synchronize do
    @cv.wait_until { @committed }
  end
end

await_sent() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 193
def await_sent
  synchronize { @cv.wait_until { @sent } }
end

body() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 318
def body
  @stream.body
end

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

body=(body) Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 327
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

Allows you to manually set or override the response body.

body_parts() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 371
def body_parts
  parts = []
  @stream.each { |x| parts << x }
  parts
end

charset() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 288
def charset
  header_info = parsed_content_type_header
  header_info.charset || self.class.default_charset
end

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.

charset=(charset) Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 277
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

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'

close() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 380
def close
  stream.close if stream.respond_to?(:close)
end

code() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 299
def code
  @status.to_s
end

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

commit!() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 197
def commit!
  synchronize do
    before_committed
    @committed = true
    @cv.broadcast
  end
end

committed?() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 221
def committed?; synchronize { @committed }; end

content_type() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 247
def content_type
  if self.class.return_only_media_type_on_content_type
    ActiveSupport::Deprecation.warn(
      "Rails 6.1 will return Content-Type header without modification." \
      " If you want just the MIME type, please use `#media_type` instead."
    )

    content_type = super
    content_type ? content_type.split(/;\s*charset=/)[0].presence : content_type
  else
    super.presence
  end
end

Content type of response.

Calls superclass method

content_type=(content_type) Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 237
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

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.

cookies() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 408
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

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

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

delete_header(key) Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 185
def delete_header(key); headers.delete key; end

each(&block) Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 74
def each(&block)
  sending!
  x = @stream.each(&block)
  sent!
  x
end

get_header(key) Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 183
def get_header(key);    headers[key];       end

has_header?(key) Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 182
def has_header?(key);   headers.key? key;   end

media_type() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 262
def media_type
  parsed_content_type_header.mime_type
end

Media type of response.

message() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 311
def message
  Rack::Utils::HTTP_STATUS_CODES[@status]
end

Returns the corresponding message for the current HTTP status code:

response.status = 200
response.message # => "OK"

response.status = 404
response.message # => "Not Found"

Also aliased as: status_message

prepare!()

Alias for: to_a

reset_body!() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 367
def reset_body!
  @stream = build_buffer(self, [])
end

response_code() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 294
def response_code
  @status
end

The response code of the request.

send_file(path) Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 362
def send_file(path)
  commit!
  @stream = FileBody.new(path)
end

Send the file stored at path as the response body.

sending!() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 205
def sending!
  synchronize do
    before_sending
    @sending = true
    @cv.broadcast
  end
end

sending?() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 220
def sending?;   synchronize { @sending };   end

sending_file=(v) Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 266
def sending_file=(v)
  if true == v
    self.charset = false
  end
end

sent!() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 213
def sent!
  synchronize do
    @sent = true
    @cv.broadcast
  end
end

sent?() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 222
def sent?;      synchronize { @sent };      end

set_header(key, v) Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 184
def set_header(key, v); headers[key] = v;   end

status=(status) Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 225
def status=(status)
  @status = Rack::Utils.status_code(status)
end

Sets the HTTP status code.

status_message()

Alias for: message

to_a() Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 399
def to_a
  commit!
  rack_response @status, @header.to_hash
end

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

status, headers, body = *response

Also aliased as: prepare!

write(string) Show source

# File actionpack/lib/action_dispatch/http/response.rb, line 322
def write(string)
  @stream.write string
end