caffeinate 0.1.0

data/lib/caffeinate/dripper/campaign.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Caffeinate
+  module Dripper
+    module Campaign
+      # :nodoc:
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      # The campaign for this Dripper
+      #
+      # @return Caffeinate::Campaign
+      def campaign
+        self.class.caffeinate_campaign
+      end
+
+      module ClassMethods
+        # Sets the campaign on the Dripper and resets any existing `@caffeinate_campaign`
+        #
+        #   class OrdersDripper
+        #     campaign :order_drip
+        #   end
+        #
+        # If this is not explicitly set, we will infer it with
+        #
+        #   self.name.delete_suffix("Campaign").underscore
+        #
+        # @param [Symbol] slug The slug of a persisted `Caffeinate::Campaign`.
+        def campaign(slug)
+          @caffeinate_campaign = nil
+          @_campaign_slug = slug.to_sym
+          Caffeinate.register_dripper(@_campaign_slug, name)
+        end
+
+        # Returns the `Caffeinate::Campaign` object for the Campaign
+        def caffeinate_campaign
+          return @caffeinate_campaign if @caffeinate_campaign.present?
+
+          @caffeinate_campaign = ::Caffeinate::Campaign.find_by(slug: campaign_slug)
+          return @caffeinate_campaign if @caffeinate_campaign
+
+          raise(::ActiveRecord::RecordNotFound, "Unable to find ::Caffeinate::Campaign with slug #{campaign_slug}.")
+        end
+
+        # The defined slug or the inferred slug
+        def campaign_slug
+          @_campaign_slug || name.delete_suffix('Campaign')
+        end
+      end
+    end
+  end
+end

data/lib/caffeinate/dripper/defaults.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Caffeinate
+  module Dripper
+    module Defaults
+      # :nodoc:
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        # The defaults set in the Campaign
+        def defaults
+          @defaults ||= { mailer_class: inferred_mailer_class }
+        end
+
+        # The default options for the Campaign
+        #
+        #   class OrderCampaign
+        #     default mailer_class: "OrdersMailer"
+        #   end
+        #
+        # @param [Hash] options The options to set defaults with
+        # @option options [String] :mailer_class The mailer class
+        def default(options = {})
+          options.assert_valid_keys(:mailer_class, :mailer)
+          @defaults = options
+        end
+      end
+    end
+  end
+end

data/lib/caffeinate/dripper/delivery.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Caffeinate
+  module Dripper
+    # Handles delivery of a Caffeinate::Mailer for a Caffeinate::Dripper
+    module Delivery
+      # :nodoc:
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        # Delivers the given Caffeinate::Mailing
+        #
+        # @param [Caffeinate::Mailing] mailing The mailing to deliver
+        def deliver!(mailing)
+          Thread.current[:current_caffeinate_mailing] = mailing
+
+          if mailing.drip.parameterized?
+            mailing.mailer_class.constantize.with(mailing: mailing).send(mailing.mailer_action).deliver
+          else
+            mailing.mailer_class.constantize.send(mailing.mailer_action, mailing).deliver
+          end
+        end
+      end
+    end
+  end
+end

data/lib/caffeinate/dripper/drip.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Caffeinate
+  module Dripper
+    # The Drip DSL for registering a drip
+    module Drip
+      # A collection of Drip objects for a `Caffeinate::Dripper`
+      class DripCollection
+        include Enumerable
+
+        def initialize(dripper)
+          @dripper = dripper
+          @drips = []
+        end
+
+        # Register the drip
+        def register(action, options, &block)
+          @drips << ::Caffeinate::Drip.new(@dripper, action, options, &block)
+        end
+
+        def each(&block)
+          @drips.each { |drip| block.call(drip) }
+        end
+
+        def size
+          @drips.size
+        end
+      end
+
+      # :nodoc:
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        # A collection of Drip objects associated with a given `Caffeinate::Dripper`
+        def drips
+          @drips ||= DripCollection.new(self)
+        end
+
+        # Register a drip on the Dripper
+        #
+        #   drip :mailer_action_name, mailer_class: "MailerClass", step: 1, delay: 1.hour
+        #
+        # @param action_name [Symbol] the name of the mailer action
+        # @param [Hash] options the options to create a drip with
+        # @option options [String] :mailer_class The mailer_class
+        # @option options [Integer] :step The order in which the drip is executed
+        # @option options [ActiveSupport::Duration] :delay When the drip should be ran
+        def drip(action_name, options = {}, &block)
+          options.assert_valid_keys(:mailer_class, :step, :delay, :using, :mailer)
+          options[:mailer_class] ||= options[:mailer] || defaults[:mailer_class]
+          options[:step] ||= drips.size + 1
+
+          if options[:mailer_class].nil?
+            raise ArgumentError, "You must define :mailer_class or :mailer in the options for :#{action_name}"
+          end
+          raise ArgumentError, "You must define :delay in the options for :#{action_name}" if options[:delay].nil?
+
+          drips.register(action_name, options, &block)
+        end
+      end
+    end
+  end
+end

data/lib/caffeinate/dripper/perform.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Caffeinate
+  module Dripper
+    # Handles delivering a `Caffeinate::Mailing` for the `Caffeinate::Dripper`
+    module Perform
+      # :nodoc:
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      # Delivers the next_caffeinate_mailer for the campaign's subscribers.
+      #
+      #   OrderDripper.new.perform!
+      #
+      # @return nil
+      def perform!
+        campaign.caffeinate_campaign_subscriptions.joins(:next_caffeinate_mailing).includes(:next_caffeinate_mailing).each do |subscriber|
+          subscriber.next_caffeinate_mailing.process!
+        end
+        true
+      end
+
+      module ClassMethods
+        # Convenience method for Dripper::Base#perform
+        def perform!
+          new.perform!
+        end
+      end
+    end
+  end
+end

data/lib/caffeinate/dripper/subscriber.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Caffeinate
+  module Dripper
+    # Handles subscribing records to a campaign.
+    module Subscriber
+      # :nodoc:
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        # Runs the subscriber_block
+        #
+        #   OrderDripper.subscribe!
+        def subscribe!
+          subscribes_block.call
+        end
+
+        # Returns the campaign's `Caffeinate::CampaignSubscriber`
+        def subscribers
+          caffeinate_campaign.caffeinate_campaign_subscribers
+        end
+
+        # Subscribes to the campaign.
+        #
+        #   OrderDripper.subscribe(order, user: order.user)
+        #
+        # @param [ActiveRecord::Base] subscriber The object subscribing
+        # @option [ActiveRecord::Base] :user The associated user (optional)
+        #
+        # @return [Caffeinate::CampaignSubscriber] the created CampaignSubscriber
+        def subscribe(subscriber, user:)
+          caffeinate_campaign.subscribe(subscriber, user: user)
+        end
+
+        # :nodoc:
+        def subscribes_block
+          raise(NotImplementedError, 'Define subscribes') unless @subscribes_block
+
+          @subscribes_block
+        end
+
+        # The subscriber block. Used to create `::Caffeinate::CampaignSubscribers` subscribers.
+        #
+        #   subscribes do
+        #     Cart.left_joins(:cart_items)
+        #         .includes(:user)
+        #         .where(completed_at: nil)
+        #         .where(updated_at: 1.day.ago..2.days.ago)
+        #         .having('count(cart_items.id) > 0').each do |cart|
+        #       subscribe(cart, user: cart.user)
+        #     end
+        #   end
+        #
+        # No need to worry about checking if the given subscriber being already subscribed.
+        # The `subscribe` method does that for you.
+        #
+        # Optionally, can subscribe a user manually via `Caffeinate::Campaign#subscribe`
+        def subscribes(&block)
+          @subscribes_block = block
+        end
+      end
+    end
+  end
+end

data/lib/caffeinate/engine.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'caffeinate/action_mailer'
+require 'caffeinate/active_record/extension'
+
+module Caffeinate
+  # :nodoc:
+  class Engine < ::Rails::Engine
+    isolate_namespace Caffeinate
+
+    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
+
+    ActiveSupport.on_load(:active_record) do
+      extend ::Caffeinate::ActiveRecord::Extension
+    end
+  end
+end

data/lib/caffeinate/version.rb

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

data/lib/generators/caffeinate/install_generator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Caffeinate
+  module Generators
+    # :nodoc:
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+      include ::Rails::Generators::Migration
+
+      desc 'Creates a Caffeinate initializer and copies migrations to your application.'
+
+      # :nodoc:
+      def copy_initializer
+        template 'caffeinate.rb', 'config/initializers/caffeinate.rb'
+      end
+
+      # :nodoc:
+      def copy_application_campaign
+        template 'application_dripper.rb', 'app/drippers/application_dripper.rb'
+      end
+
+      # :nodoc:
+      def self.next_migration_number(_path)
+        if @prev_migration_nr
+          @prev_migration_nr += 1
+        else
+          @prev_migration_nr = Time.now.utc.strftime('%Y%m%d%H%M%S').to_i
+        end
+        @prev_migration_nr.to_s
+      end
+
+      # :nodoc:
+      def copy_migrations
+        require 'rake'
+        Rails.application.load_tasks
+        Rake::Task['railties:install:migrations'].reenable
+        Rake::Task['caffeinate:install:migrations'].invoke
+      end
+    end
+  end
+end

data/lib/generators/caffeinate/templates/application_campaign.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationDripper < ::Caffeinate::Dripper::Base
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+Caffeinate.setup do |config|
+  # == Current time
+  #
+  # Used for when we set a datetime column to "now" in the database
+  #
+  # Default:
+  #   -> { Time.current }
+  #
+  # config.now = -> { DateTime.now }
+  #
+  # == Mailer delivery
+  #
+  # If you want to handle delivery of individual mails in the background. See lib/caffeinate/deliver_async.rb for
+  # implementation details
+  #
+  # Default:
+  #   config.async_delivery = false
+  #   config.mailing_job = nil
+  #
+  # config.async_delivery = true
+  # config.mailing_job = 'MyCustomCaffeinateJob'
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: caffeinate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Brody
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.4
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Opinionated drip campaign framework.
+email:
+- josh@josh.mn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/caffeinate/application_controller.rb
+- app/controllers/caffeinate/campaign_subscriptions_controller.rb
+- app/models/caffeinate/application_record.rb
+- 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
+- config/routes.rb
+- db/migrate/20201124183102_create_caffeinate_campaigns.rb
+- db/migrate/20201124183303_create_caffeinate_campaign_subscriptions.rb
+- db/migrate/20201124183419_create_caffeinate_mailings.rb
+- lib/caffeinate.rb
+- lib/caffeinate/action_mailer.rb
+- lib/caffeinate/action_mailer/extension.rb
+- lib/caffeinate/action_mailer/helpers.rb
+- lib/caffeinate/action_mailer/interceptor.rb
+- lib/caffeinate/action_mailer/observer.rb
+- lib/caffeinate/active_record/extension.rb
+- lib/caffeinate/configuration.rb
+- lib/caffeinate/deliver_async.rb
+- lib/caffeinate/drip.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/perform.rb
+- lib/caffeinate/dripper/subscriber.rb
+- lib/caffeinate/engine.rb
+- lib/caffeinate/version.rb
+- lib/generators/caffeinate/install_generator.rb
+- lib/generators/caffeinate/templates/application_campaign.rb
+- lib/generators/caffeinate/templates/caffeinate.rb
+homepage: https://github.com/joshmn/caffeinate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Opinionated drip campaign framework.
+test_files: []