caffeinate 0.8.4 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a1b112ae3aa4c5c0d6f5d0754dffe6fc720c025739d3b78487b78754b4bd8fb
-  data.tar.gz: a7ede18dbf114ebf23c3c6eba347b60524963574a921687ffba1943885055777
+  metadata.gz: 3f6b38c582c7ac99605a366b1217a973ebea58dad20cc60e4dd4a0f555da7474
+  data.tar.gz: a975e28f6386905c9e776cf2cc1dcb835054f0200d91fce9554d5c1f4bcdfd9b
 SHA512:
-  metadata.gz: 83efe161d7aa1885ebd1080b1fe640ea87e21b9dd1dbf494998b361a4ae6f1188a23a4aa509766edec90eabea2fbc9b08d6f8b305592cbaeeaf38343737e16ef
-  data.tar.gz: 4c42564577a0321ad57cf7a052645a2ea3fe2670e701789dfb123a1801e95a98dc3754602d318b9d341921b1f41c47cc03d8bfd1a678d4ef3e3b0317d32e29c6
+  metadata.gz: dd713236a833425f2a17d8c455fadaec49ba60bf17083c4bd879aa343611d30793e6aaef0e70db5e6cae3e760beec69ea41bdb2e38881ec2ecaabdb00c9c28a7
+  data.tar.gz: 935e59b886250e6b216535f236241221f313eefe304b9a588f0c42384d0236335e8da0fef7f71421dd80bef4e3fd114729153766c1d52bc95f4c760d681ba2c9

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

@@ -30,7 +30,7 @@ module Caffeinate
     has_many :mailings, class_name: 'Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id, dependent: :destroy
 
     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_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
@@ -83,6 +83,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 +103,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,6 +125,18 @@ 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

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!(**args)
-      mailing.caffeinate_campaign_subscription.end!(**args)
-      false
+    def end!(*args)
+      mailing.caffeinate_campaign_subscription.end!(*args)
+      throw(:abort)
     end
 
     # Unsubscribes the CampaignSubscription
-    def unsubscribe!(**args)
-      mailing.caffeinate_campaign_subscription.unsubscribe!(**args)
-      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/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.4'
+  VERSION = '0.10.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.4
+  version: 0.10.0
 platform: ruby
 authors:
 - Josh Brody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-23 00:00:00.000000000 Z
+date: 2020-12-26 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: