authentication-zero 0.0.23 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78818129456d7a394a2a456605b007a2d0d68203038bb79ac0a8d9b74a9de59d
-  data.tar.gz: 7a7b8485f5c7cb9d3573e1768e25b40ba2de04fcf27d97d2383696ffabdb2249
+  metadata.gz: c038ff0229826dcb0ef7416e95f41ef7e18a01a7e5993a3995eb992c2a21a44a
+  data.tar.gz: 6295fb855b41a0ea8242916c18c40686f41d6f32e83fe66ed8922fe3b2c24ee7
 SHA512:
-  metadata.gz: 23bf695588244691a1a9db956f0f096e785ecd83bba969d05c7ee109b00a3a97c30a6ad13b3f874ac1f783f49181b0bdd92ff7f9cfa31b05ae223af1734ab420
-  data.tar.gz: 0b360acf0cb305053ca5610cb2a7de73ba3a2b2a091090ddd770f7ca99daa0e2ad48e5eebdba9d1e216e13418f4ff6c93802403f5c5f12de0ee7e0c0de42fb01
+  metadata.gz: fbbbb3287c24e23260ca3ad7adcc206c864f02843c255c111b6c1f06fd822581db35c522358dfa60a626e83bb2eb0f8494274847185a122f9cd90726c94ae2cf
+  data.tar.gz: fb427adb9595073f03b76bba0683cafd5ce9a699b25d79bbd4df2902abc7f4643f326a4b25c017ce6ab98b7e21d69d0532539aaeec8a018c3d69b7fd597f4d81

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    authentication-zero (0.0.23)
+    authentication-zero (1.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -27,7 +27,7 @@ The purpose of authentication zero is to generate a pre-built authentication sys
 - [Action mailer](https://api.rubyonrails.org/classes/ActionMailer/Base.html): Action Mailer allows you to send email from your application using a mailer model and views.
 - [Log filtering](https://guides.rubyonrails.org/action_controller_overview.html#log-filtering): Parameters 'token' and 'password' are marked [FILTERED] in the log.
 - [Functional Tests](https://guides.rubyonrails.org/testing.html#functional-tests-for-your-controllers): In Rails, testing the various actions of a controller is a form of writing functional tests.
-- [System Testing][https://guides.rubyonrails.org/testing.html#system-testing]: System tests allow you to test user interactions with your application, running tests in either a real or a headless browser.
+- [System Testing](https://guides.rubyonrails.org/testing.html#system-testing): System tests allow you to test user interactions with your application, running tests in either a real or a headless browser.
 
 ## Installation
 
@@ -83,6 +83,8 @@ config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
 $ rails generate authentication user
 ```
 
+Then run `bundle install` again!
+
 ## Development
 
 To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/lib/authentication_zero/version.rb

@@ -1,3 +1,3 @@
 module AuthenticationZero
-  VERSION = "0.0.23"
+  VERSION = "1.0.2"
 end

data/lib/generators/authentication/authentication_generator.rb

@@ -1,28 +1,40 @@
 require "rails/generators/active_record"
 
 class AuthenticationGenerator < Rails::Generators::NamedBase
-  include ActiveRecord::Generators::Migration
-
   class_option :api, type: :boolean, desc: "Generates API authentication"
+
+  class_option :migration, type: :boolean, default: true
+  class_option :test_framework, type: :string, desc: "Test framework to be invoked"
+
+  class_option :fixture, type: :boolean, default: true
   class_option :system_tests, type: :string, desc: "Skip system test files"
 
+  class_option :skip_routes, type: :boolean
+  class_option :template_engine, type: :string, desc: "Template engine to be invoked"
+
   source_root File.expand_path("templates", __dir__)
 
   def add_bcrypt
-    uncomment_lines 'Gemfile', /bcrypt/
+    uncomment_lines "Gemfile", /bcrypt/
   end
 
-  def create_migrations
-    invoke "migration", ["create_#{table_name}", "email:string:uniq", "password_digest:string", "session_token:string:uniq"]
+  def create_migration
+    if options.migration
+      invoke "migration", ["create_#{table_name}", "email:string:uniq", "password:digest", "session_token:string:uniq"]
+    end
   end
 
   def create_models
-    template "app/models/model.rb", "app/models/#{file_name}.rb"
-    template "app/models/current.rb", "app/models/current.rb"
+    template "models/model.rb", "app/models/#{file_name}.rb"
+    template "models/current.rb", "app/models/current.rb"
   end
 
+  hook_for :fixture_replacement
+
   def create_fixture_file
-    template "test_unit/fixtures.yml", "test/fixtures/#{fixture_file_name}.yml"
+    if options.fixture && options.fixture_replacement.nil?
+      template "#{test_framework}/fixtures.yml", "test/fixtures/#{fixture_file_name}.yml"
+    end
   end
 
   def add_application_controller_methods
@@ -57,42 +69,59 @@ class AuthenticationGenerator < Rails::Generators::NamedBase
   end
 
   def create_controllers
-    directory "app/controllers/#{format_folder}", "app/controllers"
+    directory "controllers/#{format_folder}", "app/controllers"
   end
 
   def create_views
     if options.api
-      directory "app/views/email_mailer", "app/views/email_mailer"
-      directory "app/views/password_mailer", "app/views/password_mailer"
+      directory "erb/email_mailer", "app/views/email_mailer"
+      directory "erb/password_mailer", "app/views/password_mailer"
     else
-      directory "app/views", "app/views"
+      directory "#{template_engine}", "app/views"
     end
   end
 
   def create_mailers
-    template "app/mailers/email_mailer.rb", "app/mailers/email_mailer.rb"
-    template "app/mailers/password_mailer.rb", "app/mailers/password_mailer.rb"
+    directory "mailers", "app/mailers"
   end
 
   def add_routes
-    route "resource :password_resets, only: [:new, :edit, :create, :update]"
-    route "resource :cancellations, only: [:new, :create]"
-    route "resource :passwords, only: [:edit, :update]"
-    route "resource :emails, only: [:edit, :update]"
-    route "delete 'sign_out', to: 'sessions#destroy'"
-    route "post 'sign_up', to: 'registrations#create'"
-    route "get 'sign_up', to: 'registrations#new'" unless options.api?
-    route "post 'sign_in', to: 'sessions#create'"
-    route "get 'sign_in', to: 'sessions#new'" unless options.api?
+    unless options.skip_routes
+      route "resource :password_resets, only: [:new, :edit, :create, :update]"
+      route "resource :cancellations, only: [:new, :create]"
+      route "resource :passwords, only: [:edit, :update]"
+      route "resource :emails, only: [:edit, :update]"
+      route "delete 'sign_out', to: 'sessions#destroy'"
+      route "post 'sign_up', to: 'registrations#create'"
+      route "get 'sign_up', to: 'registrations#new'" unless options.api?
+      route "post 'sign_in', to: 'sessions#create'"
+      route "get 'sign_in', to: 'sessions#new'" unless options.api?
+    end
   end
 
   def create_test_files
-    directory "test_unit/controllers/#{format_folder}", "test/controllers"
-    directory "test_unit/system", "test/system" if !options.api? && options[:system_tests]
+    directory "#{test_framework}/controllers/#{format_folder}", "test/controllers"
+    directory "#{system_tests}/system", "test/system" if system_tests?
   end
 
   private
     def format_folder
       options.api ? "api" : "html"
     end
+
+    def template_engine
+      options.template_engine
+    end
+
+    def test_framework
+      options.test_framework
+    end
+
+    def system_tests
+      options.system_tests
+    end
+
+    def system_tests?
+      !options.api? && options.system_tests
+    end
 end

data/lib/generators/authentication/templates/{app/controllers → controllers}/api/password_resets_controller.rb.tt

@@ -1,5 +1,6 @@
 class PasswordResetsController < ApplicationController
   skip_before_action :authenticate
+
   before_action :set_<%= singular_table_name %>, only: %i[ edit update ]
 
   def edit
@@ -10,7 +11,7 @@ class PasswordResetsController < ApplicationController
     if @<%= singular_table_name %> = <%= class_name %>.find_by_email(params[:email])
       PasswordMailer.with(<%= singular_table_name %>: @<%= singular_table_name %>).reset.deliver_later
     else
-      render json: { error: "The email address doesn't exist in our database" }, status: :not_found
+      render json: { error: "Sorry, we didn't recognize that email address" }, status: :not_found
     end
   end
 
@@ -24,7 +25,7 @@ class PasswordResetsController < ApplicationController
 
   private
     def set_<%= singular_table_name %>
-      @<%= singular_table_name %> = <%= class_name %>.find_signed!(params[:token], purpose: "password_reset")
+      @<%= singular_table_name %> = <%= class_name %>.find_signed!(params[:token], purpose: :password_reset)
     rescue ActiveSupport::MessageVerifier::InvalidSignature
       render json: { error: "Your token has expired, please request a new one" }, status: :bad_request
     end

data/lib/generators/authentication/templates/{app/controllers → controllers}/html/password_resets_controller.rb.tt

@@ -1,5 +1,6 @@
 class PasswordResetsController < ApplicationController
   skip_before_action :authenticate
+
   before_action :set_<%= singular_table_name %>, only: %i[ edit update ]
 
   def new
@@ -13,7 +14,7 @@ class PasswordResetsController < ApplicationController
       PasswordMailer.with(<%= singular_table_name %>: @<%= singular_table_name %>).reset.deliver_later
       redirect_to sign_in_path, notice: "You will receive an email with instructions on how to reset your password in a few minutes"
     else
-      redirect_to new_password_resets_path(email_hint: params[:email]), alert: "The email address doesn't exist in our database"
+      redirect_to new_password_resets_path, alert: "Sorry, we didn't recognize that email address"
     end
   end
 
@@ -27,7 +28,7 @@ class PasswordResetsController < ApplicationController
 
   private
     def set_<%= singular_table_name %>
-      @<%= singular_table_name %> = <%= class_name %>.find_signed!(params[:token], purpose: "password_reset")
+      @<%= singular_table_name %> = <%= class_name %>.find_signed!(params[:token], purpose: :password_reset)
     rescue ActiveSupport::MessageVerifier::InvalidSignature
       redirect_to new_password_resets_path, alert: "Your token has expired, please request a new one"
     end

data/lib/generators/authentication/templates/{app/views → erb}/password_resets/new.html.erb.tt

@@ -5,7 +5,7 @@
 <%%= form_with(url: password_resets_path) do |form| %>
   <div>
     <%%= form.label :email, style: "display: block" %>
-    <%%= form.email_field :email, value: params[:email_hint], autofocus: true, required: true %>
+    <%%= form.email_field :email, autofocus: true, required: true %>
   </div>
 
   <div>

data/lib/generators/authentication/templates/{app/mailers → mailers}/password_mailer.rb.tt

@@ -4,7 +4,7 @@ class PasswordMailer < ApplicationMailer
   end
 
   def reset
-    @signed_id = params[:<%= singular_table_name %>].signed_id(purpose: "password_reset", expires_in: 20.minutes)
+    @signed_id = params[:<%= singular_table_name %>].signed_id(purpose: :password_reset, expires_in: 20.minutes)
     mail to: params[:<%= singular_table_name %>].email
   end
 end

data/lib/generators/authentication/templates/{app/models → models}/model.rb.tt

@@ -23,11 +23,11 @@ class <%= class_name %> < ApplicationRecord
   end
 <% if options.api? %>
   def signed_session_token
-    self.class.signed_id_verifier.generate(session_token)
+    Rails.application.message_verifier(:session_token).generate(session_token)
   end
 
   def self.find_signed_session_token(signed_session_token)
-    if session_token = signed_id_verifier.verified(signed_session_token)
+    if session_token = Rails.application.message_verifier(:session_token).verified(signed_session_token)
       find_by_session_token(session_token)
     end
   end

data/lib/generators/authentication/templates/test_unit/controllers/api/password_resets_controller_test.rb.tt

@@ -3,8 +3,8 @@ require "test_helper"
 class PasswordResetsControllerTest < ActionDispatch::IntegrationTest
   setup do
     @<%= singular_table_name %> = <%= table_name %>(:lazaro_nixon)
-    @sid = @<%= singular_table_name %>.signed_id(purpose: "password_reset", expires_in: 20.minutes)
-    @sid_exp = @<%= singular_table_name %>.signed_id(purpose: "password_reset", expires_in: 0.minutes)
+    @sid = @<%= singular_table_name %>.signed_id(purpose: :password_reset, expires_in: 20.minutes)
+    @sid_exp = @<%= singular_table_name %>.signed_id(purpose: :password_reset, expires_in: 0.minutes)
   end
 
   test "should get edit" do
@@ -28,12 +28,11 @@ class PasswordResetsControllerTest < ActionDispatch::IntegrationTest
     end
 
     assert_response :not_found
-    assert_equal "The email address doesn't exist in our database", response.parsed_body["error"]
+    assert_equal "Sorry, we didn't recognize that email address", response.parsed_body["error"]
   end
 
   test "should update password" do
     patch password_resets_url, params: { token: @sid, password: "new_password", password_confirmation: "new_password" }
-
     assert_response :success
   end
 

data/lib/generators/authentication/templates/test_unit/controllers/html/password_resets_controller_test.rb.tt

@@ -3,8 +3,8 @@ require "test_helper"
 class PasswordResetsControllerTest < ActionDispatch::IntegrationTest
   setup do
     @<%= singular_table_name %> = <%= table_name %>(:lazaro_nixon)
-    @sid = @<%= singular_table_name %>.signed_id(purpose: "password_reset", expires_in: 20.minutes)
-    @sid_exp = @<%= singular_table_name %>.signed_id(purpose: "password_reset", expires_in: 0.minutes)
+    @sid = @<%= singular_table_name %>.signed_id(purpose: :password_reset, expires_in: 20.minutes)
+    @sid_exp = @<%= singular_table_name %>.signed_id(purpose: :password_reset, expires_in: 0.minutes)
   end
 
   test "should get new" do
@@ -30,13 +30,12 @@ class PasswordResetsControllerTest < ActionDispatch::IntegrationTest
       post password_resets_url, params: { email: "invalid_email@hey.com" }
     end
 
-    assert_redirected_to new_password_resets_url(email_hint: "invalid_email@hey.com")
-    assert_equal "The email address doesn't exist in our database", flash[:alert]
+    assert_redirected_to new_password_resets_url
+    assert_equal "Sorry, we didn't recognize that email address", flash[:alert]
   end
 
   test "should update password" do
     patch password_resets_url, params: { token: @sid, <%= singular_table_name %>: { password: "new_password", password_confirmation: "new_password" } }
-
     assert_redirected_to sign_in_path
   end
 

data/lib/generators/authentication/templates/test_unit/system/password_resets_test.rb.tt

@@ -3,7 +3,7 @@ require "application_system_test_case"
 class PasswordResetsTest < ApplicationSystemTestCase
   setup do
     @<%= singular_table_name %> = <%= table_name %>(:lazaro_nixon)
-    @sid = @<%= singular_table_name %>.signed_id(purpose: "password_reset", expires_in: 20.minutes)
+    @sid = @<%= singular_table_name %>.signed_id(purpose: :password_reset, expires_in: 20.minutes)
   end
 
   test "sending a password reset email" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authentication-zero
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 1.0.2
 platform: ruby
 authors:
 - Nixon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-21 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -31,35 +31,35 @@ files:
 - lib/authentication_zero/version.rb
 - lib/generators/authentication/USAGE
 - lib/generators/authentication/authentication_generator.rb
-- lib/generators/authentication/templates/app/controllers/api/cancellations_controller.rb.tt
-- lib/generators/authentication/templates/app/controllers/api/emails_controller.rb.tt
-- lib/generators/authentication/templates/app/controllers/api/password_resets_controller.rb.tt
-- lib/generators/authentication/templates/app/controllers/api/passwords_controller.rb.tt
-- lib/generators/authentication/templates/app/controllers/api/registrations_controller.rb.tt
-- lib/generators/authentication/templates/app/controllers/api/sessions_controller.rb.tt
-- lib/generators/authentication/templates/app/controllers/html/cancellations_controller.rb.tt
-- lib/generators/authentication/templates/app/controllers/html/emails_controller.rb.tt
-- lib/generators/authentication/templates/app/controllers/html/password_resets_controller.rb.tt
-- lib/generators/authentication/templates/app/controllers/html/passwords_controller.rb.tt
-- lib/generators/authentication/templates/app/controllers/html/registrations_controller.rb.tt
-- lib/generators/authentication/templates/app/controllers/html/sessions_controller.rb.tt
-- lib/generators/authentication/templates/app/mailers/email_mailer.rb.tt
-- lib/generators/authentication/templates/app/mailers/password_mailer.rb.tt
-- lib/generators/authentication/templates/app/models/current.rb.tt
-- lib/generators/authentication/templates/app/models/model.rb.tt
-- lib/generators/authentication/templates/app/views/cancellations/new.html.erb.tt
-- lib/generators/authentication/templates/app/views/email_mailer/changed.html.erb.tt
-- lib/generators/authentication/templates/app/views/email_mailer/changed.text.erb.tt
-- lib/generators/authentication/templates/app/views/emails/edit.html.erb.tt
-- lib/generators/authentication/templates/app/views/password_mailer/changed.html.erb.tt
-- lib/generators/authentication/templates/app/views/password_mailer/changed.text.erb.tt
-- lib/generators/authentication/templates/app/views/password_mailer/reset.html.erb.tt
-- lib/generators/authentication/templates/app/views/password_mailer/reset.text.erb.tt
-- lib/generators/authentication/templates/app/views/password_resets/edit.html.erb.tt
-- lib/generators/authentication/templates/app/views/password_resets/new.html.erb.tt
-- lib/generators/authentication/templates/app/views/passwords/edit.html.erb.tt
-- lib/generators/authentication/templates/app/views/registrations/new.html.erb.tt
-- lib/generators/authentication/templates/app/views/sessions/new.html.erb.tt
+- lib/generators/authentication/templates/controllers/api/cancellations_controller.rb.tt
+- lib/generators/authentication/templates/controllers/api/emails_controller.rb.tt
+- lib/generators/authentication/templates/controllers/api/password_resets_controller.rb.tt
+- lib/generators/authentication/templates/controllers/api/passwords_controller.rb.tt
+- lib/generators/authentication/templates/controllers/api/registrations_controller.rb.tt
+- lib/generators/authentication/templates/controllers/api/sessions_controller.rb.tt
+- lib/generators/authentication/templates/controllers/html/cancellations_controller.rb.tt
+- lib/generators/authentication/templates/controllers/html/emails_controller.rb.tt
+- lib/generators/authentication/templates/controllers/html/password_resets_controller.rb.tt
+- lib/generators/authentication/templates/controllers/html/passwords_controller.rb.tt
+- lib/generators/authentication/templates/controllers/html/registrations_controller.rb.tt
+- lib/generators/authentication/templates/controllers/html/sessions_controller.rb.tt
+- lib/generators/authentication/templates/erb/cancellations/new.html.erb.tt
+- lib/generators/authentication/templates/erb/email_mailer/changed.html.erb.tt
+- lib/generators/authentication/templates/erb/email_mailer/changed.text.erb.tt
+- lib/generators/authentication/templates/erb/emails/edit.html.erb.tt
+- lib/generators/authentication/templates/erb/password_mailer/changed.html.erb.tt
+- lib/generators/authentication/templates/erb/password_mailer/changed.text.erb.tt
+- lib/generators/authentication/templates/erb/password_mailer/reset.html.erb.tt
+- lib/generators/authentication/templates/erb/password_mailer/reset.text.erb.tt
+- lib/generators/authentication/templates/erb/password_resets/edit.html.erb.tt
+- lib/generators/authentication/templates/erb/password_resets/new.html.erb.tt
+- lib/generators/authentication/templates/erb/passwords/edit.html.erb.tt
+- lib/generators/authentication/templates/erb/registrations/new.html.erb.tt
+- lib/generators/authentication/templates/erb/sessions/new.html.erb.tt
+- lib/generators/authentication/templates/mailers/email_mailer.rb.tt
+- lib/generators/authentication/templates/mailers/password_mailer.rb.tt
+- lib/generators/authentication/templates/models/current.rb.tt
+- lib/generators/authentication/templates/models/model.rb.tt
 - lib/generators/authentication/templates/test_unit/controllers/api/cancellations_controller_test.rb.tt
 - lib/generators/authentication/templates/test_unit/controllers/api/emails_controller_test.rb.tt
 - lib/generators/authentication/templates/test_unit/controllers/api/password_resets_controller_test.rb.tt