devise_code_authenticatable 0.1.3 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92aeed0596899fc54c2f4055f0973d3a5abfc78154934af614b2f8d9beb66151
-  data.tar.gz: 89f80c474d061b03bc8715023f27b54ebdd1197562af5d1f603a32679b409489
+  metadata.gz: fd002956ced9c39d04aff6ae2571c6436a33d764a0018f0c1c63d076b1ab080d
+  data.tar.gz: 2b3b514a7add40d4aff0679369e16ffb2bb59168b4fc61d38f18177e4cb283f2
 SHA512:
-  metadata.gz: 9c03c02dd6728b7ba3b18b2d5e55a168157d146ad5b395116ad1bcbaa23489a50e0fdee33d584847846f442d4ad373a26d54245b5b71338f8d0ab7954d861949
-  data.tar.gz: '09107222a306a85ac035d8fc8c1095e46f1be0ede2d774ba32f511bccabf69c3eb0bfccf859b41d7392e88a21e74448dcbaf59a06ffd2dd032b6a9decf7ee66d'
+  metadata.gz: 5b2c4800b08725bdff4fe3b50ce11ce353494f5064f87a68dfa09df6044b282a11f6155e8a4d32d4eef3fc75abfae099d98c96e647ea597fe22fd06de0924733
+  data.tar.gz: 33ab15669026be9ab140fe8f81d6581dd5e652ba55c32615a3c18b48dd4e94d117c75d4e5daf977e317f897bcaedfe548830c437a5eb11045374152c383cef93

data/README.md

@@ -1,9 +1,6 @@
 # DeviseCodeAuthenticatable
 A Devise plugin for two-factor authenticatable.
 
-## Demo
-An example rails app to use this plugin is setup in [demo](https://github.com/vincentying15/demo_for_devise_code_authenticatable)
-
 ## Installation
 Add this line to your Rails Gemfile:
 
@@ -11,21 +8,19 @@ Add this line to your Rails Gemfile:
 gem 'devise_code_authenticatable'
 ```
 
-### Automatic installation
 Run:
 
 ```bash
 rails generate devise_code_authenticatable:install
 ```
 
-This will create a migration file name in your <tt>db/migrate</tt> folder, then
- 
+This will create a migration file in your `db/migrate` folder, then
+
 
 ```ruby
 rails db:migrate
 ```
-### Devise Configuration
-Add <tt>:authenticatable</tt> to the model you want to enable code_authenticatable
+Add `:authenticatable` to the model you want to enable code_authenticatable, also make sure `:database_authenticatable` is removed
 
 ```ruby
 class User < ActiveRecord::Base
@@ -40,8 +35,5 @@ This plugin is included with basic views, to customize the views you need to run
 rails generate devise_code_authenticatable:views
 ```
 
-### Login by password
-The existing <tt>Devise::SessionsController</tt> would be override, so you can not login by your password 
-
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/devise_code_authenticatable.rb

@@ -16,6 +16,20 @@ require 'devise_code_authenticatable/rails'
 require 'devise_code_authenticatable/strategies/code_authenticatable'
 
 module Devise
+  # Public: Maximum retry times for a code to be verifed (default: 5).
+  # Login code will not change even if user click resend mail,
+  # and the same code will be sent again.
+  #
+  #   config.retry_limit = 1 # => The code will be reset immediately when user passed wrong code
+  mattr_accessor :retry_limit
+  @@retry_limit = 5
+
+  # Public: Deadline for a code to be verifed (default: 10.minutes).
+  # Login code will expired if user has not enter the login_code in 10 minutes
+  #
+  #   config.expire_time = 1.hour # => The code is valid in the next hour after generated
+  mattr_accessor :expire_time
+  @@expire_time = 10.minutes
 end
 
 

data/lib/devise_code_authenticatable/login_code.rb

@@ -17,16 +17,20 @@ module DeviseCodeAuthenticatable
 
     def verify(code)
       if expired?
-        raise ActiveModel::Errors "expired code should never be validated!"
+        return false
       end
 
       self.retry_times += 1; save
       self.code == code
     end
 
+    def used?
+      expired
+    end
+
     def expired?
-      retry_time_limit = 5
-      expire_at = (self.created_at || Time.now) + 10.minutes
+      retry_time_limit = self.class.retry_limit
+      expire_at = (self.created_at || Time.now) + self.class.expire_time
 
       self.expired = self.expired || Time.now.after?(expire_at) || self.retry_times.to_i > retry_time_limit
     end
@@ -36,7 +40,8 @@ module DeviseCodeAuthenticatable
     end
 
     module ClassMethods
-      Devise::Models.config(self, :login_codes)
+      Devise::Models.config(self, :retry_limit)
+      Devise::Models.config(self, :expire_time)
     end
 
   end

data/lib/devise_code_authenticatable/mailer.rb

@@ -9,6 +9,7 @@ module DeviseCodeAuthenticatable
     # deliver a mail containing login code
     def code_login_instructions(record, code, opts = {})
       @code = code
+      opts[:subject] = "#{@code} is your login code"
       devise_mail(record, :login_code, opts)
     end
   end

data/lib/devise_code_authenticatable/models.rb

@@ -11,6 +11,9 @@ module Devise
         def send_login_token_keys
           [:email]
         end
+
+        Devise::Models.config(self, :retry_limit)
+        Devise::Models.config(self, :expire_time)
       end
 
     end

data/lib/devise_code_authenticatable/strategies/code_authenticatable.rb

@@ -10,21 +10,25 @@ module DeviseCodeAuthenticatable
         login_code = params[scope].fetch "login_code", ""
 
         if resource.nil?
-          fail(:not_found_in_database)
+          fail(:not_found_in_database); return
+        end
+
+        if resource.login_codes.empty?
+          resource.send_code_login_instructions
+          fail(:login_code_expired); return
+        end
+
+        if resource.login_codes.last.expired?
+          resource.send_code_login_instructions unless resource.login_codes.last.used?
+          fail(:login_code_expired); return
+        end
+
+        if validate(resource){ hashed = true; resource.login_codes.last.verify(login_code) }
+          remember_me(resource)
+          resource.after_code_authentication
+          success!(resource)
         else
-          if resource.login_codes.last.nil? || resource.login_codes.last.expired?
-            resource.generate_login_code
-            resource.send_code_login_instructions
-            fail(:login_code_expired)
-          end
-
-          if validate(resource){ hashed = true; resource.login_codes.last.verify(login_code) }
-            remember_me(resource)
-            resource.after_code_authentication
-            success!(resource)
-          else
-            fail(:invalid_login_code)
-          end
+          fail(:invalid_login_code)
         end
       end
 

data/lib/devise_code_authenticatable/version.rb

@@ -1,3 +1,3 @@
 module DeviseCodeAuthenticatable
-  VERSION = '0.1.3'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_code_authenticatable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.2
 platform: ruby
 authors:
 - vincentying15
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-21 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: '6.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.2.1
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: '6.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.2.1