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

37
38
39

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

def blank
  @blank
end

response.content_type = "text/plain"

134
135
136

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

def charset
  @charset
end

response.content_type = "text/plain"

134
135
136

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

def content_type
  @content_type
end

39
40
41

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

def header=(value)
  @header = value
end

37
38
39

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

def request
  @request
end

39
40
41

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

def sending_file=(value)
  @sending_file = value
end

100
101
102
103
104

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

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

108
109
110
111

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

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

113
114
115

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

def body_parts
  @body
end

79
80
81

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

def code
  @status.to_s
end

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

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

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

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

150
151
152
153
154
155
156
157
158
159
160

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

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

117
118
119

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

def location
  headers['Location']
end

122
123
124

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

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

83
84
85

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

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

88
89
90
91
92
93
94

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

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

74
75
76

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

def response_code
  @status
end

69
70
71

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

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

140
141
142
143
144
145
146

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

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

96
97
98

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

def to_path
  @body.to_path
end

162
163
164
165
166

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

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