123456789_123456789_123456789_123456789_123456789_

Class: ActionDispatch::Response

Relationships & Source Files
Namespace Children
Classes:
Extension / Inclusion / Inheritance Descendants
Subclasses:
ActionController::LiveTestResponse, TestResponse, ActionController::Live::Response
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, MonitorMixin, Http::Cache::Response, Http::FilterRedirect, Rack::Response::Helpers
Inherits: Object
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).

The Response object for the current request is exposed on controllers as ActionController::Metal#response. ::ActionController::Metal also provides a few additional methods that delegate to attributes of the Response such as ActionController::Metal#headers.

Integration tests will likely also want to inspect responses in more detail. Methods such as Integration::RequestHelpers#get and Integration::RequestHelpers#post return instances of TestResponse (which inherits from Response) for this purpose.

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

Constant Summary

Http::Cache::Response - Included

DATE, DEFAULT_CACHE_CONTROL, LAST_MODIFIED, MUST_REVALIDATE, NO_CACHE, NO_STORE, PRIVATE, PUBLIC, SPECIAL_KEYS

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

Http::Cache::Response - Included

#cache_control, #date, #date=, #date?,
#etag=

This method sets a weak ETag validator on the response so browsers and proxies may cache the response, keyed on the ETag.

#etag?, #last_modified, #last_modified=, #last_modified?, #strong_etag=,
#strong_etag?

True if an ETag is set, and it isn’t a weak validator (not preceded with W/).

#weak_etag=,
#weak_etag?

True if an ETag is set, and it’s a weak validator (preceded with W/).

Instance Method Summary

Constructor Details

.new(status = 200, headers = nil, body = []) {|_self| ... } ⇒ Response

Yields:

  • (_self)

Yield Parameters:

  • _self (Response)

    the object that the method was called on

[ GitHub ]

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

def initialize(status = 200, headers = nil, body = [])
  super()

  @headers = Headers.new

  headers&.each do |key, value|
    @headers[key] = value
  end

  self.body, self.status = body, status

  @cv           = new_cond
  @committed    = false
  @sending      = false
  @sent         = false

  prepare_cache_control!

  yield self if block_given?
end

Class Attribute Details

.default_charset (rw) Also known as: #default_charset

[ GitHub ]

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

cattr_accessor :default_charset, default: "utf-8"

.default_headers (rw) Also known as: #default_headers

[ GitHub ]

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

cattr_accessor :default_headers

Class Method Details

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

[ GitHub ]

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

def self.create(status = 200, headers = {}, body = [], default_headers: self.default_headers)
  headers = merge_default_headers(headers, default_headers)
  new status, headers, body
end

.merge_default_headers(original, default)

[ GitHub ]

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

def self.merge_default_headers(original, default)
  default.respond_to?(:merge) ? default.merge(original) : original
end

Instance Attribute Details

#body (rw)

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

[ GitHub ]

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

def body
  @stream.body
end

#body=(body) (rw)

Allows you to manually set or override the response body.

[ GitHub ]

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

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

#charset (rw)

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.

[ GitHub ]

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

def charset
  header_info = parsed_content_type_header
  header_info.charset || self.class.default_charset
end

#charset=(charset) (rw)

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'
[ GitHub ]

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

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

#committed?Boolean (readonly)

[ GitHub ]

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

def committed?; synchronize { @committed }; end

#content_type (rw)

Content type of response.

[ GitHub ]

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

def content_type
  super.presence
end

#content_type=(content_type) (rw)

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.

[ GitHub ]

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

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

#default_charset (rw)

[ GitHub ]

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

cattr_accessor :default_charset, default: "utf-8"

#default_headers (rw)

[ GitHub ]

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

cattr_accessor :default_headers

#header (readonly)

Alias for #headers.

[ GitHub ]

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

alias_method :header, :headers

#headers (readonly) Also known as: #header

The headers for the response.

header["Content-Type"] # => "text/plain"
header["Content-Type"] = "application/json"
header["Content-Type"] # => "application/json"

Also aliased as headers.

headers["Content-Type"] # => "text/plain"
headers["Content-Type"] = "application/json"
headers["Content-Type"] # => "application/json"

Also aliased as #header for compatibility.

[ GitHub ]

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

attr_reader :headers

#request (rw)

The request that the response is responding to.

[ GitHub ]

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

attr_accessor :request

#sending?Boolean (readonly)

[ GitHub ]

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

def sending?;   synchronize { @sending };   end

#sending_file=(v) (writeonly)

[ GitHub ]

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

def sending_file=(v)
  if true == v
    self.charset = false
  end
end

#sent?Boolean (readonly)

[ GitHub ]

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

def sent?;      synchronize { @sent };      end

#status (rw)

The HTTP status code.

[ GitHub ]

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

attr_reader :status

#status=(status) (rw)

Sets the HTTP status code.

[ GitHub ]

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

def status=(status)
  @status = Rack::Utils.status_code(status)
end

#stream (readonly)

The underlying body, as a streamable object.

[ GitHub ]

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

attr_reader :stream

Instance Method Details

#[]

[ GitHub ]

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

delegate :[], :[]=, to: :@headers

#[]=

[ GitHub ]

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

delegate :[], :[]=, to: :@headers

#_cache_control

Aliasing these off because AD::Http::Cache::Response defines them.

[ GitHub ]

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

alias :_cache_control :cache_control

#_cache_control=

[ GitHub ]

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

alias :_cache_control= :cache_control=

#abort

[ GitHub ]

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

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

[ GitHub ]

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

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

#await_sent

[ GitHub ]

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

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

#body_parts

[ GitHub ]

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

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

#close

[ GitHub ]

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

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

#code

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

[ GitHub ]

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

def code
  @status.to_s
end

#commit!

[ GitHub ]

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

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

#cookies

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

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

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

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

#delete_header(key)

[ GitHub ]

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

def delete_header(key); @headers.delete key; end

#each(&block)

[ GitHub ]

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

def each(&block)
  sending!
  x = @stream.each(&block)
  sent!
  x
end

#get_header(key)

[ GitHub ]

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

def get_header(key);    @headers[key];       end

#handle_no_content!

[ GitHub ]

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

def handle_no_content!
  if NO_CONTENT_CODES.include?(@status)
    @headers.delete CONTENT_TYPE
    @headers.delete "Content-Length"
  end
end

#has_header?(key) ⇒ Boolean

[ GitHub ]

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

def has_header?(key);   @headers.key? key;   end

#media_type

Media type of response.

[ GitHub ]

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

def media_type
  parsed_content_type_header.mime_type
end

#message 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"
[ GitHub ]

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

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

#prepare!

Alias for #to_a.

[ GitHub ]

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

alias prepare! to_a

#rack_response(status, headers)

[ GitHub ]

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

def rack_response(status, headers)
  if NO_CONTENT_CODES.include?(status)
    [status, headers, []]
  else
    [status, headers, RackBody.new(self)]
  end
end

#redirect_url

The location header we’ll be responding with.

[ GitHub ]

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

alias_method :redirect_url, :location

#reset_body!

[ GitHub ]

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

def reset_body!
  @stream = build_buffer(self, [])
end

#response_code

The response code of the request.

[ GitHub ]

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

def response_code
  @status
end

#send_file(path)

Send the file stored at path as the response body.

[ GitHub ]

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

def send_file(path)
  commit!
  @stream = FileBody.new(path)
end

#sending!

[ GitHub ]

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

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

#sent!

[ GitHub ]

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

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

#set_header(key, v)

[ GitHub ]

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

def set_header(key, v); @headers[key] = v;   end

#status_message

Alias for #message.

[ GitHub ]

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

alias_method :status_message, :message

#to_a Also known as: #prepare!

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

status, headers, body = *response
[ GitHub ]

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

def to_a
  commit!
  rack_response @status, @headers.to_hash
end

#write(string)

[ GitHub ]

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

def write(string)
  @stream.write string
end