caffeinate 0.8.2 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 855b98e11499fe2a9fbf1e589530d60d511363e55ea80cdf1b4322dc92af1f3c
-  data.tar.gz: ca000ad1c32cb053901e3f69dcc370725044c3529c673839c3f4ef9b43dc5505
+  metadata.gz: '095e6f42c70709ca95a941768e06cc69a2f3d0da75d85f281ca238e68582b991'
+  data.tar.gz: f79889cab476a10cb3c4d284280aa438a505fb8824426a1fca838c74497dcc45
 SHA512:
-  metadata.gz: 1d8e13de2b19eb8d7a628ae2e5ca9e0bca0d985f36629994257775a2d3b7b5b0641584fc349929ac6930e65fd6a4958556dbd0ab3604600a37c5879858657720
-  data.tar.gz: 999a9e763d4e1b7f96a5549f61eca6c0c1e2029e346dadea08281eb00c754ed2ccd1022dcdcbf13b315572446bf1eb5d699dde802604cc441f897cdac5fe5256
+  metadata.gz: '098c9a44b05d586a9a80c300d65ec0e9e40b23674bc9b079566cdd30835f3f4c42f0a272a38658b4c5e206d16bb082e47bc89cfc63ff6cb1724de1f4514a54ac'
+  data.tar.gz: 0f63cdd8db2b88ad13a1e8ab7424b7c30c77f8eb623d50f7bfb856f7b36be8b2c9feb15b5e076062a1ddf1e2ad3d29fb9829204845b9b98fb9780571041226fd

data/app/models/caffeinate/campaign.rb

@@ -56,7 +56,15 @@ module Caffeinate
     def unsubscribe(subscriber, **args)
       reason = args.delete(:reason)
       subscription = subscriber(subscriber, **args)
-      raise ActiveRecord::RecordInvalid, subscription if subscription.nil?
+      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?
 
       subscription.unsubscribe!(reason)
     end
@@ -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

@@ -12,25 +12,28 @@ module Caffeinate
     def call(&block)
       return true unless block
 
-      instance_eval(&block)
+      catch(:abort) do
+        return instance_eval(&block)
+      end
+      false
     end
 
     # Ends the CampaignSubscription
-    def end!
-      mailing.caffeinate_campaign_subscription.end!
-      false
+    def end!(*args)
+      mailing.caffeinate_campaign_subscription.end!(*args)
+      throw(:abort)
     end
 
     # Unsubscribes the CampaignSubscription
-    def unsubscribe!
-      mailing.caffeinate_campaign_subscription.unsubscribe!
-      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/perform.rb

@@ -20,7 +20,7 @@ module Caffeinate
           .upcoming
           .unsent
           .joins(:caffeinate_campaign_subscription)
-          .merge(Caffeinate::CampaignSubscription.active)
+          .merge(Caffeinate::CampaignSubscription.active.where(caffeinate_campaign: self.campaign))
           .in_batches(of: self.class.batch_size)
           .each do |batch|
           run_callbacks(:on_perform, self, batch)

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.2'
+  VERSION = '0.9.2'
 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

data/lib/generators/caffeinate/views_generator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module Caffeinate
+  module Generators
+    module ViewPathTemplates #:nodoc:
+      extend ActiveSupport::Concern
+
+      included do
+        public_task :copy_views
+      end
+
+      def copy_views
+        view_directory :campaign_subscriptions
+      end
+
+      protected
+
+      def view_directory(name, _target_path = nil)
+        directory name.to_s, _target_path || "#{target_path}/#{name}" do |content|
+          content
+        end
+      end
+
+      def target_path
+        @target_path ||= "app/views/caffeinate"
+      end
+    end
+
+    class SharedViewsGenerator < Rails::Generators::Base #:nodoc:
+      include ViewPathTemplates
+      source_root File.expand_path("../../../../app/views/caffeinate", __FILE__)
+      desc "Copies shared Caffeinate views to your application."
+      hide!
+    end
+
+    class ViewsGenerator < Rails::Generators::Base
+      desc "Copies Caffeinate views to your application."
+
+      invoke SharedViewsGenerator
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caffeinate
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.2
 platform: ruby
 authors:
 - Josh Brody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-17 00:00:00.000000000 Z
+date: 2020-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -175,8 +175,11 @@ 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:
 - MIT