Class: ActionDispatch::Response

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

Defined Under Namespace

Classes: BodyBuster

Constant Summary collapse

CONTENT_TYPE = 
"Content-Type"
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:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/action_dispatch/http/response.rb', line 62

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 || "UTF-8"
  end

  prepare_cache_control!

  yield self if block_given?
end

Instance Attribute Details

#charset ⇒ Object

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.



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

def charset
  @charset
end

#content_type ⇒ Object

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.



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

def content_type
  @content_type
end

#header ⇒ Object Also known as: headers

Returns the value of attribute header.



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

def header
  @header
end

#request ⇒ Object

Returns the value of attribute request.



36
37
38
 
# File '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.



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

def sending_file=(value)
  @sending_file = value
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

Instance Method Details

#body ⇒ Object 



110
111
112
113
114
 
# File 'lib/action_dispatch/http/response.rb', line 110

def body
  str = ''
  each { |part| str << part.to_s }
  str
end

#body=(body) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/action_dispatch/http/response.rb', line 135

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

  if body.respond_to?(:call)
    ActiveSupport::Deprecation.warn "Setting a Proc or an object that responds to call " \
      "in response_body is no longer supported", caller
    body = BodyBuster.new(self).bust(body)
  end

  # 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_parts ⇒ Object 



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

def body_parts
  @body
end

#close ⇒ Object 



175
176
177
 
# File 'lib/action_dispatch/http/response.rb', line 175

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

#code ⇒ Object

Returns a String to ensure compatibility with Net::HTTPResponse



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

def code
  @status.to_s
end

#cookies ⇒ Object

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

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



198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/action_dispatch/http/response.rb', line 198

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 = {}) ⇒ Object 



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

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

#location ⇒ Object Also known as: redirect_url 



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

def location
  headers['Location']
end

#location=(url) ⇒ Object 



171
172
173
 
# File 'lib/action_dispatch/http/response.rb', line 171

def location=(url)
  headers['Location'] = url
end

#message ⇒ Object Also known as: status_message 



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

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

#respond_to?(method) ⇒ Boolean

Returns:

  • (Boolean) 


98
99
100
101
102
103
104
 
# File 'lib/action_dispatch/http/response.rb', line 98

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

#response_code ⇒ Object

The response code of the request



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

def response_code
  @status
end

#set_cookie(key, value) ⇒ Object 



158
159
160
 
# File 'lib/action_dispatch/http/response.rb', line 158

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

#to_a ⇒ Object Also known as: prepare!, to_ary 



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

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_path ⇒ Object 



106
107
108
 
# File 'lib/action_dispatch/http/response.rb', line 106

def to_path
  @body.to_path
end