Contents

require 'devise/hooks/timeoutable'

module Devise
  module Models
    # Timeoutable takes care of verifyng whether a user session has already
    # expired or not. When a session expires after the configured time, the user
    # will be asked for credentials again, it means, he/she will be redirected
    # to the sign in page.
    #
    # == Options
    #
    # Timeoutable adds the following options to devise_for:
    #
    #   * +timeout_in+: the interval to timeout the user session without activity.
    #
    # == Examples
    #
    #   user.timedout?(30.minutes.ago)
    #
    module Timeoutable
      extend ActiveSupport::Concern

      def self.required_fields(klass)
        []
      end

      # Checks whether the user session has expired based on configured time.
      def timedout?(last_access)
        return false if remember_exists_and_not_expired?
        !timeout_in.nil? && last_access && last_access <= timeout_in.ago
      end

      def timeout_in
        self.class.timeout_in
      end

      private

      def remember_exists_and_not_expired?
        return false unless respond_to?(:remember_created_at) && respond_to?(:remember_expired?)
        remember_created_at && !remember_expired?
      end

      module ClassMethods
        Devise::Models.config(self, :timeout_in)
      end
    end
  end
end

Version data entries

11 entries across 11 versions & 1 rubygems

Version	Path
devise-3.2.2	lib/devise/models/timeoutable.rb
devise-3.2.1	lib/devise/models/timeoutable.rb
devise-3.1.2	lib/devise/models/timeoutable.rb
devise-3.0.4	lib/devise/models/timeoutable.rb
devise-3.2.0	lib/devise/models/timeoutable.rb
devise-3.1.1	lib/devise/models/timeoutable.rb
devise-3.1.0	lib/devise/models/timeoutable.rb
devise-3.0.3	lib/devise/models/timeoutable.rb
devise-3.1.0.rc2	lib/devise/models/timeoutable.rb
devise-3.0.2	lib/devise/models/timeoutable.rb
devise-3.0.1	lib/devise/models/timeoutable.rb