Module: Roda::RodaPlugins::Base::ResponseMethods
- Defined in:
- lib/roda.rb
Overview
Instance methods for RodaResponse
Constant Summary collapse
- CONTENT_LENGTH =
"Content-Length".freeze
- DEFAULT_HEADERS =
{"Content-Type" => "text/html".freeze}.freeze
- LOCATION =
"Location".freeze
Instance Attribute Summary collapse
-
#body ⇒ Object
readonly
The body for the current response.
-
#headers ⇒ Object
readonly
The hash of response headers for the current response.
-
#status ⇒ Object
The status code to use for the response.
Instance Method Summary collapse
-
#[](key) ⇒ Object
Return the response header with the given key.
-
#[]=(key, value) ⇒ Object
Set the response header with the given key to the given value.
-
#default_headers ⇒ Object
The default headers to use for responses.
-
#empty? ⇒ Boolean
Whether the response body has been written to yet.
-
#finish ⇒ Object
Return the rack response array of status, headers, and body for the current response.
-
#finish_with_body(body) ⇒ Object
Return the rack response array using a given body.
-
#initialize ⇒ Object
Set the default headers when creating a response.
-
#inspect ⇒ Object
Show response class, status code, response headers, and response body.
-
#redirect(path, status = 302) ⇒ Object
Set the Location header to the given path, and the status to the given status.
-
#roda_class ⇒ Object
Return the Roda class related to this response.
-
#write(str) ⇒ Object
Write to the response body.
Instance Attribute Details
#body ⇒ Object (readonly)
The body for the current response.
836 837 838 |
# File 'lib/roda.rb', line 836 def body @body end |
#headers ⇒ Object (readonly)
The hash of response headers for the current response.
839 840 841 |
# File 'lib/roda.rb', line 839 def headers @headers end |
#status ⇒ Object
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.
843 844 845 |
# File 'lib/roda.rb', line 843 def status @status end |
Instance Method Details
#[](key) ⇒ Object
Return the response header with the given key. Example:
response['Content-Type'] # => 'text/html'
856 857 858 |
# File 'lib/roda.rb', line 856 def [](key) @headers[key] end |
#[]=(key, value) ⇒ Object
Set the response header with the given key to the given value.
response['Content-Type'] = 'application/json'
863 864 865 |
# File 'lib/roda.rb', line 863 def []=(key, value) @headers[key] = value end |
#default_headers ⇒ Object
The default headers to use for responses.
868 869 870 |
# File 'lib/roda.rb', line 868 def default_headers DEFAULT_HEADERS end |
#empty? ⇒ Boolean
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
879 880 881 |
# File 'lib/roda.rb', line 879 def empty? @body.empty? end |
#finish ⇒ Object
Return the rack response array of status, headers, and body for the current response. If the status has not been set, uses a 200 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'},
# []]
895 896 897 898 899 900 901 902 |
# File 'lib/roda.rb', line 895 def finish b = @body s = (@status ||= b.empty? ? 404 : 200) set_default_headers h = @headers h[CONTENT_LENGTH] ||= @length.to_s [s, h, b] end |
#finish_with_body(body) ⇒ Object
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.
908 909 910 911 |
# File 'lib/roda.rb', line 908 def finish_with_body(body) set_default_headers [@status || 200, @headers, body] end |
#initialize ⇒ Object
Set the default headers when creating a response.
846 847 848 849 850 851 |
# File 'lib/roda.rb', line 846 def initialize @status = nil @headers = {} @body = [] @length = 0 end |
#inspect ⇒ Object
Show response class, status code, response headers, and response body
914 915 916 |
# File 'lib/roda.rb', line 914 def inspect "#<#{self.class.inspect} #{@status.inspect} #{@headers.inspect} #{@body.inspect}>" end |
#redirect(path, status = 302) ⇒ Object
Set the Location header to the given path, and the status to the given status. Example:
response.redirect('foo', 301)
response.redirect('bar')
923 924 925 926 |
# File 'lib/roda.rb', line 923 def redirect(path, status = 302) @headers[LOCATION] = path @status = status end |
#roda_class ⇒ Object
Return the Roda class related to this response.
929 930 931 |
# File 'lib/roda.rb', line 929 def roda_class self.class.roda_class end |
#write(str) ⇒ Object
Write to the response body. Returns nil.
response.write('foo')
936 937 938 939 940 941 |
# File 'lib/roda.rb', line 936 def write(str) s = str.to_s @length += s.bytesize @body << s nil end |