caffeinate 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3241ca7ca0c6e31220511ad04172105d97058fa84f1de1e6ac442052823a91e0
-  data.tar.gz: 5b0bda6f08ae89f79cbd64df4c75f48fcb0dacf7471155aae779290b6a1b2e41
+  metadata.gz: 3095db5083c76905bf72f39bb96264c4fc90cbe93ef2740614c2275a3a95c87c
+  data.tar.gz: 76b7ffad86369d443d44a1bce50a9498547981522c6192d11cb35b300a4ce94e
 SHA512:
-  metadata.gz: d43a0030851c7fa107fed83fcc05c9cfa8596be068a8327d01f597a0a45fc84aa403d1a95990e8a4c45013fb44bc899215778d36ce8a8f5cc770db50b33cd0df
-  data.tar.gz: 6f9e399cc7e0a00bbb544b668d80e0438f4482013f3163a819b9f2ab8ea502f3c8535aacb91d57eb80efc5f12c22bd03a2bdfd36c2216544bb9aa1fd6928e797
+  metadata.gz: 0c605b54079ebe483d5ade7afa85298ae4d0983863b498732c137f13cf1bf10621338ab2e0d5887996a7d8fa1b84f4c8bedffdf291efc54931f6093abc650646
+  data.tar.gz: 2673a9957170a65695487facc9ba68fdcdd01b7fc441b140a7573f7e69248954548cbe5309751783b7c224073b8b424823c912e57eb9e2887cc6e7cffaa53d3f

data/README.md

@@ -6,6 +6,8 @@ Caffeinate tries to make creating and managing timed and scheduled email sequenc
 and has everything you need to get started and to successfully manage campaigns. It's only dependency is the stack you're
 already familiar with: Ruby on Rails.
 
+![Caffeinate logo](logo.png)
+
 ## Usage
 
 You can probably imagine seeing a Mailer like this:

data/app/controllers/caffeinate/campaign_subscriptions_controller.rb

@@ -2,7 +2,7 @@
 
 module Caffeinate
   class CampaignSubscriptionsController < ApplicationController
-    layout 'caffeinate'
+    layout '_caffeinate'
 
     helper_method :caffeinate_unsubscribe_url, :caffeinate_subscribe_url
 

data/app/models/caffeinate/campaign_subscription.rb

@@ -65,15 +65,15 @@ module Caffeinate
     end
 
     # Updates `ended_at` and runs `on_complete` callbacks
-    def end!
-      update!(ended_at: ::Caffeinate.config.time_now)
+    def end!(reason = nil)
+      update!(ended_at: ::Caffeinate.config.time_now, ended_reason: reason)
 
       caffeinate_campaign.to_dripper.run_callbacks(:on_complete, self)
     end
 
     # Updates `unsubscribed_at` and runs `on_subscribe` callbacks
-    def unsubscribe!
-      update!(unsubscribed_at: ::Caffeinate.config.time_now)
+    def unsubscribe!(reason = nil)
+      update!(unsubscribed_at: ::Caffeinate.config.time_now, unsubscribe_reason: reason)
 
       caffeinate_campaign.to_dripper.run_callbacks(:on_unsubscribe, self)
     end

data/app/models/caffeinate/mailing.rb

@@ -30,6 +30,13 @@ module Caffeinate
     scope :skipped, -> { where.not(skipped_at: nil) }
     scope :unskipped, -> { where(skipped_at: nil) }
 
+    def initialize_dup(args)
+      super
+      self.send_at = nil
+      self.sent_at = nil
+      self.skipped_at = nil
+    end
+
     # Checks if the Mailing is not skipped and not sent
     def pending?
       unskipped? && unsent?
@@ -59,13 +66,13 @@ module Caffeinate
     def skip!
       update!(skipped_at: Caffeinate.config.time_now)
 
-      caffeinate_campaign.to_dripper.run_callbacks(:on_skip, caffeinate_campaign_subscription, self)
+      caffeinate_campaign.to_dripper.run_callbacks(:on_skip, self)
     end
 
     # The associated drip
     # @todo This can be optimized with a better cache
     def drip
-      @drip ||= caffeinate_campaign.to_dripper.drip_collection[mailer_action]
+      @drip ||= caffeinate_campaign.to_dripper.drip_collection.for(mailer_action)
     end
 
     # The associated Subscriber from `::Caffeinate::CampaignSubscription`
@@ -80,7 +87,7 @@ module Caffeinate
 
     # Assigns attributes to the Mailing from the Drip
     def from_drip(drip)
-      self.send_at = drip.send_at
+      self.send_at = drip.send_at(self)
       self.mailer_class = drip.options[:mailer_class]
       self.mailer_action = drip.action
       self

data/db/migrate/20201124183102_create_caffeinate_campaigns.rb

@@ -6,6 +6,7 @@ class CreateCaffeinateCampaigns < ActiveRecord::Migration[6.0]
     create_table :caffeinate_campaigns do |t|
       t.string :name, null: false
       t.string :slug, null: false
+      t.boolean :active, default: true, null: false
 
       t.timestamps
     end

data/db/migrate/20201124183303_create_caffeinate_campaign_subscriptions.rb

@@ -12,8 +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,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rails/all'
+require 'caffeinate/mail_ext'
 require 'caffeinate/engine'
 require 'caffeinate/drip'
 require 'caffeinate/url_helpers'
@@ -28,14 +29,4 @@ module Caffeinate
   def self.setup
     yield config
   end
-
-  # The current mailing
-  def self.current_mailing=(val)
-    Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY] = val
-  end
-
-  # The current mailing
-  def self.current_mailing
-    Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY]
-  end
 end

data/lib/caffeinate/action_mailer/extension.rb

@@ -7,7 +7,7 @@ module Caffeinate
     module Extension
       def self.included(klass)
         klass.before_action do
-          @mailing = Caffeinate.current_mailing if Caffeinate.current_mailing
+          @mailing = params[:mailing] if params
         end
 
         klass.helper_method :caffeinate_unsubscribe_url, :caffeinate_subscribe_url

data/lib/caffeinate/action_mailer/interceptor.rb

@@ -7,10 +7,10 @@ module Caffeinate
     class Interceptor
       # Handles `before_send` callbacks for a `Caffeinate::Dripper`
       def self.delivering_email(message)
-        mailing = Caffeinate.current_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,15 @@
 
 module Caffeinate
   module ActionMailer
-    # Handles updating the Caffeinate::Message if it's available in Caffeinate.current_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 = Caffeinate.current_mailing
+        mailing = message.caffeinate_mailing
         return unless mailing
 
         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.caffeinate_campaign_subscription, mailing, message)
+        mailing.caffeinate_campaign.to_dripper.run_callbacks(:after_send, mailing, message)
       end
     end
   end

data/lib/caffeinate/configuration.rb

@@ -3,13 +3,14 @@
 module Caffeinate
   # Global configuration
   class Configuration
-    attr_accessor :now, :async_delivery, :mailing_job, :batch_size
+    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

@@ -19,8 +19,20 @@ module Caffeinate
       options[:using] == :parameterized
     end
 
-    def send_at
-      options[:delay].from_now
+    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

data/lib/caffeinate/dripper/base.rb

@@ -8,6 +8,7 @@ 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
@@ -22,7 +23,10 @@ module Caffeinate
       include Drip
       include Inferences
       include Perform
+      include Periodical
       include Subscriber
     end
   end
 end
+
+ActiveSupport.run_load_hooks :caffeinate, Caffeinate::Dripper::Base

data/lib/caffeinate/dripper/batching.rb

@@ -1,19 +1,21 @@
 # frozen_string_literal: true
 
 module Caffeinate
-  # 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
+  module Dripper
+    # Includes batch support for setting the batch size for Perform
+    module Batching
+      def self.included(klass)
+        klass.extend ClassMethods
       end
 
-      def _batch_size
-        @_batch_size || ::Caffeinate.config.batch_size
+      module ClassMethods
+        def batch_size=(num)
+          @batch_size = num
+        end
+
+        def batch_size
+          @batch_size || ::Caffeinate.config.batch_size
+        end
       end
     end
   end

data/lib/caffeinate/dripper/callbacks.rb

@@ -94,9 +94,8 @@ module Caffeinate
         #     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
@@ -112,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)
@@ -130,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)
@@ -180,7 +177,6 @@ module Caffeinate
         #     Slack.notify(:caffeinate, "#{campaign_sub.id} has unsubscribed... sad day.")
         #   end
         #
-        # @yield `Caffeinate::CampaignSubscription`
         # @yield `Caffeinate::Mailing`
         def on_skip(&block)
           on_skip_blocks << block

data/lib/caffeinate/dripper/campaign.rb

@@ -28,7 +28,7 @@ module Caffeinate
         #   self.name.delete_suffix("Campaign").underscore
         #
         # @param [Symbol] slug The slug of a persisted `Caffeinate::Campaign`.
-        def campaign(slug)
+        def campaign=(slug)
           @caffeinate_campaign = nil
           @_campaign_slug = slug.to_sym
           Caffeinate.register_dripper(@_campaign_slug, name)
@@ -40,6 +40,7 @@ module Caffeinate
 
           @caffeinate_campaign = ::Caffeinate::Campaign[campaign_slug]
         end
+        alias campaign caffeinate_campaign
 
         # The defined slug or the inferred slug
         def campaign_slug

data/lib/caffeinate/dripper/defaults.rb

@@ -24,6 +24,7 @@ module Caffeinate
         # @param [Hash] options The options to set defaults with
         # @option options [String] :mailer_class The mailer class
         def default(options = {})
+          options.symbolize_keys!
           options.assert_valid_keys(:mailer_class, :mailer, :using, :batch_size)
           @defaults = options
         end

data/lib/caffeinate/dripper/delivery.rb

@@ -14,13 +14,13 @@ module Caffeinate
         #
         # @param [Caffeinate::Mailing] mailing The mailing to deliver
         def deliver!(mailing)
-          Caffeinate.current_mailing = mailing
-
-          if mailing.drip.parameterized?
-            mailing.mailer_class.constantize.with(mailing: mailing).send(mailing.mailer_action).deliver
-          else
-            mailing.mailer_class.constantize.send(mailing.mailer_action, mailing).deliver
-          end
+          message = if mailing.drip.parameterized?
+                      mailing.mailer_class.constantize.with(mailing: mailing).send(mailing.mailer_action)
+                    else
+                      mailing.mailer_class.constantize.send(mailing.mailer_action, mailing)
+                    end
+          message.caffeinate_mailing = mailing
+          message.deliver
         end
       end
     end

data/lib/caffeinate/dripper/drip.rb

@@ -13,9 +13,15 @@ module Caffeinate
           @drips = {}
         end
 
+        def for(action)
+          @drips[action.to_sym]
+        end
+
         # Register the drip
         def register(action, options, &block)
-          @drips[action.to_s] = ::Caffeinate::Drip.new(@dripper, action, options, &block)
+          options = validate_drip_options(action, options)
+
+          @drips[action.to_sym] = ::Caffeinate::Drip.new(@dripper, action, options, &block)
         end
 
         def each(&block)
@@ -33,6 +39,26 @@ module Caffeinate
         def [](val)
           @drips[val]
         end
+
+        private
+
+        def validate_drip_options(action, options)
+          options.symbolize_keys!
+          options.assert_valid_keys(:mailer_class, :step, :delay, :every, :start, :using, :mailer)
+          options[:mailer_class] ||= options[:mailer] || @dripper.defaults[:mailer_class]
+          options[:using] ||= @dripper.defaults[:using]
+          options[:step] ||= @dripper.drips.size + 1
+
+          if options[:mailer_class].nil?
+            raise ArgumentError, "You must define :mailer_class or :mailer in the options for #{action.inspect} on #{@dripper.inspect}"
+          end
+
+          if options[:every].nil? && options[:delay].nil?
+            raise ArgumentError, "You must define :delay in the options for #{action.inspect} on #{@dripper.inspect}"
+          end
+
+          options
+        end
       end
 
       # :nodoc:
@@ -60,17 +86,8 @@ module Caffeinate
         # @option options [String] :mailer_class The mailer_class
         # @option options [Integer] :step The order in which the drip is executed
         # @option options [ActiveSupport::Duration] :delay When the drip should be ran
+        # @option options [Symbol] :using set to :parameters if the mailer action uses ActionMailer::Parameters
         def drip(action_name, options = {}, &block)
-          options.assert_valid_keys(:mailer_class, :step, :delay, :using, :mailer)
-          options[:mailer_class] ||= options[:mailer] || defaults[:mailer_class]
-          options[:using] ||= defaults[:using]
-          options[:step] ||= drips.size + 1
-
-          if options[:mailer_class].nil?
-            raise ArgumentError, "You must define :mailer_class or :mailer in the options for :#{action_name}"
-          end
-          raise ArgumentError, "You must define :delay in the options for :#{action_name}" if options[:delay].nil?
-
           drip_collection.register(action_name, options, &block)
         end
       end

data/lib/caffeinate/dripper/perform.rb

@@ -9,19 +9,31 @@ module Caffeinate
         klass.extend ClassMethods
       end
 
-      # Delivers the next_caffeinate_mailer for the campaign's subscribers.
-      #
-      # Handles with batches based on batch_size.
+      # Delivers the next_caffeinate_mailer for the campaign's subscribers. Handles with batches based on `batch_size`.
       #
       #   OrderDripper.new.perform!
       #
       # @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.in_batches(of: self.class._batch_size).each do |batch|
+        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!
+            subscriber.next_caffeinate_mailing.process!
           end
         end
         run_callbacks(:after_process, self)

data/lib/caffeinate/dripper/periodical.rb

@@ -0,0 +1,24 @@
+module Caffeinate
+  module Dripper
+    module Periodical
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def periodical(action_name, every:, start: -> { ::Caffeinate.config.time_now }, **options, &block)
+          options[:start] = start
+          options[:every] = every
+          drip(action_name, options, &block)
+          after_send do |mailing, _message|
+            if mailing.drip.action == action_name
+              next_mailing = mailing.dup
+              next_mailing.send_at = mailing.drip.send_at(mailing)
+              next_mailing.save!
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/caffeinate/engine.rb

@@ -10,6 +10,12 @@ module Caffeinate
     isolate_namespace Caffeinate
     config.eager_load_namespaces << Caffeinate
 
+    config.to_prepare do
+      Dir.glob(Rails.root.join(Caffeinate.config.drippers_path, "**", "*.rb")).each do |dripper|
+        require dripper
+      end
+    end
+
     ActiveSupport.on_load(:action_mailer) do
       include ::Caffeinate::ActionMailer::Extension
       ::ActionMailer::Base.register_interceptor(::Caffeinate::ActionMailer::Interceptor)
@@ -21,7 +27,7 @@ module Caffeinate
     end
 
     ActiveSupport.on_load(:action_view) do
-      ApplicationHelper.include ::Caffeinate::Helpers
+      ActionView::Base.include ::Caffeinate::Helpers
     end
   end
 end

data/lib/caffeinate/mail_ext.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Mail
+  # Extend Mail::Message to account for a Caffeinate::Mailing
+  class Message
+    attr_accessor :caffeinate_mailing
+
+    def caffeinate?
+      caffeinate_mailing.present?
+    end
+  end
+end

data/lib/caffeinate/version.rb

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

data/lib/generators/caffeinate/install_generator.rb

@@ -20,7 +20,7 @@ module Caffeinate
       end
 
       def install_routes
-        inject_into_file 'config/routes.rb', "\n  mount ::Caffeinate::Engine => '/caffeinate", after: /Rails.application.routes.draw do/
+        inject_into_file 'config/routes.rb', "\n  mount ::Caffeinate::Engine => '/caffeinate'", after: /Rails.application.routes.draw do/
       end
 
       # :nodoc:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caffeinate
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Josh Brody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-28 00:00:00.000000000 Z
+date: 2020-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -126,7 +126,7 @@ files:
 - app/models/caffeinate/mailing.rb
 - app/views/caffeinate/campaign_subscriptions/subscribe.html.erb
 - app/views/caffeinate/campaign_subscriptions/unsubscribe.html.erb
-- app/views/layouts/caffeinate.html.erb
+- app/views/layouts/_caffeinate.html.erb
 - config/locales/en.yml
 - config/routes.rb
 - db/migrate/20201124183102_create_caffeinate_campaigns.rb
@@ -151,9 +151,11 @@ files:
 - lib/caffeinate/dripper/drip.rb
 - lib/caffeinate/dripper/inferences.rb
 - lib/caffeinate/dripper/perform.rb
+- lib/caffeinate/dripper/periodical.rb
 - lib/caffeinate/dripper/subscriber.rb
 - lib/caffeinate/engine.rb
 - lib/caffeinate/helpers.rb
+- lib/caffeinate/mail_ext.rb
 - lib/caffeinate/url_helpers.rb
 - lib/caffeinate/version.rb
 - lib/generators/caffeinate/install_generator.rb