caffeinate 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a76e8b67d3a3ab36c7805028f96cc78a7ee734afd966b27711ccbbfc18b0f8f3
-  data.tar.gz: 5aa9c1bcf06842f1def891e6ca2bd911d5e47aa0f447ace61a3a217ace84eb8a
+  metadata.gz: 3032e43fad1742429e8961a3bfca1e522c9fcf19714c8cc998d6dea629c30a6e
+  data.tar.gz: a51f59c2d0767d18002051827590d31a7ab0b96ae570a1c048d0a37ab4446007
 SHA512:
-  metadata.gz: 162f21354008999da301307dd3ef11d1a5bb3ed8232f54e6abbacf4906fcdf7aa2ad8c6a78683a5ef7816b68a99cdd98cbce1c2da20fa6b52a43543964a672f0
-  data.tar.gz: 3bd71c2357d9e0a205ad66fe524b450df54832436c2ab08f54be288ea637a9cc878e336a533d4bff7e960f3be0e6e47405a1341f2b656981791e1fd0d36dba5e
+  metadata.gz: ede225ce8d0fbb71214411d38366ea43992da7b95428734af5c4134f496c04d2dbf2b4a940f19ffbbf24dde9c4536834b96051bd493ec3476897f6f376b2324a
+  data.tar.gz: acc6124e88a4d8e6beced5afc80e7774de78b60858940e579f821ed172ad14f6a033e7b0419c105c233806f94005f98d4dab73f25bbb53e40175d7dca289c9f2

data/app/controllers/caffeinate/campaign_subscriptions_controller.rb

@@ -2,18 +2,33 @@
 
 module Caffeinate
   class CampaignSubscriptionsController < ApplicationController
+    layout 'caffeinate'
+
+    helper_method :caffeinate_unsubscribe_url, :caffeinate_subscribe_url
+
     before_action :find_campaign_subscription!
 
     def unsubscribe
       @campaign_subscription.unsubscribe!
-      render plain: 'You have been unsubscribed.'
+    end
+
+    def subscribe
+      @campaign_subscription.subscribe!
     end
 
     private
 
+    def caffeinate_subscribe_url(**options)
+      Caffeinate::UrlHelpers.caffeinate_subscribe_url(@campaign_subscription, options)
+    end
+
+    def caffeinate_unsubscribe_url
+      Caffeinate::UrlHelpers.caffeinate_unsubscribe_url(@campaign_subscription, options)
+    end
+
     def find_campaign_subscription!
       @campaign_subscription = ::Caffeinate::CampaignSubscription.find_by(token: params[:token])
-      return render plain: '404' if @campaign_subscription.nil?
+      raise ::ActiveRecord::RecordNotFound if @campaign_subscription.nil?
     end
   end
 end

data/app/models/caffeinate/campaign.rb

@@ -1,7 +1,17 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: caffeinate_campaigns
+#
+#  id         :integer          not null, primary key
+#  name       :string           not null
+#  slug       :string           not null
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
 module Caffeinate
-  # Campaign.
+  # Campaign ties together subscribers and mailings, and provides one core model for handling your Drippers.
   class Campaign < ApplicationRecord
     self.table_name = 'caffeinate_campaigns'
     has_many :caffeinate_campaign_subscriptions, class_name: 'Caffeinate::CampaignSubscription', foreign_key: :caffeinate_campaign_id

data/app/models/caffeinate/campaign_subscription.rb

@@ -1,12 +1,29 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: caffeinate_campaign_subscriptions
+#
+#  id                     :integer          not null, primary key
+#  caffeinate_campaign_id :integer          not null
+#  subscriber_type        :string           not null
+#  subscriber_id          :string           not null
+#  user_type              :string
+#  user_id                :string
+#  token                  :string           not null
+#  ended_at               :datetime
+#  unsubscribed_at        :datetime
+#  created_at             :datetime         not null
+#  updated_at             :datetime         not null
+#
 module Caffeinate
-  # CampaignSubscription associates an object and its optional user to a Campaign.
+  # CampaignSubscription associates an object and its optional user to a Campaign
+  # and its relevant Mailings.
   class CampaignSubscription < ApplicationRecord
     self.table_name = 'caffeinate_campaign_subscriptions'
 
     has_many :caffeinate_mailings, class_name: 'Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
-    has_one :next_caffeinate_mailing, -> { upcoming.unsent.limit(1).first }, class_name: 'Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
+    has_one :next_caffeinate_mailing, -> { upcoming.unsent.limit(1).first }, class_name: '::Caffeinate::Mailing', foreign_key: :caffeinate_campaign_subscription_id
     belongs_to :caffeinate_campaign, class_name: 'Caffeinate::Campaign', foreign_key: :caffeinate_campaign_id
     belongs_to :subscriber, polymorphic: true
     belongs_to :user, polymorphic: true, optional: true
@@ -37,12 +54,12 @@ module Caffeinate
       !ended? && !unsubscribed?
     end
 
-    # Checks if the CampaignSubscription is not subscribed
+    # Checks if the CampaignSubscription is not subscribed by checking the presence of `unsubscribed_at`
     def unsubscribed?
-      !subscribed?
+      unsubscribed_at.present?
     end
 
-    # Checks if the CampaignSubscription is ended
+    # Checks if the CampaignSubscription is ended by checking the presence of `ended_at`
     def ended?
       ended_at.present?
     end

data/app/models/caffeinate/mailing.rb

@@ -1,8 +1,24 @@
 # frozen_string_literal: true
 
+# == Schema Information
+#
+# Table name: caffeinate_mailings
+#
+#  id                                  :integer          not null, primary key
+#  caffeinate_campaign_subscription_id :integer          not null
+#  send_at                             :datetime
+#  sent_at                             :datetime
+#  skipped_at                          :datetime
+#  mailer_class                        :string           not null
+#  mailer_action                       :string           not null
+#  created_at                          :datetime         not null
+#  updated_at                          :datetime         not null
+#
 module Caffeinate
   # Records of the mails sent and to be sent for a given `::Caffeinate::CampaignSubscriber`
   class Mailing < ApplicationRecord
+    CURRENT_THREAD_KEY = :current_caffeinate_mailing.freeze
+
     self.table_name = 'caffeinate_mailings'
 
     belongs_to :caffeinate_campaign_subscription, class_name: 'Caffeinate::CampaignSubscription'
@@ -49,7 +65,7 @@ module Caffeinate
     # The associated drip
     # @todo This can be optimized with a better cache
     def drip
-      @drip ||= caffeinate_campaign.to_dripper.drips.find { |drip| drip.action.to_s == mailer_action }
+      @drip ||= caffeinate_campaign.to_dripper.drip_collection[mailer_action]
     end
 
     # The associated Subscriber from `::Caffeinate::CampaignSubscription`
@@ -64,7 +80,7 @@ module Caffeinate
 
     # Assigns attributes to the Mailing from the Drip
     def from_drip(drip)
-      self.send_at = drip.options[:delay].from_now
+      self.send_at = drip.send_at
       self.mailer_class = drip.options[:mailer_class]
       self.mailer_action = drip.action
       self

data/app/views/caffeinate/campaign_subscriptions/subscribe.html.erb

@@ -0,0 +1,3 @@
+<%= t("caffeinate.campaign_subscriptions.subscribe") %>
+<p><%= t("caffeinate.campaign_subscriptions.changed_your_mind")%></p>
+<p><%= link_to "Unsubscribe", caffeinate_subscribe_url %></p>

data/app/views/caffeinate/campaign_subscriptions/unsubscribe.html.erb

@@ -0,0 +1,3 @@
+<h5><%= t("caffeinate.campaign_subscriptions.unsubscribe")%></h5>
+<p><%= t("caffeinate.campaign_subscriptions.changed_your_mind")%></p>
+<p><%= link_to "Resubscribe", caffeinate_subscribe_url %></p>

data/app/views/layouts/caffeinate.html.erb

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= Rails.application.class.module_parent_name %></title>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  caffeinate:
+    campaign_subscriptions:
+      subscribe: "You have been subscribed."
+      unsubscribe: "You have been unsubscribed."
+      changed_your_mind: "Change your mind?"

data/lib/caffeinate.rb

@@ -3,6 +3,7 @@
 require 'rails/all'
 require 'caffeinate/engine'
 require 'caffeinate/drip'
+require 'caffeinate/url_helpers'
 require 'caffeinate/configuration'
 require 'caffeinate/dripper/base'
 require 'caffeinate/deliver_async'

data/lib/caffeinate/action_mailer/extension.rb

@@ -5,8 +5,18 @@ module Caffeinate
     module Extension
       def self.included(klass)
         klass.before_action do
-          @mailing = Thread.current[:current_caffeinate_mailing] if Thread.current[:current_caffeinate_mailing]
+          @mailing = Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY] if Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY]
         end
+
+        klass.helper_method :caffeinate_unsubscribe_url, :caffeinate_subscribe_url
+      end
+
+      def caffeinate_unsubscribe_url(**options)
+        Caffeinate::UrlHelpers.caffeinate_unsubscribe_url(@mailing.caffeinate_campaign_subscription, **options)
+      end
+
+      def caffeinate_subscribe_url
+        Caffeinate::UrlHelpers.caffeinate_subscribe_url(@mailing.caffeinate_campaign_subscription, **options)
       end
     end
   end

data/lib/caffeinate/action_mailer/interceptor.rb

@@ -5,7 +5,7 @@ module Caffeinate
     class Interceptor
       # Handles `before_send` callbacks for a `Caffeinate::Dripper`
       def self.delivering_email(message)
-        mailing = Thread.current[:current_caffeinate_mailing]
+        mailing = Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY]
         return unless mailing
 
         mailing.caffeinate_campaign.to_dripper.run_callbacks(:before_send, mailing.caffeinate_campaign_subscription, mailing, message)

data/lib/caffeinate/action_mailer/observer.rb

@@ -2,14 +2,14 @@
 
 module Caffeinate
   module ActionMailer
-    # Handles updating the Caffeinate::Message if it's available in Thread.current[:current_caffeinate_mailing]
+    # Handles updating the Caffeinate::Message if it's available in Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY]
     # and runs any associated callbacks
     class Observer
       def self.delivered_email(message)
-        mailing = Thread.current[:current_caffeinate_mailing]
+        mailing = Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY]
         return unless mailing
 
-        mailing.update!(sent_at: Caffeinate.config.time_now) if message.perform_deliveries
+        mailing.update!(sent_at: Caffeinate.config.time_now, skipped_at: nil) if message.perform_deliveries
         mailing.caffeinate_campaign.to_dripper.run_callbacks(:after_send, mailing.caffeinate_campaign_subscription, mailing, message)
       end
     end

data/lib/caffeinate/active_record/extension.rb

@@ -9,7 +9,7 @@ module Caffeinate
         has_many :caffeinate_campaigns, through: :caffeinate_campaign_subscriptions, class_name: '::Caffeinate::Campaign'
         has_many :caffeinate_mailings, through: :caffeinate_campaign_subscriptions, class_name: '::Caffeinate::Mailing'
 
-        scope :not_subscribed_to, lambda { |list|
+        scope :not_subscribed_to_campaign, lambda { |list|
           subscribed = ::Caffeinate::CampaignSubscription.select(:subscriber_id).joins(:caffeinate_campaign).where(caffeinate_campaigns: { slug: list }, subscriber_type: name)
           where.not(id: subscribed)
         }

data/lib/caffeinate/drip.rb

@@ -1,40 +1,11 @@
 # frozen_string_literal: true
 
+require 'caffeinate/drip_evaluator'
 module Caffeinate
   # A Drip object
+  #
+  # Handles the block and provides convenience methods for the drip
   class Drip
-    # Handles the block and provides convenience methods for the drip
-    class Evaluator
-      attr_reader :mailing
-      def initialize(mailing)
-        @mailing = mailing
-      end
-
-      def call(&block)
-        return true unless block
-
-        instance_eval(&block)
-      end
-
-      # Ends the CampaignSubscription
-      def end!
-        mailing.caffeinate_campaign_subscription.end!
-        false
-      end
-
-      # Unsubscribes the CampaignSubscription
-      def unsubscribe!
-        mailing.caffeinate_campaign_subscription.unsubscribe!
-        false
-      end
-
-      # Skips the mailing
-      def skip!
-        mailing.skip!
-        false
-      end
-    end
-
     attr_reader :dripper, :action, :options, :block
     def initialize(dripper, action, options, &block)
       @dripper = dripper
@@ -43,14 +14,18 @@ module Caffeinate
       @block = block
     end
 
-    # If the associated ActionMailer uses `ActionMailer::Parameterized` initialization
+    # If the associated ActionMailer uses `ActionMailer::Parameterized` initialization instead of argument-based initialization
     def parameterized?
       options[:using] == :parameterized
     end
 
-    # If the drip is enabled.
+    def send_at
+      options[:delay].from_now
+    end
+
+    # Checks if the drip is enabled
     def enabled?(mailing)
-      Evaluator.new(mailing).call(&@block)
+      DripEvaluator.new(mailing).call(&@block)
     end
   end
 end

data/lib/caffeinate/drip_evaluator.rb

@@ -0,0 +1,33 @@
+module Caffeinate
+  # Handles evaluating the `drip` block and provides convenience methods for handling the mailing or its campaign.
+  class DripEvaluator
+    attr_reader :mailing
+    def initialize(mailing)
+      @mailing = mailing
+    end
+
+    def call(&block)
+      return true unless block
+
+      instance_eval(&block)
+    end
+
+    # Ends the CampaignSubscription
+    def end!
+      mailing.caffeinate_campaign_subscription.end!
+      false
+    end
+
+    # Unsubscribes the CampaignSubscription
+    def unsubscribe!
+      mailing.caffeinate_campaign_subscription.unsubscribe!
+      false
+    end
+
+    # Skips the mailing
+    def skip!
+      mailing.skip!
+      false
+    end
+  end
+end

data/lib/caffeinate/dripper/base.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'caffeinate/dripper/drip'
+require 'caffeinate/dripper/inferences'
 require 'caffeinate/dripper/callbacks'
 require 'caffeinate/dripper/defaults'
 require 'caffeinate/dripper/subscriber'
@@ -16,18 +17,9 @@ module Caffeinate
       include Defaults
       include Delivery
       include Drip
+      include Inferences
       include Perform
       include Subscriber
-
-      # The inferred mailer class
-      def self.inferred_mailer_class
-        klass_name = "#{name.delete_suffix('Dripper')}Mailer"
-        klass = klass_name.safe_constantize
-        return nil unless klass
-        return klass_name if klass < ::ActionMailer::Base
-
-        nil
-      end
     end
   end
 end

data/lib/caffeinate/dripper/campaign.rb

@@ -45,7 +45,7 @@ module Caffeinate
 
         # The defined slug or the inferred slug
         def campaign_slug
-          @_campaign_slug || name.delete_suffix('Campaign')
+          @_campaign_slug || inferred_campaign_slug
         end
       end
     end

data/lib/caffeinate/dripper/delivery.rb

@@ -14,7 +14,7 @@ module Caffeinate
         #
         # @param [Caffeinate::Mailing] mailing The mailing to deliver
         def deliver!(mailing)
-          Thread.current[:current_caffeinate_mailing] = mailing
+          Thread.current[::Caffeinate::Mailing::CURRENT_THREAD_KEY] = mailing
 
           if mailing.drip.parameterized?
             mailing.mailer_class.constantize.with(mailing: mailing).send(mailing.mailer_action).deliver

data/lib/caffeinate/dripper/drip.rb

@@ -10,21 +10,29 @@ module Caffeinate
 
         def initialize(dripper)
           @dripper = dripper
-          @drips = []
+          @drips = {}
         end
 
         # Register the drip
         def register(action, options, &block)
-          @drips << ::Caffeinate::Drip.new(@dripper, action, options, &block)
+          @drips[action.to_s] = ::Caffeinate::Drip.new(@dripper, action, options, &block)
         end
 
         def each(&block)
-          @drips.each { |drip| block.call(drip) }
+          @drips.each { |action_name, drip| block.call(action_name, drip) }
+        end
+
+        def values
+          @drips.values
         end
 
         def size
           @drips.size
         end
+
+        def [](val)
+          @drips[val]
+        end
       end
 
       # :nodoc:
@@ -33,9 +41,14 @@ module Caffeinate
       end
 
       module ClassMethods
+        # A collection of Drip objects associated with a given `Caffeinate::Dripper`
+        def drip_collection
+          @drip_collection ||= DripCollection.new(self)
+        end
+
         # A collection of Drip objects associated with a given `Caffeinate::Dripper`
         def drips
-          @drips ||= DripCollection.new(self)
+          drip_collection.values
         end
 
         # Register a drip on the Dripper
@@ -58,7 +71,7 @@ module Caffeinate
           end
           raise ArgumentError, "You must define :delay in the options for :#{action_name}" if options[:delay].nil?
 
-          drips.register(action_name, options, &block)
+          drip_collection.register(action_name, options, &block)
         end
       end
     end

data/lib/caffeinate/dripper/inferences.rb

@@ -0,0 +1,26 @@
+module Caffeinate
+  module Dripper
+    module Inferences
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        # The inferred mailer class
+        def inferred_mailer_class
+          klass_name = "#{name.delete_suffix('Dripper')}Mailer"
+          klass = klass_name.safe_constantize
+          return nil unless klass
+          return klass_name if klass < ::ActionMailer::Base
+
+          nil
+        end
+
+        # The inferred mailer class
+        def inferred_campaign_slug
+          "#{name.delete_suffix('Dripper')}".underscore
+        end
+      end
+    end
+  end
+end

data/lib/caffeinate/dripper/perform.rb

@@ -15,8 +15,10 @@ module Caffeinate
       #
       # @return nil
       def perform!
-        campaign.caffeinate_campaign_subscriptions.joins(:next_caffeinate_mailing).includes(:next_caffeinate_mailing).each do |subscriber|
-          subscriber.next_caffeinate_mailing.process!
+        campaign.caffeinate_campaign_subscriptions.active.includes(:next_caffeinate_mailing).each do |subscriber|
+          if subscriber.next_caffeinate_mailing
+           subscriber.next_caffeinate_mailing.process!
+          end
         end
         true
       end

data/lib/caffeinate/engine.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'caffeinate/helpers'
 require 'caffeinate/action_mailer'
 require 'caffeinate/active_record/extension'
 
@@ -8,22 +9,24 @@ module Caffeinate
   class Engine < ::Rails::Engine
     isolate_namespace Caffeinate
 
+    config.to_prepare do
+      Dir.glob(Rails.root.join("app/drippers/**/*.rb")).each do |file|
+        require file
+      end
+    end
+
     ActiveSupport.on_load(:action_mailer) do
       include ::Caffeinate::ActionMailer::Extension
       ::ActionMailer::Base.register_interceptor(::Caffeinate::ActionMailer::Interceptor)
       ::ActionMailer::Base.register_observer(::Caffeinate::ActionMailer::Observer)
     end
 
-    unless config.eager_load
-      config.to_prepare do
-        Dir.glob("#{Rails.root}/app/drippers/**/*.rb").each do |f|
-          require f
-        end
-      end
-    end
-
     ActiveSupport.on_load(:active_record) do
       extend ::Caffeinate::ActiveRecord::Extension
     end
+
+    ActiveSupport.on_load(:action_view) do
+      ApplicationHelper.send(:include, ::Caffeinate::Helpers)
+    end
   end
 end

data/lib/caffeinate/helpers.rb

@@ -0,0 +1,21 @@
+module Caffeinate
+  module Helpers
+    def caffeinate_unsubscribe_url(subscription, **options)
+      opts = (::ActionMailer::Base.default_url_options || {}).merge(options)
+      Caffeinate::Engine.routes.url_helpers.unsubscribe_campaign_subscription_url(token: subscription.token, **opts)
+    end
+
+    def caffeinate_subscribe_url(subscription, **options)
+      opts = (::ActionMailer::Base.default_url_options || {}).merge(options)
+      Caffeinate::Engine.routes.url_helpers.subscribe_campaign_subscription_url(token: subscription.token, **opts)
+    end
+
+    def caffeinate_unsubscribe_path(subscription, **options)
+      Caffeinate::Engine.routes.url_helpers.unsubscribe_campaign_subscription_path(token: subscription.token, **options)
+    end
+
+    def caffeinate_subscribe_path(subscription, **options)
+      Caffeinate::Engine.routes.url_helpers.subscribe_campaign_subscription_path(token: subscription.token, **options)
+    end
+  end
+end

data/lib/caffeinate/url_helpers.rb

@@ -0,0 +1,7 @@
+require 'caffeinate/helpers'
+
+module Caffeinate
+  class UrlHelpers
+    extend Helpers
+  end
+end

data/lib/caffeinate/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caffeinate
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Josh Brody
@@ -124,8 +124,10 @@ files:
 - app/models/caffeinate/campaign.rb
 - app/models/caffeinate/campaign_subscription.rb
 - app/models/caffeinate/mailing.rb
-- app/views/layouts/caffeinate/application.html.erb
-- app/views/layouts/caffeinate/campaign_subscriptions/unsubscribe.html.erb
+- app/views/caffeinate/campaign_subscriptions/subscribe.html.erb
+- app/views/caffeinate/campaign_subscriptions/unsubscribe.html.erb
+- 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
@@ -140,15 +142,19 @@ files:
 - lib/caffeinate/configuration.rb
 - lib/caffeinate/deliver_async.rb
 - lib/caffeinate/drip.rb
+- lib/caffeinate/drip_evaluator.rb
 - lib/caffeinate/dripper/base.rb
 - lib/caffeinate/dripper/callbacks.rb
 - lib/caffeinate/dripper/campaign.rb
 - lib/caffeinate/dripper/defaults.rb
 - lib/caffeinate/dripper/delivery.rb
 - lib/caffeinate/dripper/drip.rb
+- lib/caffeinate/dripper/inferences.rb
 - lib/caffeinate/dripper/perform.rb
 - lib/caffeinate/dripper/subscriber.rb
 - lib/caffeinate/engine.rb
+- lib/caffeinate/helpers.rb
+- lib/caffeinate/url_helpers.rb
 - lib/caffeinate/version.rb
 - lib/generators/caffeinate/install_generator.rb
 - lib/generators/caffeinate/templates/application_dripper.rb

data/app/views/layouts/caffeinate/application.html.erb

@@ -1,15 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Caffeinate</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%= stylesheet_link_tag    "caffeinate/application", media: "all" %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/app/views/layouts/caffeinate/campaign_subscriptions/unsubscribe.html.erb

@@ -1 +0,0 @@
-<h5>You have been unsubscribed.</h5>