auto-session-timeout 0.9.7 → 0.9.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc498b02e7b05cbf09f3af63eb7f83617970fa76287e7beb522e2b676df6c6a0
-  data.tar.gz: fad257ffc2872343879ab12346d6d029c5df75e3ec7eb0913e61f441afa5250b
+  metadata.gz: 71d3e9f467963b89be2bdfb4e87ce915ed693536fd0760cf954d6116c8987c3a
+  data.tar.gz: f3b2cfee583099d5bb29400db0e4e187f8fdfd1750cc12cfc45380316719df50
 SHA512:
-  metadata.gz: 58db2799f2c39e9f4107bbdd21b95a563786e5e1bed28670ff0f0d04d86596c0690846a8d07c71b92804d584a40704295539b06115e52eb538a4f5693f20152a
-  data.tar.gz: 0ba4a07545611dd012b465e9f21eb6768de9dd588ef4c9bb2c1815bc3253bab062c360443b088c5083cfc524b0e563193edaa86307ba00f8078f4d9064eaabb6
+  metadata.gz: 20685219ebb5e6750e215d8a873ad60b7de0a3e05f36c9bfb03249266b4886b240ea6b009242a718dc7d91b723053d3c5c3a2ae4f768b6ab016cefe915d7ed73
+  data.tar.gz: d94594ce6b6d7464ad543fcad88e8343e53b1d3a1f6af02f0d6d24a2877167b6cd776a4e62f575cc023ee752a30be4b7ed518b0283ed6eb144b42a5345d2705c

data/.gitignore

@@ -5,6 +5,7 @@
 .yardoc
 *.sublime-project
 *.sublime-workspace
+.idea
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.travis.yml

@@ -2,13 +2,12 @@ sudo: false
 language: ruby
 cache: bundler
 before_install:
-  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
-  - gem install bundler -v '< 2'
+  - gem install bundler -v '~> 2'
 rvm:
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
   - ruby-head
 env:
   - RAILS_VERSION='~> 3.2'
@@ -18,15 +17,21 @@ env:
   - RAILS_VERSION='~> 5.0'
   - RAILS_VERSION='~> 5.1'
   - RAILS_VERSION='~> 5.2'
+  - RAILS_VERSION='~> 6.0'
+  - RAILS_VERSION='~> 6.1'
 jobs:
   exclude:
-    - rvm: 2.7.0
+    - rvm: 2.4.10
+      env: RAILS_VERSION='~> 6.0'
+    - rvm: 2.4.10
+      env: RAILS_VERSION='~> 6.1'
+    - rvm: 2.7.2
       env: RAILS_VERSION='~> 3.2'
-    - rvm: 2.7.0
+    - rvm: 2.7.2
       env: RAILS_VERSION='~> 4.0'
-    - rvm: 2.7.0
+    - rvm: 2.7.2
       env: RAILS_VERSION='~> 4.1'
-    - rvm: 2.7.0
+    - rvm: 2.7.2
       env: RAILS_VERSION='~> 4.2'
     - rvm: ruby-head
       env: RAILS_VERSION='~> 3.2'

data/CHANGELOG

@@ -1,3 +1,7 @@
+2021-10-11 - v0.9.8
+
+2021-10-10 - Custom session timeout method [JunaidUK]
+
 2021-02-02 - v0.9.7
 
 2021-02-02 - Rails 6 compatibility [jasonheecs]

data/README.md

@@ -18,11 +18,15 @@ gem 'auto-session-timeout'
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install auto-session-timeout
+```
+$ gem install auto-session-timeout
+```
 
 ## Usage
 
@@ -31,14 +35,15 @@ After installing, tell your application controller to use auto timeout:
 ```ruby
 class ApplicationController < ActionController::Base
   auto_session_timeout 1.hour
-  ...
 end
 ```
 
-This will use a global timeout of 1 hour. If you want to specify a
-custom timeout value per user, don't pass a value above. Instead,
-override `#auto_timeout` in your `#current_user` model. This is
-typically the `User` class:
+This will use a global timeout of 1 hour. The gem assumes your authentication
+provider has a `#current_user` method that returns the currently logged in user.
+
+If you want to specify a  custom timeout value per user, don't pass a value to
+the controller as shown above. Instead,  override `#auto_timeout` in your
+`#current_user` model. This is  typically the `User` class:
 
 ```ruby
 class ApplicationController < ActionController::Base
@@ -86,7 +91,7 @@ actions entirely with your own custom code:
 ```ruby
 class SessionsController < ApplicationController
   def active
-   render_session_status
+    render_session_status
   end
 
   def timeout
@@ -99,13 +104,50 @@ In any of these cases, make sure to properly map the actions in your
 routes.rb file:
 
 ```ruby
-get 'active'  => 'sessions#active'
-get 'timeout' => 'sessions#timeout'
+get "active",  to: "sessions#active"
+get "timeout", to: "sessions#timeout"
 ```
 
 You're done! Enjoy watching your sessions automatically timeout.
 
-## Additional Configuration
+## Using with Devise
+
+When using Devise for authentication you will need to add a scoped
+sessions controller and call the timeout actions helper there.
+For example:
+
+```ruby
+class Users::SessionsController < Devise::SessionsController
+  auto_session_timeout_actions
+end
+```
+
+In your routes.rb file you will need to declare your scoped controller
+and declare the timeout actions inside the same Devise scope:
+
+```ruby
+Rails.application.routes.draw do
+  devise_for :users, controllers: { sessions: "users/sessions" }
+  
+  devise_scope :user do
+    get "active", to: "users/sessions#active"
+    get "timeout", to: "users/sessions#timeout"
+  end
+end
+```
+
+You can use Devise's `#user_signed_in?` method when you call the JS helper
+method in your view:
+
+```erb
+<body>
+  <% if user_signed_in? %>
+    <%= auto_session_timeout_js %>
+  <% end %>
+</body>
+```
+
+## Optional Configuration
 
 By default, the JavaScript code checks the server every 60 seconds for
 active sessions. If you prefer that it check more frequently, pass a
@@ -113,23 +155,13 @@ frequency attribute to the helper method. The frequency is given in
 seconds. The following example checks the server every 15 seconds:
 
 ```erb
-<html>
-  <head>...</head>
-  <body>
-    <% if current_user %>
-      <%= auto_session_timeout_js frequency: 15 %>
-    <% end %>
-    ...
-  </body>
-</html>
+<body>
+  <% if current_user %>
+    <%= auto_session_timeout_js frequency: 15 %>
+  <% end %>
+</body>
 ```
 
-## TODO
-
-* current_user must be defined
-* using Prototype vs. jQuery
-* using with Devise
-
 ## Contributing
 
 1. Fork it

data/lib/auto/session/timeout/version.rb

@@ -1,7 +1,7 @@
 module Auto
   module Session
     module Timeout
-      VERSION = "0.9.7"
+      VERSION = "0.9.8"
     end
   end
 end

data/lib/auto_session_timeout.rb

@@ -9,7 +9,7 @@ module AutoSessionTimeout
       protect_from_forgery except: [:active, :timeout]
       prepend_before_action do |c|
         if session_expired?(c) && !signing_in?(c)
-          c.send :reset_session
+          handle_session_reset(c)
         else
           unless c.request.original_url.start_with?(c.send(:active_url))
             offset = seconds || (current_user.respond_to?(:auto_timeout) ? current_user.auto_timeout : nil)
@@ -37,6 +37,10 @@ module AutoSessionTimeout
 
   private
 
+  def handle_session_reset(c)
+    c.send :reset_session
+  end
+
   def signing_in?(c)
     c.request.env["PATH_INFO"] == sign_in_path && c.request.env["REQUEST_METHOD"] == "POST"
   end

data/test/auto_session_timeout_helper_test.rb

@@ -2,17 +2,21 @@ require File.dirname(__FILE__) + '/test_helper'
 
 describe AutoSessionTimeoutHelper do
 
-  class ActionView::Base
+  class StubView
+    include AutoSessionTimeoutHelper
+    include ActionView::Helpers::JavaScriptHelper
+    include ActionView::Helpers::TagHelper
+
     def timeout_path
-      '/timeout'
+      "/timeout"
     end
-    
+
     def active_path
-      '/active'
+      "/active"
     end
   end
 
-  subject { ActionView::Base.new }
+  subject { StubView.new }
 
   describe "#auto_session_timeout_js" do
     it "returns correct JS" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: auto-session-timeout
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors:
 - Matthew Bass
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Provides automatic session timeout in a Rails application.