devise_invitable 2.0.3 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 853e0a1f85a22c77e6caa07a56e90cde6f0b54ad39651a756f73d213f2d8a085
-  data.tar.gz: a824c95001fb09a4b9c2b11809c46bf7a4cc1ca667166889a1d8d0f8a3f842d0
+  metadata.gz: 3803fa69fe6bdecc811ab934878cc365f31ae0a124e54bbde34ad967752f1d3c
+  data.tar.gz: df5c2b785956d22e8bf69d644326605a649f1fd76b1d19af04d4bcd48a3c15f6
 SHA512:
-  metadata.gz: 48e4376634d9c32e9703a635b9676c7aa6859ad5c9abaa7a301538d7b918871340304c0897fbf8b7c950398065a7254c88ecbc951f747bc4e3edb91a59a0baaf
-  data.tar.gz: b5a98b61c21f14585205679a0577194df7c542214552970e9fa9eb0b6c81f93f35a7fd4fbf443904e1d25f4c817dd32dfca69f160b93d71c26bcc67e992c1f4a
+  metadata.gz: 925df2c1ef1a893f9e4d9b376b298fa5e21a4c516d8829d7990aa5e5b4a18a7d288d209658f38a1793c51b5a4fca83cbff814a19f2e725ddd8baa4307f448092
+  data.tar.gz: 4380da8ff7d5ff6e680393ab8f8935dae7b10e3d50271fdfaa839d0968caad99a56282ba6765b3d18f2f70090796c607c0198dc3932f3ac21f24821a8635a4e5

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 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))
+
+## 2.0.5
+- Fix NoMethodError in random_password when validatable is not used ([#850](https://github.com/scambra/devise_invitable/pull/850))
+
+## 2.0.4
+- Fix devise deprecations ([#842](https://github.com/scambra/devise_invitable/pull/842))
+- Update translations ([#844](https://github.com/scambra/devise_invitable/pull/844), [#845](https://github.com/scambra/devise_invitable/pull/845))
+- Fix/enforce initial password length to follow devise ([#848](https://github.com/scambra/devise_invitable/pull/848))
+
 ## 2.0.3
 - Add locales ([#834](https://github.com/scambra/devise_invitable/pull/834), [#835](https://github.com/scambra/devise_invitable/pull/835))
 - Remove index on invitations_count column ([#830](https://github.com/scambra/devise_invitable/pull/830))

data/README.rdoc

@@ -35,14 +35,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
@@ -181,15 +181,15 @@ To change behaviour of inviting or accepting users, you can simply override two
   class Users::InvitationsController < Devise::InvitationsController
     private
 
-      # this is called when creating invitation
-      # should return an instance of resource class
+      # This is called when creating invitation.
+      # It should return an instance of resource class.
       def invite_resource
         # skip sending emails on invite
         super { |user| user.skip_invitation = true }
       end
 
-      # this is called when accepting invitation
-      # should return an instance of resource class
+      # This is called when accepting invitation.
+      # It should return an instance of resource class.
       def accept_resource
         resource = resource_class.accept_invitation!(update_resource_params)
         # Report accepting invitation to analytics
@@ -217,6 +217,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
 

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
 

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

@@ -18,7 +18,7 @@ es:
     mailer:
       invitation_instructions:
         subject: "Instruciones de la invitación"
-        hello: "Estimada/o %{nombre}"
+        hello: "Hola %{email}"
         someone_invited_you: "Has sido invitado a %{url}, puedes aceptarlo siguiendo el siguiente enlace"
         accept: "Aceptar la invitación"
         accept_until: "Esta invitación expirará en %{due_date}."
@@ -28,4 +28,4 @@ es:
       devise:
         mailer:
           invitation_instructions:
-            accept_until_format: "%d de %B de %Y, %H:%M"
+            accept_until_format: "%d de %B de %Y, %H:%M"

data/config/locales/ja.yml

@@ -20,7 +20,6 @@ ja:
         subject: '招待を承認するには'
         hello: 'こんにちは、%{email}さん'
         someone_invited_you: '%{url}に招待されました。以下のリンクから承認できます。'
-        accept: 'Accept invitation'
         accept: '招待を承認する'
         accept_until: 'この招待は%{due_date}まで有効です。'
         ignore: '招待を承認しない場合は、このメールを無視してください。<br />あなたのアカウントは上記のリンク先にアクセスしパスワードを設定するまでは作成されません。'

data/lib/devise_invitable/models/authenticatable.rb

@@ -1,11 +1,17 @@
 module Devise
   module Models
     module Authenticatable
-      BLACKLIST_FOR_SERIALIZATION.concat %i[
+      list = %i[
         invitation_token invitation_created_at invitation_sent_at
         invitation_accepted_at invitation_limit invited_by_type
         invited_by_id invitations_count
       ]
+      
+      if defined?(UNSAFE_ATTRIBUTES_FOR_SERIALIZATION)
+        UNSAFE_ATTRIBUTES_FOR_SERIALIZATION.concat(list)
+      else
+        BLACKLIST_FOR_SERIALIZATION.concat(list)
+      end
     end
   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
 
@@ -397,7 +398,10 @@ module Devise
           # lower + upper case, a digit and a symbol.
           # For more unusual rules, this method can be overridden.
           def random_password
-            'aA1!' + Devise.friendly_token[0, 20]
+            length = respond_to?(:password_length) ? password_length : Devise.password_length
+
+            prefix = 'aA1!'
+            prefix + Devise.friendly_token(length.last - prefix.length)
           end
       end
     end

data/lib/devise_invitable/version.rb

@@ -1,3 +1,3 @@
 module DeviseInvitable
-  VERSION = '2.0.3'.freeze
+  VERSION = '2.0.6'.freeze
 end

data/test/models/invitable_test.rb

@@ -1,6 +1,10 @@
 require 'test_helper'
 require 'model_tests_helper'
 
+class Validatable < User
+  devise :validatable, password_length: 10..20
+end
+
 class InvitableTest < ActiveSupport::TestCase
 
   def setup
@@ -760,4 +764,16 @@ class InvitableTest < ActiveSupport::TestCase
     assert user.persisted?
     assert user.errors.empty?
   end
+
+  test 'should set initial password following Devise.password_length' do
+    user = User.invite!(email: 'valid@email.com')
+    assert_empty user.errors
+    assert_equal Devise.password_length.last, user.password.length
+  end
+
+  test 'should set initial passsword using :validatable with custom password_length' do
+    user = Validatable.invite!(email: 'valid@email.com')
+    assert_empty user.errors
+    assert_equal Validatable.password_length.last, user.password.length
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_invitable
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.6
 platform: ruby
 authors:
 - Sergio Cambra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -186,8 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.9
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: An invitation strategy for Devise