one_time_password 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ead089daeb8fa2834811aadf3edae12fb7b679730a0e17a5fda7e8a5ea8a9b4
-  data.tar.gz: e779e98aeac41c6c2dfb8cee488cba4b40e9a89b8ab9300f80fa1041f5ff5440
+  metadata.gz: cc46ac36457860d5fef057d9f61f4248fda3a1bf86a14926ebc713f8349cc216
+  data.tar.gz: 030f37f6b244c8715d1899c0fbac377097e4e3f341e020bf0f235ad93d42dc52
 SHA512:
-  metadata.gz: 7e9a39b88ac4d0f14a594c086dd30ee5f1ed113a0cb5c88c1c1c5a1464b026844ee464f3b1ec74db7ad204441a5f35e766f7fa90cabe59ede86220c3d9ce35cc
-  data.tar.gz: 73c118f1dbb173a595e8d7c2f6ef8090fe42cfc13d1833c0268eef59b6030eab4a7a44ed530ef17b36812942f6ea8e8d47b4cd519d2cf96a27bf3a4b67c58bd4
+  metadata.gz: fc716b7f866b17e2ed3c8aa4c484a771af590e62144fe768122f25d7c841404da4ba1182007fc3a6e118e09b3a76e1cc67c0634443043604056911d7543f69c7
+  data.tar.gz: 81edb4614b3bb1154797e9f84c8b45224d18f76239dcb14029fe9b9149f592f838e6ffc102f58ae0c33061978b46d2f66853e04f9c833f1aba0abcf37f829d9b

data/README.md

@@ -2,9 +2,8 @@
 
 This Gem can be used to create 2FA (Two-Factor Authentication) function, email address verification function for member registration and etc in Ruby on Rails.
 
-
-
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -12,17 +11,17 @@ gem "one_time_password"
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
 Or install it yourself as:
+
 ```bash
 $ gem install one_time_password
 ```
 
-
-
 ## Usage
 
 ### Run command for an installation.
@@ -32,6 +31,7 @@ bundle exec rails g one_time_password:install
 ```
 
 The following events will take place when using the install generator:
+
 - An initializer file will be created at `config/initializers/one_time_password.rb`
 - A migration file will be created at `db/migrate/xxxxxxxxxxxxxx_create_one_time_authentication.rb`
 - A model file will be created at `app/models/one_time_authentication.rb`
@@ -46,29 +46,26 @@ bundle exec rails db:migrate
 
 Configuration in `config/initializers/one_time_password.rb`.
 
-`FUNCTION_NAMES`: Using function_name in OneTimeAuthentication Model enum. 
-
+`FUNCTION_NAMES`: Using function_name in OneTimeAuthentication Model enum.
 
 Hash, one of `CONTEXTS`:
-|     |     |
+| | |
 | --- | --- |
-| function_name (Symbol)                         | Name each function. |
-| version (Integer)                              | Version each function_name. |
-| expires_in (ActiveSupport::Duration)           | Password validity time. |
-| max_authenticate_password_count (Integer)      | Number of times user can enter password each generated password. |
-| password_length (Integer)                      | Password length. At 6, for example, the password would be 123456. |
+| function_name (Symbol) | Name each function. |
+| expires_in (ActiveSupport::Duration) | Password validity time. |
+| max_authenticate_password_count (Integer) | Number of times user can enter password each generated password. |
+| password_length (Integer) | Password length. At 6, for example, the password would be 123456. |
 | password_failed_limit (Integer)<br>password_failed_period (ActiveSupport::Duration) | If you try to authenticate with the wrong password a password_failed_limit times within the time set by password_failed_period, you will not be able to generate a new password. |
-|     |     |
+| | |
 
 ### See example and its sequence diagram
+
 [here](#example-and-its-sequence-diagram)
 
 ### `OneTimePassword::OneTimeAuthentication`'s methods.
 
 For more information, see the [implementation of OneTimePassword :: OneTimeAuthenticationModel](https://github.com/yosipy/one_time_password/blob/main/lib/one_time_password/one_time_authentication_model.rb).
 
-
-
 ## Example and its sequence diagram
 
 See [sign up exsample](https://github.com/yosipy/one_time_password/blob/main/spec/dummy/app/controllers/test_users_controller.rb).
@@ -77,12 +74,9 @@ Sequence diagram.
 
 ![sequence diagram image](document/sequence_diagram/sequencediagram.png)
 
-
-
 <!-- ## Contributing
 Contribution directions go here. -->
 
-
-
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/generators/one_time_password/templates/config/initializers/one_time_password.rb

@@ -17,7 +17,6 @@ module OneTimePassword
 
   # {
   #   function_name (Symbol): Name each function.
-  #   version (Integer): Version each function_name.
   #   expires_in (ActiveSupport::Duration): Password validity time.
   #   max_authenticate_password_count (Integer): Number of times user can enter password each generated password.
   #   password_length (Integer): Password length. At 6, for example, the password would be 123456.
@@ -28,7 +27,6 @@ module OneTimePassword
   CONTEXTS = [
     {
       function_name: :sign_up,
-      version: 0,
       expires_in: 30.minutes,
       max_authenticate_password_count: 5,
       password_length: 6,
@@ -37,7 +35,6 @@ module OneTimePassword
     },
     {
       function_name: :sign_in,
-      version: 0,
       expires_in: 30.minutes,
       max_authenticate_password_count: 5,
       password_length: 10,
@@ -46,7 +43,6 @@ module OneTimePassword
     },
     # {
     #   function_name: :change_email,
-    #   version: 0,
     #   expires_in: 30.minutes,
     #   max_authenticate_password_count: 5,
     #   password_length: 6

data/lib/generators/one_time_password/templates/db/migrate/create_one_time_authentication.rb.erb

@@ -2,7 +2,7 @@ class CreateOneTimeAuthentication < ActiveRecord::Migration<%= migration_version
   def change
     create_table :one_time_authentications do |t|
       t.integer :function_name, null: false
-      t.integer :version, null: false, index: true
+      t.integer :version, null: false, index: true, default: 0
       t.string :user_key, null: false, index: true
       t.string :client_token
       t.integer :password_length, null: false

data/lib/one_time_password/errors.rb

@@ -0,0 +1,5 @@
+module OneTimePassword
+  module Errors
+    class NoUserKeyArgmentError < StandardError; end
+  end
+end

data/lib/one_time_password/one_time_authentication_model.rb

@@ -17,32 +17,36 @@ module OneTimePassword
     end
 
     module ClassMethods
-      def find_context(function_name, version: 0)
+      def find_context(function_name)
         context = OneTimePassword::CONTEXTS
           .select{ |context|
-            context[:function_name] == function_name &&
-              context[:version] == version
+            context[:function_name] == function_name
           }
           .first
-  
+
         if context.nil?
-          raise ArgumentError.new('Not found context.')
+          raise ArgumentError, 'Not found context.'
         elsif context[:expires_in].class != ActiveSupport::Duration
-          raise RuntimeError.new('Mistake OneTimePassword::CONTEXTS[:expires_in]')
+          raise RuntimeError, 'Mistake OneTimePassword::CONTEXTS[:expires_in].'
         elsif context[:max_authenticate_password_count].class != Integer
-          raise RuntimeError.new('Mistake OneTimePassword::CONTEXTS[:max_authenticate_password_count]')
+          raise RuntimeError, 'Mistake OneTimePassword::CONTEXTS[:max_authenticate_password_count].'
         elsif context[:password_length].class != Integer
-          raise RuntimeError.new('Mistake OneTimePassword::CONTEXTS[:password_length]')
+          raise RuntimeError, 'Mistake OneTimePassword::CONTEXTS[:password_length].'
         elsif context[:password_failed_limit].class != Integer
-          raise RuntimeError.new('Mistake OneTimePassword::CONTEXTS[:password_failed_limit]')
+          raise RuntimeError, 'Mistake OneTimePassword::CONTEXTS[:password_failed_limit].'
         elsif context[:password_failed_period].class != ActiveSupport::Duration
-          raise RuntimeError.new('Mistake OneTimePassword::CONTEXTS[:password_failed_period]')
+          raise RuntimeError, 'Mistake OneTimePassword::CONTEXTS[:password_failed_period].'
         end
   
         context
       end
 
       def create_one_time_authentication(context, user_key, user_key_downcase: true)
+        if user_key.blank?
+          raise OneTimePassword::Errors::NoUserKeyArgmentError,
+            'Not present user_key.'
+        end
+
         user_key = user_key.downcase if user_key_downcase
 
         recent_failed_authenticate_password_count =
@@ -55,7 +59,6 @@ module OneTimePassword
         if recent_failed_authenticate_password_count <= context[:password_failed_limit]
           one_time_authentication = OneTimeAuthentication.new(
             function_name: context[:function_name],
-            version: context[:version],
             user_key: user_key,
             password_length: context[:password_length],
             expires_seconds: context[:expires_in].to_i,
@@ -71,11 +74,15 @@ module OneTimePassword
       end
 
       def find_one_time_authentication(context, user_key, user_key_downcase: true)
+        if user_key.blank?
+          raise OneTimePassword::Errors::NoUserKeyArgmentError,
+            'Not present user_key.'
+        end
+
         user_key = user_key.downcase if user_key_downcase
 
         OneTimeAuthentication
           .where(function_name: context[:function_name])
-          .where(version: context[:version])
           .where(user_key: user_key)
           .last
       end

data/lib/one_time_password/version.rb

@@ -1,3 +1,3 @@
 module OneTimePassword
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/one_time_password.rb

@@ -1,3 +1,4 @@
 require "one_time_password/version"
 require "one_time_password/railtie"
+require "one_time_password/errors"
 require "one_time_password/one_time_authentication_model"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: one_time_password
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - yosipy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-02 00:00:00.000000000 Z
+date: 2022-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -95,6 +95,7 @@ files:
 - lib/generators/one_time_password/templates/config/initializers/one_time_password.rb
 - lib/generators/one_time_password/templates/db/migrate/create_one_time_authentication.rb.erb
 - lib/one_time_password.rb
+- lib/one_time_password/errors.rb
 - lib/one_time_password/one_time_authentication_model.rb
 - lib/one_time_password/railtie.rb
 - lib/one_time_password/version.rb