session_timeout_prompter 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6be9fd633cab048831eaf8e2a706ef4dc8f87620
-  data.tar.gz: 11c086142b91fb883a39d4fdd3b7a81a26ea3a1b
+  metadata.gz: 8c7fbaf882ad6d1a5a7db7e458d261f10d99727a
+  data.tar.gz: 338e1df2e8fe1d5771e332bab2811aff96c08e06
 SHA512:
-  metadata.gz: 72d21ca10cd794f5d5b9001692a28e96a4e251cb7d54ecba662f67d51d915aa22574f02b9447f22006dbbeff907a0c0e13e86c5ce8735e614d77ee9e4bbacb8e
-  data.tar.gz: 16d1882386159825f8c1e41465ef3b45ab8c9c3ffe6804ccea53e56d8531d70cf3d9dc596e78a24859ce14ac5803c7f1e0fb6b12d6ca006924821d4d6c85ccef
+  metadata.gz: a9f5905795425218208f886f1351727dbd04144f3079858cb032f50adf35baecc919558caa38b677b1f9e5399a4b60531bb21cce02301dfe8f57550a0580091a
+  data.tar.gz: f9b973def95f829b61592cc3549fc5ba768fd8347dd0c89c9211f384cf065a2f88f1d9e338014bd05ea1796d2001a4fcd4a75d8ec1e3a68257f8831422d36e2b

data/README.md

@@ -10,10 +10,16 @@ Add the gem to your Gemfile:
 gem 'session_timeout_prompter'
 ```
 
+Run bundle install
+
+```ruby
+bundle install
+```
+
 Mount the engine in your routes:
 
 ```ruby
-mount SessionTimeoutPrompter::Engine at: "/session_timeout_prompter"`
+mount SessionTimeoutPrompter::Engine, at: "/session_timeout_prompter"
 ```
 
 Require the js:
@@ -35,7 +41,7 @@ Require the css:
 Add the following after the body tag in your layout or on any page you wish to display the timeout prompt:
 
 ```ruby
-= session_timeout_prompter(session_timeout_in_seconds: User.timeout_in.to_i, timeout_warning_in_seconds: 305, scope: :user)
+= init_session_timeout_prompter(session_timeout_in_seconds: User.timeout_in.to_i, seconds_to_warn_before_timeout: 305, scope: :user)
 ```
 (The example values assume you are using Devise timeoutable and are using a scope/model called User. The scope is purely so you can use multiple in the same application if necessary.)
 

data/app/assets/javascripts/session_timeout_prompter.js

@@ -41,6 +41,7 @@ var Bootstrap3PromptRenderer = (function () {
     value: function hideAll() {
       this.timeoutWarningModal.modal('hide');
       this.timedOutModal.modal('hide');
+      this.currentlyShowingWarningPrompt = false;
     }
   }, {
     key: 'updateRemainingTimeText',
@@ -104,6 +105,20 @@ var ServerPinger = (function () {
 })();
 'use strict';
 
+var sessionTimeoutPrompter = undefined;
+jQuery(function () {
+
+  var timeoutPrompterContainer = jQuery('#session-timeout-prompter-container');
+
+  // If the container cannot be found then assume we don't need timeout prompting on this page.
+  if (timeoutPrompterContainer.length) {
+    var configData = timeoutPrompterContainer.data();
+    sessionTimeoutPrompter = new SessionTimeoutPrompter(configData);
+    sessionTimeoutPrompter.start();
+  }
+});
+'use strict';
+
 var _createClass = (function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ('value' in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; })();
 
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError('Cannot call a class as a function'); } }
@@ -113,7 +128,7 @@ var SessionTimeoutPrompter = (function () {
     _classCallCheck(this, SessionTimeoutPrompter);
 
     var serverPingPath = configData.serverPingPath;
-    var timeoutWarningInSeconds = configData.timeoutWarningInSeconds;
+    var secondsToWarnBeforeTimeout = configData.secondsToWarnBeforeTimeout;
     var sessionTimeoutInSeconds = configData.sessionTimeoutInSeconds;
     var sessionKey = configData.sessionKey;
 
@@ -123,7 +138,7 @@ var SessionTimeoutPrompter = (function () {
 
     var promptRenderer = new Bootstrap3PromptRenderer(timeoutWarningModal, timedOutModal, remainingTimeContainer);
 
-    this.timeoutTimer = new TimeoutTimer(timeoutWarningInSeconds, sessionTimeoutInSeconds, sessionKey, promptRenderer);
+    this.timeoutTimer = new TimeoutTimer(secondsToWarnBeforeTimeout, sessionTimeoutInSeconds, sessionKey, promptRenderer);
     this.serverPinger = new ServerPinger(serverPingPath);
     this.remainLoggedInButton = jQuery('#session-timeout-prompter-remain-logged-in-btn');
   }
@@ -167,20 +182,6 @@ var SessionTimeoutPrompter = (function () {
 
   return SessionTimeoutPrompter;
 })();
-'use strict';
-
-var sessionTimeoutPrompter = undefined;
-jQuery(function () {
-
-  var timeoutPrompterContainer = jQuery('#session-timeout-prompter-container');
-
-  // If the container cannot be found then assume we don't need timeout prompting on this page.
-  if (timeoutPrompterContainer.length) {
-    var configData = timeoutPrompterContainer.data();
-    sessionTimeoutPrompter = new SessionTimeoutPrompter(configData);
-    sessionTimeoutPrompter.start();
-  }
-});
 "use strict";
 
 var _createClass = (function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; })();
@@ -189,18 +190,18 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
 
 var TimeoutTimer = (function () {
 
-  // timeoutWarningInSeconds: Warning that their session is about to timeout
+  // secondsToWarnBeforeTimeout: Warning that their session is about to timeout
   //                          when there are this many minutes left.
   // sessionTimeoutInSeconds: Tell them their session has timed out when this
   //                          many minutes have elapsed.
   // sessionKey:              Unique key for this session - used in local storage
   //                          to make sure multiple browser tabs are synched.
 
-  function TimeoutTimer(timeoutWarningInSeconds, sessionTimeoutInSeconds, sessionKey, promptRenderer) {
+  function TimeoutTimer(secondsToWarnBeforeTimeout, sessionTimeoutInSeconds, sessionKey, promptRenderer) {
     _classCallCheck(this, TimeoutTimer);
 
     this.sessionTimeoutInSeconds = sessionTimeoutInSeconds;
-    this.timeoutWarningInSeconds = timeoutWarningInSeconds;
+    this.secondsToWarnBeforeTimeout = secondsToWarnBeforeTimeout;
     this.sessionKey = sessionKey;
     this.promptRenderer = promptRenderer;
     this.tickInterval = undefined;
@@ -248,7 +249,7 @@ var TimeoutTimer = (function () {
       var timeLeftInSeconds = this.timeoutAt - this.currentTimestamp();
       if (timeLeftInSeconds <= 0) {
         this.showTimedOutPrompt();
-      } else if (timeLeftInSeconds <= this.timeoutWarningInSeconds) {
+      } else if (timeLeftInSeconds <= this.secondsToWarnBeforeTimeout) {
         this.showTimeoutWarningPrompt(timeLeftInSeconds);
       }
     }

data/app/helpers/session_timeout_prompter/prompt_helper.rb

@@ -4,19 +4,19 @@ module SessionTimeoutPrompter
     # session_timeout_in_seconds: The session timeout length set for your app
     #                             (most often from User.timeout_in.to_i if using Devise)
     #
-    # timeout_warning_in_seconds: Show a warning this many seconds before the session times out.
+    # seconds_to_warn_before_timeout: Show a warning this many seconds before the session times out.
     #
     # scope:       e.g. :user - most often the name of the Devise scope/model
     #
     # session_key: Unique key for this app and scope - used to enable multi-tab support
-    def init_session_timeout_prompter(session_timeout_in_seconds:, timeout_warning_in_seconds:, scope:)
+    def init_session_timeout_prompter(session_timeout_in_seconds:, seconds_to_warn_before_timeout:, scope:)
       render(
         partial: "session_timeout_prompter/modal_dialogs",
         locals: {
           container_data_attributes: {
             server_ping_path:   session_timeout_prompter.server_pings_path,
             session_timeout_in_seconds: session_timeout_in_seconds,
-            timeout_warning_in_seconds: timeout_warning_in_seconds,
+            seconds_to_warn_before_timeout: seconds_to_warn_before_timeout,
             session_key:      "#{::Rails.application.class.parent_name.downcase}-#{scope}"
           }
         }

data/lib/session_timeout_prompter/version.rb

@@ -1,3 +1,3 @@
 module SessionTimeoutPrompter
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/session_timeout_prompter.gemspec

@@ -38,4 +38,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency "jasmine"
   spec.add_development_dependency "babel-transpiler"
+  spec.add_development_dependency "phantomjs"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: session_timeout_prompter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ant Nettleship
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-04 00:00:00.000000000 Z
+date: 2017-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -248,6 +248,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: phantomjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - anthony.nettleship@epigenesys.org.uk