Strelka::App::

Sessions

module

Included Modules: Strelka::Constants; Strelka::HTTPRequest::Session; Strelka::HTTPResponse::Session
Extended With: Strelka::Plugin; Strelka::MethodUtilities; Configurability; Loggability

This plugin adds a persistant storage mechanism to Strelka applications that can be used to store data about a user's session.

Examples¶ ↑

class HelloWorld < Strelka::App

    # Use the default session store and id-generator
    plugins :routing, :sessions

    session_namespace :foo  # defaults to the app's ID

    get '' do
        finish_with HTTP::FORBIDDEN, "no session!" unless req.session?

        username = req.session[:username]
    end

end # class HelloWorld

Components¶ ↑

This plugin is split up into four parts:

Strelka::Session: The abstract base class for the session object; provides the interface for getting and setting session data, writing the resulting data structure to permanent storage (if necessary), and generating the token that associates the request with the session.
Strelka::HTTPRequest::Session: A mixin module that's added to HTTPRequest when the :sessions plugin is installed. Provides the API on HTTPRequest for fetching and interacting with the Session object.
Strelka::HTTPResponse::Session: A mixin module that's added to HTTPResponse when the :sessions plugin is installed. Provides the API on HTTPResponse for fetching and interacting with the Session object.
Strelka::App::Sessions: This module; stitches the whole system together in your application.

Configuration¶ ↑

To specify which Session class to use with your application, add a ':sessions' section with at least the 'session_class' key to your config.yml:

# Use the default session class, but change the name of the cookie
# it uses
sessions:
  session_class: default

defaultsession:
    cookie_name: acme-session

# Use the database-backed session type and point it
# at a database
sessions:
  session_class: db

dbsession:
    connect: "postgres://pg.example.com/db01"
    table_name: sessions

The session_class value will be used to look up the class (see Strelka::Session for more information about how this works), and the options section is passed to the session class's ::configure method (if it has one).

Constants

CONFIG_DEFAULTS: Default options to pass to the session object

Public Class Methods

anchor

configure( config=nil )

Configurability API – set up session type and options with values from the config.

# File lib/strelka/app/sessions.rb, line 150
def self::configure( config=nil )
        # Figure out which session class is going to be used, or choose a default one
        if config
                self.session_class = config[:session_class]
        else
                self.session_class = CONFIG_DEFAULTS[:session_class]
        end

end

anchor

included( object )

Extension callback – extend the HTTPRequest classes with Session support when this plugin is loaded.

# File lib/strelka/app/sessions.rb, line 163
def self::included( object )
        self.log.debug "Extending Request with Session mixin"
        Strelka::HTTPRequest.class_eval { include Strelka::HTTPRequest::Session }
        self.log.debug "Extending Response with Session mixin"
        Strelka::HTTPResponse.class_eval { include Strelka::HTTPResponse::Session }
        super
end

anchor

session_class=( newclass )

Get the configured session class (Strelka::Session subclass)

# File lib/strelka/app/sessions.rb, line 143
def self::session_class=( newclass )
        @session_class = Strelka::Session.get_subclass( newclass )
end

Public Instance Methods

anchor

fixup_request( request )

Set the session namespace on the HTTPRequest before running the application.

# File lib/strelka/app/sessions.rb, line 173
def fixup_request( request )
        request.session_namespace = self.class.session_namespace
        return super
end

anchor

fixup_response( response )

Save the session after the app and plugins are done with the HTTPResponse.

# File lib/strelka/app/sessions.rb, line 180
def fixup_response( response )
        self.log.debug "Saving the session in the response."
        response.save_session
        return super
end

anchor

session_class()

What session class to use (String, Symbol, or Class); passed to Strelka::Session.create.

# File lib/strelka/app/sessions.rb, line 139
singleton_attr_reader :session_class