Class: ActionDispatch::Response

Inherits:
Object
  • Object
show all
Includes:
Http::Cache::Response, 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

Direct Known Subclasses

TestResponse

Constant Summary collapse

CONTENT_TYPE =
"Content-Type".freeze
"Set-Cookie".freeze
LOCATION =
"Location".freeze
EMPTY =
" "

Instance Attribute Summary collapse

Attributes included from Http::Cache::Response

#cache_control, #etag

Instance Method Summary collapse

Methods included from Http::Cache::Response

#last_modified, #last_modified=, #last_modified?

Constructor Details

#initialize(status = 200, header = {}, body = []) {|_self| ... } ⇒ Response

Returns a new instance of Response

Yields:

  • (_self)

Yield Parameters:


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'actionpack/lib/action_dispatch/http/response.rb', line 65

def initialize(status = 200, header = {}, body = [])
  self.body, self.header, self.status = body, header, status

  @sending_file = false
  @blank = false

  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

#charsetObject

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.


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

def charset
  @charset
end

#content_typeObject

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.


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

def content_type
  @content_type
end

#headerObject Also known as: headers

Returns the value of attribute header


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

def header
  @header
end

#requestObject

Returns the value of attribute request


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.


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

def sending_file=(value)
  @sending_file = value
end

#statusObject

Returns the value of attribute status


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

def status
  @status
end

Instance Method Details

#bodyObject


113
114
115
116
117
# File 'actionpack/lib/action_dispatch/http/response.rb', line 113

def body
  strings = []
  each { |part| strings << part.to_s }
  strings.join
end

#body=(body) ⇒ Object


121
122
123
124
125
126
127
128
129
130
131
132
# File 'actionpack/lib/action_dispatch/http/response.rb', line 121

def body=(body)
  @blank = true if body == EMPTY

  # Explicitly check for strings. This is *wrong* theoretically
  # but if we don't check this, the performance on string bodies
  # is bad on Ruby 1.8 (because strings responds to each then).
  @body = if body.respond_to?(:to_str) || !body.respond_to?(:each)
    [body]
  else
    body
  end
end

#body_partsObject


134
135
136
# File 'actionpack/lib/action_dispatch/http/response.rb', line 134

def body_parts
  @body
end

#closeObject


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

def close
  @body.close if @body.respond_to?(:close)
end

#codeObject

Returns a String to ensure compatibility with Net::HTTPResponse


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

def code
  @status.to_s
end

#cookiesObject

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

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

178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'actionpack/lib/action_dispatch/http/response.rb', line 178

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

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

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

#locationObject Also known as: redirect_url


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

def location
  headers[LOCATION]
end

#location=(url) ⇒ Object


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

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

#messageObject Also known as: status_message


96
97
98
# File 'actionpack/lib/action_dispatch/http/response.rb', line 96

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

#respond_to?(method) ⇒ Boolean

Returns:

  • (Boolean)

101
102
103
104
105
106
107
# File 'actionpack/lib/action_dispatch/http/response.rb', line 101

def respond_to?(method)
  if method.to_sym == :to_path
    @body.respond_to?(:to_path)
  else
    super
  end
end

#response_codeObject

The response code of the request


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

def response_code
  @status
end

138
139
140
# File 'actionpack/lib/action_dispatch/http/response.rb', line 138

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

#to_aObject Also known as: prepare!, to_ary


159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'actionpack/lib/action_dispatch/http/response.rb', line 159

def to_a
  assign_default_content_type_and_charset!
  handle_conditional_get!

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

  if [204, 304].include?(@status)
    @header.delete CONTENT_TYPE
    [@status, @header, []]
  else
    [@status, @header, self]
  end
end

#to_pathObject


109
110
111
# File 'actionpack/lib/action_dispatch/http/response.rb', line 109

def to_path
  @body.to_path
end