devise_code_authenticatable 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d59c09da1f30b55c31bebdefc644bface2a0368967e34d42359e148259f3516
-  data.tar.gz: fbae74bca964a26b673a51ed3093ad9bcc729fec3d439c8ca0d537b7da9454ab
+  metadata.gz: d5b5e44ba5833b455ffd654e935463a2596ae87326875e727c2d883f9983c272
+  data.tar.gz: 7ef83bb888e39e7fce3cb8aa3bc0d9a54000d75fc2449c7c11f2463fe086030c
 SHA512:
-  metadata.gz: 79ee709e8042b39336ca4ec6f3bf8aa25850aad59ffd915686348d4e7256fca027988ab5cda806e81f8f2ba4cffa4cc36c643e2e75da7f90fb1e1c623fbff8a3
-  data.tar.gz: f65055c2bbb8c1ce2a15bb64313ea93886c16cdcd1183185fccca731347b4644fc8c80b385677f2dddfd5ab05ebf2dd1800b35b1cf3fa7b781fb7c78fc5a7ad8
+  metadata.gz: 84c616b0a1ddc8722c7d6c102a6259ec6a598974d7f0cf2588ba58f032dee866e92e2de266b668f23e96e3be1615bb1c4570960a59d3a9a0b244dde4e13b4216
+  data.tar.gz: e3f720d265c3ee899a712b649115b619c0f66b0e3e680c7838ebbdf83d9ba636f5ca454bbfd388f00013c4657606e08a3336179b398c09522b4a129ea796c6a5

data/README.md

@@ -1,28 +1,47 @@
 # DeviseCodeAuthenticatable
-Short description and motivation.
+A Devise plugin for two-factor authenticatable.
 
-## Usage
-How to use my plugin.
+## 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 application's Gemfile:
+Add this line to your Rails Gemfile:
 
 ```ruby
 gem 'devise_code_authenticatable'
 ```
 
-And then execute:
+### Automatic installation
+Run:
+
 ```bash
-$ bundle
+rails generate devise_code_authenticatable:install
+```
+
+This will create a migration file name in your <tt>db/migrate</tt> folder, then
+ 
+
+```ruby
+rails db:migrate
 ```
+### Devise Configuration
+Add <tt>:authenticatable</tt> to the model you want to enable code_authenticatable
+
+```ruby
+class User < ActiveRecord::Base
+  devise :database_authenticatable, :confirmable, :code_authenticatable
+end
+```
+## Usage
+### Customize views
+This plugin is included with basic views, to customize the views you need to run
 
-Or install it yourself as:
 ```bash
-$ gem install devise_code_authenticatable
+rails generate devise_code_authenticatable:views
 ```
 
-## Contributing
-Contribution directions go here.
+### 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/version.rb

@@ -1,3 +1,3 @@
 module DeviseCodeAuthenticatable
-  VERSION = '0.0.7'
+  VERSION = '0.1.0'
 end

data/lib/generators/devise_code_authenticatable/install_generator.rb

@@ -0,0 +1,32 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module DeviseCodeAuthenticatable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ::Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_locale
+        copy_file '../../../../config/locales/en.yml', 'config/locales/devise_code_authenticatable.en.yml'
+      end
+
+      def copy_devise_migration
+        migration_template 'migration.rb', "db/migrate/create_login_codes.rb", migration_version: migration_version
+      end
+
+      def migration_version
+        major = ActiveRecord::VERSION::MAJOR
+        if major >= 6
+          "[#{major}.#{ActiveRecord::VERSION::MINOR}]"
+        end
+      end
+
+      def self.next_migration_number(dirname)
+        ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+    end
+  end
+end

data/lib/generators/devise_code_authenticatable/templates/migration.rb

@@ -0,0 +1,12 @@
+class CreateLoginCodes < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :login_codes do |t|
+      t.string :code
+      t.integer :retry_times
+      t.boolean :expired
+      t.references :resource, polymorphic: true, index: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/devise_code_authenticatable/templates/simple_form_for/login_codes/show.html.erb

@@ -0,0 +1,7 @@
+<h2><%= t(".sign_in") %></h2>
+<%= simple_form_for resource, url: verify_user_login_code_path(@login_code) do |f| %>
+    <%= f.input :email, placeholder: "email" %>
+    <%= f.input :login_code, placeholder: "code" %>
+    <%= f.submit t(".sign_in") %>
+<% end %>
+<%= link_to t(".resend_code"), resend_user_login_code_path(@login_code) %>

data/lib/generators/devise_code_authenticatable/templates/simple_form_for/sessions/new.html.erb

@@ -0,0 +1,5 @@
+<h2><%= t(".sign_in") %></h2>
+<%= form_for resource, url: new_session_path(resource_name) do |f| %>
+    <%= f.input :email, placeholder: "email" %>
+    <%= f.submit t(".send_code") %>
+<% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_code_authenticatable
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - vincentying15
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2020-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -60,6 +60,10 @@ files:
 - lib/devise_code_authenticatable/routes.rb
 - lib/devise_code_authenticatable/strategies/code_authenticatable.rb
 - lib/devise_code_authenticatable/version.rb
+- lib/generators/devise_code_authenticatable/install_generator.rb
+- lib/generators/devise_code_authenticatable/templates/migration.rb
+- lib/generators/devise_code_authenticatable/templates/simple_form_for/login_codes/show.html.erb
+- lib/generators/devise_code_authenticatable/templates/simple_form_for/sessions/new.html.erb
 homepage: https://rubygems.org/gems/devise_code_authenticatable
 licenses:
 - MIT