Strelka: A Ruby Web Framework

Abstract base class for pluggable session strategies for the Sessions plugin.

To define your own session type, you'll need to inherit this class (either directly or via a subclass), name it Strelka::Session::{Something}, save it in a file named strelka/session/{something}.rb, and override the required methods.

The class methods you'll need to provide implementations for are:

self.configure
self.get_session_id
self.get_existing_session_id
self.load_session_data
self.save_session_data
self.delete_session_data

The instance methods fetch and set values in the session itself, and manipulate the namespace that's used to partition session data between applications:

[]
[]=
save
delete
key?
namespace=
namespace

These methods provide basic functionality, but you might find it more efficient to override them:

self.load_or_create
self.load

Attributes

session_id[R]: The key of the session in the session store

Public Class Methods

anchor

configure( options )

Configure the session class with the given options, which should be a Hash or an object that has a Hash-like interface. This is a no-op by default.

# File lib/strelka/session.rb, line 61
def self::configure( options )
end

anchor

delete_session_data( session_id )

Delete the session data for the specified session_id.

# File lib/strelka/session.rb, line 95
def self::delete_session_data( session_id )
end

anchor

get_existing_session_id( request )

Fetch the session ID from the given +request, returning nil if it doesn't have any session attributes. You should override this and provide the code which fetches the ID from the request.

# File lib/strelka/session.rb, line 68
def self::get_existing_session_id( request )
        return nil
end

anchor

get_session_id( request=nil )

Fetch the session ID from the given request, or create a new one if the request is nil or doesn't have the necessary attributes. You should override this, as the default implementation just returns nil.

# File lib/strelka/session.rb, line 76
def self::get_session_id( request=nil )
        return nil
end

anchor

has_session_for?( request )

Return true if the given request has a valid session token, and that token corresponds to an existing session ID. You should override this if there's a cheaper way to check for an existing session than just calling ::load_session_data.

# File lib/strelka/session.rb, line 122
def self::has_session_for?( request )
        id = self.get_existing_session_id( request ) or return false
        return true if self.load( id )
end

anchor

load( session_id )

Load a session instance from storage using the given session_id and return it. Returns nil if no session could be loaded. You can either overload ::load_session_data if you are loading a data structure, or override ::load if you're serializing the session object directly.

# File lib/strelka/session.rb, line 103
def self::load( session_id )
        values = self.load_session_data( session_id ) or return nil
        return new( session_id, values )
end

anchor

load_or_create( request=nil )

Return an instance of the session class that's associated with the specified request, either loading one from the persistant store, or creating a new one if it can't be loaded or request is nil.

# File lib/strelka/session.rb, line 112
def self::load_or_create( request=nil )
        session_id = self.get_session_id( request )
        return self.load( session_id ) || new( session_id )
end

anchor

load_session_data( session_id )

Load session data for the specified session_id. This should return a data structure that can merge!, or nil if there was no existing session data associated with session_id.

# File lib/strelka/session.rb, line 84
def self::load_session_data( session_id )
        return nil
end

anchor

save_session_data( session_id, data )

Save the session data for the specified session_id.

# File lib/strelka/session.rb, line 90
def self::save_session_data( session_id, data )
end

Protected Instance Methods

anchor

initialize( session_id=nil, initial_values={} )

Set up a new instance with the given session_id and initial_values.

# File lib/strelka/session.rb, line 133
def initialize( session_id=nil, initial_values={} ) # :notnew:
        @session_id = session_id || self.class.get_session_id
end