lib/session_persistence.rb

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