Module: Sessions::EndReason

Defined in:

lib/sessions/end_reason.rb

Overview

Canonical lifecycle vocabulary for registry rows.

v0.1.x used “row missing + event tombstone” as the revocation signal. That made Warden infer security intent from absence, which is exactly how quiet housekeeping ended up looking too much like a real logout. v0.2 moves the source of truth onto the session row itself: events are audit trail, not liveness state.

External precedents:

• Rails 8 generated auth resolves a Session row on every request: github.com/rails/rails/blob/main/railties/lib/rails/generators/rails/authentication/templates/app/controllers/concerns/authentication.rb.tt

• Rodauth’s active_sessions feature keeps explicit active-session state separate from audit logging: github.com/jeremyevans/rodauth/blob/master/lib/rodauth/features/active_sessions.rb

Constant Summary

LOGOUT =

"logout"

EXPIRED =

"expired"

SUPERSEDED =

"superseded"

REVOKED =

%w[
  user_revoked
  admin_revoked
  password_change
  logout_everywhere
  pruned
  unknown
].freeze

INTERNAL =

[SUPERSEDED].freeze

EVENTS =

{
  LOGOUT => "logout",
  EXPIRED => "expired"
}.freeze

KICKING =

([LOGOUT, EXPIRED] + REVOKED).freeze

Class Method Summary

• .event_for(reason) ⇒ Object
• .internal?(reason) ⇒ Boolean
• .kicks_on_resume?(reason) ⇒ Boolean
• .normalize(reason) ⇒ Object
• .revoked_reason_for(reason) ⇒ Object

Class Method Details

.event_for(reason) ⇒ Object

# File 'lib/sessions/end_reason.rb', line 55

def event_for(reason)
  normalized = normalize(reason)
  return nil if internal?(normalized)

  EVENTS.fetch(normalized, "revoked")
end

.internal?(reason) ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/sessions/end_reason.rb', line 47

def internal?(reason)
  INTERNAL.include?(normalize(reason))
end

.kicks_on_resume?(reason) ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/sessions/end_reason.rb', line 51

def kicks_on_resume?(reason)
  KICKING.include?(normalize(reason))
end

.normalize(reason) ⇒ Object

# File 'lib/sessions/end_reason.rb', line 42

def normalize(reason)
  value = reason.to_s.presence || "unknown"
  value == "revoked" ? "user_revoked" : value
end

.revoked_reason_for(reason) ⇒ Object

# File 'lib/sessions/end_reason.rb', line 62

def revoked_reason_for(reason)
  normalized = normalize(reason)
  event_for(normalized) == "revoked" ? normalized : nil
end