devise-passwordless 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c07993e3995252a9cdc3e65f5fd8a21564bde80e33244310ff4d0b3d553d49c
-  data.tar.gz: 329ce513cb9d7b8e85f39d8d85ce32d2192c653237750722e7a010a750541a33
+  metadata.gz: 1d2e1ca1ad92971a19df58fd41e8e017c147f241705588a80eeb622142b256ce
+  data.tar.gz: 77ed842f7ae12a33fbf181fecac1770c0f9f4f4d9a0c842ed634d41da8946a96
 SHA512:
-  metadata.gz: fd1df26917844eab3030415ae4ecb2507925ddd957885767c2278653d86c43a0d5727223dc8fc67623348088e9957ab981302cec32b72d2785b60d6e9606d96a
-  data.tar.gz: 5009df7b815ee82e211e6e47508038f8b3c9d94d4fff693c40c54b6cd84c244226038fe4630541ef8ce1528c1d6fd9f5fd19ad79e64fd236a25e5c75f01b3ec3
+  metadata.gz: 5a496c66a599f699c4b7c451394c7d4bb4f9c4f8af1ff1195ea8dfb1c348a2af658a4f780238a36e42ff208d280d908a0df708c6cb9e23c64a01d81b5e4e73e5
+  data.tar.gz: 3e27189adc9b61ff6a455bf0defbbdbaa01a436ef4caed221f2f84d6261aff6a40532e8393e61c8a34fe5516dd4b75bf728339f1ecd33808807ef9bc3561d017

data/README.md

@@ -4,9 +4,9 @@ A passwordless a.k.a. "magic link" login strategy for [Devise][]
 
 ## Features
 
-* No database migrations / state needed - links are stateless encrypted tokens thanks to Rails's MessageEncryptor
+* No special database migrations needed - magic links are stateless encrypted tokens
 * Magic links are sent from your app - not a mounted Rails engine - so path and URL helpers work as expected
-* Multiple user types
+* [Supports multiple user (resource) types](#multiple-user-resource-types)
 * All the goodness of Devise!
 
 ## Installation
@@ -37,7 +37,7 @@ See the [customization section](#customization) for details on what gets install
 
 This gem adds a `:magic_link_authenticatable` strategy that can be used in your Devise models for passwordless authentication. This strategy plays well with most other Devise strategies (see [*notes on other Devise strategies*](#notes-on-other-devise-strategies)).
 
-For example, for a User model, you can now do this (other strategies listed are optional and not exhaustive):
+For example, given a User model, you can now do this (other strategies listed are optional and not exhaustive):
 
 ```ruby
 # app/models/user.rb
@@ -50,20 +50,17 @@ class User < ApplicationRecord
 end
 ```
 
-Then, you'll need to generate two controllers to modify Devise's default session create logic and to handle processing magic links:
-
-```
-$ rails g devise:passwordless:controller User
-```
-
-Then, set up your Devise routes like so to use these controllers:
+Then, you'll need to set up your Devise routes like so to use the passwordless controllers to modify Devise's default session create logic and to handle processing magic links:
 
 ```ruby
 # config/routes.rb
 Rails.application.routes.draw do
-  devise_for :users, controllers: { sessions: "users/sessions" }
+  devise_for :users,
+    controllers: { sessions: "devise/passwordless/sessions" }
   devise_scope :user do
-    get "/users/magic_links" => "users/magic_links#show"
+    get "/users/magic_link",
+      to: "devise/passwordless/magic_links#show",
+      as: "users_magic_link"
   end
 end
 ```
@@ -130,6 +127,71 @@ en:
 
 To customize the magic link email body, edit `app/views/devise/mailer/magic_link.html.erb`
 
+### Multiple user (resource) types
+
+Devise supports multiple resource types, so we do too.
+
+For example, if you have a User and Admin model, enable the `:magic_link_authenticatable` strategy for each:
+
+```ruby
+# app/models/user.rb
+class User < ApplicationRecord
+  devise :magic_link_authenticatable # , :registerable, :rememberable, ...
+end
+
+# app/models/admin.rb
+class Admin < ApplicationRecord
+  devise :magic_link_authenticatable # , :registerable, :rememberable, ...
+end
+```
+
+Then just set up your routes like this:
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  devise_for :users,
+    controllers: { sessions: "devise/passwordless/sessions" }
+  devise_scope :user do
+    get "/users/magic_link",
+      to: "devise/passwordless/magic_links#show",
+      as: "users_magic_link"
+  end
+  devise_for :admins,
+    controllers: { sessions: "devise/passwordless/sessions" }
+  devise_scope :admin do
+    get "/admins/magic_link",
+      to: "devise/passwordless/magic_links#show",
+      as: "admins_magic_link"
+  end
+end
+```
+
+And that's it!
+
+Messaging can be customized per-resource using [Devise's usual I18n support][devise-i18n]:
+
+```yaml
+en:
+  devise:
+    passwordless:
+      user:
+        not_found_in_database: "Could not find a USER for that email address"
+        magic_link_sent: "A USER login link has been sent to your email address. Please follow the link to log in to your account."
+      admin:
+        not_found_in_database: "Could not find an ADMIN for that email address"
+        magic_link_sent: "An ADMIN login link has been sent to your email address. Please follow the link to log in to your account."
+    failure:
+      user:
+        magic_link_invalid: "Invalid or expired USER login link."
+      admin:
+        magic_link_invalid: "Invalid or expired ADMIN login link."
+    mailer:
+      magic_link:
+        user_subject: "Here's your USER magic login link ✨"
+        admin_subject: "Here's your ADMIN magic login link ✨"
+```
+
 ### Notes on other Devise strategies
 
 If using the `:rememberable` strategy for "remember me" functionality, you'll need to add a `remember_token` column to your resource, as by default that strategy assumes you're using a password auth strategy and relies on comparing the password's salt to validate cookies:
@@ -147,3 +209,4 @@ If using the `:confirmable` strategy, you may want to override the default Devis
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 [Devise]: https://github.com/heartcombo/devise
+[devise-i18n]: https://github.com/heartcombo/devise#i18n

data/lib/devise/passwordless/version.rb

@@ -1,5 +1,5 @@
 module Devise
   module Passwordless
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/generators/devise/passwordless/install_generator.rb

@@ -5,7 +5,19 @@ require "yaml"
 module Devise::Passwordless
   module Generators # :nodoc:
     class InstallGenerator < ::Rails::Generators::Base # :nodoc:
-      desc "Creates default install and config files for the Devise passwordless auth strategy"
+      desc "Creates default install and config files for the Devise :magic_link_authenticatable strategy"
+
+      def self.default_generator_root
+        File.dirname(__FILE__)
+      end
+
+      def create_sessions_controller
+        template "sessions_controller.rb.erb", "app/controllers/devise/passwordless/sessions_controller.rb"
+      end
+
+      def create_magic_links_controller
+        template "magic_links_controller.rb.erb", "app/controllers/devise/passwordless/magic_links_controller.rb"
+      end
 
       def update_devise_initializer
         inject_into_file 'config/initializers/devise.rb', before: /^end$/ do <<~'CONFIG'.indent(2)
@@ -39,7 +51,7 @@ module Devise::Passwordless
 
           <p>You can login using the link below:</p>
           
-          <p><%= link_to "Log in to my account", send("#{@scope_name.to_s.pluralize}_magic_links_url", Hash[@scope_name, {email: @resource.email, token: @token, remember_me: @remember_me}]) %></p>
+          <p><%= link_to "Log in to my account", send("#{@scope_name.to_s.pluralize}_magic_link_url", Hash[@scope_name, {email: @resource.email, token: @token, remember_me: @remember_me}]) %></p>
           
           <p>Note that the link will expire in <%= Devise.passwordless_login_within.inspect %>.</p>          
         FILE

data/lib/generators/devise/passwordless/templates/magic_links_controller.rb.erb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 <% module_namespacing do -%>
-class <%= class_name.pluralize %>::MagicLinksController < DeviseController
+class Devise::Passwordless::MagicLinksController < DeviseController
   prepend_before_action :require_no_authentication, only: :show
   prepend_before_action :allow_params_authentication!, only: :show
   prepend_before_action(only: [:show]) { request.env["devise.skip_timeout"] = true }

data/lib/generators/devise/passwordless/templates/sessions_controller.rb.erb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 <% module_namespacing do -%>
-class <%= class_name.pluralize %>::SessionsController < Devise::SessionsController
+class Devise::Passwordless::SessionsController < Devise::SessionsController
   def create
     self.resource = resource_class.find_by(email: create_params[:email])
     if self.resource

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise-passwordless
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Abe Voelker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -89,7 +89,6 @@ files:
 - lib/devise/passwordless/mailer.rb
 - lib/devise/passwordless/version.rb
 - lib/devise/strategies/magic_link_authenticatable.rb
-- lib/generators/devise/passwordless/controller_generator.rb
 - lib/generators/devise/passwordless/install_generator.rb
 - lib/generators/devise/passwordless/templates/magic_links_controller.rb.erb
 - lib/generators/devise/passwordless/templates/sessions_controller.rb.erb

data/lib/generators/devise/passwordless/controller_generator.rb

@@ -1,21 +0,0 @@
-require "rails/generators/named_base"
-
-module Devise::Passwordless
-  module Generators # :nodoc:
-    class ControllerGenerator < ::Rails::Generators::NamedBase # :nodoc:
-      desc "Creates the session and magic link controllers needed for a Devise resource to use passwordless auth"
-
-      def self.default_generator_root
-        File.dirname(__FILE__)
-      end
-
-      def create_sessions_controller
-        template "sessions_controller.rb.erb", File.join("app/controllers", class_path, plural_name, "sessions_controller.rb")
-      end
-
-      def create_magic_links_controller
-        template "magic_links_controller.rb.erb", File.join("app/controllers", class_path, plural_name, "magic_links_controller.rb")
-      end
-    end
-  end
-end