The Auth helper can be used for authentication without using a model. This can be useful when working with very basic applications that don’t require database access.
If you’re looking for a way to do authentication using a model you should take a look at Helper::User instead.
Log a user in based on the :username and :password key in the request hash.
@return [String] The login template in case the user’s login data was
incorrect.
# File lib/ramaze/helper/auth.rb, line 33 33: def login 34: if trait[:auth_post_only] and !request.post? 35: return auth_template 36: end 37: 38: @username, password = request[:username, :password] 39: 40: answer(request.referer) if auth_login(@username, password) 41: 42: return auth_template 43: end
Try to log the user in based on the username and password. This method is called by the login() method and shouldn’t be called directly.
@param [String] user The users’s username. @param [String] pass The user’s password.
# File lib/ramaze/helper/auth.rb, line 81 81: def auth_login(user, pass) 82: return unless user and pass 83: return if user.empty? or pass.empty? 84: 85: return unless table = ancestral_trait[:auth_table] 86: return unless hashify = ancestral_trait[:auth_hashify] 87: 88: if table.respond_to?(:to_sym) or table.respond_to?(:to_str) 89: table = send(table) 90: elsif table.respond_to?(:call) 91: table = table.call 92: end 93: 94: return unless table[user] == hashify.call(pass) 95: 96: session[:logged_in] = true 97: session[:username] = user 98: end
Remove the session items that specified that the user was logged in.
# File lib/ramaze/helper/auth.rb, line 103 103: def auth_logout 104: session.delete(:logged_in) 105: session.delete(:username) 106: end
Method that returns a small form that can be used for logging in.
@return [String] The login form.
# File lib/ramaze/helper/auth.rb, line 112 112: def auth_template 113: <form method="post" action="#{r(:login)}"> <ul style="list-style:none;"> <li>Username: <input type="text" name="username" value="#@username"/></li> <li>Password: <input type="password" name="password" /></li> <li><input type="submit" /></li> </ul></form>.strip! 114: end
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.