Module: Devise::Models::Lockable::ClassMethods

Defined in:
lib/devise/models/lockable.rb

Instance Method Summary collapse

Instance Method Details

#lock_strategy_enabled?(strategy) ⇒ Boolean

Is the lock enabled for the given lock strategy?

Returns:

  • (Boolean) 


161
162
163
 
# File 'lib/devise/models/lockable.rb', line 161

def lock_strategy_enabled?(strategy)
  self.lock_strategy == strategy
end

#send_unlock_instructions(attributes = {}) ⇒ Object

Attempt to find a user by it’s email. If a record is found, send new unlock instructions to it. If not user is found, returns a new user with an email not found error. Options must contain the user email



139
140
141
142
143
 
# File 'lib/devise/models/lockable.rb', line 139

def send_unlock_instructions(attributes={})
 lockable = find_or_initialize_with_errors(unlock_keys, attributes, :not_found)
 lockable.resend_unlock_token if lockable.persisted?
 lockable
end

#unlock_access_by_token(unlock_token) ⇒ Object

Find a user by it’s unlock token and try to unlock it. If no user is found, returns a new user with an error. If the user is not locked, creates an error for the user Options must have the unlock_token



149
150
151
152
153
 
# File 'lib/devise/models/lockable.rb', line 149

def unlock_access_by_token(unlock_token)
  lockable = find_or_initialize_with_error_by(:unlock_token, unlock_token)
  lockable.unlock_access! if lockable.persisted?
  lockable
end

#unlock_strategy_enabled?(strategy) ⇒ Boolean

Is the unlock enabled for the given unlock strategy?

Returns:

  • (Boolean) 


156
157
158
 
# File 'lib/devise/models/lockable.rb', line 156

def unlock_strategy_enabled?(strategy)
  [:both, strategy].include?(self.unlock_strategy)
end

#unlock_token ⇒ Object 



165
166
167
 
# File 'lib/devise/models/lockable.rb', line 165

def unlock_token
  Devise.friendly_token
end