Provides access to the callback array for after_failed_fetch :api: private
# File lib/warden/hooks.rb, line 143 def _after_failed_fetch @_after_failed_fetch ||= [] end
Provides access to the callback array for before_failure :api: private
# File lib/warden/hooks.rb, line 115 def _before_failure @_before_failure ||= [] end
Provides access to the callback array for before_logout :api: private
# File lib/warden/hooks.rb, line 171 def _before_logout @_before_logout ||= [] end
Provides access to the callback array for before_logout :api: private
# File lib/warden/hooks.rb, line 196 def _on_request @_on_request ||= [] end
after_authentication is just a wrapper to after_set_user, which is only invoked when the user is set through the authentication path. The options and yielded arguments are the same as in after_set_user.
:api: public
# File lib/warden/hooks.rb, line 74 def after_authentication(options = {}, method = :push, &block) after_set_user(options.merge(:event => :authentication), method, &block) end
A callback that runs if no user could be fetched, meaning there is now no user logged in.
Parameters: <options> Some options which specify when the callback should be executed
scope - Executes the callback only if it maches the scope(s) given
<block> A block to contain logic for the callback
Block Parameters: |user, auth, scope| user - The authenticated user for the current scope auth - The warden proxy object opts - any options passed into the authenticate call including :scope
Example:
Warden::Manager.after_failed_fetch do |user, auth, opts| I18n.locale = :en end
:api: public
# File lib/warden/hooks.rb, line 136 def after_failed_fetch(options = {}, method = :push, &block) raise BlockNotGiven unless block_given? _after_failed_fetch.send(method, [block, options]) end
after_fetch is just a wrapper to after_set_user, which is only invoked when the user is fetched from sesion. The options and yielded arguments are the same as in after_set_user.
:api: public
# File lib/warden/hooks.rb, line 83 def after_fetch(options = {}, method = :push, &block) after_set_user(options.merge(:event => :fetch), method, &block) end
A callback hook set to run every time after a user is set. This callback is triggered the first time one of those three events happens during a request: :authentication, :fetch (from session) and :set_user (when manually set). You can supply as many hooks as you like, and they will be run in order of decleration.
If you want to run the callbacks for a given scope and/or event, you can specify them as options. See parameters and example below.
Parameters: <options> Some options which specify when the callback should be executed
scope - Executes the callback only if it maches the scope(s) given only - Executes the callback only if it matches the event(s) given except - Executes the callback except if it matches the event(s) given
<block> A block where you can set arbitrary logic to run every time a user is set
Block Parameters: |user, auth, opts| user - The user object that is being set auth - The raw authentication proxy object. opts - any options passed into the set_user call includeing :scope
Example:
Warden::Manager.after_set_user do |user,auth,opts| scope = opts[:scope] if auth.session["#{scope}.last_access"].to_i > (Time.now - 5.minutes) auth.logout(scope) throw(:warden, :scope => scope, :reason => "Times Up") end auth.session["#{scope}.last_access"] = Time.now end Warden::Manager.after_set_user :except => :fetch do |user,auth,opts| user.login_count += 1 end
:api: public
# File lib/warden/hooks.rb, line 51 def after_set_user(options = {}, method = :push, &block) raise BlockNotGiven unless block_given? if options.key?(:only) options[:event] = options.delete(:only) elsif options.key?(:except) options[:event] = [:set_user, :authentication, :fetch] - Array(options.delete(:except)) end _after_set_user.send(method, [block, options]) end
A callback that runs just prior to the failur application being called. This callback occurs after PATH_INFO has been modified for the failure (default /unauthenticated) In this callback you can mutate the environment as required by the failure application If a Rails controller were used for the failure_app for example, you would need to set request[:action] = :unauthenticated
Parameters: <options> Some options which specify when the callback should be executed
scope - Executes the callback only if it maches the scope(s) given
<block> A block to contain logic for the callback
Block Parameters: |env, opts| env - The rack env hash opts - any options passed into the authenticate call includeing :scope
Example:
Warden::Manager.before_failure do |env, opts| params = Rack::Request.new(env).params params[:action] = :unauthenticated params[:warden_failure] = opts end
:api: public
# File lib/warden/hooks.rb, line 108 def before_failure(options = {}, method = :push, &block) raise BlockNotGiven unless block_given? _before_failure.send(method, [block, options]) end
A callback that runs just prior to the logout of each scope.
Parameters: <options> Some options which specify when the callback should be executed
scope - Executes the callback only if it maches the scope(s) given
<block> A block to contain logic for the callback
Block Parameters: |user, auth, scope| user - The authenticated user for the current scope auth - The warden proxy object opts - any options passed into the authenticate call including :scope
Example:
Warden::Manager.before_logout do |user, auth, opts| user.forget_me! end
:api: public
# File lib/warden/hooks.rb, line 164 def before_logout(options = {}, method = :push, &block) raise BlockNotGiven unless block_given? _before_logout.send(method, [block, options]) end
A callback that runs on each request, just after the proxy is initialized
Parameters: <block> A block to contain logic for the callback
Block Parameters: |proxy| proxy - The warden proxy object for the request
Example:
user = "A User" Warden::Manager.on_request do |proxy| proxy.set_user = user end
:api: public
# File lib/warden/hooks.rb, line 189 def on_request(options = {}, method = :push, &block) raise BlockNotGiven unless block_given? _on_request.send(method, [block, options]) end
Generated with the Darkfish Rdoc Generator 2.