Class: Parse::Session

Inherits:
Object
  • Object
show all
Defined in:
lib/parse/model/classes/session.rb,
lib/parse/stack/generators/templates/model_session.rb

Overview

This class represents the data and columns contained in the standard Parse _Session collection. The Session class maintains per-device (or website) authentication information for a particular user. Whenever a User object is logged in, a new Session record, with a session token is generated. You may use a known active session token to find the corresponding user for that session. Deleting a Session record (and session token), effectively logs out the user, when making Parse requests on behalf of the user using the session token.

The default schema for the Session class is as follows:

class Parse::Session < Parse::Object
 # See Parse::Object for inherited properties...

 property :session_token
 property :created_with, :object
 property :expires_at, :date
 property :installation_id
 property :restricted, :boolean

 belongs_to :user

 # Installation where the installation_id matches.
 has_one :installation, ->{ where(installation_id: i.installation_id) }, scope_only: true
end

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#created_with ⇒ Hash

Returns data on how this Session was created.

Returns:

  • (Hash) —

    data on how this Session was created.



36
 
# File 'lib/parse/model/classes/session.rb', line 36

property :created_with, :object

#expires_at ⇒ Parse::Date

Returns when the session token expires.

Returns:



40
 
# File 'lib/parse/model/classes/session.rb', line 40

property :expires_at, :date

#installation ⇒ Parse::Installation (readonly)

Returns the Installation where the sessions installation_id field matches the installation_id field in the Installation collection. This is implemented as a has_one scope.

Returns:

Version:

  • 1.7.1



66
 
# File 'lib/parse/model/classes/session.rb', line 66

has_one :installation, -> { where(installation_id: i.installation_id) }, scope_only: true

#installation_id ⇒ String

Returns The installation id from the Installation table.

Returns:

  • (String) —

    The installation id from the Installation table.

See Also:



45
 
# File 'lib/parse/model/classes/session.rb', line 45

property :installation_id

#restricted ⇒ Boolean (readonly)

Returns whether this session token is restricted.

Returns:

  • (Boolean) —

    whether this session token is restricted.



49
 
# File 'lib/parse/model/classes/session.rb', line 49

property :restricted, :boolean

#session_token ⇒ String (readonly)

Returns the session token for this installation and user pair.

Returns:

  • (String) —

    the session token for this installation and user pair.



53
 
# File 'lib/parse/model/classes/session.rb', line 53

property :session_token

#user ⇒ User (readonly)

This property is mapped as a belongs_to association with the User class. Every session instance is tied to a specific logged in user.

Returns:

  • (User) —

    the user corresponding to this session.

See Also:



59
 
# File 'lib/parse/model/classes/session.rb', line 59

belongs_to :user

Class Method Details

.active ⇒ Parse::Query

Query scope for active (non-expired) sessions.

Examples:

active_sessions = Parse::Session.active.all

Returns:

  • (Parse::Query) —

    a query for sessions that haven't expired



95
96
97
 
# File 'lib/parse/model/classes/session.rb', line 95

def active
  query(:expires_at.gte => Time.now)
end

.active_count_for_user(user) ⇒ Integer

Count active sessions for a specific user.

Examples:

count = Parse::Session.active_count_for_user(user)

Parameters:

Returns:

  • (Integer) —

    count of active sessions



140
141
142
 
# File 'lib/parse/model/classes/session.rb', line 140

def active_count_for_user(user)
  for_user(user).where(:expires_at.gte => Time.now).count
end

.expired ⇒ Parse::Query

Query scope for expired sessions.

Examples:

expired_sessions = Parse::Session.expired.all

Returns:



103
104
105
 
# File 'lib/parse/model/classes/session.rb', line 103

def expired
  query(:expires_at.lt => Time.now)
end

.for_user(user) ⇒ Parse::Query

Query scope for sessions belonging to a specific user.

Examples:

user_sessions = Parse::Session.for_user(user).all

Parameters:

Returns:



112
113
114
115
 
# File 'lib/parse/model/classes/session.rb', line 112

def for_user(user)
  user = Parse::User.pointer(user) if user.is_a?(String)
  query(user: user)
end

.revoke_all_for_user(user, except: nil) ⇒ Integer

Revoke (delete) all sessions for a specific user.

Examples:

# Revoke all sessions for a user
Parse::Session.revoke_all_for_user(user)

# Revoke all except current session
Parse::Session.revoke_all_for_user(user, except: current_session_token)

Parameters:

Returns:

  • (Integer) —

    the number of sessions revoked



127
128
129
130
131
132
133
 
# File 'lib/parse/model/classes/session.rb', line 127

def revoke_all_for_user(user, except: nil)
  sessions = for_user(user)
  sessions = sessions.where(:session_token.ne => except) if except
  sessions_to_revoke = sessions.all
  sessions_to_revoke.each(&:destroy)
  sessions_to_revoke.count
end

.session(token, **opts) ⇒ Session

Return the Session record for this session token.

Parameters:

  • token (String) —

    the session token

  • opts (Hash) —

    additional keyword options forwarded to the underlying client request (e.g. cache: false, use_master_key: false, headers:).

Returns:

  • (Session) —

    the session for this token, otherwise nil.



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/parse/model/classes/session.rb', line 79

def session(token, **opts)
  # A stray :session_token in opts would be forwarded into the request
  # stack and silently override the positional token argument. Drop it
  # so the explicit token always wins.
  opts.delete(:session_token)
  response = client.fetch_session(token, **opts)
  if response.success?
    return Parse::Session.build response.result
  end
  nil
end

Instance Method Details

#expired? ⇒ Boolean

Check if this session has expired.

Examples:

if session.expired?
  puts "Session has expired"
end

Returns:

  • (Boolean) —

    true if the session has expired



155
156
157
158
 
# File 'lib/parse/model/classes/session.rb', line 155

def expired?
  return false if expires_at.nil?
  expires_at < Time.now
end

#expires_within?(duration) ⇒ Boolean

Check if this session expires within the given duration.

Examples:

if session.expires_within?(1.hour)
  puts "Session expires soon!"
end

Parameters:

  • duration (Integer) —

    number of seconds

Returns:

  • (Boolean) —

    true if session expires within the duration



188
189
190
191
 
# File 'lib/parse/model/classes/session.rb', line 188

def expires_within?(duration)
  return false if expires_at.nil?
  expires_at < (Time.now + duration)
end

#revoke! ⇒ Boolean

Revoke (delete) this session, effectively logging out the user on this device.

Examples:

session.revoke!

Returns:

  • (Boolean) —

    true if successfully revoked



197
198
199
 
# File 'lib/parse/model/classes/session.rb', line 197

def revoke!
  destroy
end

#time_remaining ⇒ Float?

Get the remaining time until this session expires.

Examples:

remaining = session.time_remaining
puts "Session expires in #{remaining / 3600} hours" if remaining

Returns:

  • (Float, nil) —

    seconds remaining until expiration, nil if no expiration, 0 if already expired



175
176
177
178
179
 
# File 'lib/parse/model/classes/session.rb', line 175

def time_remaining
  return nil if expires_at.nil?
  remaining = expires_at.to_time - Time.now
  remaining > 0 ? remaining : 0
end

#valid? ⇒ Boolean

Check if this session is still valid (not expired).

Examples:

if session.valid?
  puts "Session is still active"
end

Returns:

  • (Boolean) —

    true if the session is still valid



166
167
168
 
# File 'lib/parse/model/classes/session.rb', line 166

def valid?
  !expired?
end