module Rack::Response::Helpers

Public Instance Methods

# File lib/rack/response.rb, line 191
def accepted?;            status == 202;                        end

add_header (key, value)

Add a header that may have multiple values.

Example:

response.add_header 'vary', 'accept-encoding'
response.add_header 'vary', 'cookie'

assert_equal 'accept-encoding,cookie', response.get_header('vary')

www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2

# File lib/rack/response.rb, line 219
def add_header(key, value)
  raise ArgumentError unless key.is_a?(String)

  if value.nil?
    return get_header(key)
  end

  value = value.to_s

  if header = get_header(key)
    if header.is_a?(Array)
      header << value
    else
      set_header(key, [header, value])
    end
  else
    set_header(key, value)
  end
end

bad_request? ()

# File lib/rack/response.rb, line 194
def bad_request?;         status == 400;                        end

cache! (duration = 3600, directive: "public")

Specify that the content should be cached. @param duration [Integer] The number of seconds until the cache expires. @option directive [String] The cache control directive, one of “public”, “private”, “no-cache” or “no-store”.

# File lib/rack/response.rb, line 307
def cache!(duration = 3600, directive: "public")
  unless headers[CACHE_CONTROL] =~ /no-cache/
    set_header CACHE_CONTROL, "#{directive}, max-age=#{duration}"
    set_header EXPIRES, (Time.now + duration).httpdate
  end
end

cache_control ()

# File lib/rack/response.rb, line 290
def cache_control
  get_header CACHE_CONTROL
end

cache_control= (value)

# File lib/rack/response.rb, line 294
def cache_control=(value)
  set_header CACHE_CONTROL, value
end

client_error? ()

# File lib/rack/response.rb, line 186
def client_error?;        status >= 400 && status < 500;        end

content_length ()

# File lib/rack/response.rb, line 257
def content_length
  cl = get_header CONTENT_LENGTH
  cl ? cl.to_i : cl
end

content_type ()

Get the content type of the response.

# File lib/rack/response.rb, line 240
def content_type
  get_header CONTENT_TYPE
end

content_type= (content_type)

Set the content type of the response.

# File lib/rack/response.rb, line 245
def content_type=(content_type)
  set_header CONTENT_TYPE, content_type
end

created? ()

# File lib/rack/response.rb, line 190
def created?;             status == 201;                        end

delete_cookie (key, value = {})

# File lib/rack/response.rb, line 274
def delete_cookie(key, value = {})
  set_header(SET_COOKIE,
    Utils.delete_set_cookie_header!(
      get_header(SET_COOKIE), key, value
    )
  )
end

do_not_cache! ()

Specifies that the content shouldn’t be cached. Overrides ‘cache!` if already called.

# File lib/rack/response.rb, line 299
def do_not_cache!
  set_header CACHE_CONTROL, "no-cache, must-revalidate"
  set_header EXPIRES, Time.now.httpdate
end

etag ()

# File lib/rack/response.rb, line 314
def etag
  get_header ETAG
end

etag= (value)

# File lib/rack/response.rb, line 318
def etag=(value)
  set_header ETAG, value
end

forbidden? ()

# File lib/rack/response.rb, line 196
def forbidden?;           status == 403;                        end

include? (header)

# File lib/rack/response.rb, line 206
def include?(header)
  has_header?(header)
end

informational? ()

# File lib/rack/response.rb, line 183
def informational?;       status >= 100 && status < 200;        end

invalid? ()

# File lib/rack/response.rb, line 181
def invalid?;             status < 100 || status >= 600;        end

location ()

# File lib/rack/response.rb, line 262
def location
  get_header "location"
end

location= (location)

# File lib/rack/response.rb, line 266
def location=(location)
  set_header "location", location
end

media_type ()

# File lib/rack/response.rb, line 249
def media_type
  MediaType.type(content_type)
end

media_type_params ()

# File lib/rack/response.rb, line 253
def media_type_params
  MediaType.params(content_type)
end

method_not_allowed? ()

# File lib/rack/response.rb, line 198
def method_not_allowed?;  status == 405;                        end

moved_permanently? ()

# File lib/rack/response.rb, line 193
def moved_permanently?;   status == 301;                        end

no_content? ()

# File lib/rack/response.rb, line 192
def no_content?;          status == 204;                        end

not_acceptable? ()

# File lib/rack/response.rb, line 199
def not_acceptable?;      status == 406;                        end

not_found? ()

# File lib/rack/response.rb, line 197
def not_found?;           status == 404;                        end

ok? ()

# File lib/rack/response.rb, line 189
def ok?;                  status == 200;                        end

precondition_failed? ()

# File lib/rack/response.rb, line 201
def precondition_failed?; status == 412;                        end

redirect? ()

# File lib/rack/response.rb, line 204
def redirect?;            [301, 302, 303, 307, 308].include? status; end

redirection? ()

# File lib/rack/response.rb, line 185
def redirection?;         status >= 300 && status < 400;        end

request_timeout? ()

# File lib/rack/response.rb, line 200
def request_timeout?;     status == 408;                        end

server_error? ()

# File lib/rack/response.rb, line 187
def server_error?;        status >= 500 && status < 600;        end

set_cookie (key, value)

# File lib/rack/response.rb, line 270
def set_cookie(key, value)
  add_header SET_COOKIE, Utils.set_cookie_header(key, value)
end

set_cookie_header ()

# File lib/rack/response.rb, line 282
def set_cookie_header
  get_header SET_COOKIE
end

set_cookie_header= (value)

# File lib/rack/response.rb, line 286
def set_cookie_header=(value)
  set_header SET_COOKIE, value
end

successful? ()

# File lib/rack/response.rb, line 184
def successful?;          status >= 200 && status < 300;        end

unauthorized? ()

# File lib/rack/response.rb, line 195
def unauthorized?;        status == 401;                        end

unprocessable? ()

# File lib/rack/response.rb, line 202
def unprocessable?;       status == 422;                        end

Protected Instance Methods

append (chunk)

# File lib/rack/response.rb, line 359
def append(chunk)
  chunk = chunk.dup unless chunk.frozen?
  @body << chunk

  if @length
    @length += chunk.bytesize
  elsif @buffered
    @length = chunk.bytesize
  end

  return chunk
end

buffered_body! ()

Convert the body of this response into an internally buffered Array if possible.

‘@buffered` is a ternary value which indicates whether the body is buffered. It can be:

‘nil` - The body has not been buffered yet.
‘true` - The body is buffered as an Array instance.
‘false` - The body is not buffered and cannot be buffered.

@return [Boolean] whether the body is buffered as an Array instance.

# File lib/rack/response.rb, line 332
def buffered_body!
  if @buffered.nil?
    if @body.is_a?(Array)
      # The user supplied body was an array:
      @body = @body.compact
      @length = @body.sum{|part| part.bytesize}
      @buffered = true
    elsif @body.respond_to?(:each)
      # Turn the user supplied body into a buffered array:
      body = @body
      @body = Array.new
      @buffered = true

      body.each do |part|
        @writer.call(part.to_s)
      end

      body.close if body.respond_to?(:close)
    else
      # We don't know how to buffer the user-supplied body:
      @buffered = false
    end
  end

  return @buffered
end