devise-automaticlogout 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7376a12b6138d60c5313dff7b3920fd377680f4158600517f73ae3697d7d08c9
-  data.tar.gz: 252322e067196b1ec2d6ed3d2972a51a510251ab9af83efa380fdf39524e25a8
+  metadata.gz: c65ca7bde577d272a4d8ed64fe207d9e1fe383bc3a650d6692b2241a041c9617
+  data.tar.gz: 1f9de9666f2c64ef38406951191b1a462e089f92d66a59370c4ec2cc92ae48df
 SHA512:
-  metadata.gz: f291157a5b46de703a70cf80cd5c231a9c918bb8652f5c2ac77cd6c9a7bbbc13d0157361900946a74dbdf7da0d51bd14f5e67db21620d54e4101dc4ca7f44249
-  data.tar.gz: 6baba66024afd9be78928af7bcb99ffe7b7c8b7bf536b5d3b14c18cc37b85427096d290546166be2bb05a354bcb8f90b4954881dcde6304bf29a30e746130cdd
+  metadata.gz: 2f1aef7607fe60b6decb7d79b51ce226bfaf5b750d340cdf5ddde2abe05c280866c42ce4e629212302ae144fa4dcc3d5a1ab93c628ea9f69751e7eb36ca6dbe7
+  data.tar.gz: 59314f10e3fc2264a0c6688cba8e58319a0e283c076e7c112a96a357affd253954dae99c2e42dcfef8c80da1dd4be71380f00f0bce87ebf9d3f741a673eddd91

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'
+```
+
+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/lib/devise/automaticlogout/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module Automaticlogout
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.0.1'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise-automaticlogout
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Thadeu Esteves Jr