devise-automaticlogout 0.1.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 60c16b638b9295ea0c311d1017b1f87a92b77637
-  data.tar.gz: 3b6bbc12b9e7f595f1af9241bc71c335f37e2e9c
+SHA256:
+  metadata.gz: aca65c04b699ce7cb31abf9b49dab1febc2a4f482f625e287e9ae3f719c2d1aa
+  data.tar.gz: cb44d36d8a3b55fbdd67bd08d0a08f8c8d5d5ba6da4cfbcdc0f6270030413dc7
 SHA512:
-  metadata.gz: 3731202a8922acc897e944296e9fa90ab21fdf927f29b7618bdbc939fe7a2822bdc66394e57a0f852ceb1d8a296ce3a164a874ae73d1f43e12b8865a7767f890
-  data.tar.gz: 0e0ef041a0dbe58c85015c9a318640db805f52c69a6713ea89c78524bd6066f707241027286d761ff86b0629a565219c74390590340d9c29b2a4e8ab8df9d795
+  metadata.gz: dc5dfb45b4b13ffef4a0fab14e88c8b5c68890b494f09da2a739dac22c16a8625fd73472e72685edba97c6bf940680e72c60188de2faac834e433e705e60ead9
+  data.tar.gz: 686250322f63cb25a803b2f004da123a1b5643efca8f1dbb6e794198b073d01487928012949af72c09ab17a84276d04bd5c22bfbf98479e1b38274f9413a678f

data/README.md

@@ -1,47 +1,128 @@
 # Devise Automatic Logout
+
 By Thadeu Esteves Jr.
 
-Provides automatic session timeout in a Rails application. Very easy to install and configure. Have you ever wanted to force your users off your app if they go idle for a certain period of time? Many online banking sites use this technique. If your app is used on any kind of public computer system, this plugin is a necessity.
+Provê um logout automático da sessão numa aplicação Rails utilizando Devise. É simples e fácil.
+Faz com que a sessão seja destruída após a conclusão do tempo estipulado. É de grande ajuda em sistemas que necessitam de sessão auto destrutiva, evitando de o usuário ficar logado por muito tempo de forma ociosa.
+
+## O que isso faz?
+
+* Força o usuário a sair da sessão (logout)
+* Opção de mostrar um timer regressivo
+* Opção de dar um alerta na tela ao ser deslogado
+
+## Começando
+
+Adicione ao seu Gemfile
+
+```ruby
+gem 'devise-automaticlogout', '~> 1.0.1'
+```
+
+Rode o `bundle install`
+
+## Configure o controller
+
+No controller que você deseja aplicar o timer para o devise, use:
+
+```ruby
+devise_automatic_logout
+```
+
+Por exemplo, para o comum ApplicationController, poderia ser
+
+```ruby
+class ApplicationController < ActionController::Base
+  devise_automatic_logout
+end
+```
+
+Isso por si só, já prepara a aplicação para ler os dados do `Devise#timeout_in`, utilizando o scope padrão `user` e uma mensagem padrão de alerta.
+
+Mas se você quiser, configurar um tempo diferente do timeout_in do devise? Fácil, use o seguinte:
+
+```ruby
+devise_automatic_logout time: 1.hour.to_i
+```
+
+Isso vai aplicar 1 hora para o logout automático. 
+
+Mas e se você quiser colocar outra mensagem? Fácil, use o seguinte:
+
+```ruby
+devise_automatic_logout time: 1.hour.to_i, message: 'SUA MENSAGEM'
+```
 
-* Force your users power off session
-* show for they the regressive time
+Mas e se você quiser fazer, com que seja utilizado outro tipo de mapping do devise? Fácil, use o seguinte:
 
-## Getting started
+```ruby
+devise_automatic_logout scope: 'member'
+```
 
-You can add it to your Gemfile with:
+É possível também utilizar todos de uma vez só, por exemplo
 
 ```ruby
-gem 'devise-automaticlogout'
+devise_automatic_logout time: 15.minutes.to_i, message: 'Sua sessão expirou! Faça login novamente.', scope: 'member'
 ```
 
-Then run bundle install
+__OBS: Quando o `time` não é passado, o timeout_in do devise será aplicado, se configurado, é claro!__
 
-## How to use?
+## Configurando Timeoutable
 
-## Configure Timeoutable in /config/initializers/devise.rb
+Veja na documentação do próprio devise como fazer isso.
 
-Besides :stretches, you can define :pepper, :encryptor, :confirm_within, :remember_for, :timeout_in, :unlock_in among other options. For more details, see the initializer file that was created when you invoked the "devise:install" generator described above. This file is usually located at /config/initializers/devise.rb.
+[Configurar o tempo](https://github.com/plataformatec/devise#configuring-models)
 
-[Configure time](https://github.com/plataformatec/devise#configuring-models)
+[Mais informações sobre Timeoutable](http://www.rubydoc.info/github/plataformatec/devise/master/Devise/Models/Timeoutable)
 
-[More informations](http://www.rubydoc.info/github/plataformatec/devise/master/Devise/Models/Timeoutable)
+## Configurando o timer regressivo (OBRIGATÓRIO)
 
-### Configure Javascript
-Add in your application.js this require
+Esse helper deve ser usado em qualquer view, ele é importante, pois tudo será baseado nele
+
+```ruby
+<%= regressive_timer visible: true, alert: true %>
+```
+
+* visible: mostra um timer regressivo
+* alert: lança um `window.alert` se ativado, ao final do timer
+
+## Configurando Javascript
+
+Adicione no seu application.js, o seguinte:
 
 ```javascript
 //= require automatic_logout
 ```
-### Configure View (OPTIONAL)
 
-Use Helper in your view, for show regressive timer. Add this in your file application.html.erb
+Se você usa vanilla js, adicionar também o seguinte:
 
-```ruby
-<%= regressive_timer %>
+```javascript
+//= require automatic_logout/classic
+```
+
+Se você usa jQuery, use:
+
+```javascript
+//= require automatic_logout/jquery
+```
+
+Se você usa Turbolinks mais atual, use:
+
+```javascript
+//= require automatic_logout/turbolinks
 ```
 
-## TODO
+Se você usa Turbolinks mais antigo, use:
 
+```javascript
+//= require automatic_logout/turbolinks-classic
+```
+
+Se preferir, use manualmente em algum momento desejado
+
+```javascript
+AutomaticLogout.load();
+```
 
 ## Contributing
 

data/app/controllers/automaticlogout_controller.rb

@@ -0,0 +1,9 @@
+class AutomaticlogoutController < ::ApplicationController
+  def destroy
+    session[:devise_autl_seconds] = nil
+    session[:live] = !current_user.nil?
+    reset_session
+
+    redirect_to '/', notice: session[:devise_autl_message]
+  end
+end

data/app/views/automatic_logout/_timer.html.erb

@@ -1,4 +1,9 @@
-<div class="regressive-timer"
-  data-seconds="<%= session[:seconds] %>"
-  data-message="<%= session[:message] %>">
-</div>
+<% unless request.env["devise.skip_timeout"] %>
+  <span class="regressive-timer"
+    style="<%= "display: #{visible ? 'block' : 'none'}" %>"
+    data-visible="<%= visible %>"
+    data-alert="<%= alert.presence || false %>"
+    data-seconds="<%= session[:devise_autl_seconds] %>"
+    data-message="<%= session[:devise_autl_message] %>">
+  </span>
+<% end %>

data/config/routes.rb

@@ -1,4 +1,3 @@
 Rails.application.routes.draw do
-  get 'devise/automatic_logout/status'  => 'application#automatic_logout_status'
-  get 'devise/automatic_logout/destroy' => 'application#automatic_logout_destroy'
+  get 'automatic_logout/destroy' => 'automaticlogout#destroy'
 end

data/lib/assets/javascripts/automatic_logout.js

@@ -2,72 +2,105 @@
  * Module AutomaticLogout for JS Files
  * @type {[type]}
  */
-var AutomaticLogout = AutomaticLogout || {};
+window.AutomaticLogout = {};
 
-$(document).ready(function(){
-  // Change to $() for document.querySelector(".regressive-timer")
-  var $regressiveTimer = $('.regressive-timer');
+AutomaticLogout.load = function () {
+  var $regressiveTimer = document.querySelectorAll(".regressive-timer")[0];
 
-  ($regressiveTimer.length > 0 &&
-  $regressiveTimer.data('expires-at') !== '')
-    ? AutomaticLogout.regressiveTimer()
-    : AutomaticLogout.ajaxSessionTimeout();
-});
+  if (!!$regressiveTimer && $regressiveTimer.dataset.seconds != "") {
+    console.log("[AutomaticLogout] regressiveTimer started");
+    AutomaticLogout.regressiveTimer();
+  }
+};
 
 /**
  * Send request for destroy session current_user
  * @return {[type]} [description]
  */
-AutomaticLogout.destroySession = function(){
-  return window.location.href = '/devise/automatic_logout/destroy';
-}
+AutomaticLogout.destroySession = function (message) {
+  var xhr = new XMLHttpRequest();
+  xhr.open("GET", "/automatic_logout/destroy", true);
+
+  xhr.onload = function () {
+    if (xhr.status == 200) {
+      var $wrapper = document.querySelectorAll(".regressive-timer")[0];
+
+      if ($wrapper && eval($wrapper.dataset.alert) && message) {
+        window.alert(message);
+      }
+
+      return (window.location.href = "/");
+    }
+  };
+  xhr.send();
+};
 
 /**
  * Method regressive time based in session auto expired at.
  * @param  {[type]} date_session [description]
  * @return {[type]}              [description]
  */
-AutomaticLogout.regressiveTimer = function(){;
+AutomaticLogout.regressiveTimer = function () {
+  /**
+   * Define o que vai ser impresso no DOM.
+   * @param {DOM Object} container
+   * @param {Boolean} visible
+   * @param {String} textContent
+   */
+  var visibleTimer = function (container, visible, textContent) {
+    if (!visible) visible = "false";
+    if (!textContent) textContent = "00:00:00";
+
+    if (visible == "true") {
+      return (container.textContent = textContent);
+    }
+  };
+
   /**
    * Variables used
    * @param  {[type]} '.regressive-timer' [description]
    * @return {[type]}                     [description]
    */
-  var data_message = $('.regressive-timer').data('message'),
-      data_seconds = $('.regressive-timer').data('seconds'),
-      current_time = new Date().getTime();
+  var $regressiveTimer = document.querySelector(".regressive-timer"),
+    data_message = String($regressiveTimer.dataset.message),
+    data_seconds = Number($regressiveTimer.dataset.seconds),
+    current_time = new Date().getTime();
+
+  visibleTimer($regressiveTimer, $regressiveTimer.dataset.visible);
 
   var time_expired = new Date();
   time_expired.setSeconds(time_expired.getSeconds() + data_seconds);
 
-  if (data_seconds != 0 && data_seconds != ''){
-    var timerDecrement = setInterval(function(){
-      
-      if (data_seconds == 0) { 
-        clearInterval(timerDecrement); 
-
+  if (data_seconds != 0 && data_seconds != "") {
+    var timerDecrement = setInterval(function () {
+      if (data_seconds == 0) {
+        clearInterval(timerDecrement);
         // limpa a sessão após o ok
-        if (confirm(data_message)) {
-          AutomaticLogout.destroySession();
-        };
-      }else{
+        AutomaticLogout.destroySession(data_message);
+      } else {
         //tempo descrecente
         time_expired.setSeconds(time_expired.getSeconds() - 1);
-        
-        var 
-          // converte pra segundos
-          seconds_integer = (time_expired.getTime() - current_time) / 1000,
-          //faz o parse 
-          date_format = AutomaticLogout.parseDate(seconds_integer);
-
-        // atualiza o DOM
-        $('.regressive-timer').text(date_format.hours + ':' + date_format.minutes + ':' + date_format.seconds);
+
+        var seconds_integer = (time_expired.getTime() - current_time) / 1000,
+          date_format = AutomaticLogout.parseDate(seconds_integer),
+          output_date_format =
+            date_format.hours +
+            ":" +
+            date_format.minutes +
+            ":" +
+            date_format.seconds;
+
+        visibleTimer(
+          $regressiveTimer,
+          $regressiveTimer.dataset.visible,
+          output_date_format
+        );
       }
-      
+
       data_seconds -= 1;
-    }, 1000)
+    }, 1000);
   }
-}
+};
 
 /**
  * Parse Date
@@ -79,12 +112,8 @@ AutomaticLogout.regressiveTimer = function(){;
  *   seconds: seconds
  * }
  */
-AutomaticLogout.parseDate = function(seconds_float){
-
-  var days,
-      hours,
-      minutes,
-      seconds;
+AutomaticLogout.parseDate = function (seconds_float) {
+  var days, hours, minutes, seconds;
 
   days = parseInt(seconds_float / 86400);
   seconds_float = seconds_float % 86400;
@@ -95,57 +124,24 @@ AutomaticLogout.parseDate = function(seconds_float){
   minutes = parseInt(seconds_float / 60);
   seconds = parseInt(seconds_float % 60);
 
-  if(hours < 10){
-    hours = "0"+hours;
+  if (hours < 10) {
+    hours = "0" + hours;
     hours = hours.substr(0, 2);
   }
 
-  if(minutes < 10){
-    minutes = "0"+minutes;
+  if (minutes < 10) {
+    minutes = "0" + minutes;
     minutes = minutes.substr(0, 2);
   }
 
-  if(seconds <=9){
-    seconds = "0"+seconds;
+  if (seconds <= 9) {
+    seconds = "0" + seconds;
   }
 
   return {
     days: days,
     hours: hours,
     minutes: minutes,
-    seconds: seconds
-  }
-}
-
-/**
- * Method for request ajax, check value e logout
- * @return {[type]} [description]
- */
-AutomaticLogout.ajaxSessionTimeout = function(){
-  setTimeout(function () {
-   //TODO: Change to ES6/7 fetch() feature 
-    $.ajax({
-      url: '/devise/automatic_logout/status',
-      success: function(data) {
-        if (data.seconds !== "null" && data.live === true){
-          
-          var data_message = data.message, data_seconds = data.seconds;
-
-          if (data_seconds != 0 && data_seconds != ''){
-            var timerDecrement = setInterval(function(){    
-              if (data_seconds == 0) { 
-                clearInterval(timerDecrement); 
-                // limpa a sessão após o ok do alertify
-                if (confirm(data_message)) {
-                  AutomaticLogout.destroySession();
-                }
-              }
-              
-              data_seconds -= 1;
-            }, 1000)
-          }
-        }
-      }
-    });
-  }, 1000); //1s
-};
+    seconds: seconds,
+  };
+};

data/lib/assets/javascripts/automatic_logout/classic.js

@@ -0,0 +1,4 @@
+// sem turbolinks
+document.addEventListener('DOMContentLoaded', function () {
+  AutomaticLogout.load();
+})

data/lib/assets/javascripts/automatic_logout/jquery.js

@@ -0,0 +1,4 @@
+// jquery ready
+$(document).on('page:change turbolinks:load',function(){
+  AutomaticLogout.load();
+})

data/lib/assets/javascripts/automatic_logout/turbolinks-classic.js

@@ -0,0 +1,5 @@
+// rails 4
+// turbolinks-classic
+document.addEventListener('page:change', function(){
+  AutomaticLogout.load();
+})

data/lib/assets/javascripts/automatic_logout/turbolinks.js

@@ -0,0 +1,5 @@
+// rails 5 >
+// turbolinks 5
+document.addEventListener('turbolinks:load', function(){
+  AutomaticLogout.load();
+})

data/lib/devise/automaticlogout/controllers.rb

@@ -1,35 +1,31 @@
 module Devise
-  module AutomaticLogout
+  module Automaticlogout
     module Controllers
       extend ActiveSupport::Concern
 
-      included do
-        ::ApplicationController.before_action do |c|
-          if current_user.present?
-            key_classify = Devise.mappings.keys.first
-            resource_name = Devise.mappings[key_classify].class_name.to_s
-            # get instance for class using devise
-            c.session[:seconds] = resource_name.classify.constantize.timeout_in.seconds.to_i
-            # I18n.t devise.automaticlogout.message
-            c.session[:message] = I18n.t 'devise.automaticlogout.message' || 'Session expired!'
-          end
-        end
+      DEFAULT_MESSAGE = 'Session expired! You will be redirect.'.freeze
 
-        ::ApplicationController.send :define_method, :automatic_logout_status do
-          Rails.logger.info 'Sessão atualizada'
-          render json: {
-            live: !current_user.nil?,
-            message: session[:message],
-            seconds: session[:seconds]
-          }, status: :ok
-        end
+      module ClassMethods
+        def devise_automatic_logout(options = {})
+          prepend_before_action do |c|
+            time = options.fetch(:time, nil)
+            message = options.fetch(:message, DEFAULT_MESSAGE)
+            scope = options.fetch(:scope, 'user')
 
-        ::ApplicationController.send :define_method, :automatic_logout_destroy do
-          Rails.logger.info 'Sessão destruída'
-          session[:seconds] = ''
-          session[:live] = !current_user.nil?
-          reset_session
-          redirect_to '/', notice: session[:message]
+            seconds = if time&.positive?
+                        time
+                      else
+                        mapping = Devise.mappings[scope.to_sym]
+                        return unless mapping
+
+                        mapping.to.timeout_in.seconds.to_i
+                      end
+
+            if seconds
+              c.session[:devise_autl_message] = message
+              c.session[:devise_autl_seconds] = seconds
+            end
+          end
         end
       end
     end

data/lib/devise/automaticlogout/engine.rb

@@ -1,14 +1,14 @@
 module Devise
-  module AutomaticLogout
+  module Automaticlogout
     class Engine < ::Rails::Engine
-      require 'jquery-rails'
+      engine_name 'devise_automaticlogout'
 
       ActiveSupport.on_load :action_controller do
-        include Devise::AutomaticLogout::Controllers
+        include Devise::Automaticlogout::Controllers
       end
 
       ActiveSupport.on_load :action_view do
-        include Devise::AutomaticLogout::Helpers
+        include Devise::Automaticlogout::Helpers
       end
     end
   end

data/lib/devise/automaticlogout/helpers.rb

@@ -1,8 +1,8 @@
 module Devise
-  module AutomaticLogout
+  module Automaticlogout
     module Helpers
-      def regressive_timer
-        render 'automatic_logout/timer'
+      def regressive_timer(visible: false, alert: false)
+        render 'automatic_logout/timer', visible: visible, alert: alert
       end
     end
   end

data/lib/devise/automaticlogout/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module Automaticlogout
-    VERSION = '0.1.0'.freeze
+    VERSION = '1.0.2'.freeze
   end
 end

metadata

@@ -1,83 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: devise-automaticlogout
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Thadeu Esteves Jr
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-04-24 00:00:00.000000000 Z
+date: 2020-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: jquery-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   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'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   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: Provides automatic session timeout in a Rails Devise application.
@@ -90,19 +76,24 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/controllers/automaticlogout_controller.rb
 - app/views/automatic_logout/_timer.html.erb
 - config/routes.rb
 - lib/assets/javascripts/automatic_logout.js
+- lib/assets/javascripts/automatic_logout/classic.js
+- lib/assets/javascripts/automatic_logout/jquery.js
+- lib/assets/javascripts/automatic_logout/turbolinks-classic.js
+- lib/assets/javascripts/automatic_logout/turbolinks.js
 - lib/devise/automaticlogout.rb
 - lib/devise/automaticlogout/controllers.rb
 - lib/devise/automaticlogout/engine.rb
 - lib/devise/automaticlogout/helpers.rb
 - lib/devise/automaticlogout/version.rb
-homepage: https://github.com/Thadeu/devise-automaticlogout
+homepage: https://github.com/thadeu/devise-automaticlogout
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -117,9 +108,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
 specification_version: 4
 summary: Provides automatic session timeout in a Rails Devise application.
 test_files: []