module Roda::RodaPlugins::Base::ResponseMethods

  1. lib/roda.rb

Instance methods for RodaResponse

Constants

DEFAULT_HEADERS = {"Content-Type" => "text/html".freeze}.freeze  

Attributes

body [R]

The body for the current response.

headers [R]

The hash of response headers for the current response.

status [RW]

The status code to use for the response. If none is given, will use 200 code for non-empty responses and a 404 code for empty responses.

Public Class methods

new ()

Set the default headers when creating a response.

[show source]
     # File lib/roda.rb
1263 def initialize
1264   @headers = {}
1265   @body    = []
1266   @length  = 0
1267 end

Public Instance methods

[] (key)

Return the response header with the given key. Example:

response['Content-Type'] # => 'text/html'
[show source]
     # File lib/roda.rb
1272 def [](key)
1273   @headers[key]
1274 end
[]= (key, value)

Set the response header with the given key to the given value.

response['Content-Type'] = 'application/json'
[show source]
     # File lib/roda.rb
1279 def []=(key, value)
1280   @headers[key] = value
1281 end
default_headers ()

The default headers to use for responses.

[show source]
     # File lib/roda.rb
1284 def default_headers
1285   DEFAULT_HEADERS
1286 end
default_status ()

Return the default response status to be used when the body has been written to. This is split out to make overriding easier in plugins.

[show source]
     # File lib/roda.rb
1346 def default_status
1347   200
1348 end
empty? ()

Whether the response body has been written to yet. Note that writing an empty string to the response body marks the response as not empty. Example:

response.empty? # => true
response.write('a')
response.empty? # => false
[show source]
     # File lib/roda.rb
1295 def empty?
1296   @body.empty?
1297 end
finish ()

Return the rack response array of status, headers, and body for the current response. If the status has not been set, uses the return value of default_status if the body has been written to, otherwise uses a 404 status. Adds the Content-Length header to the size of the response body.

Example:

response.finish
#  => [200,
#      {'Content-Type'=>'text/html', 'Content-Length'=>'0'},
#      []]
[show source]
     # File lib/roda.rb
1311 def finish
1312   b = @body
1313   set_default_headers
1314   h = @headers
1315 
1316   if b.empty?
1317     s = @status || 404
1318     if (s == 304 || s == 204 || (s >= 100 && s <= 199))
1319       h.delete("Content-Type")
1320     elsif s == 205
1321       h.delete("Content-Type")
1322       h["Content-Length"] = '0'
1323     else
1324       h["Content-Length"] ||= '0'
1325     end
1326   else
1327     s = @status || default_status
1328     h["Content-Length"] ||= @length.to_s
1329   end
1330 
1331   [s, h, b]
1332 end
finish_with_body (body)

Return the rack response array using a given body. Assumes a 200 response status unless status has been explicitly set, and doesn't add the Content-Length header or use the existing body.

[show source]
     # File lib/roda.rb
1338 def finish_with_body(body)
1339   set_default_headers
1340   [@status || default_status, @headers, body]
1341 end
inspect ()

Show response class, status code, response headers, and response body

[show source]
     # File lib/roda.rb
1351 def inspect
1352   "#<#{self.class.inspect} #{@status.inspect} #{@headers.inspect} #{@body.inspect}>"
1353 end
redirect (path, status = 302)

Set the Location header to the given path, and the status to the given status. Example:

response.redirect('foo', 301)
response.redirect('bar')
[show source]
     # File lib/roda.rb
1360 def redirect(path, status = 302)
1361   @headers["Location"] = path
1362   @status  = status
1363   nil
1364 end
roda_class ()

Return the Roda class related to this response.

[show source]
     # File lib/roda.rb
1367 def roda_class
1368   self.class.roda_class
1369 end
write (str)

Write to the response body. Returns nil.

response.write('foo')
[show source]
     # File lib/roda.rb
1374 def write(str)
1375   s = str.to_s
1376   @length += s.bytesize
1377   @body << s
1378   nil
1379 end