module Roda::RodaPlugins::Base::RequestMethods

  1. lib/roda.rb

Instance methods for RodaRequest, mostly related to handling routing for the request.

Constants

TERM = Object.new  

Attributes

captures [R]

The current captures for the request. This gets modified as routing occurs.

remaining_path [R]

The current path to match requests against.

scope [R]

The Roda instance related to this request object. Useful if routing methods need access to the scope of the Roda route block.

Public Class methods

new (scope, env)

Store the roda instance and environment.

[show source]
# File lib/roda.rb, line 377
def initialize(scope, env)
  @scope = scope
  @captures = []
  @remaining_path = _remaining_path(env)
  super(env)
end

Public Instance methods

block_result (result)

Handle match block return values. By default, if a string is given and the response is empty, use the string as the response body.

[show source]
# File lib/roda.rb, line 386
def block_result(result)
  res = response
  if res.empty? && (body = block_result_body(result))
    res.write(body)
  end
end
get (*args, &block)

Match GET requests. If no arguments are provided, matches all GET requests, otherwise, matches only GET requests where the arguments given fully consume the path.

[show source]
# File lib/roda.rb, line 396
def get(*args, &block)
  _verb(args, &block) if is_get?
end
halt (res=response.finish)

Immediately stop execution of the route block and return the given rack response array of status, headers, and body. If no argument is given, uses the current response.

r.halt [200, {'Content-Type'=>'text/html'}, ['Hello World!']]

response.status = 200
response['Content-Type'] = 'text/html'
response.write 'Hello World!'
r.halt
[show source]
# File lib/roda.rb, line 410
def halt(res=response.finish)
  throw :halt, res
end
inspect ()

Show information about current request, including request class, request method and full path.

r.inspect
# => '#<Roda::RodaRequest GET /foo/bar>'
[show source]
# File lib/roda.rb, line 419
def inspect
  "#<#{self.class.inspect} #{@env["REQUEST_METHOD"]} #{path}>"
end
is (*args, &block)

Does a terminal match on the current path, matching only if the arguments have fully matched the path. If it matches, the match block is executed, and when the match block returns, the rack response is returned.

r.remaining_path
# => "/foo/bar"

r.is 'foo' do
  # does not match, as path isn't fully matched (/bar remaining)
end

r.is 'foo/bar' do
  # matches as path is empty after matching
end

If no arguments are given, matches if the path is already fully matched.

r.on 'foo/bar' do
  r.is do
    # matches as path is already empty
  end
end

Note that this matches only if the path after matching the arguments is empty, not if it still contains a trailing slash:

r.remaining_path
# =>  "/foo/bar/"

r.is 'foo/bar' do
  # does not match, as path isn't fully matched (/ remaining)
end

r.is 'foo/bar/' do
  # matches as path is empty after matching
end

r.on 'foo/bar' do
  r.is "" do
    # matches as path is empty after matching
  end
end
[show source]
# File lib/roda.rb, line 466
def is(*args, &block)
  if args.empty?
    if empty_path?
      always(&block)
    end
  else
    args << TERM
    if_match(args, &block)
  end
end
is_get? ()

Optimized method for whether this request is a GET request. Similar to the default Rack::Request get? method, but can be overridden without changing rack's behavior.

[show source]
# File lib/roda.rb, line 480
def is_get?
  @env["REQUEST_METHOD"] == 'GET'
end
matched_path ()

The already matched part of the path, including the original SCRIPT_NAME.

[show source]
# File lib/roda.rb, line 520
def matched_path
  e = @env
  e["SCRIPT_NAME"] + e["PATH_INFO"].chomp(@remaining_path)
end
on (*args, &block)

Does a match on the path, matching only if the arguments have matched the path. Because this doesn't fully match the path, this is usually used to setup branches of the routing tree, not for final handling of the request.

r.remaining_path
# => "/foo/bar"

r.on 'foo' do
  # matches, path is /bar after matching
end

r.on 'bar' do
  # does not match
end

Like other routing methods, If it matches, the match block is executed, and when the match block returns, the rack response is returned. However, in general you will call another routing method inside the match block that fully matches the path and does the final handling for the request:

r.on 'foo' do
  r.is 'bar' do
    # handle /foo/bar request
  end
end
[show source]
# File lib/roda.rb, line 511
def on(*args, &block)
  if args.empty?
    always(&block)
  else
    if_match(args, &block)
  end
end
path ()

This an an optimized version of Rack::Request#path.

r.env['SCRIPT_NAME'] = '/foo'
r.env['PATH_INFO'] = '/bar'
r.path
# => '/foo/bar'
[show source]
# File lib/roda.rb, line 531
def path
  e = @env
  "#{e["SCRIPT_NAME"]}#{e["PATH_INFO"]}"
end
post (*args, &block)

Match POST requests. If no arguments are provided, matches all POST requests, otherwise, matches only POST requests where the arguments given fully consume the path.

[show source]
# File lib/roda.rb, line 548
def post(*args, &block)
  _verb(args, &block) if post?
end
real_remaining_path ()

An alias of remaining_path. If a plugin changes #remaining_path then it should override this method to return the untouched original.

[show source]
# File lib/roda.rb, line 541
def real_remaining_path
  remaining_path
end
redirect (path=default_redirect_path, status=default_redirect_status)

Immediately redirect to the path using the status code. This ends the processing of the request:

r.redirect '/page1', 301 if r['param'] == 'value1'
r.redirect '/page2' # uses 302 status code
response.status = 404 # not reached

If you do not provide a path, by default it will redirect to the same path if the request is not a GET request. This is designed to make it easy to use where a POST request to a URL changes state, GET returns the current state, and you want to show the current state after changing:

r.is "foo" do
  r.get do
    # show state
  end

  r.post do
    # change state
    r.redirect
  end
end
[show source]
# File lib/roda.rb, line 575
def redirect(path=default_redirect_path, status=default_redirect_status)
  response.redirect(path, status)
  throw :halt, response.finish
end
response ()

The response related to the current request. See ResponseMethods for instance methods for the response, but in general the most common usage is to override the response status and headers:

response.status = 200
response['Header-Name'] = 'Header value'
[show source]
# File lib/roda.rb, line 586
def response
  @scope.response
end
roda_class ()

Return the Roda class related to this request.

[show source]
# File lib/roda.rb, line 591
def roda_class
  self.class.roda_class
end
root (&block)

Match method that only matches GET requests where the current path is /. If it matches, the match block is executed, and when the match block returns, the rack response is returned.

[r.request_method, r.remaining_path]
# => ['GET', '/']

r.root do
  # matches
end

This is usuable inside other match blocks:

[r.request_method, r.remaining_path]
# => ['GET', '/foo/']

r.on 'foo' do
  r.root do
    # matches
  end
end

Note that this does not match non-GET requests:

[r.request_method, r.remaining_path]
# => ['POST', '/']

r.root do
  # does not match
end

Use r.post "" for POST requests where the current path is /.

Nor does it match empty paths:

[r.request_method, r.remaining_path]
# => ['GET', '/foo']

r.on 'foo' do
  r.root do
    # does not match
  end
end

Use r.get true to handle GET requests where the current path is empty.

[show source]
# File lib/roda.rb, line 642
def root(&block)
  if remaining_path == "/" && is_get?
    always(&block)
  end
end
run (app)

Call the given rack app with the environment and return the response from the rack app as the response for this request. This ends the processing of the request:

r.run(proc{[403, {}, []]}) unless r['letmein'] == '1'
r.run(proc{[404, {}, []]})
response.status = 404 # not reached

This updates SCRIPT_NAME/PATH_INFO based on the current #remaining_path before dispatching to another rack app, so the app still works as a URL mapper.

[show source]
# File lib/roda.rb, line 659
def run(app)
  e = @env
  path = real_remaining_path
  sn = "SCRIPT_NAME"
  pi = "PATH_INFO"
  script_name = e[sn]
  path_info = e[pi]
  begin
    e[sn] += path_info.chomp(path)
    e[pi] = path
    throw :halt, app.call(e)
  ensure
    e[sn] = script_name
    e[pi] = path_info
  end
end
session ()

The session for the current request. Raises a RodaError if a session handler has not been loaded.

[show source]
# File lib/roda.rb, line 678
def session
  @env['rack.session'] || raise(RodaError, "You're missing a session handler. You can get started by adding use Rack::Session::Cookie")
end