devise_invitable 2.0.0 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2723ccf2ae328662f6728a699ac484ff5067dbb24248e59d7d596a9d445747ab
-  data.tar.gz: 7d95b8d919685e863dbe8126ce5823b78f949c67f6ada3e69adab431d29e7711
+  metadata.gz: 0517f954240bfc3c1fd255df0d502d5fdbd461d4e695cd0c5ec725854af50dcf
+  data.tar.gz: 239b887a32e66dbc38fbf1e04625def2f1dea325fcc6d20af0e1befd066dd000
 SHA512:
-  metadata.gz: ba422fbe6c9b3d7d13dae30f24daf9638ace499ceead90f7d3d18949655028b33d53c5275000aafecd4a9b75595ad174d3348a4511a7dbe70957bd9a43cd5945
-  data.tar.gz: b8eb68401a1fd5e41b861fbe8d8dd38b4f9050d87427d00cb5ea394630e5e5f5a16d6889da85199e597d8bdc2947aa8523208aca95fb731d39c50ba9f5d4a4d5
+  metadata.gz: 957006ebe6e94715459f941b52004a1002e72005e9344baca46679398bc34e360604e3a8a205d9099a4ff5015be597c1c02a89055137db6c12f10ecf03949db7
+  data.tar.gz: 17200aa6cf76d5abf07de1e4c0987f197140087a7a3210df0bf948a6098602eeeab05d65983cc69ef2185f2de741813ebc778a28d476a86bc5b1527bbd918f4c

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 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))
+
+## 2.0.2
+- Fix ruby 2.7 deprecation warning
+
+## 2.0.1
+- Use per-model allow_insecure_sign_in_after_accept ([#790](https://github.com/scambra/devise_invitable/pull/790))
+
 ## 2.0.0
 - Remove deprecated devise_error_messages! from templates ([#786](https://github.com/scambra/devise_invitable/pull/785))
 - Drop Devise < 4.6 support ([#786](https://github.com/scambra/devise_invitable/pull/786))

data/README.rdoc

@@ -1,5 +1,5 @@
 = 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.png"/>}[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://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]
 
 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.
 
@@ -70,11 +70,6 @@ or for a model that already exists, define a migration to add DeviseInvitable to
       add_column :users, :invited_by_id, :integer
       add_column :users, :invited_by_type, :string
       add_index :users, :invitation_token, unique: true
-
-      # Allow null encrypted_password
-      change_column_null :users, :encrypted_password, :string, true
-      # Allow null password_salt (add it if you are using Devise's encryptable module)
-      change_column_null :users, :password_salt, :string, true
   end
 
 If you previously used devise_invitable with a <tt>:limit</tt> on <tt>:invitation_token</tt>, remove it:
@@ -109,13 +104,13 @@ Remember to create indexes within the MongoDB database after deploying your chan
 
 DeviseInvitable adds some new configuration options:
 
-* <tt>invite_for</tt>: The period the generated invitation token is valid, after this period, the invited resource won't be able to accept the invitation. When <tt>invite_for</tt> is <tt>0</tt> (the default), the invitation won't expire.
+* <tt>invite_for</tt>: The period the generated invitation token is valid. After this period, the invited resource won't be able to accept the invitation. When <tt>invite_for</tt> is <tt>0</tt> (the default), the invitation won't expire.
 
 You can set this configuration option in the Devise initializer as follow:
 
   # ==> Configuration for :invitable
-  # The period the generated invitation token is valid, after
-  # this period, the invited resource won't be able to accept the invitation.
+  # The period the generated invitation token is valid.
+  # After this period, the invited resource won't be able to accept the invitation.
   # When invite_for is 0 (the default), the invitation won't expire.
   # config.invite_for = 2.weeks
 
@@ -186,23 +181,21 @@ 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
-    def invite_resource
-      ## skip sending emails on invite
-      super do |u|
-        u.skip_invitation = true
+      # 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
-    end
 
-    # this is called when accepting invitation
-    # should return an instance of resource class
-    def accept_resource
-      resource = resource_class.accept_invitation!(update_resource_params)
-      ## Report accepting invitation to analytics
-      Analytics.report('invite.accept', resource.id)
-      resource
-    end
+      # 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
+        Analytics.report('invite.accept', resource.id)
+        resource
+      end
   end
 
 == Strong Parameters
@@ -241,13 +234,13 @@ If you want to create the invitation but not send it, you can set <tt>skip_invit
   end
   # => the record will be created, but the invitation email will not be sent
 
-When generating the <tt>accept_user_invitation_url</tt> yourself, you must use the <tt>raw_invitation_token</tt>
-the value is temporarily available when you invite a user and will be decrypted when recieved.
+When generating the <tt>accept_user_invitation_url</tt> yourself, you must use the <tt>raw_invitation_token</tt>. 
+This value is temporarily available when you invite a user and will be decrypted when received.
 
   accept_user_invitation_url(invitation_token: user.raw_invitation_token)
 
 When <tt>skip_invitation</tt> is used, you must also then set the <tt>invitation_sent_at</tt> field when the user is sent their token. Failure to do so will yield "Invalid invitation token" error when the user attempts to accept the invite.
-You can set column, or call <tt>deliver_invitation</tt> to sent invitation and set column:
+You can set the column, or call <tt>deliver_invitation</tt> to send the invitation and set the column:
 
   user.deliver_invitation
 
@@ -315,7 +308,7 @@ A pair of scopes to find those users that have accepted, and those that have not
 
 == Integration in a Rails application
 
-Since the invitations controller take care of all the creation/acceptation of an invitation, in most cases you wouldn't call the <tt>invite!</tt> and <tt>accept_invitation!</tt> methods directly.
+Since the invitations controller takes care of all the creation/acceptation of an invitation, in most cases you wouldn't call the <tt>invite!</tt> and <tt>accept_invitation!</tt> methods directly.
 Instead, in your views, put a link to <tt>new_user_invitation_path</tt> or <tt>new_invitation_path(:user)</tt> or even <tt>/users/invitation/new</tt> to prepare and send an invitation (to a user in this example).
 
 After an invitation is created and sent, the inviter will be redirected to <tt>after_invite_path_for(inviter, invitee)</tt>, which is the same path as <tt>signed_in_root_path</tt> by default.
@@ -324,7 +317,7 @@ After an invitation is accepted, the invitee will be redirected to <tt>after_acc
 
 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 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 who.
+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.
 
 == Controller filter
 
@@ -335,10 +328,11 @@ Default behavior requires authentication of the same resource as the invited one
 You would have a <tt>User</tt> model which is configured as invitable and an <tt>Admin</tt> model which is not. If you want to allow only admins to send invitations, simply overwrite the <tt>authenticate_inviter!</tt> method as follow:
 
   class ApplicationController < ActionController::Base
-  protected
-    def authenticate_inviter!
-      authenticate_admin!(force: true)
-    end
+    protected
+
+      def authenticate_inviter!
+        authenticate_admin!(force: true)
+      end
   end
 
 And include <tt>DeviseInvitable::Inviter</tt> module into <tt>Admin</tt> model:

data/app/controllers/devise/invitations_controller.rb

@@ -51,9 +51,10 @@ class Devise::InvitationsController < DeviseController
     yield resource if block_given?
 
     if invitation_accepted
-      if Devise.allow_insecure_sign_in_after_accept
+      if resource.class.allow_insecure_sign_in_after_accept
         flash_message = resource.active_for_authentication? ? :updated : :updated_not_active
         set_flash_message :notice, flash_message if is_flashing_format?
+        resource.after_database_authentication
         sign_in(resource_name, resource)
         respond_with resource, location: after_accept_path_for(resource)
       else
@@ -75,42 +76,42 @@ class Devise::InvitationsController < DeviseController
 
   protected
 
-  def invite_resource(&block)
-    resource_class.invite!(invite_params, current_inviter, &block)
-  end
+    def invite_resource(&block)
+      resource_class.invite!(invite_params, current_inviter, &block)
+    end
 
-  def accept_resource
-    resource_class.accept_invitation!(update_resource_params)
-  end
+    def accept_resource
+      resource_class.accept_invitation!(update_resource_params)
+    end
 
-  def current_inviter
-    authenticate_inviter!
-  end
+    def current_inviter
+      authenticate_inviter!
+    end
 
-  def has_invitations_left?
-    unless current_inviter.nil? || current_inviter.has_invitations_left?
-      self.resource = resource_class.new
-      set_flash_message :alert, :no_invitations_remaining if is_flashing_format?
-      respond_with_navigational(resource) { render :new }
+    def has_invitations_left?
+      unless current_inviter.nil? || current_inviter.has_invitations_left?
+        self.resource = resource_class.new
+        set_flash_message :alert, :no_invitations_remaining if is_flashing_format?
+        respond_with_navigational(resource) { render :new }
+      end
     end
-  end
 
-  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)
+    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)
+      end
     end
-  end
 
-  def invite_params
-    devise_parameter_sanitizer.sanitize(:invite)
-  end
+    def invite_params
+      devise_parameter_sanitizer.sanitize(:invite)
+    end
 
-  def update_resource_params
-    devise_parameter_sanitizer.sanitize(:accept_invitation)
-  end
+    def update_resource_params
+      devise_parameter_sanitizer.sanitize(:accept_invitation)
+    end
 
-  def translation_scope
-    'devise.invitations'
-  end
+    def translation_scope
+      'devise.invitations'
+    end
 end

data/app/controllers/devise_invitable/registrations_controller.rb

@@ -1,17 +1,17 @@
 class DeviseInvitable::RegistrationsController < Devise::RegistrationsController
   protected
 
-  def build_resource(hash = {})
-    if hash[:email]
-      self.resource = resource_class.where(email: hash[:email]).first
-      if self.resource && self.resource.respond_to?(:invited_to_sign_up?) && self.resource.invited_to_sign_up?
-        self.resource.attributes = hash
-        self.resource.send_confirmation_instructions if self.resource.confirmation_required_for_invited?
-        self.resource.accept_invitation
-      else
-        self.resource = nil
+    def build_resource(hash = {})
+      if hash[:email]
+        self.resource = resource_class.where(email: hash[:email]).first
+        if self.resource && self.resource.respond_to?(:invited_to_sign_up?) && self.resource.invited_to_sign_up?
+          self.resource.attributes = hash
+          self.resource.send_confirmation_instructions if self.resource.confirmation_required_for_invited?
+          self.resource.accept_invitation
+        else
+          self.resource = nil
+        end
       end
+      self.resource ||= super
     end
-    self.resource ||= super
-  end
 end

data/app/views/devise/invitations/edit.html.erb

@@ -7,7 +7,7 @@
   <% if f.object.class.require_password_on_accepting %>
     <div class="field">
       <%= f.label :password %><br />
-      <%= f.password_field :password %></p>
+      <%= f.password_field :password %>
     </div>
 
     <div class="field">

data/app/views/devise/mailer/invitation_instructions.html.erb

@@ -2,7 +2,7 @@
 
 <p><%= t("devise.mailer.invitation_instructions.someone_invited_you", url: root_url) %></p>
 
-<p><%= link_to t("devise.mailer.invitation_instructions.accept"), accept_invitation_url(@resource, :invitation_token => @token) %></p>
+<p><%= link_to t("devise.mailer.invitation_instructions.accept"), accept_invitation_url(@resource, invitation_token: @token) %></p>
 
 <% if @resource.invitation_due_at %>
   <p><%= t("devise.mailer.invitation_instructions.accept_until", due_date: l(@resource.invitation_due_at, format: :'devise.mailer.invitation_instructions.accept_until_format')) %></p>

data/app/views/devise/mailer/invitation_instructions.text.erb

@@ -2,7 +2,7 @@
 
 <%= t("devise.mailer.invitation_instructions.someone_invited_you", url: root_url) %>
 
-<%= accept_invitation_url(@resource, :invitation_token => @token) %>
+<%= accept_invitation_url(@resource, invitation_token: @token) %>
 
 <% if @resource.invitation_due_at %>
   <%= t("devise.mailer.invitation_instructions.accept_until", due_date: l(@resource.invitation_due_at, format: :'devise.mailer.invitation_instructions.accept_until_format')) %>

data/config/locales/ar.yml

@@ -0,0 +1,23 @@
+ar:
+  devise:
+    failure:
+      invited: 'لديك دعوة معلّقة، يجب عليك قبولها للإنتهاء من إنشاء حسابك.'
+    invitations:
+      send_instructions: 'تم إرسال الدعوة إلى البريد الإلكتروني %{email}.'
+      invitation_token_invalid: 'كود الدعوة غير صحيح'
+      updated: 'تم تحديد كلمة المرور الخاص بك، انت الآن مسجل دخول.'
+      no_invitations_remaining: "لم يبق لديك دعوات"
+      invitation_removed: 'تم حذف دعوتك.'
+      new:
+        header: "ارسال الدعوة"
+        submit_button: "ارسل الدعوة"
+      edit:
+        header: "تحديد كلمة المرور"
+        submit_button: "حدد كلمة المرور"
+    mailer:
+      invitation_instructions:
+        subject: 'تعليمات الدعوة'
+        hello: 'مرحبا %{email}'
+        someone_invited_you: 'تم إرسال دعوة لك إلى %{url}, يمكنك الموافقة من خلال الرابط في الأسفل'
+        accept: 'قبول الدعوة'
+        ignore: "إذا كنت لا تريد قبول الدعوة، الرجاء تجاهل هذا البريد.<br />لن يتم إنشاء حساب خاص بك إلا إذا دخلت على الرابط أعلاه وحددت كلمة مرور خاص بك."

data/config/locales/da.yml

@@ -0,0 +1,41 @@
+da:
+  activerecord:
+    attributes:
+      user:
+        invitation_token: Invitationsnøgle
+        invitation_created_at: Invitation oprettet
+        invitation_sent_at: Invitation sendt
+        invitation_accepted_at: Invitation accepteret
+        invitation_limit: Invitationsbegrænsning
+        invited_by: Inviteret af
+        invitations_count: Antal invitationer
+  devise:
+    failure:
+      invited: "Du har allerede en ventende invitation, som du bedes acceptere for at oprette en konto."
+    invitations:
+      send_instructions: "Der er sendt en invitationsmail til %{email}."
+      invitation_token_invalid: "Den angivne invitationsnøgle er ikke gyldig."
+      updated: "Din adgangskode er gemt, og du er nu logget ind."
+      updated_not_active: "Din adgangskode er gemt, og du kan nu logge ind på din konto."
+      no_invitations_remaining: "Ikke flere invitationer tilbage"
+      invitation_removed: "Din invitation er blevet fjernet."
+      new:
+        header: "Send en invitation"
+        submit_button: "Send mail"
+      edit:
+        header: "Vælg din adgangskode"
+        submit_button: "Gem adgangskode"
+    mailer:
+      invitation_instructions:
+        subject: "Invitation til at oprette en konto"
+        hello: "Hej %{email}"
+        someone_invited_you: "Du er blevet inviteret til at oprette en konto på %{url}, og du kan gøre det via linket herunder."
+        accept: "Accepter invitation"
+        accept_until: "Invitation gælder indtil %{due_date}."
+        ignore: "Hvis du ikke vil tage imod invitationen om at oprette en konto, kan du blot ignorere denne mail.<br />\nDer vil ikke blive oprettet nogen konto, medmindre du følger linket herover og derefter opretter en adgangskode."
+  time:
+    formats:
+      devise:
+        mailer:
+          invitation_instructions:
+            accept_until_format: "%e. %B %Y kl. %H.%M"

data/config/locales/de.yml

@@ -0,0 +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"

data/config/locales/es.yml

@@ -0,0 +1,31 @@
+es:
+  devise:
+    failure:
+      invited: "Tienes una invitación pendiente, acéptala para acabar de crear tu cuenta."
+    invitations:
+      send_instructions: "Se ha enviado una invitación a %{email}."
+      invitation_token_invalid: "¡La invitación no es válida!"
+      updated: "Se ha configurado su contraseña y ha ingresado al sistema"
+      updated_not_active: "Su contraseña se ha configurado correctamente."
+      no_invitations_remaining: "No quedan invitaciones"
+      invitation_removed: "Se ha retirado su invitación"
+      new:
+        header: "Enviar Invitación"
+        submit_button: "Envía una invitación"
+      edit:
+        header: "Establecer contraseña"
+        submit_button: "Guardar mi contraseña"
+    mailer:
+      invitation_instructions:
+        subject: "Instruciones 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"
+        accept_until: "Esta invitación expirará en %{due_date}."
+        ignore: "Si no le interesa esta invitación, simplemente ignore este correo. No se creará tu cuenta hasta que accedas al enlace anterior y crees una contraseña."
+  time:
+    formats:
+      devise:
+        mailer:
+          invitation_instructions:
+            accept_until_format: "%d de %B de %Y, %H:%M"

data/config/locales/et.yml

@@ -0,0 +1,23 @@
+et:
+  devise:
+    failure:
+      invited: 'Sul on kutse ootel - aktsepteeri, et konto loomine lõpule viia.'
+    invitations:
+      send_instructions: 'Kutse on saadetud emailile %{email}.'
+      invitation_token_invalid: 'Antud kutse ei ole kehtiv!'
+      updated: 'Sinu salasõna on edukalt sätitud. Oled nüüd sisse logitud.'
+      no_invitations_remaining: "Kutseid pole rohkem järgi."
+      invitation_removed: 'Sinu kutse eemaldati.'
+      new:
+        header: "Kutse saatmine"
+        submit_button: "Saada kutse"
+      edit:
+        header: "Salasõna sättimine"
+        submit_button: "Säti mu salasõna"
+    mailer:
+      invitation_instructions:
+        subject: 'Kutse juhised'
+        hello: 'Tere, %{email}'
+        someone_invited_you: 'Keegi kutsus Sind aadressile %{url}. Kutse saad vastu võtta allolevalt lingilt.'
+        accept: 'Võta kutse vastu'
+        ignore: "Kui Sa ei soovi kutset vastu võtta, siis lihtsalt ignoreeri seda emaili.<br />Sinu kontot ei looda enne, kui oled ülalolevat linki külastanud ja oma salasõna määranud."