Class: ActionDispatch::Response

Inherits:

Object

• Object
• ActionDispatch::Response

show all

Includes:

Http::Cache::Response, Rack::Response::Helpers

Defined in:

actionpack/lib/action_dispatch/http/response.rb

Overview

class DemoControllerTest < ActionDispatch::IntegrationTest
  def test_print_root_path_to_console
    get('/')
    puts @response.body
  end
end

Defined Under Namespace

Classes: BodyBuster

Constant Summary

CONTENT_TYPE =

"Content-Type"

EMPTY =

" "

Constants included from Http::Cache::Response

Http::Cache::Response::DEFAULT_CACHE_CONTROL

Instance Attribute Summary (collapse)

• - (Object) charset

  Sets the HTTP response's content MIME type.

• - (Object) content_type

  Sets the HTTP response's content MIME type.

• - (Object) header (also: #headers)

  Returns the value of attribute header.

• - (Object) request

  Returns the value of attribute request.

• - (Object) sending_file writeonly

  Sets the attribute sending_file.

• - (Object) status

  Returns the value of attribute status.

Attributes included from Http::Cache::Response

#cache_control, #etag

Instance Method Summary (collapse)

• - (Object) body
• - (Object) body=(body)
• - (Object) body_parts
• - (Object) close
• - (Object) code

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

• - (Object) cookies

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

• - (Object) delete_cookie(key, value = {})
• - (Response) initialize(status = 200, header = {}, body = []) {|_self| ... } constructor

  A new instance of Response.

• - (Object) location (also: #redirect_url)
• - (Object) location=(url)
• - (Object) message (also: #status_message)
• - (Boolean) respond_to?(method)
• - (Object) response_code

  The response code of the request.

• - (Object) set_cookie(key, value)
• - (Object) to_a (also: #prepare!, #to_ary)
• - (Object) to_path

Methods included from Http::Cache::Response

#last_modified, #last_modified=, #last_modified?

62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

# File 'actionpack/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

response.content_type = "text/plain"

53
54
55

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

def charset
  @charset
end

response.content_type = "text/plain"

53
54
55

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

def content_type
  @content_type
end

36
37
38

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

def header
  @header
end

36
37
38

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

def request
  @request
end

37
38
39

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

def sending_file=(value)
  @sending_file = value
end

36
37
38

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

def status
  @status
end

110
111
112
113
114

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

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

135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

# File 'actionpack/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

154
155
156

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

def body_parts
  @body
end

175
176
177

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

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

89
90
91

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

def code
  @status.to_s
end

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

198
199
200
201
202
203
204
205
206
207
208
209
210

# File 'actionpack/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

162
163
164

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

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

166
167
168

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

def location
  headers['Location']
end

171
172
173

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

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

93
94
95

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

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

98
99
100
101
102
103
104

# File 'actionpack/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

84
85
86

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

def response_code
  @status
end

158
159
160

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

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

179
180
181
182
183
184
185
186
187
188
189
190
191

# File 'actionpack/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

106
107
108

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

def to_path
  @body.to_path
end