caffeinate 0.1.4 → 0.5.0

data/db/migrate/20201124183303_create_caffeinate_campaign_subscriptions.rb

@@ -12,7 +12,10 @@ class CreateCaffeinateCampaignSubscriptions < ActiveRecord::Migration[6.0]
       t.string :user_id
       t.string :token, null: false
       t.datetime :ended_at
+      t.string :ended_reason
+      t.datetime :resubscribed_at
       t.datetime :unsubscribed_at
+      t.string :unsubscribe_reason
 
       t.timestamps
     end

data/db/migrate/20201124183419_create_caffeinate_mailings.rb

@@ -14,6 +14,9 @@ class CreateCaffeinateMailings < ActiveRecord::Migration[6.0]
 
       t.timestamps
     end
-    add_index :caffeinate_mailings, %i[campaign_subscription_id mailer_class mailer_action sent_at send_at skipped_at], name: :index_caffeinate_mailings
+    add_index :caffeinate_mailings, :sent_at
+    add_index :caffeinate_mailings, :send_at
+    add_index :caffeinate_mailings, :skipped_at
+    add_index :caffeinate_mailings, %i[caffeinate_campaign_subscription_id mailer_class mailer_action], name: :index_caffeinate_mailings
   end
 end

data/lib/caffeinate.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require 'rails/all'
+require 'caffeinate/mail_ext'
 require 'caffeinate/engine'
 require 'caffeinate/drip'
+require 'caffeinate/url_helpers'
 require 'caffeinate/configuration'
 require 'caffeinate/dripper/base'
 require 'caffeinate/deliver_async'

data/lib/caffeinate/action_mailer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'caffeinate/action_mailer/extension'
-require 'caffeinate/action_mailer/helpers'
-require 'caffeinate/action_mailer/interceptor'
-require 'caffeinate/action_mailer/observer'
+require 'mail'
+
+# Includes all files in `caffeinate/action_mailer`
+Dir["#{__dir__}/action_mailer/*"].each { |path| require "caffeinate/action_mailer/#{File.basename(path)}" }

data/lib/caffeinate/action_mailer/extension.rb

@@ -2,11 +2,27 @@
 
 module Caffeinate
   module ActionMailer
+    # Convenience for setting `@mailing`, and convenience methods for inferred `caffeinate_unsubscribe_url` and
+    # `caffeinate_subscribe_url`.
     module Extension
       def self.included(klass)
         klass.before_action do
-          @mailing = Thread.current[:current_caffeinate_mailing] if Thread.current[:current_caffeinate_mailing]
+          @mailing = params[:mailing] if params
         end
+
+        klass.helper_method :caffeinate_unsubscribe_url, :caffeinate_subscribe_url
+      end
+
+      # Assumes `@mailing` is set
+      def caffeinate_unsubscribe_url(mailing: nil, **options)
+        mailing ||= @mailing
+        Caffeinate::UrlHelpers.caffeinate_unsubscribe_url(mailing.caffeinate_campaign_subscription, **options)
+      end
+
+      # Assumes `@mailing` is set
+      def caffeinate_subscribe_url(mailing: nil, **options)
+        mailing ||= @mailing
+        Caffeinate::UrlHelpers.caffeinate_subscribe_url(mailing.caffeinate_campaign_subscription, **options)
       end
     end
   end

data/lib/caffeinate/action_mailer/interceptor.rb

@@ -2,13 +2,15 @@
 
 module Caffeinate
   module ActionMailer
+    # Handles the evaluation of a drip against a mailing to determine if it ultimately gets delivered.
+    # Also invokes the `before_send` callbacks.
     class Interceptor
       # Handles `before_send` callbacks for a `Caffeinate::Dripper`
       def self.delivering_email(message)
-        mailing = Thread.current[:current_caffeinate_mailing]
+        mailing = message.caffeinate_mailing
         return unless mailing
 
-        mailing.caffeinate_campaign.to_dripper.run_callbacks(:before_send, mailing.caffeinate_campaign_subscription, mailing, message)
+        mailing.caffeinate_campaign.to_dripper.run_callbacks(:before_send, mailing, message)
         drip = mailing.drip
         message.perform_deliveries = drip.enabled?(mailing)
       end

data/lib/caffeinate/action_mailer/observer.rb

@@ -2,15 +2,16 @@
 
 module Caffeinate
   module ActionMailer
-    # Handles updating the Caffeinate::Message if it's available in Thread.current[:current_caffeinate_mailing]
+    # Handles updating the Caffeinate::Message if it's available in Mail::Message.caffeinate_mailing
     # and runs any associated callbacks
     class Observer
       def self.delivered_email(message)
-        mailing = Thread.current[:current_caffeinate_mailing]
+        mailing = message.caffeinate_mailing
         return unless mailing
 
-        mailing.update!(sent_at: Caffeinate.config.time_now) if message.perform_deliveries
-        mailing.caffeinate_campaign.to_dripper.run_callbacks(:after_send, mailing.caffeinate_campaign_subscription, mailing, message)
+        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/active_record/extension.rb

@@ -2,14 +2,15 @@
 
 module Caffeinate
   module ActiveRecord
+    # Includes the ActiveRecord association and relevant scopes for an ActiveRecord-backed model
     module Extension
       # Adds the associations for a subscriber
       def caffeinate_subscriber
-        has_many :caffeinate_campaign_subscriptions, as: :subscriber, class_name: '::Caffeinate::CampaignSubscription'
+        has_many :caffeinate_campaign_subscriptions, as: :subscriber, class_name: '::Caffeinate::CampaignSubscription', dependent: :destroy
         has_many :caffeinate_campaigns, through: :caffeinate_campaign_subscriptions, class_name: '::Caffeinate::Campaign'
         has_many :caffeinate_mailings, through: :caffeinate_campaign_subscriptions, class_name: '::Caffeinate::Mailing'
 
-        scope :not_subscribed_to, lambda { |list|
+        scope :not_subscribed_to_campaign, lambda { |list|
           subscribed = ::Caffeinate::CampaignSubscription.select(:subscriber_id).joins(:caffeinate_campaign).where(caffeinate_campaigns: { slug: list }, subscriber_type: name)
           where.not(id: subscribed)
         }

data/lib/caffeinate/configuration.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
 module Caffeinate
+  # Global configuration
   class Configuration
-    attr_accessor :now, :async_delivery, :mailing_job
+    attr_accessor :now, :async_delivery, :mailing_job, :batch_size, :drippers_path
 
     def initialize
       @now = -> { Time.current }
       @async_delivery = false
       @mailing_job = nil
+      @batch_size = 1_000
+      @drippers_path = "app/drippers"
     end
 
     def now=(val)

data/lib/caffeinate/drip.rb

@@ -1,40 +1,11 @@
 # frozen_string_literal: true
 
+require 'caffeinate/drip_evaluator'
 module Caffeinate
   # A Drip object
+  #
+  # Handles the block and provides convenience methods for the drip
   class Drip
-    # Handles the block and provides convenience methods for the drip
-    class Evaluator
-      attr_reader :mailing
-      def initialize(mailing)
-        @mailing = mailing
-      end
-
-      def call(&block)
-        return true unless block
-
-        instance_eval(&block)
-      end
-
-      # Ends the CampaignSubscription
-      def end!
-        mailing.caffeinate_campaign_subscription.end!
-        false
-      end
-
-      # Unsubscribes the CampaignSubscription
-      def unsubscribe!
-        mailing.caffeinate_campaign_subscription.unsubscribe!
-        false
-      end
-
-      # Skips the mailing
-      def skip!
-        mailing.skip!
-        false
-      end
-    end
-
     attr_reader :dripper, :action, :options, :block
     def initialize(dripper, action, options, &block)
       @dripper = dripper
@@ -43,14 +14,30 @@ module Caffeinate
       @block = block
     end
 
-    # If the associated ActionMailer uses `ActionMailer::Parameterized` initialization
+    # If the associated ActionMailer uses `ActionMailer::Parameterized` initialization instead of argument-based initialization
     def parameterized?
       options[:using] == :parameterized
     end
 
-    # If the drip is enabled.
+    def send_at(mailing = nil)
+      if periodical?
+        start = mailing.instance_exec(&options[:start])
+        if mailing.caffeinate_campaign_subscription.caffeinate_mailings.count > 0
+          start += options[:every]
+        end
+        start.from_now
+      else
+        options[:delay].from_now
+      end
+    end
+
+    def periodical?
+      options[:every].present?
+    end
+
+    # Checks if the drip is enabled
     def enabled?(mailing)
-      Evaluator.new(mailing).call(&@block)
+      DripEvaluator.new(mailing).call(&@block)
     end
   end
 end

data/lib/caffeinate/drip_evaluator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Caffeinate
+  # Handles evaluating the `drip` block and provides convenience methods for handling the mailing or its campaign.
+  class DripEvaluator
+    attr_reader :mailing
+    def initialize(mailing)
+      @mailing = mailing
+    end
+
+    def call(&block)
+      return true unless block
+
+      instance_eval(&block)
+    end
+
+    # Ends the CampaignSubscription
+    def end!
+      mailing.caffeinate_campaign_subscription.end!
+      false
+    end
+
+    # Unsubscribes the CampaignSubscription
+    def unsubscribe!
+      mailing.caffeinate_campaign_subscription.unsubscribe!
+      false
+    end
+
+    # Skips the mailing
+    def skip!
+      mailing.skip!
+      false
+    end
+  end
+end

data/lib/caffeinate/dripper/base.rb

@@ -1,33 +1,32 @@
 # frozen_string_literal: true
 
-require 'caffeinate/dripper/drip'
+require 'caffeinate/dripper/batching'
 require 'caffeinate/dripper/callbacks'
-require 'caffeinate/dripper/defaults'
-require 'caffeinate/dripper/subscriber'
 require 'caffeinate/dripper/campaign'
-require 'caffeinate/dripper/perform'
+require 'caffeinate/dripper/defaults'
 require 'caffeinate/dripper/delivery'
+require 'caffeinate/dripper/drip'
+require 'caffeinate/dripper/inferences'
+require 'caffeinate/dripper/perform'
+require 'caffeinate/dripper/periodical'
+require 'caffeinate/dripper/subscriber'
 
 module Caffeinate
   module Dripper
+    # Base class
     class Base
+      include Batching
       include Callbacks
       include Campaign
       include Defaults
       include Delivery
       include Drip
+      include Inferences
       include Perform
+      include Periodical
       include Subscriber
-
-      # The inferred mailer class
-      def self.inferred_mailer_class
-        klass_name = "#{name.delete_suffix('Dripper')}Mailer"
-        klass = klass_name.safe_constantize
-        return nil unless klass
-        return klass_name if klass < ::ActionMailer::Base
-
-        nil
-      end
     end
   end
 end
+
+ActiveSupport.run_load_hooks :caffeinate, Caffeinate::Dripper::Base

data/lib/caffeinate/dripper/batching.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Caffeinate
+  module Dripper
+    # Includes batch support for setting the batch size for Perform
+    module Batching
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def batch_size=(num)
+          @batch_size = num
+        end
+
+        def batch_size
+          @batch_size || ::Caffeinate.config.batch_size
+        end
+      end
+    end
+  end
+end

data/lib/caffeinate/dripper/callbacks.rb

@@ -2,12 +2,17 @@
 
 module Caffeinate
   module Dripper
+    # Callbacks for a Dripper.
     module Callbacks
       # :nodoc:
       def self.included(klass)
         klass.extend ClassMethods
       end
 
+      def run_callbacks(name, *args)
+        self.class.run_callbacks(name, *args)
+      end
+
       module ClassMethods
         # :nodoc:
         def run_callbacks(name, *args)
@@ -33,15 +38,64 @@ module Caffeinate
           @on_subscribe_blocks ||= []
         end
 
+        # Callback before the mailings get processed.
+        #
+        #   before_perform do |dripper|
+        #     Slack.notify(:caffeinate, "Dripper is getting ready for mailing! #{dripper.caffeinate_campaign.name}!")
+        #   end
+        #
+        # @yield Caffeinate::Dripper
+        def before_perform(&block)
+          before_perform_blocks << block
+        end
+
+        # :nodoc:
+        def before_perform_blocks
+          @before_perform_blocks ||= []
+        end
+
+        # Callback before the mailings get processed in a batch.
+        #
+        #   after_process do |dripper, mailings|
+        #     Slack.notify(:caffeinate, "Dripper #{dripper.name} sent #{mailings.size} mailings! Whoa!")
+        #   end
+        #
+        # @yield Caffeinate::Dripper
+        # @yield Caffeinate::Mailing [Array]
+        def on_perform(&block)
+          on_perform_blocks << block
+        end
+
+        # :nodoc:
+        def on_perform_blocks
+          @on_perform_blocks ||= []
+        end
+
+        # Callback after the all the mailings have been sent.
+        #
+        #   after_process do |dripper|
+        #     Slack.notify(:caffeinate, "Dripper #{dripper.name} sent #{mailings.size} mailings! Whoa!")
+        #   end
+        #
+        # @yield Caffeinate::Dripper
+        # @yield Caffeinate::Mailing [Array]
+        def after_perform(&block)
+          after_perform_blocks << block
+        end
+
+        # :nodoc:
+        def after_perform_blocks
+          @after_perform_blocks ||= []
+        end
+
         # Callback before a Drip has called the mailer.
         #
         #   before_drip do |campaign_subscription, mailing, drip|
         #     Slack.notify(:caffeinate, "#{drip.action_name} is starting")
         #   end
         #
-        # @yield Caffeinate::CampaignSubscription
-        # @yield Caffeinate::Mailing
         # @yield Caffeinate::Drip current drip
+        # @yield Caffeinate::Mailing
         def before_drip(&block)
           before_drip_blocks << block
         end
@@ -57,7 +111,6 @@ module Caffeinate
         #     Slack.notify(:caffeinate, "A new subscriber to #{campaign_subscription.campaign.name}!")
         #   end
         #
-        # @yield Caffeinate::CampaignSubscription
         # @yield Caffeinate::Mailing
         # @yield Mail::Message
         def before_send(&block)
@@ -75,7 +128,6 @@ module Caffeinate
         #     Slack.notify(:caffeinate, "A new subscriber to #{campaign_subscription.campaign.name}!")
         #   end
         #
-        # @yield Caffeinate::CampaignSubscription
         # @yield Caffeinate::Mailing
         # @yield Mail::Message
         def after_send(&block)
@@ -119,14 +171,30 @@ 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|
         #     Slack.notify(:caffeinate, "#{campaign_sub.id} has unsubscribed... sad day.")
         #   end
         #
-        # @yield Caffeinate::CampaignSubscription
-        # @yield Caffeinate::Mailing
+        # @yield `Caffeinate::Mailing`
         def on_skip(&block)
           on_skip_blocks << block
         end