devise_invitable 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96e5afbd2a5df8b9d94f1b1cbe30a2544f6c759b9c5c4ccb4f1de2a37a8f6e3a
-  data.tar.gz: ccef0234148611c07c9eae801b104da63066fd856ea3d1bd592180936e1a3042
+  metadata.gz: 54bcb44af270be6f5192f01771df589f95045ee16206315e7784c16c49d93df5
+  data.tar.gz: 74fea42d1bae1ec385ca62291817679a59c3430fc6f4e609c966ee08db17c2d3
 SHA512:
-  metadata.gz: e81ee3d1513dded1dbaaf4685bea5fe71c6d4f08bc57bec248407488ce9f0122498a3dac8c9e80a0db7cf8812bc36c88b570d4688cad52360076d439e172a8ae
-  data.tar.gz: db4f74177f9f44b361f689a3ebb58e49e42827e07ee39f98dfb9c907a0d1e4e2704381d24e101d41014fc8a1125eb9dbdd01131e694b572580669bb7c8ae2b9d
+  metadata.gz: dd0dbba52b99e4117a02072d3f48fbb3623614697a5e972a4f99081351479c9a2846696752a112ffd63d9528631ef196763146af5cc2792996246bcdaa755a97
+  data.tar.gz: 406bdf51f7114cc26354cf682658a3f44cb192db2f94cb45d0c7fd72384774d1464678275aac671a973b1660031084c21b4a290279e8e52a9ea69109a8186068

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Unreleased
 
+## 3.0.2
+
+- Add `DeviseInvitable::Invitation#deliver` to send a skipped pending
+  invitation later, including resource-less invitations
+- Start the `invite_for` validity period when an invitation is sent instead of
+  when it is created, so approval delays do not shorten the acceptance window
+- Leave an invitation unsent when delivery fails so it can be retried
+
 ## 3.0.1
 
 - Raise `DeviseInvitable::AmbiguousInviteKeyError` instead of selecting an

data/README.md

@@ -470,16 +470,32 @@ user and will be decrypted when received.
 accept_user_invitation_url(invitation_token: user.raw_invitation_token)
 ```
 
-When `skip_invitation` is used, you must also then set the
-`invitation_sent_at` 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 the column, or call `deliver_invitation` to send the
-invitation and set the column:
+When `skip_invitation` is used, the resulting invitation remains pending with
+an unset `invitation_sent_at`. Deliver it later by calling `deliver` on the
+invitation:
 
 ```ruby
-user.deliver_invitation
+invitation = user.current_invitation
+invitation.deliver
 ```
 
+This works for both placeholder-backed and resource-less invitations. For a
+resource-less invitation, `deliver` reconstructs the resource from the stored
+invite key. It generates a fresh token, sends the email, and sets
+`invitation_sent_at`. Calling it again after successful delivery does nothing.
+
+For example, an approval workflow can find unsent pending invitations and
+deliver an approved one after applying its own authorization policy:
+
+```ruby
+invitations = DeviseInvitable::Invitation.pending.where(invitation_sent_at: nil)
+invitation = invitations.find(approved_invitation_id)
+invitation.deliver
+```
+
+Invitation validity starts at `invitation_sent_at`, so time spent awaiting
+approval does not reduce the configured `invite_for` period.
+
 You can add `:skip_invitation` to attributes hash if `skip_invitation` is
 added to `attr_accessible`.
 
@@ -495,12 +511,6 @@ User.invite!(email: 'new_user@example.com', skip_invitation: true)
 To check if a particular user is created by invitation, irrespective to state
 of invitation one can use `created_by_invite?`
 
-**Warning**
-
-When using `skip_invitation` you must send the email with the user object
-instance that generated the tokens, as `user.raw_invitation_token` is
-available only to the instance and is not persisted in the database.
-
 You can also set `invited_by` when using the `invite!` class method:
 
 ```ruby

data/lib/devise_invitable/invitation.rb

@@ -67,7 +67,18 @@ module DeviseInvitable
     end
 
     def invitation_period_valid?(period)
-      period.to_i.zero? || (invitation_created_at && invitation_created_at.utc >= period.ago)
+      invitation_sent_at &&
+        (period.to_i.zero? || invitation_sent_at.utc >= period.ago)
+    end
+
+    # Deliver a pending invitation that has not been sent yet. Resource-less
+    # invitations are reconstructed from their stored invite key.
+    def deliver(options = {})
+      return unless pending? && invitation_sent_at.nil?
+
+      resource = invitable || invitable_type.constantize.new(invite_key)
+      resource.instance_variable_set(:@current_invitation, self)
+      resource.deliver_invitation(options)
     end
 
     def invite_key

data/lib/devise_invitable/models.rb

@@ -267,7 +267,6 @@ module Devise
         run_callbacks :invitation_created do
           now = Time.now.utc
           invitation.invitation_created_at = now
-          invitation.invitation_sent_at = now unless skip_invitation
 
           validate = options.key?(:validate) ? options[:validate] : self.class.validate_on_invite
           save_invitation = !self.class.create_resource_on_invitation || save(validate: validate)
@@ -332,10 +331,15 @@ module Devise
       # Deliver the invitation email
       def deliver_invitation(options = {})
         generate_invitation_token! unless @raw_invitation_token
+        marked_as_sent = false
         unless current_invitation.invitation_sent_at
           current_invitation.update_attribute :invitation_sent_at, Time.now.utc
+          marked_as_sent = true
         end
         send_devise_notification(:invitation_instructions, @raw_invitation_token, options)
+      rescue
+        current_invitation.update_attribute(:invitation_sent_at, nil) if marked_as_sent
+        raise
       end
 
       # provide alias to the encrypted invitation_token stored by devise
@@ -350,7 +354,7 @@ module Devise
       def invitation_due_at
         return nil if (self.class.invite_for == 0 || self.class.invite_for.nil?)
 
-        return unless (time = self.invitation_created_at || self.invitation_sent_at)
+        return unless (time = self.invitation_sent_at)
 
         time + self.class.invite_for
       end

data/lib/devise_invitable/version.rb

@@ -1,3 +1,3 @@
 module DeviseInvitable
-  VERSION = '3.0.1'.freeze
+  VERSION = '3.0.2'.freeze
 end

data/test/models/invitable_test.rb

@@ -113,27 +113,31 @@ class InvitableTest < ActiveSupport::TestCase
     user = User.invite!(email: 'valid@email.com')
 
     User.stubs(:invite_for).returns(nil)
-    user.invitation_created_at = Time.now.utc
+    user.invitation_sent_at = Time.now.utc
     assert_predicate user, :valid_invitation?
 
     User.stubs(:invite_for).returns(nil)
-    user.invitation_created_at = 1.year.ago
+    user.invitation_sent_at = 1.year.ago
     assert_predicate user, :valid_invitation?
 
     User.stubs(:invite_for).returns(0)
-    user.invitation_created_at = Time.now.utc
+    user.invitation_sent_at = Time.now.utc
     assert_predicate user, :valid_invitation?
 
     User.stubs(:invite_for).returns(0)
-    user.invitation_created_at = 1.day.ago
+    user.invitation_sent_at = 1.day.ago
     assert_predicate user, :valid_invitation?
 
     User.stubs(:invite_for).returns(1.day)
-    user.invitation_created_at = Time.now.utc
+    user.invitation_sent_at = Time.now.utc
     assert_predicate user, :valid_invitation?
 
     User.stubs(:invite_for).returns(1.day)
-    user.invitation_created_at = 2.days.ago
+    user.invitation_sent_at = 2.days.ago
+    refute_predicate user, :valid_invitation?
+
+    User.stubs(:invite_for).returns(0)
+    user.invitation_sent_at = nil
     refute_predicate user, :valid_invitation?
   end
 
@@ -141,8 +145,7 @@ class InvitableTest < ActiveSupport::TestCase
     User.stubs(:invite_for).returns(1.day)
 
     user = User.invite!(email: 'valid@email.com')
-    sent_at = user.invitation_created_at || user.invitation_sent_at
-    valid_until = sent_at + User.invite_for
+    valid_until = user.invitation_sent_at + User.invite_for
 
     assert_equal user.invitation_due_at, valid_until
   end
@@ -294,7 +297,7 @@ class InvitableTest < ActiveSupport::TestCase
     User.stubs(:invite_for).returns(1.day)
     user = User.invite!(email: 'valid@email.com')
     assert user.invited_to_sign_up?
-    user.invitation_created_at = Time.now.utc - 2.days
+    user.invitation_sent_at = Time.now.utc - 2.days
     token, user.reset_password_token = Devise.token_generator.generate(User, :reset_password_token)
     user.reset_password_sent_at = Time.now.utc
     user.save
@@ -539,7 +542,7 @@ class InvitableTest < ActiveSupport::TestCase
   test 'should return record with errors if invitation_token has expired' do
     User.stubs(:invite_for).returns(10.hours)
     invited_user = User.invite!(email: 'valid@email.com')
-    invited_user.invitation_created_at = 2.days.ago
+    invited_user.invitation_sent_at = 2.days.ago
     invited_user.save(validate: false)
     user = User.accept_invitation!(invitation_token: Thread.current[:token])
     assert_equal user, invited_user

data/test/models/separate_invitations_test.rb

@@ -26,6 +26,38 @@ class SeparateInvitationsTest < ActiveSupport::TestCase
     assert_includes User.no_active_invitation, registered
   end
 
+  test 'an unsent resource-less invitation can be delivered later' do
+    User.create_resource_on_invitation = false
+    User.stubs(:invite_for).returns(1.day)
+
+    invited = User.invite!(email: 'deferred@example.com', skip_invitation: true)
+    invitation = invited.current_invitation
+    invitation.update!(invitation_created_at: 2.days.ago)
+
+    assert_nil invitation.invitation_sent_at
+    assert_difference('ActionMailer::Base.deliveries.size', 1) do
+      invitation.reload.deliver
+    end
+
+    assert_predicate invitation.reload, :invitation_sent_at
+    assert invitation.invitation_period_valid?(1.day)
+    assert_equal ['deferred@example.com'], ActionMailer::Base.deliveries.last.to
+
+    assert_no_difference('ActionMailer::Base.deliveries.size') do
+      invitation.deliver
+    end
+  end
+
+  test 'a failed later delivery remains unsent and can be retried' do
+    User.create_resource_on_invitation = false
+    invited = User.invite!(email: 'retry@example.com', skip_invitation: true)
+    invitation = invited.current_invitation.reload
+    User.any_instance.stubs(:send_devise_notification).raises('delivery failed')
+
+    assert_raises(RuntimeError) { invitation.deliver }
+    assert_nil invitation.reload.invitation_sent_at
+  end
+
   test 'accepting one of multiple invitations creates the resource and supersedes the others' do
     User.create_resource_on_invitation = false
     first_inviter = User.create!(email: 'first@example.com', password: '123456789')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise_invitable
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Sergio Cambra