Module: Devise::Controllers::Rememberable

Included in:
Hooks::Proxy
Defined in:
lib/devise/controllers/rememberable.rb

Overview

A module that may be optionally included in a controller in order to provide remember me behavior. Useful when signing in is done through a callback, like in OmniAuth.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

Return default cookie values retrieved from session options.


10
11
12
# File 'lib/devise/controllers/rememberable.rb', line 10

def self.cookie_values
  Rails.configuration.session_options.slice(:path, :domain, :secure)
end

Instance Method Details


38
39
40
# File 'lib/devise/controllers/rememberable.rb', line 38

def forget_cookie_values(resource)
  Devise::Controllers::Rememberable.cookie_values.merge!(resource.rememberable_options)
end

#forget_me(resource) ⇒ Object

Forgets the given resource by deleting a cookie


30
31
32
33
34
# File 'lib/devise/controllers/rememberable.rb', line 30

def forget_me(resource)
  scope = Devise::Mapping.find_scope!(resource)
  resource.forget_me!
  cookies.delete(remember_key(resource, scope), forget_cookie_values(resource))
end

42
43
44
45
46
47
48
49
# File 'lib/devise/controllers/rememberable.rb', line 42

def remember_cookie_values(resource)
  options = { httponly: true }
  options.merge!(forget_cookie_values(resource))
  options.merge!(
    value: resource.class.serialize_into_cookie(resource),
    expires: resource.remember_expires_at
  )
end

#remember_key(resource, scope) ⇒ Object (protected)


51
52
53
# File 'lib/devise/controllers/rememberable.rb', line 51

def remember_key(resource, scope)
  resource.rememberable_options.fetch(:key, "remember_#{scope}_token")
end

#remember_me(resource) ⇒ Object

Remembers the given resource by setting up a cookie


22
23
24
25
26
27
# File 'lib/devise/controllers/rememberable.rb', line 22

def remember_me(resource)
  return if request.env["devise.skip_storage"]
  scope = Devise::Mapping.find_scope!(resource)
  resource.remember_me!
  cookies.signed[remember_key(resource, scope)] = remember_cookie_values(resource)
end

#remember_me_is_active?(resource) ⇒ Boolean

Returns:

  • (Boolean)

14
15
16
17
18
19
# File 'lib/devise/controllers/rememberable.rb', line 14

def remember_me_is_active?(resource)
  return false unless resource.respond_to?(:remember_me)
  scope = Devise::Mapping.find_scope!(resource)
  _, token, generated_at = cookies.signed[remember_key(resource, scope)]
  resource.remember_me?(token, generated_at)
end