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


53
54
55
 
# File 'lib/clearance/authentication.rb', line 53

def authenticate
  deny_access unless signed_in?
end

#current_user ⇒ User?

User in the current cookie

Returns:



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

def current_user
  @_current_user ||= user_from_cookie
end

#current_user=(user) ⇒ Object

Set the current user

Parameters:



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

def current_user=(user)
  @_current_user = user
end

#deny_access(flash_message = nil) ⇒ Object

Store the current location and redirect to sign in. Display a failure flash message if included.

Parameters:

  • optional (String) —

    flash message to display to denied user



87
88
89
90
91
 
# File 'lib/clearance/authentication.rb', line 87

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

#sign_in(user) ⇒ Object

Sign user in to cookie.

Examples:

(@user)

Parameters:



63
64
65
66
67
68
69
70
71
 
# File 'lib/clearance/authentication.rb', line 63

def (user)
  if user
    cookies[:remember_token] = {
      :value   => user.remember_token,
      :expires => Clearance.configuration.cookie_expiration.call
    }
    self.current_user = user
  end
end

#sign_out ⇒ Object

Sign user out of cookie.

Examples:

sign_out


77
78
79
80
81
 
# File 'lib/clearance/authentication.rb', line 77

def sign_out
  current_user.reset_remember_token! if current_user
  cookies.delete(:remember_token)
  self.current_user = nil
end

#signed_in? ⇒ true, false

Is the current user signed in?

Returns:

  • (true, false) 


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

def signed_in?
  ! current_user.nil?
end

#signed_out? ⇒ true, false

Is the current user signed out?

Returns:

  • (true, false) 


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

def signed_out?
  current_user.nil?
end