devise-automaticlogout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60c16b638b9295ea0c311d1017b1f87a92b77637
+  data.tar.gz: 3b6bbc12b9e7f595f1af9241bc71c335f37e2e9c
+SHA512:
+  metadata.gz: 3731202a8922acc897e944296e9fa90ab21fdf927f29b7618bdbc939fe7a2822bdc66394e57a0f852ceb1d8a296ce3a164a874ae73d1f43e12b8865a7767f890
+  data.tar.gz: 0e0ef041a0dbe58c85015c9a318640db805f52c69a6713ea89c78524bd6066f707241027286d761ff86b0629a565219c74390590340d9c29b2a4e8ab8df9d795

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Thadeu Esteves Jr
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# 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.
+
+* Force your users power off session
+* show for they the regressive time
+
+## Getting started
+
+You can add it to your Gemfile with:
+
+```ruby
+gem 'devise-automaticlogout'
+```
+
+Then run bundle install
+
+## How to use?
+
+## Configure Timeoutable in /config/initializers/devise.rb
+
+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.
+
+[Configure time](https://github.com/plataformatec/devise#configuring-models)
+
+[More informations](http://www.rubydoc.info/github/plataformatec/devise/master/Devise/Models/Timeoutable)
+
+### Configure Javascript
+Add in your application.js this require
+
+```javascript
+//= require automatic_logout
+```
+### Configure View (OPTIONAL)
+
+Use Helper in your view, for show regressive timer. Add this in your file application.html.erb
+
+```ruby
+<%= regressive_timer %>
+```
+
+## TODO
+
+
+## Contributing
+
+We have a long list of valued contributors. Check them all at: https://github.com/Thadeu/devise-automaticlogout.

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Devise::Automaticlogout'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

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

@@ -0,0 +1,4 @@
+<div class="regressive-timer"
+  data-seconds="<%= session[:seconds] %>"
+  data-message="<%= session[:message] %>">
+</div>

data/config/routes.rb

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

data/lib/assets/javascripts/automatic_logout.js

@@ -0,0 +1,151 @@
+/**
+ * Module AutomaticLogout for JS Files
+ * @type {[type]}
+ */
+var AutomaticLogout = AutomaticLogout || {};
+
+$(document).ready(function(){
+  // Change to $() for document.querySelector(".regressive-timer")
+  var $regressiveTimer = $('.regressive-timer');
+
+  ($regressiveTimer.length > 0 &&
+  $regressiveTimer.data('expires-at') !== '')
+    ? AutomaticLogout.regressiveTimer()
+    : AutomaticLogout.ajaxSessionTimeout();
+});
+
+/**
+ * Send request for destroy session current_user
+ * @return {[type]} [description]
+ */
+AutomaticLogout.destroySession = function(){
+  return window.location.href = '/devise/automatic_logout/destroy';
+}
+
+/**
+ * Method regressive time based in session auto expired at.
+ * @param  {[type]} date_session [description]
+ * @return {[type]}              [description]
+ */
+AutomaticLogout.regressiveTimer = function(){;
+  /**
+   * 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 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); 
+
+        // limpa a sessão após o ok
+        if (confirm(data_message)) {
+          AutomaticLogout.destroySession();
+        };
+      }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);
+      }
+      
+      data_seconds -= 1;
+    }, 1000)
+  }
+}
+
+/**
+ * Parse Date
+ * @param  float seconds seconds_float [description]
+ * @return {
+ *   days: days,
+ *   hours: hours,
+ *   minutes: minutes,
+ *   seconds: seconds
+ * }
+ */
+AutomaticLogout.parseDate = function(seconds_float){
+
+  var days,
+      hours,
+      minutes,
+      seconds;
+
+  days = parseInt(seconds_float / 86400);
+  seconds_float = seconds_float % 86400;
+
+  hours = parseInt(seconds_float / 3600);
+  seconds_float = seconds_float % 3600;
+
+  minutes = parseInt(seconds_float / 60);
+  seconds = parseInt(seconds_float % 60);
+
+  if(hours < 10){
+    hours = "0"+hours;
+    hours = hours.substr(0, 2);
+  }
+
+  if(minutes < 10){
+    minutes = "0"+minutes;
+    minutes = minutes.substr(0, 2);
+  }
+
+  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
+};

data/lib/devise/automaticlogout.rb

@@ -0,0 +1,9 @@
+require 'devise'
+require 'devise/automaticlogout/controllers'
+require 'devise/automaticlogout/helpers'
+require 'devise/automaticlogout/engine'
+
+module Devise
+  module Automaticlogout
+  end
+end

data/lib/devise/automaticlogout/controllers.rb

@@ -0,0 +1,37 @@
+module Devise
+  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
+
+        ::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
+
+        ::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]
+        end
+      end
+    end
+  end
+end

data/lib/devise/automaticlogout/engine.rb

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

data/lib/devise/automaticlogout/helpers.rb

@@ -0,0 +1,9 @@
+module Devise
+  module AutomaticLogout
+    module Helpers
+      def regressive_timer
+        render 'automatic_logout/timer'
+      end
+    end
+  end
+end

data/lib/devise/automaticlogout/version.rb

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

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: devise-automaticlogout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thadeu Esteves Jr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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.
+email:
+- tadeuu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/views/automatic_logout/_timer.html.erb
+- config/routes.rb
+- lib/assets/javascripts/automatic_logout.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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Provides automatic session timeout in a Rails Devise application.
+test_files: []