123456789_123456789_123456789_123456789_123456789_

Class: ActionDispatch::Response

Relationships & Source Files
Namespace Children
Classes:
ContentTypeHeader, RackBody
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).

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

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, header = {}, 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 174



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


  







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, header = {}, body = [], default_headers: self.default_headers)  
  

  [ GitHub ]


  

  


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



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)  
  

  [ GitHub ]


  

  


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



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


  








  

    .return_only_media_type_on_content_type  
  

  [ GitHub ]


  

  


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



def self.return_only_media_type_on_content_type
  ActiveSupport::Deprecation.warn(
    ".return_only_media_type_on_content_type is dreprecated with no replacement and will be removed in 7.0."
  )
end


  








  

    .return_only_media_type_on_content_type=  
  

  [ GitHub ]


  

  


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



def self.return_only_media_type_on_content_type=(*)
  ActiveSupport::Deprecation.warn(
    ".return_only_media_type_on_content_type= is dreprecated with no replacement and will be removed in 7.0."
  )
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 317



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 326



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 287



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 276



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 230



def committed?; synchronize { @committed }; end


  








  

    #content_type   (rw)
  



  

    

Content type of response.


  



  [ GitHub ]


  

  


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



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 246



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)
    Also known as: #headers
  



  

    

Get headers for this response.


  



  [ GitHub ]


  

  


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



attr_reader :header


  








  

    #headers   (readonly)
  



  

    

Alias for #header.


  



  [ GitHub ]


  

  


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



alias_method :headers,  :header


  








  

    #request   (rw)
  



  

    

The request that the response is responding to.


  



  [ GitHub ]


  

  


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



attr_accessor :request


  








  

    #sending?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


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



def sending?;   synchronize { @sending };   end


  








  

    #sending_file=(v)   (writeonly)
  

  [ GitHub ]


  

  


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



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 231



def sent?;      synchronize { @sent };      end


  








  

    #status   (rw)
  



  

    

The HTTP status code.


  



  [ GitHub ]


  

  


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



attr_reader :status


  








  

    #status=(status)   (rw)
  



  

    

Sets the HTTP status code.


  



  [ GitHub ]


  

  


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



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 172



attr_reader :stream


  







Instance Method Details



  

    #[]  
  

  [ GitHub ]


  

  


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



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


  








  

    #[]=  
  

  [ GitHub ]


  

  


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



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


  








  

    #_cache_control  
  



  

    

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


  



  [ GitHub ]


  

  


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



alias :_cache_control :cache_control


  








  

    #_cache_control=  
  

  [ GitHub ]


  

  


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



alias :_cache_control= :cache_control=


  








  

    #abort  
  

  [ GitHub ]


  

  


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



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 196



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


  








  

    #await_sent  
  

  [ GitHub ]


  

  


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



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


  








  

    #body_parts  
  

  [ GitHub ]


  

  


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



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


  








  

    #close  
  

  [ GitHub ]


  

  


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



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 298



def code
  @status.to_s
end


  








  

    #commit!  
  

  [ GitHub ]


  

  


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



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 407



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 194



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


  








  

    #each(&block)  
  

  [ GitHub ]


  

  


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



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


  








  

    #get_header(key)  
  

  [ GitHub ]


  

  


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



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


  








  

    #handle_no_content!  
  

  [ GitHub ]


  

  


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



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


  








  

    #has_header?(key)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


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



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


  








  

    #media_type  
  



  

    

Media type of response.


  



  [ GitHub ]


  

  


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



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 310



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


  








  

    #prepare!  
  



  

    

Alias for #to_a.


  



  [ GitHub ]


  

  


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



alias prepare! to_a


  








  

    #rack_response(status, header)  
  

  [ GitHub ]


  

  


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



def rack_response(status, header)
  if NO_CONTENT_CODES.include?(status)
    [status, header, []]
  else
    [status, header, 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 377



alias_method :redirect_url, :location


  








  

    #reset_body!  
  

  [ GitHub ]


  

  


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



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 293



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 361



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


  








  

    #sending!  
  

  [ GitHub ]


  

  


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



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


  








  

    #sent!  
  

  [ GitHub ]


  

  


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



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


  








  

    #set_header(key, v)  
  

  [ GitHub ]


  

  


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



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


  








  

    #status_message  
  



  

    

Alias for #message.


  



  [ GitHub ]


  

  


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



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 398



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


  








  

    #write(string)  
  

  [ GitHub ]


  

  


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



def write(string)
  @stream.write string
end