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
1267 def initialize
1268   @headers = {}
1269   @body    = []
1270   @length  = 0
1271 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
1276 def [](key)
1277   @headers[key]
1278 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
1283 def []=(key, value)
1284   @headers[key] = value
1285 end
default_headers ()

The default headers to use for responses.

[show source]
     # File lib/roda.rb
1288 def default_headers
1289   DEFAULT_HEADERS
1290 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
1350 def default_status
1351   200
1352 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
1299 def empty?
1300   @body.empty?
1301 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
1315 def finish
1316   b = @body
1317   set_default_headers
1318   h = @headers
1319 
1320   if b.empty?
1321     s = @status || 404
1322     if (s == 304 || s == 204 || (s >= 100 && s <= 199))
1323       h.delete("Content-Type")
1324     elsif s == 205
1325       h.delete("Content-Type")
1326       h["Content-Length"] = '0'
1327     else
1328       h["Content-Length"] ||= '0'
1329     end
1330   else
1331     s = @status || default_status
1332     h["Content-Length"] ||= @length.to_s
1333   end
1334 
1335   [s, h, b]
1336 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
1342 def finish_with_body(body)
1343   set_default_headers
1344   [@status || default_status, @headers, body]
1345 end
inspect ()

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

[show source]
     # File lib/roda.rb
1355 def inspect
1356   "#<#{self.class.inspect} #{@status.inspect} #{@headers.inspect} #{@body.inspect}>"
1357 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
1364 def redirect(path, status = 302)
1365   @headers["Location"] = path
1366   @status  = status
1367   nil
1368 end
roda_class ()

Return the Roda class related to this response.

[show source]
     # File lib/roda.rb
1371 def roda_class
1372   self.class.roda_class
1373 end
write (str)

Write to the response body. Returns nil.

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