caffeinate 2.0.5 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d84c243657ac1177c4f95941325ae508cd67e9a4dd1d27a7f8eb070d641ee49
-  data.tar.gz: c3541dc68d6611e673e235d9dcba55c584a1d854f1c0e38f3e379e391e88b5e1
+  metadata.gz: 6ee66cd0cefbff81f194970176755cde5fe49ccc8acd9307f3081bc13f71bd2f
+  data.tar.gz: 25380078f2edd4c8ccb7fdd4adc5903a783ce1f123ea59981def0bf5ee08698c
 SHA512:
-  metadata.gz: 1bdda981dbdec2d7b655def0cba92d475e176f22577878e4dec8f50cc48b0668bdee23d53eba0eabe800e3bb92b43b5f93493a81be744b5336e5217ff9046e4c
-  data.tar.gz: bbf2c4f17b7cee49956e7bf287497bffd653fde9920d343d75daae7c3b3a37c4ad2f2693c413b74ce9684628e0490b277b4b3b6d94feceac00c4afee9a7c6127
+  metadata.gz: 5fe9f92105e1acf59ce7f931a75a3e5d7e7a7ed5a58ee19d1b9cd1ce661c3f86011e3e910576fdad058009a8a2b2e54ab1e99eb073f11ec5a4d6bd27a9c30f47
+  data.tar.gz: 397e39515c8d7bf8e7bfb1d794b0beb434bb916af1f4ac310a027c9a9f21fb8ef0a74abf99acc53f6f59e8efd6b32ac50239e75cb329241d5d3ca8cc3a876405

data/README.md

@@ -20,7 +20,7 @@ Caffeinate is a drip email engine for managing, creating, and sending scheduled
 
 Caffeinate provides a simple DSL to create scheduled email sequences which can be used by ActionMailer without any additional configuration. 
 
-There's a cool demo with all the things included at [caffeinate.email](https://caffeinate.email). You can view the [marketing site source code here](https://github.com/joshmn/caffeinate-marketing).
+There's a cool demo app you can spin up [here](https://github.com/joshmn/caffeinate-marketing).
 
 ## Is this thing dead?
 
@@ -28,6 +28,10 @@ No! Not at all!
 
 There's not a lot of activity here because it's stable and working! I am more than happy to entertain new features.
 
+## Oh my gosh, a web UI!
+
+See https://github.com/joshmn/caffeinate-webui for an accompanying lightweight UI for simple administrative tasks and overview.
+
 ## Do you suffer from ActionMailer tragedies?
 
 If you have _anything_ like this is your codebase, **you need Caffeinate**:

data/app/controllers/caffeinate/campaign_subscriptions_controller.rb

@@ -19,11 +19,11 @@ module Caffeinate
     private
 
     def caffeinate_subscribe_url(**options)
-      Caffeinate::UrlHelpers.caffeinate_subscribe_url(@campaign_subscription, options)
+      Caffeinate::UrlHelpers.caffeinate_subscribe_url(@campaign_subscription, **options)
     end
 
     def caffeinate_unsubscribe_url(**options)
-      Caffeinate::UrlHelpers.caffeinate_unsubscribe_url(@campaign_subscription, options)
+      Caffeinate::UrlHelpers.caffeinate_unsubscribe_url(@campaign_subscription, **options)
     end
 
     def find_campaign_subscription!

data/app/models/caffeinate/campaign_subscription.rb

@@ -16,6 +16,7 @@
 #  created_at             :datetime         not null
 #  updated_at             :datetime         not null
 #
+
 module Caffeinate
   # If a record tries to be `unsubscribed!` or `ended!` or `resubscribe!` and it's in a state that is not
   # correct, raise this
@@ -59,6 +60,22 @@ module Caffeinate
 
     after_commit :on_complete, if: :completed?
 
+    # Add (new) drips to a `CampaignSubscriber`.
+    #
+    # Useful if you added new drips to a `Campaign` and have existing `CampaignSubscription`
+    # which you want to add them to.
+    #
+    # Pass `:created_at` if you want to offset `Mailing#send_at` time from the time the `CampaignSubscription`
+    # was originally created. That is to say that if you add a new drip for 5 days from now, the mailing will be sent
+    # 5 days from when the `CampaignSubscription` was created.
+    #
+    # Pass `:current` to offset from the current time (doesn't offset anything, actually)
+    def refuel!(offset: :created_at)
+      ::CampaignSubscriptions::RefuelService.new(self, offset: offset).call
+
+      true
+    end
+
     # Actually deliver and process the mail
     def deliver!(mailing)
       caffeinate_campaign.to_dripper.deliver!(mailing)

data/app/models/caffeinate/mailing.rb

@@ -32,6 +32,14 @@ module Caffeinate
 
     after_touch :end_if_no_mailings!
 
+    def self.find_or_initialize_from_drip(campaign_subscription, drip)
+      find_or_initialize_by(
+        caffeinate_campaign_subscription: campaign_subscription,
+        mailer_class: drip.options[:mailer_class],
+        mailer_action: drip.action
+      )
+    end
+
     def initialize_dup(args)
       super
       self.send_at = nil

data/app/services/campaign_subscriptions/refuel_service.rb

@@ -0,0 +1,33 @@
+module CampaignSubscriptions
+  class RefuelService
+
+    def initialize(campaign_subscription, offset: :created_at)
+      raise ArgumentError, "must be either :current or :created_at" unless [:created_at, :current].include?(offset.to_sym)
+
+      @campaign_subscription = campaign_subscription
+      @campaign = @campaign_subscription.caffeinate_campaign
+      @offset = offset.to_sym
+    end
+
+    def call
+      mailings = []
+
+      @campaign.to_dripper.drips.each do |drip|
+        mailing = Caffeinate::Mailing.find_or_initialize_from_drip(@campaign_subscription, drip)
+        if mailing.new_record?
+          mailing.send_at = drip.send_at(@campaign_subscription)
+          if @offset == :created_at
+            mailing.send_at + (Caffeinate.config.now.call - @campaign_subscription.created_at)
+          elsif @offset == :current
+            # do nothing on purpose!
+          end
+
+          mailing.save!
+          mailings << mailing
+        end
+      end
+
+      mailings
+    end
+  end
+end

data/lib/caffeinate/dripper/base.rb

@@ -9,6 +9,7 @@ require 'caffeinate/dripper/drip'
 require 'caffeinate/dripper/inferences'
 require 'caffeinate/dripper/perform'
 require 'caffeinate/dripper/periodical'
+require 'caffeinate/dripper/rescuable'
 require 'caffeinate/dripper/subscriber'
 
 module Caffeinate
@@ -24,6 +25,7 @@ module Caffeinate
       include Inferences
       include Perform
       include Periodical
+      include Rescuable
       include Subscriber
     end
   end

data/lib/caffeinate/dripper/delivery.rb

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

data/lib/caffeinate/dripper/rescuable.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Caffeinate
+  module Dripper
+    module Rescuable
+      def self.included(klass)
+        klass.include ::ActiveSupport::Rescuable
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def deliver!(mailing)
+          begin
+            super
+          rescue Exception => exception
+            if self.rescue_with_handler(exception, object: mailing)
+              return
+            end
+            raise
+          end
+        end
+      end
+    end
+  end
+end

data/lib/caffeinate/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caffeinate
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.2.0
 platform: ruby
 authors:
 - Josh Brody
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-11 00:00:00.000000000 Z
+date: 2023-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -153,6 +153,7 @@ files:
 - app/models/caffeinate/campaign.rb
 - app/models/caffeinate/campaign_subscription.rb
 - app/models/caffeinate/mailing.rb
+- app/services/campaign_subscriptions/refuel_service.rb
 - app/views/caffeinate/campaign_subscriptions/subscribe.html.erb
 - app/views/caffeinate/campaign_subscriptions/unsubscribe.html.erb
 - app/views/layouts/_caffeinate.html.erb
@@ -179,6 +180,7 @@ files:
 - lib/caffeinate/dripper/inferences.rb
 - lib/caffeinate/dripper/perform.rb
 - lib/caffeinate/dripper/periodical.rb
+- lib/caffeinate/dripper/rescuable.rb
 - lib/caffeinate/dripper/subscriber.rb
 - lib/caffeinate/dripper_collection.rb
 - lib/caffeinate/engine.rb
@@ -200,7 +202,7 @@ homepage: https://github.com/joshmn/caffeinate
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -216,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Create, manage, and send scheduled email sequences and drip campaigns from
   your Rails app.