Class Waves::Request
In: lib/runtime/request.rb
Parent: Object

Waves::Request represents an HTTP request and provides convenient methods for accessing request attributes. See Rack::Request for documentation of any method not defined here.

Methods

[]   accept   accept_charset   accept_language   method   method_missing   new   not_found   params   path   query   rack_request   redirect  

Included Modules

Attributes

Classes and Modules

Module Waves::Request::Utilities
Class Waves::Request::Accept
Class Waves::Request::ParseError
Class Waves::Request::Query

External Aliases

host -> domain

Attributes

response  [R] 
session  [R] 
traits  [R] 

Public Class methods

new( env )

Create a new request. Takes a env parameter representing the request passed in from Rack. You shouldn‘t need to call this directly.

[Source]

    # File lib/runtime/request.rb, line 16
16:     def initialize( env )
17:       @traits = Class.new { include Attributes }.new( :waves => {} )
18:       @request = Rack::Request.new( env ).freeze
19:       @response = Waves::Response.new( self )
20:       @session = Waves::Session.new( self )
21:     end

Public Instance methods

[]( key )

[Source]

    # File lib/runtime/request.rb, line 52
52:     def []( key ) ; @request.env[ key.to_s.upcase ] ; end
accept()

this is a hack - need to incorporate browser variations for "accept" here … def accept ; Accept.parse(@request.env[‘HTTP_ACCEPT’]).unshift( Waves.config.mime_types[ path ] ).compact.uniq ; end

[Source]

     # File lib/runtime/request.rb, line 103
103:     def accept ; @accept ||= Accept.parse( Waves.config.mime_types[ path.downcase ] || 'text/html' ) ; end
accept_charset()

[Source]

     # File lib/runtime/request.rb, line 104
104:     def accept_charset ; @charset ||= Accept.parse(@request.env['HTTP_ACCEPT_CHARSET']) ; end
accept_language()

[Source]

     # File lib/runtime/request.rb, line 105
105:     def accept_language ; @lang ||= Accept.parse(@request.env['HTTP_ACCEPT_LANGUAGE']) ; end
method()

The request method. Because browsers can‘t send PUT or DELETE requests this can be simulated by sending a POST with a hidden field named ‘_method’ and a value with ‘PUT’ or ‘DELETE’. Also accepted is when a query parameter named ‘_method’ is provided.

[Source]

    # File lib/runtime/request.rb, line 47
47:     def method
48:       @method ||= ( ( ( m = @request.request_method.downcase ) == 'post' and 
49:         ( n = @request['_method'] ) ) ? n.downcase : m ).intern
50:     end
method_missing( name, *args, &body )

access HTTP headers as methods

[Source]

    # File lib/runtime/request.rb, line 55
55:     def method_missing( name, *args, &body )
56:       return super unless args.empty? and body.nil?
57:       key = "HTTP_#{name.to_s.upcase}" 
58:       @request.env[ key ] if @request.env.has_key?( key )
59:     end
not_found()

Raise a not found exception.

[Source]

    # File lib/runtime/request.rb, line 62
62:     def not_found
63:       raise Waves::Dispatchers::NotFoundError, "#{@request.url} not found." 
64:     end
params()

Alias for query

path()

The request path (PATH_INFO). Ex: +/entry/2008-01-17+

[Source]

    # File lib/runtime/request.rb, line 31
31:     def path ; @request.path_info ; end
query()

Access to "params" - aka the query string - as a hash

[Source]

    # File lib/runtime/request.rb, line 34
34:     def query ; @request.params ; end
rack_request()

[Source]

    # File lib/runtime/request.rb, line 23
23:     def rack_request; @request; end
redirect( path, status = '302' )

Issue a redirect for the given path.

[Source]

    # File lib/runtime/request.rb, line 67
67:     def redirect( path, status = '302' )
68:       raise Waves::Dispatchers::Redirect.new( path, status )
69:     end

[Validate]