class ActionDispatch::Response - actionpack-4.2.3 Documentation

# class ActionDispatch::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 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::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
EMPTY
LOCATION
NO_CONTENT_CODES
SET_COOKIE

### Attributes

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.

content_type[R]

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.

header[RW]

Get and set headers for this response.

headers=[RW]

Get and set headers for this response.

request[RW]

The request that the response is responding to.

sending_file[W]
status[R]

The HTTP status code.

stream[R]

The underlying body, as a streamable object.

### Public Class Methods

new(status = 200, header = {}, body = [], options = {}) { |self| ... } click to toggle source
Calls superclass method

    # File lib/action_dispatch/http/response.rb, line 118
    def initialize(status = 200, header = {}, body = [], options = {})
      super()

      default_headers = options.fetch(:default_headers, self.class.default_headers)
      header = merge_default_headers(header, 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

### Public Instance Methods

abort() click to toggle source

    # File lib/action_dispatch/http/response.rb, line 268
    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() click to toggle source

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

await_sent() click to toggle source

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

body() click to toggle source

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

    # File lib/action_dispatch/http/response.rb, line 218
    def body
      strings = []
      each { |part| strings << part.to_s }
      strings.join
    end

body=(body) click to toggle source

Allows you to manually set or override the response body.

    # File lib/action_dispatch/http/response.rb, line 227
    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() click to toggle source

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

close() click to toggle source

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

code() click to toggle source

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

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

commit!() click to toggle source

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

committed?() click to toggle source

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

content_type=(content_type) click to toggle source

Sets the HTTP content type.

    # File lib/action_dispatch/http/response.rb, line 189
    def content_type=(content_type)
      @content_type = content_type.to_s
    end

cookies() click to toggle source

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

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

    # File lib/action_dispatch/http/response.rb, line 305
    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={}) click to toggle source

    # File lib/action_dispatch/http/response.rb, line 249
    def delete_cookie(key, value={})
      ::Rack::Utils.delete_cookie_header!(header, key, value)
    end

location() click to toggle source

The location header we'll be responding with.

    # File lib/action_dispatch/http/response.rb, line 254
    def location
      headers[LOCATION]
    end

Also aliased as: redirect_url
location=(url) click to toggle source

Sets the location header we'll be responding with.

    # File lib/action_dispatch/http/response.rb, line 260
    def location=(url)
      headers[LOCATION] = url
    end

message() click to toggle source

Returns the corresponding message for the current HTTP status code:

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

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

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

Also aliased as: status_message
prepare!()
Alias for: to_a
redirect_url()
Alias for: location
response_code() click to toggle source

The response code of the request.

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

sending!() click to toggle source

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

sending?() click to toggle source

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

sent!() click to toggle source

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

sent?() click to toggle source

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

set_cookie(key, value) click to toggle source

    # File lib/action_dispatch/http/response.rb, line 245
    def set_cookie(key, value)
      ::Rack::Utils.set_cookie_header!(header, key, value)
    end

status=(status) click to toggle source

Sets the HTTP status code.

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

status_message()
Alias for: message
to_a() click to toggle source

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

    status, headers, body = *response

    # File lib/action_dispatch/http/response.rb, line 283
    def to_a
      rack_response @status, @header.to_hash
    end

Also aliased as: prepare!
to_ary() click to toggle source

Be super clear that a response object is not an Array. Defining this would make implicit splatting work, but it also makes adding responses as arrays work, and “flattening” responses, cascading to the rack body! Not sensible behavior.

    # File lib/action_dispatch/http/response.rb, line 292
        def to_ary
          ActiveSupport::Deprecation.warn("        `ActionDispatch::Response#to_ary` no longer performs implicit conversion
            to an array. Please use `response.to_a` instead, or a splat like `status,
            headers, body = *response`.
    ".squish)

          to_a
        end

### Private Instance Methods

append_charset?() click to toggle source

    # File lib/action_dispatch/http/response.rb, line 351
    def append_charset?
      !@sending_file && @charset != false
    end

assign_default_content_type_and_charset!(headers) click to toggle source

    # File lib/action_dispatch/http/response.rb, line 339
    def assign_default_content_type_and_charset!(headers)
      return if headers[CONTENT_TYPE].present?

      @content_type ||= Mime::HTML
      @charset      ||= self.class.default_charset unless @charset == false

      type = @content_type.to_s.dup
      type << "; charset=#{@charset}" if append_charset?

      headers[CONTENT_TYPE] = type
    end

before_committed() click to toggle source

    # File lib/action_dispatch/http/response.rb, line 321
    def before_committed
    end

before_sending() click to toggle source

    # File lib/action_dispatch/http/response.rb, line 324
    def before_sending
    end

build_buffer(response, body) click to toggle source

    # File lib/action_dispatch/http/response.rb, line 331
    def build_buffer(response, body)
      Buffer.new response, body
    end

merge_default_headers(original, default) click to toggle source

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

munge_body_object(body) click to toggle source

    # File lib/action_dispatch/http/response.rb, line 335
    def munge_body_object(body)
      body.respond_to?(:each) ? body : [body]
    end

rack_response(status, header) click to toggle source

    # File lib/action_dispatch/http/response.rb, line 391
    def rack_response(status, header)
      assign_default_content_type_and_charset!(header)
      handle_conditional_get!

      header[SET_COOKIE] = header[SET_COOKIE].join("\n") if header[SET_COOKIE].respond_to?(:join)

      if NO_CONTENT_CODES.include?(@status)
        header.delete CONTENT_TYPE
        [status, header, []]
      else
        [status, header, RackBody.new(self)]
      end
    end