devise_invitable 2.0.5 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0517f954240bfc3c1fd255df0d502d5fdbd461d4e695cd0c5ec725854af50dcf
-  data.tar.gz: 239b887a32e66dbc38fbf1e04625def2f1dea325fcc6d20af0e1befd066dd000
+  metadata.gz: f2a7d1c4ae3cc61e2992fa9920ddd35e6626745dd32333a88e8231fb267e2cb0
+  data.tar.gz: ee68fbb505a629c391934bee8c644c0ade499333d5c7065745426fd6e419642a
 SHA512:
-  metadata.gz: 957006ebe6e94715459f941b52004a1002e72005e9344baca46679398bc34e360604e3a8a205d9099a4ff5015be597c1c02a89055137db6c12f10ecf03949db7
-  data.tar.gz: 17200aa6cf76d5abf07de1e4c0987f197140087a7a3210df0bf948a6098602eeeab05d65983cc69ef2185f2de741813ebc778a28d476a86bc5b1527bbd918f4c
+  metadata.gz: fd3ead62e8c2246f9246fbac3a2138ea6ff4f1abcf3c577faad920b339f1c1795b54497d03b34f4bc685be6131f62692d2497fbc5d1081e740e0a85d7e1a25c2
+  data.tar.gz: 0453554d47731a99e931c81dbd44e77eca935ff6ca453172f40f394da84bd1d5a92507aafa881ab491202cee5fa534aef4ba9b2a4ac1fa37327a664c7ceb8e61

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+- Allow customizing invalid_token_path_for, the path to redirect users who try to accept with invalid token
+- Don't override registrations controller in routes if module option is used
+- Fix typo in spanish translation, add Catalan translation ([#857](https://github.com/scambra/devise_invitable/pull/857))
+- Fix for ruby 3.2.0
+
+## 2.0.6
+- Fix submit form failure with turbolinks, fixes ([#865](https://github.com/scambra/devise_invitable/issues/865))
+- Fix obsolete symbols in German translation ([#864](https://github.com/scambra/devise_invitable/pull/864))
+- Allow to provide validate option to the instance method "invite!", default to follow the setting validate_on_invite
+
 ## 2.0.5
 - Fix NoMethodError in random_password when validatable is not used ([#850](https://github.com/scambra/devise_invitable/pull/850))
 

data/README.rdoc

@@ -1,5 +1,7 @@
 = DeviseInvitable
-{<img src="https://badge.fury.io/rb/devise_invitable.svg"/>}[http://badge.fury.io/rb/devise_invitable] {<img src="https://travis-ci.org/scambra/devise_invitable.svg"/>}[https://travis-ci.org/scambra/devise_invitable] {<img src="https://codeclimate.com/github/scambra/devise_invitable/badges/gpa.svg"/>}[https://codeclimate.com/github/scambra/devise_invitable]
+{<img src="https://badge.fury.io/rb/devise_invitable.svg"/>}[http://badge.fury.io/rb/devise_invitable]
+{<img src="https://github.com/scambra/devise_invitable/actions/workflows/ci.yml/badge.svg"/>}[https://github.com/scambra/devise_invitable/actions/workflows/ci.yml]
+{<img src="https://codeclimate.com/github/scambra/devise_invitable/badges/gpa.svg"/>}[https://codeclimate.com/github/scambra/devise_invitable]
 
 It adds support to Devise[https://github.com/plataformatec/devise] for sending invitations by email (it requires to be authenticated) and accept the invitation setting the password.
 
@@ -35,14 +37,14 @@ Replace MODEL by the class name you want to add DeviseInvitable, like <tt>User</
 
 Follow the walkthrough for Devise and after it's done, follow this walkthrough.
 
-== Devise Configuration
+==== Devise Configuration
 Add <tt>:invitable</tt> to the <tt>devise</tt> call in your model (we’re assuming here you already have a User model with some Devise modules):
 
   class User < ActiveRecord::Base
     devise :database_authenticatable, :confirmable, :invitable
   end
 
-== ActiveRecord Migration
+==== ActiveRecord Migration
 Add <tt>t.invitable</tt> to your Devise model migration:
 
   create_table :users do
@@ -217,6 +219,61 @@ Here is an example of what your application controller might need to include in
       devise_parameter_sanitizer.permit(:accept_invitation, keys: [:first_name, :last_name, :phone])
     end
 
+Here is an example setting a User's first name, last name, and role for a custom invitation:
+  
+  #Configuring the InvitationsController to accept :first_name, :last_name, and :role
+
+  class Users::InvitationsController < Devise::InvitationsController
+    before_action :configure_permitted_parameters
+  
+    protected
+  
+    # Permit the new params here.
+    def configure_permitted_parameters
+      devise_parameter_sanitizer.permit(:invite, keys: [:first_name, :last_name, :role])
+    end
+  end
+
+  #Define your roles in the User model
+
+  class User < ApplicationRecord
+    has_many :models
+    
+    enum role: {Role 1 Name: 0, Role 2 Name: 1, Role 3 Name: 2, etc...}
+  end
+
+  #In the Invitation view
+
+  <h2><%= t "devise.invitations.new.header" %></h2>
+
+  <%= form_for(resource, as: resource_name, url: invitation_path(resource_name), html: { method: :post }) do |f| %>
+    <%= render "devise/shared/error_messages", resource: resource %>
+    <% resource.class.invite_key_fields.each do |field| -%>
+      <div class="field">
+        <%= f.label field %><br />
+        <%= f.text_field field %>
+      </div>
+    <% end %>
+
+    <div class="field">
+      <%= f.label :first_name %>
+      <%= f.text_field :first_name %>
+    </div>
+
+    <div class="field">
+      <%= f.label :last_name %>
+      <%= f.text_field :last_name %>
+    </div>
+
+    <div class="field">
+      <%= f.label :role %>
+      <%= f.select :role, options_for_select(User.roles.map { |key, value| [key.humanize, key] }), {prompt: "Select Role"} %>
+    </div>
+
+    <div class="actions">
+      <%= f.submit t("devise.invitations.new.submit_button") %>
+    </div>
+  <% end %>
 
 == Usage
 
@@ -315,7 +372,7 @@ After an invitation is created and sent, the inviter will be redirected to <tt>a
 
 After an invitation is accepted, the invitee will be redirected to <tt>after_accept_path_for(resource)</tt>, which is the same path as <tt>signed_in_root_path</tt> by default. If you want to override the path, override invitations controller and define <tt>after_accept_path_for</tt> method. This is useful in the common case that a user is invited to a specific location in your application. More on {Devise's README}[https://github.com/plataformatec/devise], "Controller filters and helpers" section.
 
-The invitation email includes a link to accept the invitation that looks like this: <tt>/users/invitation/accept?invitation_token=abcd123</tt>. When clicked, the invited must set a password in order to accept its invitation. Note that if the <tt>invitation_token</tt> is not present or not valid, the invited is redirected to <tt>after_sign_out_path_for(resource_name)</tt>.
+The invitation email includes a link to accept the invitation that looks like this: <tt>/users/invitation/accept?invitation_token=abcd123</tt>. When clicked, the invited must set a password in order to accept its invitation. Note that if the <tt>invitation_token</tt> is not present or not valid, the invited is redirected to <tt>invalid_token_path_for(resource_name)</tt>, which by default is <tt>after_sign_out_path_for(resource_name)</tt>.
 
 The controller sets the <tt>invited_by_id</tt> attribute for the new user to the current user.  This will let you easily keep track of who invited whom.
 

data/app/controllers/devise/invitations_controller.rb

@@ -31,7 +31,7 @@ class Devise::InvitationsController < DeviseController
         respond_with resource, location: after_invite_path_for(current_inviter, resource)
       end
     else
-      respond_with_navigational(resource) { render :new }
+      respond_with_navigational(resource) { render :new, status: :unprocessable_entity }
     end
   end
 
@@ -63,7 +63,7 @@ class Devise::InvitationsController < DeviseController
       end
     else
       resource.invitation_token = raw_invitation_token
-      respond_with_navigational(resource) { render :edit }
+      respond_with_navigational(resource) { render :edit, status: :unprocessable_entity }
     end
   end
 
@@ -99,7 +99,7 @@ class Devise::InvitationsController < DeviseController
     def resource_from_invitation_token
       unless params[:invitation_token] && self.resource = resource_class.find_by_invitation_token(params[:invitation_token], true)
         set_flash_message(:alert, :invitation_token_invalid) if is_flashing_format?
-        redirect_to after_sign_out_path_for(resource_name)
+        redirect_to invalid_token_path_for(resource_name)
       end
     end
 

data/config/locales/ca.yml

@@ -0,0 +1,32 @@
+
+ca:
+  devise:
+    failure:
+      invited: "Tens una invitació pendent, accepta-la per acabar de crear el teu compte."
+    invitations:
+      send_instructions: "S'ha enviat una invitació a %{email}."
+      invitation_token_invalid: "La invitació no es vàlida!"
+      updated: "S'ha configurat la seva contrasenya i s'ha ingressat al sistema"
+      updated_not_active: "La seva contrasenya s'ha configurat correctament."
+      no_invitations_remaining: "No queden invitacions"
+      invitation_removed: "S'ha retirat la seva invitació"
+      new:
+        header: "Enviar Invitació"
+        submit_button: "Envia una invitació"
+      edit:
+        header: "Establir contrasenya"
+        submit_button: "Guardar la meva contrasenya"
+    mailer:
+      invitation_instructions:
+        subject: "Instruccions de la invitació"
+        hello: "Hola %{email}"
+        someone_invited_you: "Has estat invitat a %{url}, pots acceptar-ho seguint el següent enllaç"
+        accept: "Aceptar la invitació"
+        accept_until: "Aquesta invitació expirarà en %{due_date}."
+        ignore: "Si no li interessa aquesta invitació, simplement ignori aquest correu. No es crearà el teu compte fins que accedeixis a l'anterior enllaç i creïs una contrasenya"
+  time:
+    formats:
+      devise:
+        mailer:
+          invitation_instructions:
+            accept_until_format: "%d de %B de %Y, %H:%M"

data/config/locales/de.yml

@@ -1,31 +1,31 @@
-de:                                                                                                                                                                       
-  devise:                                                                                                                                                                 
-    failure:                                                                                                                                                              
-      invited: "Du hast bereits eine Einladung erhalten. Nimm die Einladung an um dein Nutzerkonto zu erstellen."                                                         
-    invitations:                                                                                                                                                          
-      send_instructions: "Eine Einladung wurde an %{email} verschickt."                                                                                                   
-      invitation_token_invalid: "Der Einladungs-Code ist ungültig!"                                                                                                       
-      updated: "Dein Passwort wurde gesetzt. Du bist nun angemeldet."                                                                                                     
-      updated_not_active: "Dein Passwort wurde gesetzt."                                                                                                                  
-      no_invitations_remaining: "Es gibt keine weiteren Einladungen"                                                                                                      
-      invitation_removed: "Deine Einladung wurde gelöscht."                                                                                                               
-      new:                                                                                                                                                                
-        header: "Einladung schicken"                                                                                                                                      
-        submit_button: "Einladung schicken"                                                                                                                               
-      edit:                                                                                                                                                               
-        header: "Setze ein Passwort"                                                                                                                                      
-        submit_button: "Passwort setzen"                                                                                                                                  
-    mailer:                                                                                                                                                               
-      invitation_instructions:                                                                                                                                            
-        subject: "Einladung"                                                                                                                                              
-        hello: "Hallo %{email}"                                                                                                                                           
-        someone_invited_you: "Jemand hat dich zu %{url} eingeladen. Du kannst die Einladung mit dem Link unten annehmen."                                                 
-        accept: "Einladung annehmen"                                                                                                                                      
-        accept_until: "Diese Einladung ist gültig bis zum %{due_date}."                                                                                                   
-        ignore: "Wenn du die Einladung nicht annehmen willst, ignoriere diese E-Mail einfach.<br />\nEs wird kein Benutzerkonto erstellt solange du nicht die Einladung mi↪ttels des Links oben annimmst."                                                                                                                                          
-  time:                                                                                                                                                                   
-    formats:                                                                                                                                                              
-      devise:                                                                                                                                                             
-        mailer:                                                                                                                                                           
-          invitation_instructions:                                                                                                                                        
-            accept_until_format: "%d. %B %Y %H:%M"
+de:
+  devise:
+    failure:
+      invited: "Du hast bereits eine Einladung erhalten. Nimm die Einladung an um dein Nutzerkonto zu erstellen."
+    invitations:
+      send_instructions: "Eine Einladung wurde an %{email} verschickt."
+      invitation_token_invalid: "Der Einladungs-Code ist ungültig!"
+      updated: "Dein Passwort wurde gesetzt. Du bist nun angemeldet."
+      updated_not_active: "Dein Passwort wurde gesetzt."
+      no_invitations_remaining: "Es gibt keine weiteren Einladungen"
+      invitation_removed: "Deine Einladung wurde gelöscht."
+      new:
+        header: "Einladung schicken"
+        submit_button: "Einladung schicken"
+      edit:
+        header: "Setze ein Passwort"
+        submit_button: "Passwort setzen"
+    mailer:
+      invitation_instructions:
+        subject: "Einladung"
+        hello: "Hallo %{email}"
+        someone_invited_you: "Jemand hat dich zu %{url} eingeladen. Du kannst die Einladung mit dem Link unten annehmen."
+        accept: "Einladung annehmen"
+        accept_until: "Diese Einladung ist gültig bis zum %{due_date}."
+        ignore: "Wenn du die Einladung nicht annehmen willst, ignoriere diese E-Mail einfach. Es wird kein Benutzerkonto erstellt solange du nicht die Einladung mittels des Links oben annimmst."
+  time:
+    formats:
+      devise:
+        mailer:
+          invitation_instructions:
+            accept_until_format: "%d. %B %Y %H:%M"

data/config/locales/es.yml

@@ -17,7 +17,7 @@ es:
         submit_button: "Guardar mi contraseña"
     mailer:
       invitation_instructions:
-        subject: "Instruciones de la invitación"
+        subject: "Instrucciones de la invitación"
         hello: "Hola %{email}"
         someone_invited_you: "Has sido invitado a %{url}, puedes aceptarlo siguiendo el siguiente enlace"
         accept: "Aceptar la invitación"

data/lib/devise_invitable/controllers/helpers.rb

@@ -12,6 +12,10 @@ module DeviseInvitable::Controllers::Helpers
     signed_in_root_path(resource)
   end
 
+  def invalid_token_path_for(resource_name)
+    after_sign_out_path_for(resource_name)
+  end
+
   protected
 
     def authenticate_inviter!

data/lib/devise_invitable/mapping.rb

@@ -3,8 +3,10 @@ module DeviseInvitable
     private
 
       def default_controllers(options)
-        options[:controllers] ||= {}
-        options[:controllers][:registrations] ||= 'devise_invitable/registrations'
+        unless options[:module]
+          options[:controllers] ||= {}
+          options[:controllers][:registrations] ||= 'devise_invitable/registrations'
+        end
         super
       end
   end

data/lib/devise_invitable/models.rb

@@ -158,7 +158,8 @@ module Devise
           self.downcase_keys if new_record_and_responds_to?(:downcase_keys)
           self.strip_whitespace if new_record_and_responds_to?(:strip_whitespace)
 
-          if save(validate: false)
+          validate = options.key?(:validate) ? options[:validate] : self.class.validate_on_invite
+          if save(validate: validate)
             self.invited_by.decrement_invitation_limit! if !was_invited and self.invited_by.present?
             deliver_invitation(options) unless skip_invitation
           end
@@ -324,7 +325,7 @@ module Devise
           end
 
           yield invitable if block_given?
-          mail = invitable.invite!(nil, options) if invitable.errors.empty?
+          mail = invitable.invite!(nil, options.merge(validate: false)) if invitable.errors.empty?
           [invitable, mail]
         end
 

data/lib/devise_invitable/version.rb

@@ -1,3 +1,3 @@
 module DeviseInvitable
-  VERSION = '2.0.5'.freeze
+  VERSION = '2.0.7'.freeze
 end

data/lib/generators/devise_invitable/devise_invitable_generator.rb

@@ -7,7 +7,7 @@ module DeviseInvitable
 
       def inject_devise_invitable_content
         path = File.join('app', 'models', "#{file_path}.rb")
-        inject_into_file(path, 'invitable, :', after: 'devise :') if File.exists?(path)
+        inject_into_file(path, 'invitable, :', after: 'devise :') if File.exist?(path)
       end
 
       hook_for :orm

data/test/functional/controller_helpers_test.rb

@@ -41,4 +41,14 @@ class ControllerHelpersTest < ActionController::TestCase
     assert Devise::InvitationsController.method_defined? :after_accept_path_for
     assert !Devise::InvitationsController.instance_methods(false).include?(:after_accept_path_for)
   end
+
+  test 'invalid token path defaults to after sign out path' do
+    assert_equal @controller.send(:after_sign_out_path_for, :user), @controller.invalid_token_path_for(:user)
+  end
+
+  test 'invalid token path is customizable from application controller' do
+    custom_path = 'customized/invalid/token/path'
+    @controller.instance_eval "def invalid_token_path_for(resource_name) '#{custom_path}' end"
+    assert_equal @controller.invalid_token_path_for(:user), custom_path
+  end
 end

data/test/mailers/invitation_mail_test.rb

@@ -102,7 +102,7 @@ class InvitationMailTest < ActionMailer::TestCase
       def initialize(*args); end
       def deliver; end
     end
-    Devise.mailer = CustomMailer
+    Devise.mailer = 'InvitationMailTest::CustomMailer'
 
     User.invite!({ email: 'valid@email.com' }, nil, { invited_at: Time.now })
   end

data/test/model_tests_helper.rb

@@ -1,6 +1,6 @@
 class ActiveSupport::TestCase
   def setup_mailer
-    Devise.mailer = Devise::Mailer
+    Devise.mailer = 'Devise::Mailer'
     ActionMailer::Base.deliveries = []
   end
 

data/test/models/invitable_test.rb

@@ -89,12 +89,12 @@ class InvitableTest < ActiveSupport::TestCase
     user.invite!
     old_invitation_created_at = 3.days.ago
     old_invitation_sent_at = 3.days.ago
-    user.update_attributes(invitation_sent_at: old_invitation_sent_at, invitation_created_at: old_invitation_created_at)
+    user.update(invitation_sent_at: old_invitation_sent_at, invitation_created_at: old_invitation_created_at)
     3.times do
       user.invite!
       refute_equal old_invitation_sent_at, user.invitation_sent_at
       refute_equal old_invitation_created_at, user.invitation_created_at
-      user.update_attributes(invitation_sent_at: old_invitation_sent_at, invitation_created_at: old_invitation_created_at)
+      user.update(invitation_sent_at: old_invitation_sent_at, invitation_created_at: old_invitation_created_at)
     end
   end
 

data/test/orm/active_record.rb

@@ -1,7 +1,12 @@
 ActiveRecord::Migration.verbose = false
 ActiveRecord::Base.logger = Logger.new(nil)
 
-if defined? ActiveRecord::MigrationContext # rails >= 5.2
+if ActiveRecord::VERSION::MAJOR >= 6
+  ActiveRecord::MigrationContext.new(
+        File.expand_path('../../rails_app/db/migrate/', __FILE__),
+        ActiveRecord::Base.connection.schema_migration
+      ).migrate
+elsif defined? ActiveRecord::MigrationContext # rails >= 5.2
   ActiveRecord::MigrationContext.new(File.expand_path('../../rails_app/db/migrate/', __FILE__)).migrate
 else
   ActiveRecord::Migrator.migrate(File.expand_path('../../rails_app/db/migrate/', __FILE__))

data/test/test_helper.rb

@@ -7,7 +7,7 @@ require "rails_app/config/environment"
 require 'rails/test_help'
 require "orm/#{DEVISE_ORM}"
 require 'capybara/rails'
-require 'mocha/setup'
+require 'mocha/minitest'
 
 ActionMailer::Base.delivery_method = :test
 ActionMailer::Base.perform_deliveries = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_invitable
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.7
 platform: ruby
 authors:
 - Sergio Cambra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-19 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -70,6 +70,7 @@ files:
 - app/views/devise/mailer/invitation_instructions.html.erb
 - app/views/devise/mailer/invitation_instructions.text.erb
 - config/locales/ar.yml
+- config/locales/ca.yml
 - config/locales/da.yml
 - config/locales/de.yml
 - config/locales/en.yml
@@ -186,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: An invitation strategy for Devise