rails-automaticlogout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3746c6de9b1b0d8a3f5d5aa0ab9fd7f239a1aea3
+  data.tar.gz: e5159df8503aad1f9b4a44e93a60fc886b4d6206
+SHA512:
+  metadata.gz: 086a52d6ba0b6f503aeb7926d943dcd90dbc363fc34669aeedb7026b42d4921678a6b1036fd5fde8e66e5ff59070ab20e97c4cd24ede4df5948a9feeab4c28de
+  data.tar.gz: b723d77f8d35cdfe778635572ee987e695606962bed92aa27de0e1c18b5e7ca6e5b3270ba276f7e8bd1a949562065ec0bfab202a9bf70fac3fc9f316634e7dce

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in automaticlogout.gemspec
+gemspec

data/README.md

@@ -0,0 +1,77 @@
+# Rails Automatic Logout
+By Thadeu Esteves Jr.
+
+[![Gem Version](https://badge.fury.io/rb/rails-automaticlogout.svg)](https://badge.fury.io/rb/rails-automaticlogout)
+
+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
+
+Rails Automatic Logout works only Rails 4. You can add it to your Gemfile with:
+
+```ruby
+gem 'rails-automaticlogout'
+```
+
+Then run bundle install
+
+## How to use?
+
+### Configure Controller
+
+After installing, add in your application controller, _ex:_
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :authenticate_user!
+
+  # by default is time 1.hour
+  automatic_logout_at
+end
+```
+
+By default the time is _1.hour_
+
+#### Change timeout value.
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :authenticate_user!
+
+  # by default is time 1.hour
+  automatic_logout_at time: 5.minutes
+end
+```
+
+#### Change message
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :authenticate_user!
+
+  # by default is time 1.hour
+  automatic_logout_at time: 12.hour,
+                      message: 'Session expired! You will be redirect.'
+end
+```
+
+### Configure View (OPTIONAL)
+
+Use Helper in your view, for show regressive timer. Add this in your file application.html.erb
+
+```ruby
+<%= regressive_timer %>
+```
+
+## TODO
+* Add translations
+* Add configurations for action_view
+* Add Suport for Rails 5.x
+
+
+## Contributing
+
+We have a long list of valued contributors. Check them all at: https://github.com/Thadeu/rails-automaticlogout.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/app/assets/javascripts/automatic_logout.js

@@ -0,0 +1,22 @@
+(function automaticLogoutJs(){
+  setTimeout(function () {
+    $.ajax({
+      url: '/status_automatic_logout',
+      success: function(data) {
+        if (data.timeout != "null" && data.live == true){
+          var response_timeout = (new Date(data.timeout).getTime());
+
+          setInterval(function(){
+            var now_time = (new Date().getTime());
+
+            if ((response_timeout < now_time) == true){
+              if (confirm(data.message)){
+                window.location.href = '/destroy_automatic_logout';
+              }
+            }
+          }, data.seconds * 1000) // utiliza o mesmo valor em seconds que a pessoa irá ficar logado
+        }
+      }
+    });
+  }, 1000); //1s
+}());

data/app/controllers/automatic_logout/sessions_controller.rb

@@ -0,0 +1,26 @@
+module AutomaticLogout
+  class SessionsController < ApplicationController
+    skip_before_action :authenticate_user!, only: [:status, :destroy]
+
+    def status
+      response = {
+        live: !!current_user,
+        timeout: session[:auto_session_expires_at],
+        message: session[:message],
+        seconds: session[:seconds]
+      }
+
+      render json: response
+    end
+
+    def destroy
+      session[:auto_session_expires_at] = ''
+      session[:seconds] = ''
+      session[:live] = !!current_user
+
+      reset_session
+
+      redirect_to root_path, notice: session[:message]
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+<script>
+var timer = "<%= session[:auto_session_expires_at] %>";
+var now_in_seconds = new Date().getTime() / 1000;
+var timeout_in_seconds = new Date(timer).getTime() / 1000;
+
+var target_date = new Date(timer).getTime();
+var dias, horas, minutos, segundos;
+
+var diff_in_seconds = new Number();
+diff_in_seconds = (timeout_in_seconds - now_in_seconds).toFixed(0);
+
+function regressive(){
+
+  if (diff_in_seconds <= 0){
+    if (confirm("<%= session[:message] %>")){
+      window.location.href = '/destroy_automatic_logout';
+    }
+  }else{
+    var current_date = new Date().getTime();
+    var segundos_f = (target_date - current_date) / 1000;
+
+    dias = parseInt(segundos_f / 86400);
+    segundos_f = segundos_f % 86400;
+
+    horas = parseInt(segundos_f / 3600);
+    segundos_f = segundos_f % 3600;
+
+    minutos = parseInt(segundos_f / 60);
+    segundos = parseInt(segundos_f % 60);
+
+    // Formata o número menor que dez, ex: 08, 07, ...
+		if(horas < 10){
+			horas = "0"+horas;
+			horas = horas.substr(0, 2);
+		}
+
+		if(minutos < 10){
+			minutos = "0"+minutos;
+			minutos = minutos.substr(0, 2);
+		}
+
+		if(segundos <=9){
+			segundos = "0"+segundos;
+		}
+
+    if (diff_in_seconds >= 0){
+      $('.regressive-timer').text(horas + ':' + minutos + ':' + segundos);
+    }
+
+    setTimeout('regressive()',1000);
+
+    diff_in_seconds--;
+  }
+}
+
+regressive();
+
+</script>
+
+<div class="regressive-timer"></div>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "automaticlogout"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  get 'status_automatic_logout'  => 'automatic_logout/sessions#status'
+  get 'destroy_automatic_logout' => 'automatic_logout/sessions#destroy'
+end

data/lib/rails/automaticlogout/controllers/helpers.rb

@@ -0,0 +1,25 @@
+module Rails::AutomaticLogout
+  module Controllers
+    module Helpers
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def automatic_logout_at(time: 1.hour, message: "Session expired! You will be redirect.")
+          prepend_before_filter do |c|
+            if c.session[:auto_session_expires_at].present? && c.session[:auto_session_expires_at] < Time.now
+              c.send :reset_session
+            else
+              if current_user
+                c.session[:auto_session_expires_at] = Time.now + time
+                c.session[:message] = message
+                c.session[:seconds] = time.seconds
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails/automaticlogout/engine.rb

@@ -0,0 +1,13 @@
+module Rails
+  module AutomaticLogout
+    class Engine < ::Rails::Engine
+      ActiveSupport.on_load :action_controller do
+        include Rails::AutomaticLogout::Controllers::Helpers if defined?(Rails::AutomaticLogout::Controllers::Helpers)
+      end
+
+      ActiveSupport.on_load :action_view do
+        include Rails::AutomaticLogout::Views::Helpers if defined?(Rails::AutomaticLogout::Views::Helpers)
+      end
+    end
+  end
+end

data/lib/rails/automaticlogout/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module AutomaticLogout
+    VERSION = "0.1.0"
+  end
+end

data/lib/rails/automaticlogout/views/helpers.rb

@@ -0,0 +1,9 @@
+module Rails::AutomaticLogout
+  module Views
+    module Helpers
+      def regressive_timer
+        render 'automatic_logout/timer.js'
+      end
+    end
+  end
+end

data/lib/rails-automaticlogout.rb

@@ -0,0 +1,4 @@
+require 'rails'
+require 'rails/automaticlogout/controllers/helpers'
+require 'rails/automaticlogout/views/helpers'
+require 'rails/automaticlogout/engine'

data/rails-automaticlogout.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails/automaticlogout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-automaticlogout"
+  spec.version       = Rails::AutomaticLogout::VERSION
+  spec.authors       = ["Thadeu Esteves Jr"]
+  spec.email         = ["tadeuu@gmail.com"]
+
+  spec.summary       = %q{Provides automatic session timeout in a Rails application.}
+  spec.description   = %q{Provides automatic session timeout in a Rails application.}
+  spec.homepage      = "http://github.com/thadeu/rails-automaticlogout"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "actionpack", "~> 3.2"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: rails-automaticlogout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thadeu Esteves Jr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Provides automatic session timeout in a Rails application.
+email:
+- tadeuu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- app/assets/javascripts/automatic_logout.js
+- app/controllers/automatic_logout/sessions_controller.rb
+- app/views/automatic_logout/_timer.js.erb
+- bin/console
+- bin/setup
+- config/routes.rb
+- lib/rails-automaticlogout.rb
+- lib/rails/automaticlogout/controllers/helpers.rb
+- lib/rails/automaticlogout/engine.rb
+- lib/rails/automaticlogout/version.rb
+- lib/rails/automaticlogout/views/helpers.rb
+- rails-automaticlogout.gemspec
+homepage: http://github.com/thadeu/rails-automaticlogout
+licenses: []
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Provides automatic session timeout in a Rails application.
+test_files: []