Class: Authenticate::Lifecycle

Inherits:
Object
  • Object
show all
Includes:
Debug
Defined in:
lib/authenticate/lifecycle.rb

Overview

Lifecycle stores and runs callbacks for authorization events.

Heavily borrowed from warden (github.com/hassox/warden).

Events:

  • :set_user - called after the user object is loaded, either through id/password or via session token.

  • :authentication - called after the user authenticates with id & password

Callbacks are added via after_set_user or after_authentication.

Callbacks can throw(:failure,message) to signal an authentication/authorization failure, or perform actions on the user or session.

Options

The callback options may optionally specify when to run the callback:

  • only - executes the callback only if it matches the event(s) given

  • except - executes the callback except if it matches the event(s) given

The callback may also specify a ‘name’ key in options. This is for debugging purposes only.

Callback block parameters

Callbacks are invoked with the following block parameters: |user, session, opts|

  • user - the user object just loaded

  • session - the Authenticate::Session

  • opts - any options you want passed into the callback

Example

# A callback to track the users successful logins:
Authenticate.lifecycle.after_set_user do |user, session, opts|
  user. += 1
end

Instance Method Summary collapse

Methods included from Debug

#debug

Constructor Details

#initialize ⇒ Lifecycle

Returns a new instance of Lifecycle.



42
43
44
 
# File 'lib/authenticate/lifecycle.rb', line 42

def initialize
  @conditions = [:only, :except, :event].freeze
end

Instance Method Details

#after_authentication(options = {}, method = :push, &block) ⇒ Object

A callback to run after the user successfully authenticates, during the login process. Mechanically identical to [#after_set_user].



53
54
55
 
# File 'lib/authenticate/lifecycle.rb', line 53

def after_authentication(options = {}, method = :push, &block)
  add_callback(after_authentication_callbacks, options, method, &block)
end

#after_set_user(options = {}, method = :push, &block) ⇒ Object

This callback is triggered after the first time a user is set during per-hit authorization, or during login.



47
48
49
 
# File 'lib/authenticate/lifecycle.rb', line 47

def after_set_user(options = {}, method = :push, &block)
  add_callback(after_set_user_callbacks, options, method, &block)
end

#prepend_after_authentication(options = {}, &block) ⇒ Object 



78
79
80
 
# File 'lib/authenticate/lifecycle.rb', line 78

def prepend_after_authentication(options = {}, &block)
  after_authentication(options, :unshift, &block)
end

#run_callbacks(kind, user, session, *args) ⇒ Object

Run callbacks of the given kind.

  • kind - :authenticate or :after_set_user

  • args - user, session, opts hash. Opts is an optional event, e.g. { event: :authentication }

Example:

Authenticate.lifecycle.run_callbacks(:after_set_user, @current_user, self, { event: :authentication })



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/authenticate/lifecycle.rb', line 65

def run_callbacks(kind, user, session, *args) # args - |user, session, opts|
  # Last callback arg MUST be a Hash
  options = args.last
  send("#{kind}_callbacks").each do |callback, conditions| # each callback has 'conditions' stored with it
    conditions = conditions.dup.delete_if { |key, _val| !@conditions.include? key }
    invalid = conditions.find do |key, value|
      value.is_a?(Array) ? !value.include?(options[key]) : (value != options[key])
    end
    callback.call(user, session, *args) unless invalid
  end
  nil
end