Class: Rack::Response

Inherits:

Object

• Object
• Rack::Response

show all

Includes:

Helpers

Defined in:

rack/rack/response.rb

Overview

Defined Under Namespace

Modules: Helpers

Instance Attribute Summary (collapse)

• - (void) body

  Returns the value of attribute body.

• - (void) header (also: #headers) readonly

  Returns the value of attribute header.

• - (void) headers included from Helpers readonly

  Headers.

• - (void) length

  Returns the value of attribute length.

• - (void) original_headers included from Helpers readonly

  Headers.

• - (void) status

  Returns the value of attribute status.

Instance Method Summary (collapse)

• - (void) [](key)
• - (void) []=(key, value)
• - (Boolean) bad_request? included from Helpers
• - (Boolean) client_error? included from Helpers
• - (void) close
• - (void) content_length included from Helpers
• - (void) content_type included from Helpers
• - (void) delete_cookie(key, value = {})
• - (void) each(&callback)
• - (Boolean) empty?
• - (void) finish(&block) (also: #to_a, #to_ary)
• - (Boolean) forbidden? included from Helpers
• - (Boolean) include?(header) included from Helpers
• - (Boolean) informational? included from Helpers
• - (Response) initialize(body = [], status = 200, header = {}) {|_self| ... } constructor

  A new instance of Response.

• - (Boolean) invalid? included from Helpers
• - (void) location included from Helpers
• - (Boolean) method_not_allowed? included from Helpers
• - (Boolean) not_found? included from Helpers
• - (Boolean) ok? included from Helpers
• - (void) redirect(target, status = 302)
• - (Boolean) redirect? included from Helpers
• - (Boolean) redirection? included from Helpers
• - (Boolean) server_error? included from Helpers
• - (void) set_cookie(key, value)
• - (Boolean) successful? included from Helpers
• - (Boolean) unprocessable? included from Helpers
• - (void) write(str)

  Append to body and update Content-Length.

22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

# File 'rack/rack/response.rb', line 22

def initialize(body=[], status=200, header={})
  @status = status.to_i
  @header = Utils::HeaderHash.new.merge(header)

  @chunked = "chunked" == @header['Transfer-Encoding']
  @writer  = lambda { |x| @body << x }
  @block   = nil
  @length  = 0

  @body = []

  if body.respond_to? :to_str
    write body.to_str
  elsif body.respond_to?(:each)
    body.each { |part|
      write part.to_s
    }
  else
    raise TypeError, "stringable or iterable required"
  end

  yield self  if block_given?
end

47
48
49

# File 'rack/rack/response.rb', line 47

def body
  @body
end

46
47
48

# File 'rack/rack/response.rb', line 46

def header
  @header
end

20
21
22

# File 'rack/rack/response.rb', line 20

def length
  @length
end

47
48
49

# File 'rack/rack/response.rb', line 47

def status
  @status
end

49
50
51

# File 'rack/rack/response.rb', line 49

def [](key)
  header[key]
end

53
54
55

# File 'rack/rack/response.rb', line 53

def []=(key, value)
  header[key] = value
end

104
105
106

# File 'rack/rack/response.rb', line 104

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

61
62
63

# File 'rack/rack/response.rb', line 61

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

85
86
87
88
89

# File 'rack/rack/response.rb', line 85

def each(&callback)
  @body.each(&callback)
  @writer = callback
  @block.call(self)  if @block
end

108
109
110

# File 'rack/rack/response.rb', line 108

def empty?
  @block == nil && @body.empty?
end

70
71
72
73
74
75
76
77
78
79
80
81

# File 'rack/rack/response.rb', line 70

def finish(&block)
  @block = block

  if [204, 205, 304].include?(status.to_i)
    header.delete "Content-Type"
    header.delete "Content-Length"
    close
    [status.to_i, header, []]
  else
    [status.to_i, header, BodyProxy.new(self){}]
  end
end

65
66
67
68

# File 'rack/rack/response.rb', line 65

def redirect(target, status=302)
  self.status = status
  self["Location"] = target
end

57
58
59

# File 'rack/rack/response.rb', line 57

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

95
96
97
98
99
100
101
102

# File 'rack/rack/response.rb', line 95

def write(str)
  s = str.to_s
  @length += Rack::Utils.bytesize(s) unless @chunked
  @writer.call s

  header["Content-Length"] = @length.to_s unless @chunked
  str
end