Wrapper for the ever-present "user" in your application. It wraps around an arbitrary instance and worries about authentication and storing information about the user in the session.
In order to not interfere with the wrapped instance/model we start our methods with an underscore.
Patches and suggestions are highly appreciated.
@author manveru @api internal @see Ramaze::Helper::User#logged_in? @return [true false] whether the current user is logged in.
# File lib/ramaze/helper/user.rb, line 261 def _logged_in? !!_user end
@author manveru @see Ramaze::Helper::User#user_login @param [Hash] creds this hash will be stored in the session on
successful login
@return [Ramaze::Helper::User::Wrapper] wrapped return value from
model or callback
# File lib/ramaze/helper/user.rb, line 209 def _login(creds = nil) if creds if @_user = _would_login?(creds) Current.session.resid! self._persistence = {:credentials => creds} end elsif persistence = self._persistence @_user = _would_login?(persistence[:credentials]) end end
@author manveru @api internal @see Ramaze::Helper::User#user_logout
# File lib/ramaze/helper/user.rb, line 249 def _logout (_persistence || {}).clear Current.request.env['ramaze.helper.user'] = nil Current.session.resid! end
# File lib/ramaze/helper/user.rb, line 269 def _persistence Current.session[:USER] end
# File lib/ramaze/helper/user.rb, line 265 def _persistence=(obj) Current.session[:USER] = obj end
The callback should return an instance of the user, otherwise it should answer with nil.
This will not actually login, just check whether the credentials would result in a user.
# File lib/ramaze/helper/user.rb, line 227 def _would_login?(creds) return unless creds if c = @_callback c.call(creds) elsif _model.respond_to?(:authenticate) _model.authenticate(creds) else Log.warn( "Helper::User has no callback and there is no %p::authenticate" % _model ) nil end end
Generated with the Darkfish Rdoc Generator 2.