caffeinate 0.8.5 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f2ea2b9f5f03fdeb85614ae404df166822797d18861bd1c6ea5c4c867f44618
-  data.tar.gz: 38b8cd78227cc1eecffe4e09ee01fd8e26a7fc46314d30956ce29230b1209f7f
+  metadata.gz: 80e462cd99749a8f1352d481fec74d6a053a1660d200888a93844205eafb984c
+  data.tar.gz: 1c709353c202c7a97eb2fd8067f31ee40ee2753d93f8771232494867d47ce9c0
 SHA512:
-  metadata.gz: 3fd342f50ad5394c5253d1c7c00efa7ce25e1d1f90571fe16658bed9f0d251893f4953d746daf4db48728541d13fc67ee505529aae18711e491ca0819f66d6a1
-  data.tar.gz: 8ec91a5b080a1420f090a4c538c1fd1cd05def80c5aa5395ce2a2d985063e4ef7d26e935ec1131496525d44bd745abbac90cbbc749e9ec6b55d1c0f3a99d8e49
+  metadata.gz: 9d4261e176299efc975f8d11791c95a58740bd94eaa6ae2e931fb262240f9e24a27cc1c88230965386ff4658e037dcbeb00ebf2100399d077872be0196e3ba8c
+  data.tar.gz: 208bc056825501459d0247e4fa91f64b3d9c4408f8219d7f47aa6dd492e9b183e614adeb97b5746f3e9c686d31aa38035667cc003142c93417f1d6cb8935b906

data/app/models/caffeinate/campaign.rb

@@ -54,6 +54,14 @@ module Caffeinate
     #
     # Just... mintier.
     def unsubscribe(subscriber, **args)
+      reason = args.delete(:reason)
+      subscription = subscriber(subscriber, **args)
+      return false if subscription.nil?
+
+      subscription.unsubscribe(reason)
+    end
+
+    def unsubscribe!(subscriber, **args)
       reason = args.delete(:reason)
       subscription = subscriber(subscriber, **args)
       raise ::ActiveRecord::RecordInvalid, subscription if subscription.nil?
@@ -64,12 +72,12 @@ module Caffeinate
     # Creates a `CampaignSubscription` object for the present Campaign. Allows passing `**args` to
     # delegate additional arguments to the record. Uses `find_or_create_by`.
     def subscribe(subscriber, **args)
-      caffeinate_campaign_subscriptions.find_or_create_by(subscriber: subscriber, **args)
+      caffeinate_campaign_subscriptions.create(subscriber: subscriber, **args)
     end
 
     # Subscribes an object to a campaign. Raises `ActiveRecord::RecordInvalid` if the record was invalid.
     def subscribe!(subscriber, **args)
-      subscribe(subscriber, **args)
+      caffeinate_campaign_subscriptions.create!(subscriber: subscriber, **args)
     end
   end
 end

data/app/models/caffeinate/campaign_subscription.rb

@@ -28,9 +28,10 @@ module Caffeinate
 
     has_many :caffeinate_mailings, class_name: 'Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id, dependent: :destroy
     has_many :mailings, class_name: 'Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id, dependent: :destroy
+    has_many :future_mailings, -> { upcoming.unsent }, class_name: '::Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
 
-    has_one :next_caffeinate_mailing, -> { upcoming.unsent.order(send_at: :asc) }, class_name: '::Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
-    has_one :next_mailing, -> { upcoming.unsent.order(send_at: :asc) }, class_name: '::Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
+    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
 
     belongs_to :caffeinate_campaign, class_name: 'Caffeinate::Campaign', foreign_key: :caffeinate_campaign_id
     alias_attribute :campaign, :caffeinate_campaign
@@ -49,6 +50,8 @@ module Caffeinate
     before_validation :set_token!, on: [:create]
     validates :token, uniqueness: true, on: [:create]
 
+    before_validation :call_dripper_before_subscribe_blocks!, on: :create
+
     after_commit :create_mailings!, on: :create
 
     after_commit :on_complete, if: :completed?
@@ -83,6 +86,16 @@ module Caffeinate
       true
     end
 
+    # Updates `ended_at` and runs `on_complete` callbacks
+    def end(reason = nil)
+      return false if unsubscribed?
+
+      result = update(ended_at: ::Caffeinate.config.time_now, ended_reason: reason)
+
+      caffeinate_campaign.to_dripper.run_callbacks(:on_end, self)
+      result
+    end
+
     # Updates `unsubscribed_at` and runs `on_subscribe` callbacks
     def unsubscribe!(reason = nil)
       raise ::Caffeinate::InvalidState, 'CampaignSubscription is already ended.' if ended?
@@ -93,6 +106,16 @@ module Caffeinate
       true
     end
 
+    # Updates `unsubscribed_at` and runs `on_subscribe` callbacks
+    def unsubscribe(reason = nil)
+      return false if ended?
+
+      result = update(unsubscribed_at: ::Caffeinate.config.time_now, unsubscribe_reason: reason)
+
+      caffeinate_campaign.to_dripper.run_callbacks(:on_unsubscribe, self)
+      result
+    end
+
     # Updates `unsubscribed_at` to nil and runs `on_subscribe` callbacks.
     # Use `force` to forcefully reset. Does not create the mailings.
     def resubscribe!(force = false)
@@ -105,12 +128,28 @@ module Caffeinate
       true
     end
 
+    # Updates `unsubscribed_at` to nil and runs `on_subscribe` callbacks.
+    # Use `force` to forcefully reset. Does not create the mailings.
+    def resubscribe!(force = false)
+      return false if ended? && !force
+      return false if unsubscribed? && !force
+
+      result = update(unsubscribed_at: nil, resubscribed_at: ::Caffeinate.config.time_now)
+
+      caffeinate_campaign.to_dripper.run_callbacks(:on_resubscribe, self)
+      result
+    end
+
     def completed?
       caffeinate_mailings.unsent.count.zero?
     end
 
     private
 
+    def call_dripper_before_subscribe_blocks!
+      caffeinate_campaign.to_dripper.run_callbacks(:before_subscribe, self)
+    end
+
     def on_complete
       caffeinate_campaign.to_dripper.run_callbacks(:on_complete, self)
     end

data/app/models/caffeinate/mailing.rb

@@ -30,6 +30,8 @@ module Caffeinate
     scope :skipped, -> { where.not(skipped_at: nil) }
     scope :unskipped, -> { where(skipped_at: nil) }
 
+    after_touch :end_if_no_mailings!
+
     def initialize_dup(args)
       super
       self.send_at = nil
@@ -119,5 +121,9 @@ module Caffeinate
         raise NoMethodError, "Neither perform_later or perform_async are defined on #{klass}."
       end
     end
+
+    def end_if_no_mailings!
+      end! if future_mailings.empty?
+    end
   end
 end

data/lib/caffeinate/drip.rb

@@ -6,6 +6,26 @@ module Caffeinate
   #
   # Handles the block and provides convenience methods for the drip
   class Drip
+    class OptionEvaluator
+      def initialize(thing, drip, mailing)
+        @thing = thing
+        @drip = drip
+        @mailing = mailing
+      end
+
+      def call
+        if @thing.is_a?(Symbol)
+          @drip.dripper.new.send(@thing, @drip, @mailing)
+        elsif @thing.is_a?(Proc)
+          @mailing.instance_exec(&@thing)
+        elsif @thing.is_a?(String)
+          Time.parse(@thing)
+        else
+          @thing
+        end
+      end
+    end
+
     attr_reader :dripper, :action, :options, :block
 
     def initialize(dripper, action, options, &block)
@@ -26,13 +46,16 @@ module Caffeinate
         start += options[:every] if mailing.caffeinate_campaign_subscription.caffeinate_mailings.count.positive?
         date = start.from_now
       elsif options[:on]
-        date = mailing.instance_exec(&options[:on])
+        date = OptionEvaluator.new(options[:on], self, mailing).call
       else
-        date = options[:delay].from_now
+        date = OptionEvaluator.new(options[:delay], self, mailing).call
+        if date.respond_to?(:from_now)
+          date = date.from_now
+        end
       end
 
       if options[:at]
-        time = Time.parse(options[:at])
+        time = OptionEvaluator.new(options[:at], self, mailing).call
         return date.change(hour: time.hour, min: time.min, sec: time.sec)
       end
 

data/lib/caffeinate/drip_evaluator.rb

@@ -11,26 +11,29 @@ module Caffeinate
 
     def call(&block)
       return true unless block
-
-      instance_eval(&block)
+      catch(:abort) do
+        result = instance_eval(&block)
+        return result.nil? || result === true
+      end
+      false
     end
 
     # Ends the CampaignSubscription
-    def end!(msg)
-      mailing.caffeinate_campaign_subscription.end!(msg)
-      false
+    def end!(*args)
+      mailing.caffeinate_campaign_subscription.end!(*args)
+      throw(:abort)
     end
 
     # Unsubscribes the CampaignSubscription
-    def unsubscribe!(msg)
-      mailing.caffeinate_campaign_subscription.unsubscribe!(msg)
-      false
+    def unsubscribe!(*args)
+      mailing.caffeinate_campaign_subscription.unsubscribe!(*args)
+      throw(:abort)
     end
 
     # Skips the mailing
     def skip!
       mailing.skip!
-      false
+      throw(:abort)
     end
   end
 end

data/lib/caffeinate/dripper/callbacks.rb

@@ -21,6 +21,14 @@ module Caffeinate
           end
         end
 
+        def before_subscribe(&block)
+          before_subscribe_blocks << block
+        end
+
+        def before_subscribe_blocks
+          @before_subscribe_blocks ||= []
+        end
+
         # Callback after a Caffeinate::CampaignSubscription is created, and after the Caffeinate::Mailings have
         # been created.
         #

data/lib/caffeinate/dripper/perform.rb

@@ -16,11 +16,7 @@ module Caffeinate
       # @return nil
       def perform!
         run_callbacks(:before_perform, self)
-        Caffeinate::Mailing
-          .upcoming
-          .unsent
-          .joins(:caffeinate_campaign_subscription)
-          .merge(Caffeinate::CampaignSubscription.active.where(caffeinate_campaign: self.campaign))
+        self.class.upcoming_mailings
           .in_batches(of: self.class.batch_size)
           .each do |batch|
           run_callbacks(:on_perform, self, batch)
@@ -35,6 +31,14 @@ module Caffeinate
         def perform!
           new.perform!
         end
+
+        def upcoming_mailings
+          Caffeinate::Mailing
+              .upcoming
+              .unsent
+              .joins(:caffeinate_campaign_subscription)
+              .merge(Caffeinate::CampaignSubscription.active.where(caffeinate_campaign: campaign))
+        end
       end
     end
   end

data/lib/caffeinate/dripper/subscriber.rb

@@ -31,10 +31,10 @@ module Caffeinate
         #
         # @return [Caffeinate::CampaignSubscriber] the created CampaignSubscriber
         def subscribe(subscriber, **args)
-          caffeinate_campaign.subscribe(subscriber, **args)
+          caffeinate_campaign.subscribe!(subscriber, **args)
         end
 
-        # Unsubscribes from the campaign.
+        # Unsubscribes from the campaign. Returns false if something's wrong.
         #
         #   OrderDripper.unsubscribe(order, user: order.user)
         #
@@ -46,6 +46,18 @@ module Caffeinate
           caffeinate_campaign.unsubscribe(subscriber, **args)
         end
 
+        # Unsubscribes from the campaign. Raises error if somerthing's wrong.
+        #
+        #   OrderDripper.unsubscribe(order, user: order.user)
+        #
+        # @param [ActiveRecord::Base] subscriber The object subscribing
+        # @option [ActiveRecord::Base] :user The associated user (optional)
+        #
+        # @return [Caffeinate::CampaignSubscriber] the CampaignSubscriber
+        def unsubscribe!(subscriber, **args)
+          caffeinate_campaign.unsubscribe!(subscriber, **args)
+        end
+
         # :nodoc:
         def subscribes_block
           raise(NotImplementedError, 'Define subscribes') unless @subscribes_block

data/lib/caffeinate/mail_ext.rb

@@ -9,6 +9,13 @@ module Mail
   class Message
     attr_accessor :caffeinate_mailing
 
+    def caffeinate_mailing=(mailing)
+      @caffeinate_mailing = mailing
+      if mailing.is_a?(::Caffeinate::Mailing)
+        header['List-Unsubscribe'] = "<#{Caffeinate::UrlHelpers.caffeinate_subscribe_url(mailing.subscription)}>"
+      end
+    end
+
     def caffeinate?
       caffeinate_mailing.present?
     end

data/lib/caffeinate/version.rb

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

data/lib/generators/caffeinate/mailer_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Caffeinate
+  module Generators
+    # Creates a mailer from a dripper.
+    class MailerGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+      include ::Rails::Generators::Migration
+      argument :dripper, banner: "dripper"
+
+      desc 'Creates a Mailer class from a dripper.'
+
+      def create_mailer
+        @dripper_klass = @dripper.safe_constantize
+        if @dripper_klass.nil?
+          raise ArgumentError, "Unknown dripper #{@dripper}"
+        end
+        @mailer_class = @dripper_klass.defaults[:mailer_class] || @dripper_klass.defaults[:mailer]
+        template 'mailer.rb', "app/mailers/#{@mailer_class.underscore}.rb"
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+class <%= @mailer_class %> < ApplicationMailer
+<% @dripper_klass.drips.each do |action| -%>
+  def <%= action.action %><% if action.options[:using].nil? %>(mailing)<% end %>
+<% if action.options[:using].nil? -%>
+    @mailing = mailing
+<% end -%>
+  end
+<% end -%>
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caffeinate
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.12.0
 platform: ruby
 authors:
 - Josh Brody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-23 00:00:00.000000000 Z
+date: 2021-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -175,8 +175,10 @@ files:
 - lib/caffeinate/url_helpers.rb
 - lib/caffeinate/version.rb
 - lib/generators/caffeinate/install_generator.rb
+- lib/generators/caffeinate/mailer_generator.rb
 - lib/generators/caffeinate/templates/application_dripper.rb
 - lib/generators/caffeinate/templates/caffeinate.rb
+- lib/generators/caffeinate/templates/mailer.rb.tt
 - lib/generators/caffeinate/views_generator.rb
 homepage: https://github.com/joshmn/caffeinate
 licenses: