caffeinate 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9862310b9a457373cfff3e69645b2c07a01f87ba6cafb4a1818a129a757841e
-  data.tar.gz: 3b73b977f565f19dd681a56b585397fa4de24020e1ef320956eb993eec15bc52
+  metadata.gz: cac59a69d742f7948455f3f3b5787e33841664267eab72a2c6bc296735da5d1e
+  data.tar.gz: 826ca15444ba2242f99d8376d0f5a4aae9612846ee61ef53d1a4a53a879d0b54
 SHA512:
-  metadata.gz: c2aaad4b624a503bc5a0e290373ebe50167ec82446deba5ae693937f59dcd8d9ef88b0796fc5b1263351098c67af32fd9e6eca7067f803b284c9d4f10a17608b
-  data.tar.gz: 1b4f720e186533495905725aaf334087ea83eb5dd4d641ea670951b48cfa8b629188ec9872245958333484b88c5f7e1aed7fb8f37831d2b00822bcd83b4dffcb
+  metadata.gz: 2d1cc9c295d50c77c5db6c5f22d585372b513396d54a9a37b05f40af405f8f4e32b1e0d42045a9e5b0e0c40fe592466a4d835a67dd71ad62bab55d24b7586d15
+  data.tar.gz: 0ca6801b63b8e50f73654dbc6a7f5e9c5063fd825699bd6698e4af4f6846ef23358ed0955cc2d0ed8d19e705124d0f25094c0980331dd90dd31121ab06c07f3e

data/app/models/caffeinate/campaign_subscription.rb

@@ -17,9 +17,14 @@
 #  updated_at             :datetime         not null
 #
 module Caffeinate
+  # If a record tries to be `unsubscribed!` or `ended!` or `resubscribe!` and it's in a state that is not
+  # correct, raise this
+  class InvalidState < ::ActiveRecord::RecordInvalid; end
+
   # CampaignSubscription associates an object and its optional user to a Campaign
   # and its relevant Mailings.
   class CampaignSubscription < ApplicationRecord
+
     self.table_name = 'caffeinate_campaign_subscriptions'
 
     has_many :caffeinate_mailings, class_name: 'Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id, dependent: :destroy
@@ -66,23 +71,34 @@ module Caffeinate
 
     # Updates `ended_at` and runs `on_complete` callbacks
     def end!(reason = nil)
+      raise ::Caffeinate::InvalidState, "CampaignSubscription is already unsubscribed." if unsubscribed?
+
       update!(ended_at: ::Caffeinate.config.time_now, ended_reason: reason)
 
-      caffeinate_campaign.to_dripper.run_callbacks(:on_complete, self)
+      caffeinate_campaign.to_dripper.run_callbacks(:on_end, self)
+      true
     end
 
     # Updates `unsubscribed_at` and runs `on_subscribe` callbacks
     def unsubscribe!(reason = nil)
+      raise ::Caffeinate::InvalidState, "CampaignSubscription is already ended." if ended?
+
       update!(unsubscribed_at: ::Caffeinate.config.time_now, unsubscribe_reason: reason)
 
       caffeinate_campaign.to_dripper.run_callbacks(:on_unsubscribe, self)
+      true
     end
 
-    # Updates `unsubscribed_at` to nil and runs `on_subscribe` callbacks
-    def resubscribe!
+    # Updates `unsubscribed_at` to nil and runs `on_subscribe` callbacks.
+    # Use `force` to forcefully reset. Does not create the mailings.
+    def resubscribe!(force = false)
+      raise ::Caffeinate::InvalidState, "CampaignSubscription is already ended." if ended? && !force
+      raise ::Caffeinate::InvalidState, "CampaignSubscription is already unsubscribed." if unsubscribed? && !force
+
       update!(unsubscribed_at: nil, resubscribed_at: ::Caffeinate.config.time_now)
 
       caffeinate_campaign.to_dripper.run_callbacks(:on_resubscribe, self)
+      true
     end
 
     private
@@ -94,6 +110,7 @@ module Caffeinate
         mailing.save!
       end
       caffeinate_campaign.to_dripper.run_callbacks(:on_subscribe, self)
+      true
     end
 
     def set_token!

data/lib/caffeinate/action_mailer/observer.rb

@@ -11,6 +11,7 @@ module Caffeinate
 
         mailing.update!(sent_at: Caffeinate.config.time_now, skipped_at: nil) if message.perform_deliveries
         mailing.caffeinate_campaign.to_dripper.run_callbacks(:after_send, mailing, message)
+        true
       end
     end
   end

data/lib/caffeinate/dripper/callbacks.rb

@@ -40,18 +40,18 @@ module Caffeinate
 
         # Callback before the mailings get processed.
         #
-        #   before_process do |dripper|
+        #   before_perform do |dripper|
         #     Slack.notify(:caffeinate, "Dripper is getting ready for mailing! #{dripper.caffeinate_campaign.name}!")
         #   end
         #
         # @yield Caffeinate::Dripper
-        def before_process(&block)
-          before_process_blocks << block
+        def before_perform(&block)
+          before_perform_blocks << block
         end
 
         # :nodoc:
-        def before_process_blocks
-          @before_process_blocks ||= []
+        def before_perform_blocks
+          @before_perform_blocks ||= []
         end
 
         # Callback before the mailings get processed in a batch.
@@ -62,13 +62,13 @@ module Caffeinate
         #
         # @yield Caffeinate::Dripper
         # @yield Caffeinate::Mailing [Array]
-        def on_process(&block)
-          on_process_blocks << block
+        def on_perform(&block)
+          on_perform_blocks << block
         end
 
         # :nodoc:
-        def on_process_blocks
-          @on_process_blocks ||= []
+        def on_perform_blocks
+          @on_perform_blocks ||= []
         end
 
         # Callback after the all the mailings have been sent.
@@ -79,13 +79,13 @@ module Caffeinate
         #
         # @yield Caffeinate::Dripper
         # @yield Caffeinate::Mailing [Array]
-        def after_process(&block)
-          after_process_blocks << block
+        def after_perform(&block)
+          after_perform_blocks << block
         end
 
         # :nodoc:
-        def after_process_blocks
-          @after_process_blocks ||= []
+        def after_perform_blocks
+          @after_perform_blocks ||= []
         end
 
         # Callback before a Drip has called the mailer.
@@ -171,6 +171,23 @@ module Caffeinate
           @on_unsubscribe_blocks ||= []
         end
 
+
+        # Callback after a CampaignSubscriber has ended.
+        #
+        #   on_end do |campaign_sub|
+        #     Slack.notify(:caffeinate, "#{campaign_sub.id} has ended... sad day.")
+        #   end
+        #
+        # @yield Caffeinate::CampaignSubscription
+        def on_end(&block)
+          on_end_blocks << block
+        end
+
+        # :nodoc:
+        def on_end_blocks
+          @on_end_blocks ||= []
+        end
+
         # Callback after a `Caffeinate::Mailing` is skipped.
         #
         #   on_skip do |campaign_subscription, mailing, message|

data/lib/caffeinate/dripper/perform.rb

@@ -15,28 +15,20 @@ module Caffeinate
       #
       # @return nil
       def perform!
-        includes = [:next_caffeinate_mailing]
-        preloads = []
-        if ::Caffeinate.config.async_delivery?
-          # nothing
-        else
-          preloads += %i[subscriber user]
-        end
-
-        run_callbacks(:before_process, self)
-        campaign.caffeinate_campaign_subscriptions
-                .active
-                .joins(:next_caffeinate_mailing)
-                .preload(*preloads)
-                .includes(*includes)
-                .in_batches(of: self.class.batch_size)
-                .each do |batch|
-          run_callbacks(:on_process, self, batch)
-          batch.each do |subscriber|
-            subscriber.next_caffeinate_mailing.process!
+        run_callbacks(:before_perform, self)
+        Caffeinate::Mailing
+            .upcoming
+            .unsent
+            .joins(:caffeinate_campaign_subscription)
+            .merge(Caffeinate::CampaignSubscription.active)
+            .in_batches(of: self.class.batch_size)
+            .each do |batch|
+          run_callbacks(:on_perform, self, batch)
+          batch.each do |mailing|
+            mailing.process!
           end
         end
-        run_callbacks(:after_process, self)
+        run_callbacks(:after_perform, self)
         nil
       end
 

data/lib/caffeinate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Caffeinate
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caffeinate
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Josh Brody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-05 00:00:00.000000000 Z
+date: 2020-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails