Class: ActionDispatch::Response

Inherits:

Rack::Response

• Object
• Rack::Response
• ActionDispatch::Response

show all

Includes:

Http::Cache::Response, Setup

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

Modules: Setup

Constant Summary

EMPTY =

" "

CONTENT_TYPE =

"Content-Type"

Constants included from Http::Cache::Response

Http::Cache::Response::DEFAULT_CACHE_CONTROL

Instance Attribute Summary (collapse)

• - (Object) blank

  Returns the value of attribute blank.

• - (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=) writeonly

  Sets the attribute header.

• - (Object) request

  Returns the value of attribute request.

• - (Object) sending_file writeonly

  Sets the attribute sending_file.

Attributes included from Http::Cache::Response

#cache_control

Instance Method Summary (collapse)

• - (Object) body
• - (Object) body=(body)
• - (Object) body_parts
• - (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) each(&callback)
• - (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) status=(status)
• - (Object) to_a (also: #prepare!)
• - (Object) to_path
• - (Object) write(str)

Methods included from Http::Cache::Response

#etag, #etag=, #etag?, #initialize, #last_modified, #last_modified=, #last_modified?

Methods included from Setup

#initialize

36
37
38

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

def blank
  @blank
end

response.content_type = "text/plain"

133
134
135

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

def charset
  @charset
end

response.content_type = "text/plain"

133
134
135

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

def content_type
  @content_type
end

38
39
40

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

def header=(value)
  @header = value
end

36
37
38

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

def request
  @request
end

38
39
40

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

def sending_file=(value)
  @sending_file = value
end

99
100
101
102
103

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

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

107
108
109
110

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

def body=(body)
  @blank = true if body == EMPTY
  @body = body.respond_to?(:to_str) ? [body] : body
end

112
113
114

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

def body_parts
  @body
end

78
79
80

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

def code
  @status.to_s
end

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

170
171
172
173
174
175
176
177
178
179
180
181
182

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

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

149
150
151
152
153
154
155
156
157
158
159

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

def each(&callback)
  if @body.respond_to?(:call)
    @writer = lambda { |x| callback.call(x) }
    @body.call(self, self)
  else
    @body.each { |part| callback.call(part.to_s) }
  end

  @writer = callback
  @block.call(self) if @block
end

116
117
118

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

def location
  headers['Location']
end

121
122
123

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

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

82
83
84

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

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

87
88
89
90
91
92
93

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

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

73
74
75

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

def response_code
  @status
end

68
69
70

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

def status=(status)
  @status = Rack::Utils.status_code(status)
end

139
140
141
142
143
144
145

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

def to_a
  assign_default_content_type_and_charset!
  handle_conditional_get!
  self["Set-Cookie"] = self["Set-Cookie"].join("\n") if self["Set-Cookie"].respond_to?(:join)
  self["ETag"]       = @_etag if @_etag
  super
end

95
96
97

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

def to_path
  @body.to_path
end

161
162
163
164
165

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

def write(str)
  str = str.to_s
  @writer.call str
  str
end