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
994 def initialize
995   @headers = {}
996   @body    = []
997   @length  = 0
998 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
1003 def [](key)
1004   @headers[key]
1005 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
1010 def []=(key, value)
1011   @headers[key] = value
1012 end
default_headers ()

The default headers to use for responses.

[show source]
     # File lib/roda.rb
1015 def default_headers
1016   DEFAULT_HEADERS
1017 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
1074 def default_status
1075   200
1076 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
1026 def empty?
1027   @body.empty?
1028 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
1042 def finish
1043   b = @body
1044   set_default_headers
1045   h = @headers
1046 
1047   if b.empty?
1048     s = @status || 404
1049     if (s == 304 || s == 204 || s == 205 || (s >= 100 && s <= 199))
1050       h.delete("Content-Type")
1051     else
1052       h["Content-Length"] ||= '0'
1053     end
1054   else
1055     s = @status || default_status
1056     h["Content-Length"] ||= @length.to_s
1057   end
1058 
1059   [s, h, b]
1060 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
1066 def finish_with_body(body)
1067   set_default_headers
1068   [@status || default_status, @headers, body]
1069 end
inspect ()

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

[show source]
     # File lib/roda.rb
1079 def inspect
1080   "#<#{self.class.inspect} #{@status.inspect} #{@headers.inspect} #{@body.inspect}>"
1081 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
1088 def redirect(path, status = 302)
1089   @headers["Location"] = path
1090   @status  = status
1091   nil
1092 end
roda_class ()

Return the Roda class related to this response.

[show source]
     # File lib/roda.rb
1095 def roda_class
1096   self.class.roda_class
1097 end
write (str)

Write to the response body. Returns nil.

response.write('foo')
[show source]
     # File lib/roda.rb
1102 def write(str)
1103   s = str.to_s
1104   @length += s.bytesize
1105   @body << s
1106   nil
1107 end