Class: SessionInstance

Inherits:
Object
  • Object
show all
Defined in:
lib/primate/session.rb

Overview

Internal session instance class (used by framework)

Instance Method Summary collapse

Constructor Details

#initialize(session, helpers) ⇒ SessionInstance

Initialize session with JavaScript session object and helpers

Parameters:

  • session (Object) —

    JavaScript session object from the runtime

  • helpers (Object) —

    Helper functions from JavaScript runtime



75
76
77
78
 
# File 'lib/primate/session.rb', line 75

def initialize(session, helpers)
  @session = session
  @helpers = helpers
end

Instance Method Details

#create(data) ⇒ void

This method returns an undefined value.

Create a new session with data

Parameters:

  • data (Hash) —

    Initial session data



98
99
100
 
# File 'lib/primate/session.rb', line 98

def create(data)
  @session.create(data)
end

#destroy ⇒ void

This method returns an undefined value.

Destroy the session



127
128
129
 
# File 'lib/primate/session.rb', line 127

def destroy
  @session.destroy
end

#exists ⇒ Boolean

Check if session exists

Returns:

  • (Boolean) —

    True if session exists



90
91
92
 
# File 'lib/primate/session.rb', line 90

def exists
  @session['exists']
end

#get ⇒ Hash

Get session data (raises if no session)

Returns:

  • (Hash) —

    Session data



105
106
107
 
# File 'lib/primate/session.rb', line 105

def get
  @session.get
end

#id ⇒ String

Get the session ID

Returns:

  • (String) —

    Session identifier



83
84
85
 
# File 'lib/primate/session.rb', line 83

def id
  @session['id']
end

#set(data) ⇒ void

This method returns an undefined value.

Set session data

Parameters:

  • data (Hash) —

    Data to store in session



120
121
122
 
# File 'lib/primate/session.rb', line 120

def set(data)
  @session.set(data)
end

#try ⇒ Hash

Try to get session data (returns empty if no session)

Returns:

  • (Hash) —

    Session data or empty hash



112
113
114
 
# File 'lib/primate/session.rb', line 112

def try
  @session.try
end