drippings 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f40374806e4eb5c75eb6dd2667b9f85a3e344d59cdd1bf362cb423e9b41acda5
+  data.tar.gz: 8a4438bf9ace97b920972e07d88ad486847c99e0fb972386e6d9b0c552199679
+SHA512:
+  metadata.gz: f344e0f0753df5e2fbb40060a9ca58538be49d572dddc9e08f3547187c7c12b0d6564d6aaf536c7530a4843a982c5d908b1afc976164878454c3d5f429d70415
+  data.tar.gz: fc444d49844e6809a88a6e83ddacf1706a59a01a0dd2512f9e416b07c9182b8cc6a276fa6cd0d69f81d2901e9547b541f0ea9979b1e72e34094cff75983261f1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Benjamin Hogoboom
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,101 @@
+# Drippings
+Drippings is a gem used to quickly create drip campaigns within rails apps without boilerplate de-duping logic
+
+## Usage
+To define a drip, create a subclass of `Drippings::ProcessJob` which implements `process`. For example:
+
+```ruby
+class LeadFollowupJob < Drippings::ProcessJob
+  
+  # @param lead [Lead] the lead to email
+  def process(lead)
+    MessageSenderService.send(body: 'Hello, buy my product!', lead: lead)
+  end
+end
+```
+
+`ProcessJob` subclasses can also accept any ad hoc arguments you may need:
+
+```ruby
+class LeadFollowupJob < Drippings::ProcessJob
+  
+  # @param lead [Lead] the lead to email
+  def process(lead, phone:, transactional:)
+    MessageSenderService.send(
+      body: 'Hello, buy my product!',
+      lead: lead,
+      phone: phone,
+      transactional: transactional
+    )
+  end
+end
+```
+
+To define the schedule on which you want your drips to process, register a drip by defining a
+drip name, process job subclass, scope, and any additional arguments you want to pass via `options`:
+
+```ruby
+# config/initializers/drippings.rb
+Drippings.configure do |config|
+  config.register(
+    "Lead::Followup",
+    LeadFollowupJob,
+    -> { Lead.active },
+    options: {
+      phone: '555-555-5555',
+      transactional: true,
+    }
+  )
+end
+```
+
+You can also define a time to send your messages by defining a
+`wait_until` (formatted as a hash of time units) and a `time_zone`, which
+can either be a proc do determine a timezone per resource, or a string to define
+a timezone for all resources:
+
+```ruby
+Drippings.configure do |config|
+  config.register(
+    "Lead::Followup",
+    LeadFollowupJob,
+    -> { Lead.active },
+    wait_until: { hour: 16 }, # 4PM
+    time_zone: ->(lead) { lead.time_zone },
+    options: {
+      phone: '555-555-5555',
+      transactional: true,
+    }
+  )
+end
+```
+
+Finally, add the `Drippings::Kickoff` job to your recurring job scheduler, such as sidekiq-scheduler
+
+```yml
+# sidekiq.yml
+drippings_kickoff_job:
+    cron: '*/15 * * * * UTC'
+    class: Drippings::KickoffJob
+    enabled: false
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'drippings'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install drippings
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/jobs/drippings/application_job.rb

@@ -0,0 +1,9 @@
+module Drippings
+  class ApplicationJob < ActiveJob::Base
+    # Automatically retry jobs that encountered a deadlock
+    # retry_on ActiveRecord::Deadlocked
+
+    # Most jobs are safe to ignore if the underlying records are no longer available
+    # discard_on ActiveJob::DeserializationError
+  end
+end

data/app/jobs/drippings/kickoff_job.rb

@@ -0,0 +1,9 @@
+module Drippings
+  class KickoffJob < ApplicationJob
+    queue_as :default
+
+    def perform
+      Drippings.client.kickoff
+    end
+  end
+end

data/app/jobs/drippings/process_job.rb

@@ -0,0 +1,27 @@
+module Drippings
+  class ProcessJob < ApplicationJob
+    queue_as :default
+
+    def perform(scheduling, *args, **kwargs)
+      scheduling.with_lock do
+        break if scheduling.processed_at?
+
+        resource = scheduling.resource
+
+        process(resource, *args, **kwargs) unless skip?(resource)
+
+        scheduling.touch(:processed_at)
+      end
+    end
+
+    protected
+
+    def process(_)
+      raise NotImplementedError, "Drippings::ProcessJob#process must be defined by a concrete subclass"
+    end
+
+    def skip?(resource)
+      resource.nil?
+    end
+  end
+end

data/app/jobs/drippings/schedule_job.rb

@@ -0,0 +1,9 @@
+module Drippings
+  class ScheduleJob < ApplicationJob
+    queue_as :default
+
+    def perform(name)
+      Drippings.client.schedule(name)
+    end
+  end
+end

data/app/models/drippings/scheduling.rb

@@ -0,0 +1,20 @@
+module Drippings
+  class Scheduling < ApplicationRecord
+    belongs_to :resource, polymorphic: true
+    validates :name, presence: true
+
+    # @param scope [ActiveRecord::Relation]
+    # @param name [String]
+    def self.dedup(scope, name)
+      arel_on = Arel::Nodes::On.new(
+        arel_table[:name].eq(name)
+          .and(arel_table[:resource_id].eq(scope.arel_table[:id]))
+          .and(arel_table[:resource_type].eq(scope.klass.name))
+      )
+
+      arel_join = Arel::Nodes::OuterJoin.new(arel_table, arel_on)
+
+      scope.joins(arel_join).merge(where(id: nil))
+    end
+  end
+end

data/db/migrate/20220829224939_create_drippings_schedulings.rb

@@ -0,0 +1,11 @@
+class CreateDrippingsSchedulings < ActiveRecord::Migration[7.0]
+  def change
+    create_table :drippings_schedulings do |t|
+      t.string :name, null: false
+      t.references :resource, polymorphic: true, null: false, index: true
+      t.datetime :processed_at
+      t.timestamps
+      t.index %i[name resource_id resource_type], name: :index_drippings_schedulings_on_name_and_resource
+    end
+  end
+end

data/lib/drippings/client.rb

@@ -0,0 +1,50 @@
+module Drippings
+  class Client
+    Drip = Struct.new(:job, :scope, :wait_until, :time_zone, :options)
+
+    def initialize
+      @drips = {}
+    end
+
+    def kickoff
+      @drips.each do |name, _|
+        ScheduleJob.perform_later(name)
+      end
+    end
+
+    def schedule(name)
+      drip = @drips[name]
+      scope = drip.scope.call
+      job = drip.job
+      raw_wait_until = drip.wait_until
+      time_zone = drip.time_zone
+
+      Scheduling.dedup(scope, name).find_in_batches do |batch|
+        batch.each do |resource|
+          scheduling = Drippings::Scheduling.create!(name: name, resource: resource)
+          wait_until = raw_wait_until.present? ? wait_until(resource, raw_wait_until, time_zone) : nil
+          job.set(wait_until: wait_until).perform_later(scheduling, **drip.options)
+        end
+      end
+    end
+
+    def register(name, job, scope, wait_until: nil, time_zone: nil, options: {})
+      raise ArgumentError, "A drip has already been registered for #{name}" if @drips[name].present?
+      raise ArgumentError, 'Job must be a subclass of Drippings::ProcessJob' unless job < Drippings::ProcessJob
+      if wait_until.present? && time_zone.nil?
+        raise ArgumentError, 'time_zone must be defined if providing a wait_until'
+      end
+
+      @drips[name] = Drip.new(job, scope, wait_until, time_zone, options)
+    end
+
+    private
+
+    def wait_until(resource, wait_until, time_zone)
+      tz = time_zone.call(resource)
+      time = Time.current.in_time_zone(tz).change(wait_until)
+      time += 1.day if time.past?
+      time
+    end
+  end
+end

data/lib/drippings/engine.rb

@@ -0,0 +1,5 @@
+module Drippings
+  class Engine < ::Rails::Engine
+    isolate_namespace Drippings
+  end
+end

data/lib/drippings/version.rb

@@ -0,0 +1,3 @@
+module Drippings
+  VERSION = '1.0.0'.freeze
+end

data/lib/drippings.rb

@@ -0,0 +1,13 @@
+require "drippings/version"
+require "drippings/engine"
+require "drippings/client"
+
+module Drippings
+  def self.client
+    @client ||= Drippings::Client.new
+  end
+
+  def self.configure
+    yield client
+  end
+end

data/lib/tasks/drippings_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :drippings do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: drippings
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Benjamin Hogoboom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rspec_junit_formatter
+  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: rubocop
+  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: rubocop-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: rubocop-rspec
+  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: Rails extension for scheduling drip campaigns
+email:
+- benjamin.hogoboom@clutter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/jobs/drippings/application_job.rb
+- app/jobs/drippings/kickoff_job.rb
+- app/jobs/drippings/process_job.rb
+- app/jobs/drippings/schedule_job.rb
+- app/models/drippings/scheduling.rb
+- db/migrate/20220829224939_create_drippings_schedulings.rb
+- lib/drippings.rb
+- lib/drippings/client.rb
+- lib/drippings/engine.rb
+- lib/drippings/version.rb
+- lib/tasks/drippings_tasks.rake
+homepage: https://github.com/clutter/drippings
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/clutter/drippings
+  source_code_uri: https://github.com/clutter/drippings
+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.1.6
+signing_key: 
+specification_version: 4
+summary: Tool for automating drip campaigns
+test_files: []