caffeinate 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80e462cd99749a8f1352d481fec74d6a053a1660d200888a93844205eafb984c
-  data.tar.gz: 1c709353c202c7a97eb2fd8067f31ee40ee2753d93f8771232494867d47ce9c0
+  metadata.gz: a8ae5ac5375188ce5a7bc8960ac7d7b392ccc7dc7de71070e88a2285fa76e7af
+  data.tar.gz: dd06d837c2c1477bf8e48484e028016f00203066f0b2383c6f0a7a3cb5b5af1f
 SHA512:
-  metadata.gz: 9d4261e176299efc975f8d11791c95a58740bd94eaa6ae2e931fb262240f9e24a27cc1c88230965386ff4658e037dcbeb00ebf2100399d077872be0196e3ba8c
-  data.tar.gz: 208bc056825501459d0247e4fa91f64b3d9c4408f8219d7f47aa6dd492e9b183e614adeb97b5746f3e9c686d31aa38035667cc003142c93417f1d6cb8935b906
+  metadata.gz: 5c71b3ba2196a9a9f7ae66074b8eeb76ad6fe1a6b2ecff521e7f92c06da411c4722e0bc8b4a49fcfc9eaf0fde921c76fd4b13fbb5c7b59cfe1ec173ea69e5b29
+  data.tar.gz: 498848318785a2f8f4ab669cada385760f63663b1c6bf254235a7f640c189eaa170391aff58990c05c6a4d8ee6a6dc860399ea24745431dec7dfebaa8d760533

data/app/models/caffeinate/campaign_subscription.rb

@@ -33,6 +33,9 @@ module Caffeinate
     has_one :next_caffeinate_mailing, -> { joins(:caffeinate_campaign_subscription).where(caffeinate_campaign_subscriptions: { ended_at: nil, unsubscribed_at: nil }).upcoming.unsent.order(send_at: :asc) }, class_name: '::Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
     has_one :next_mailing, -> { joins(:caffeinate_campaign_subscription).where(caffeinate_campaign_subscriptions: { ended_at: nil, unsubscribed_at: nil }).upcoming.unsent.order(send_at: :asc) }, class_name: '::Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
 
+    has_one :previous_caffeinate_mailing, -> { sent.order(sent_at: :desc) }, class_name: '::Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
+    has_one :previous_mailing, -> { sent.order(sent_at: :desc) }, class_name: '::Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
+
     belongs_to :caffeinate_campaign, class_name: 'Caffeinate::Campaign', foreign_key: :caffeinate_campaign_id
     alias_attribute :campaign, :caffeinate_campaign
 
@@ -77,7 +80,7 @@ module Caffeinate
     end
 
     # Updates `ended_at` and runs `on_complete` callbacks
-    def end!(reason = nil)
+    def end!(reason = ::Caffeinate.config.default_ended_reason)
       raise ::Caffeinate::InvalidState, 'CampaignSubscription is already unsubscribed.' if unsubscribed?
 
       update!(ended_at: ::Caffeinate.config.time_now, ended_reason: reason)
@@ -87,7 +90,7 @@ module Caffeinate
     end
 
     # Updates `ended_at` and runs `on_complete` callbacks
-    def end(reason = nil)
+    def end(reason = ::Caffeinate.config.default_ended_reason)
       return false if unsubscribed?
 
       result = update(ended_at: ::Caffeinate.config.time_now, ended_reason: reason)
@@ -97,7 +100,7 @@ module Caffeinate
     end
 
     # Updates `unsubscribed_at` and runs `on_subscribe` callbacks
-    def unsubscribe!(reason = nil)
+    def unsubscribe!(reason = ::Caffeinate.config.default_unsubscribe_reason)
       raise ::Caffeinate::InvalidState, 'CampaignSubscription is already ended.' if ended?
 
       update!(unsubscribed_at: ::Caffeinate.config.time_now, unsubscribe_reason: reason)
@@ -107,7 +110,7 @@ module Caffeinate
     end
 
     # Updates `unsubscribed_at` and runs `on_subscribe` callbacks
-    def unsubscribe(reason = nil)
+    def unsubscribe(reason = ::Caffeinate.config.default_unsubscribe_reason)
       return false if ended?
 
       result = update(unsubscribed_at: ::Caffeinate.config.time_now, unsubscribe_reason: reason)

data/lib/caffeinate/action_mailer/interceptor.rb

@@ -5,7 +5,6 @@ module Caffeinate
     # 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 = message.caffeinate_mailing
         return unless mailing

data/lib/caffeinate/configuration.rb

@@ -3,15 +3,19 @@
 module Caffeinate
   # Global configuration
   class Configuration
-    attr_accessor :now, :async_delivery, :mailing_job, :batch_size, :drippers_path, :implicit_campaigns
+    attr_accessor :now, :async_delivery, :deliver_later,:mailing_job, :batch_size, :drippers_path, :implicit_campaigns,
+                  :default_ended_reason, :default_unsubscribe_reason
 
     def initialize
       @now = -> { Time.current }
       @async_delivery = false
+      @deliver_later = false
       @mailing_job = nil
       @batch_size = 1_000
       @drippers_path = 'app/drippers'
       @implicit_campaigns = true
+      @default_ended_reason = nil
+      @default_unsubscribe_reason = nil
     end
 
     def now=(val)
@@ -35,6 +39,11 @@ module Caffeinate
       @async_delivery
     end
 
+    # If we should use `#deliver_later` instead of `#deliver`
+    def deliver_later?
+      @deliver_later
+    end
+
     # The @mailing_job constantized. Only used if `async_delivery = true`
     def mailing_job_class
       @mailing_job.constantize

data/lib/caffeinate/drip.rb

@@ -67,10 +67,18 @@ module Caffeinate
     end
 
     # Checks if the drip is enabled
+    #
+    # This is kind of messy and could use some love.
+    # todo: better.
     def enabled?(mailing)
-      dripper.run_callbacks(:before_drip, self, mailing)
-
-      DripEvaluator.new(mailing).call(&@block)
+      catch(:abort) do
+        if dripper.run_callbacks(:before_drip, self, mailing)
+          return DripEvaluator.new(mailing).call(&@block)
+        else
+          return false
+        end
+      end
+      false
     end
   end
 end

data/lib/caffeinate/dripper/callbacks.rb

@@ -13,12 +13,25 @@ module Caffeinate
         self.class.run_callbacks(name, *args)
       end
 
+      def callbacks_for(name)
+        self.class.callbacks_for(name)
+      end
+
       module ClassMethods
         # :nodoc:
         def run_callbacks(name, *args)
-          send("#{name}_blocks").each do |callback|
-            callback.call(*args)
+          catch(:abort) do
+            callbacks_for(name).each do |callback|
+              callback.call(*args)
+            end
+            return true
           end
+          false
+        end
+
+        # :nodoc:
+        def callbacks_for(name)
+          send("#{name}_blocks")
         end
 
         def before_subscribe(&block)
@@ -114,10 +127,19 @@ module Caffeinate
 
         # Callback before a Drip has called the mailer.
         #
-        #   before_drip do |campaign_subscription, mailing, drip|
+        #   before_drip do |drip, mailing|
         #     Slack.notify(:caffeinate, "#{drip.action_name} is starting")
         #   end
         #
+        # Note: If you want to bail on the mailing for some reason, you need invoke `throw(:abort)`
+        #
+        #   before_drip do |drip, mailing|
+        #     if mailing.caffeinate_campaign_subscription.subscriber.trial_ended?
+        #       unsubscribe!("Trial ended")
+        #       throw(:abort)
+        #     end
+        #   end
+        #
         # @yield Caffeinate::Drip current drip
         # @yield Caffeinate::Mailing
         def before_drip(&block)

data/lib/caffeinate/dripper/delivery.rb

@@ -20,7 +20,12 @@ module Caffeinate
                       mailing.mailer_class.constantize.send(mailing.mailer_action, mailing)
                     end
           message.caffeinate_mailing = mailing
-          message.deliver
+          if ::Caffeinate.config.deliver_later?
+            message.deliver_later
+          else
+            message.deliver
+          end
+
         end
       end
     end

data/lib/caffeinate/version.rb

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

data/lib/generators/caffeinate/install_generator.rb

@@ -5,7 +5,6 @@ module Caffeinate
     # Installs Caffeinate
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path('templates', __dir__)
-      include ::Rails::Generators::Migration
 
       desc 'Creates a Caffeinate initializer and copies migrations to your application.'
 
@@ -33,12 +32,21 @@ module Caffeinate
         @prev_migration_nr.to_s
       end
 
+      def migration_version
+        if rails5_and_up?
+          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+      end
+
+      def rails5_and_up?
+        Rails::VERSION::MAJOR >= 5
+      end
+
       # :nodoc:
       def copy_migrations
-        require 'rake'
-        Rails.application.load_tasks
-        Rake::Task['railties:install:migrations'].reenable
-        Rake::Task['caffeinate:install:migrations'].invoke
+        template 'migrations/create_caffeinate_campaigns.rb', "db/migrate/#{self.class.next_migration_number("")}_create_caffeinate_campaigns.rb"
+        template 'migrations/create_caffeinate_campaign_subscriptions.rb', "db/migrate/#{self.class.next_migration_number("")}_create_caffeinate_campaign_subscriptions.rb"
+        template 'migrations/create_caffeinate_mailings.rb', "db/migrate/#{self.class.next_migration_number("")}_create_caffeinate_mailings.rb"
       end
     end
   end

data/lib/generators/caffeinate/templates/caffeinate.rb

@@ -41,4 +41,15 @@ Caffeinate.setup do |config|
   #   config.implicit_campaigns = true
   #
   # config.implicit_campaigns = false
+  #
+  # == Default reasons
+  #
+  # The default unsubscribe and end reasons.
+  #
+  # Default:
+  #   config.default_unsubscribe_reason = nil
+  #   config.default_ended_reason = nil
+  #
+  # config.default_unsubscribe_reason = "User unsubscribed"
+  # config.default_ended_reason = "User ended"
 end

data/{db/migrate/20201124183303_create_caffeinate_campaign_subscriptions.rb → lib/generators/caffeinate/templates/migrations/create_caffeinate_campaign_subscriptions.rb.tt}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class CreateCaffeinateCampaignSubscriptions < ActiveRecord::Migration[6.0]
+class CreateCaffeinateCampaignSubscriptions < ActiveRecord::Migration<%= migration_version %>
   def change
     drop_table :caffeinate_campaign_subscriptions if table_exists?(:caffeinate_campaign_subscriptions)
 

data/{db/migrate/20201124183102_create_caffeinate_campaigns.rb → lib/generators/caffeinate/templates/migrations/create_caffeinate_campaigns.rb.tt}

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-class CreateCaffeinateCampaigns < ActiveRecord::Migration[6.0]
+class CreateCaffeinateCampaigns < ActiveRecord::Migration<%= migration_version %>
   def change
-    drop_table :caffeinate_campaigns if table_exists?(:caffeinate_campaigns)
     create_table :caffeinate_campaigns do |t|
       t.string :name, null: false
       t.string :slug, null: false

data/{db/migrate/20201124183419_create_caffeinate_mailings.rb → lib/generators/caffeinate/templates/migrations/create_caffeinate_mailings.rb.tt}

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-class CreateCaffeinateMailings < ActiveRecord::Migration[6.0]
+class CreateCaffeinateMailings < ActiveRecord::Migration<%= migration_version %>
   def change
-    drop_table :caffeinate_mailings if table_exists?(:caffeinate_mailings)
-
     create_table :caffeinate_mailings do |t|
       t.references :caffeinate_campaign_subscription, null: false, foreign_key: true, index: { name: 'index_caffeinate_mailings_on_campaign_subscription' }
       t.datetime :send_at

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caffeinate
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Josh Brody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2021-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -143,9 +143,6 @@ files:
 - app/views/layouts/_caffeinate.html.erb
 - config/locales/en.yml
 - config/routes.rb
-- db/migrate/20201124183102_create_caffeinate_campaigns.rb
-- db/migrate/20201124183303_create_caffeinate_campaign_subscriptions.rb
-- db/migrate/20201124183419_create_caffeinate_mailings.rb
 - lib/caffeinate.rb
 - lib/caffeinate/action_mailer.rb
 - lib/caffeinate/action_mailer/extension.rb
@@ -179,6 +176,9 @@ files:
 - lib/generators/caffeinate/templates/application_dripper.rb
 - lib/generators/caffeinate/templates/caffeinate.rb
 - lib/generators/caffeinate/templates/mailer.rb.tt
+- lib/generators/caffeinate/templates/migrations/create_caffeinate_campaign_subscriptions.rb.tt
+- lib/generators/caffeinate/templates/migrations/create_caffeinate_campaigns.rb.tt
+- lib/generators/caffeinate/templates/migrations/create_caffeinate_mailings.rb.tt
 - lib/generators/caffeinate/views_generator.rb
 homepage: https://github.com/joshmn/caffeinate
 licenses: