Module: Clearance::Authentication::InstanceMethods

Defined in:
lib/clearance/authentication.rb

Instance Method Summary collapse

Instance Method Details

#authenticate ⇒ Object

Deny the user access if they are signed out.

Examples:

before_filter :authenticate



46
47
48
 
# File 'lib/clearance/authentication.rb', line 46

def authenticate
  deny_access unless signed_in?
end

#current_user ⇒ User?

User in the current cookie

Returns:



17
18
19
 
# File 'lib/clearance/authentication.rb', line 17

def current_user
  @_current_user ||= user_from_cookie
end

#current_user=(user) ⇒ Object

Set the current user

Parameters:



24
25
26
 
# File 'lib/clearance/authentication.rb', line 24

def current_user=(user)
  @_current_user = user
end

#deny_access(flash_message = nil) ⇒ Object

Store the current location. Display a flash message if included. Redirect to sign in.

Parameters:

  • optional (String) —

    flash message to display to denied user



81
82
83
84
85
 
# File 'lib/clearance/authentication.rb', line 81

def deny_access(flash_message = nil)
  store_location
  flash[:failure] = flash_message if flash_message
  redirect_to(new_session_url)
end

#sign_in(user) ⇒ Object

Sign user in to cookie.

Examples:

(@user)

Parameters:



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/clearance/authentication.rb', line 56

def (user)
  if user
    user.remember_me!
    cookies[:remember_token] = {
      :value   => user.remember_token,
      :expires => 1.year.from_now.utc
    }
    current_user = user
  end
end

#sign_out ⇒ Object

Sign user out of cookie.

Examples:

sign_out



71
72
73
74
 
# File 'lib/clearance/authentication.rb', line 71

def sign_out
  cookies.delete(:remember_token)
  current_user = nil
end

#signed_in? ⇒ true, false

Is the current user signed in?

Returns:

  • (true, false) 


31
32
33
 
# File 'lib/clearance/authentication.rb', line 31

def signed_in?
  ! current_user.nil?
end

#signed_out? ⇒ true, false

Is the current user signed out?

Returns:

  • (true, false) 


38
39
40
 
# File 'lib/clearance/authentication.rb', line 38

def signed_out?
  current_user.nil?
end