lib/session_persistence.rb

   1 # frozen_string_literal: true
   2
   3 # Copyright (c) 2010 August Lilleaas
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining
   6 # a copy of this software and associated documentation files (the
   7 # "Software"), to deal in the Software without restriction, including
   8 # without limitation the rights to use, copy, modify, merge, publish,
   9 # distribute, sublicense, and/or sell copies of the Software, and to
  10 # permit persons to whom the Software is furnished to do so, subject to
  11 # the following conditions:
  12 #
  13 # The above copyright notice and this permission notice shall be
  14 # included in all copies or substantial portions of the Software.
  15 #
  16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23
  24 module SessionPersistence
  25   class << self
  26     private
  27
  28     # Install filter when we are included
  29     def included(controller)
  30       super
  31       controller.after_action :persist_session
  32     end
  33   end
  34
  35   private
  36
  37   # Override this method if you don't want to use session[:_remember_for].
  38   def session_persistence_key
  39     :_remember_for
  40   end
  41
  42   # Persist the session.
  43   #
  44   #   session_expires_after 1.hour
  45   #   session_expires_after 2.weeks
  46   def session_expires_after(seconds)
  47     session[session_persistence_key] = seconds.to_i
  48   end
  49
  50   # Expire the session.
  51   def session_expires_automatically
  52     session.delete(session_persistence_key)
  53     request.session_options[:renew] = true
  54   end
  55
  56   # Filter callback
  57   def persist_session
  58     request.session_options[:expire_after] = session[session_persistence_key] if session[session_persistence_key]
  59   rescue StandardError
  60     reset_session
  61   end
  62 end