heya 0.0.1 → 0.1.0

data/lib/heya/campaigns/queries.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Heya
+  module Campaigns
+    module Queries
+      NEXT_STEP_SUBQUERY = <<~SQL
+        (WITH steps AS (SELECT * FROM (VALUES :steps_values) AS m (step_gid,campaign_gid,position))
+         SELECT m.step_gid FROM steps AS m
+         WHERE m.campaign_gid = :campaign_gid
+           AND m.position > coalesce((SELECT m.position FROM heya_campaign_receipts AS r
+             INNER JOIN steps AS m ON m.step_gid = r.step_gid
+               AND m.campaign_gid = :campaign_gid
+             WHERE r.user_type = heya_campaign_memberships.user_type
+               AND r.user_id = heya_campaign_memberships.user_id
+             ORDER BY m.position DESC
+             LIMIT 1), -1)
+         ORDER BY m.position ASC
+         LIMIT 1
+        ) = :step_gid
+      SQL
+
+      ACTIVE_CAMPAIGN_SUBQUERY = <<~SQL
+        (WITH heya_campaigns AS (SELECT * FROM (VALUES :campaigns_values) AS campaigns (campaign_gid,position))
+        SELECT memberships.campaign_gid FROM heya_campaign_memberships AS memberships
+         INNER JOIN heya_campaigns AS campaigns
+           ON campaigns.campaign_gid = memberships.campaign_gid
+         WHERE memberships.user_type = heya_campaign_memberships.user_type
+           AND memberships.user_id = heya_campaign_memberships.user_id
+           AND memberships.concurrent = FALSE
+         ORDER BY campaigns.position DESC, memberships.created_at ASC
+         LIMIT 1
+        ) = :campaign_gid
+      SQL
+
+      # Given a campaign and a step, {Queries::UsersForStep} returns the
+      # users who should complete the step.
+      UsersForStep = ->(campaign, step) {
+        wait_threshold = Time.now.utc - step.wait
+
+        # Safeguard to make sure we never complete the same step twice.
+        receipt_query = CampaignReceipt
+          .select("heya_campaign_receipts.user_id")
+          .where(user_type: campaign.user_class.name)
+          .where("heya_campaign_receipts.step_gid = ?", step.gid)
+
+        # https://www.postgresql.org/docs/9.4/queries-values.html
+        steps_values = campaign.steps.map { |m|
+          ActiveRecord::Base.sanitize_sql_array(
+            ["(?, ?, ?)", m.gid, campaign.gid, m.position]
+          )
+        }.join(", ")
+
+        priority = Heya.config.campaigns.priority.reverse.map { |c| c.is_a?(String) ? c : c.name }
+        campaigns_values = Heya.campaigns.map { |c|
+          ActiveRecord::Base.sanitize_sql_array(
+            ["(?, ?)", c.gid, priority.index(c.name) || -1]
+          )
+        }.join(", ")
+
+        users = campaign.users
+        users
+          .where.not(id: receipt_query)
+          .where(NEXT_STEP_SUBQUERY.gsub(":steps_values", steps_values), {
+            campaign_gid: campaign.gid,
+            step_gid: step.gid
+          })
+          .merge(
+            users
+              .where("heya_campaign_memberships.concurrent = ?", true)
+              .or(
+                users.where(ACTIVE_CAMPAIGN_SUBQUERY.gsub(":campaigns_values", campaigns_values), {
+                  campaign_gid: campaign.gid
+                })
+              )
+          )
+          .where(
+            "heya_campaign_memberships.last_sent_at <= ?", wait_threshold
+          )
+      }
+
+      # Given a campaign and a step, {Queries::UsersCompletedStep}
+      # returns the users who have completed the step.
+      UsersCompletedStep = ->(campaign, step) {
+        receipt_query = CampaignReceipt
+          .select("heya_campaign_receipts.user_id")
+          .where(user_type: campaign.user_class.name)
+          .where("heya_campaign_receipts.step_gid = ?", step.gid)
+
+        campaign.users
+          .where(id: receipt_query)
+      }
+
+      # Given a campaign and a user, {Queries::CampaignMembershipsForUpdate}
+      # returns the user's campaign memberships which should be updated
+      # concurrently.
+      CampaignMembershipsForUpdate = ->(campaign, user) {
+        membership = CampaignMembership.where(user: user, campaign_gid: campaign.gid).first
+        if membership.concurrent?
+          CampaignMembership
+            .where(user: user, campaign_gid: campaign.gid)
+        else
+          CampaignMembership
+            .where(user: user, concurrent: false)
+        end
+      }
+
+      # Given a campaign, {Queries::OrphanedCampaignMemberships} returns the
+      # campaign memberships which belong to users who no longer exist in the
+      # database.
+      OrphanedCampaignMemberships = ->(campaign) {
+        CampaignMembership
+          .where(campaign_gid: campaign.gid)
+          .where(user_type: campaign.user_class.base_class.name)
+          .where.not(user_id: campaign.users.select("id"))
+      }
+    end
+  end
+end

data/lib/heya/campaigns/scheduler.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Heya
+  module Campaigns
+    # {Campaigns::Scheduler} schedules campaign jobs to run for each campaign.
+    #
+    # For each step in each campaign:
+    #   1. Find users who haven't completed step, and are outside the `wait`
+    #   window
+    #   2. Match segment
+    #   3. Create CampaignReceipt (excludes user in subsequent steps)
+    #   4. Process job
+    class Scheduler
+      def run
+        Heya.campaigns.each do |campaign|
+          Queries::OrphanedCampaignMemberships.call(campaign).delete_all
+
+          campaign.steps.each do |step|
+            Queries::UsersForStep.call(campaign, step).find_each do |user|
+              self.class.process(campaign, step, user)
+            end
+          end
+
+          if (last_step = campaign.steps.last)
+            CampaignMembership.where(
+              user: Queries::UsersCompletedStep.call(campaign, last_step),
+              campaign_gid: campaign.gid
+            ).delete_all
+          end
+        end
+      end
+
+      def self.process(campaign, step, user)
+        ActiveRecord::Base.transaction do
+          return if CampaignReceipt.where(user: user, step_gid: step.gid).exists?
+
+          if step.in_segment?(user)
+            now = Time.now.utc
+            Queries::CampaignMembershipsForUpdate.call(campaign, user).update_all(last_sent_at: now)
+            CampaignReceipt.create!(user: user, step_gid: step.gid, sent_at: now)
+            step.action.new(user: user, step: step).deliver_later
+          else
+            CampaignReceipt.create!(user: user, step_gid: step.gid)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/heya/campaigns/step.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module Heya
+  module Campaigns
+    class Step < OpenStruct
+      include GlobalID::Identification
+
+      def self.find(id)
+        campaign_name, _step_name = id.to_s.split("/")
+        campaign_name.constantize.steps.find { |s| s.id == id }
+      end
+
+      def gid
+        to_gid(app: "heya").to_s
+      end
+
+      def in_segment?(user)
+        Heya.in_segments?(user, *campaign.__segments, segment)
+      end
+    end
+  end
+end

data/lib/heya/campaigns/step_action_job.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Heya
+  module Campaigns
+    class StepActionJob < ActiveJob::Base
+      queue_as { Heya.config.campaigns.queue }
+
+      rescue_from StandardError, with: :handle_exception_with_campaign_class
+
+      def perform(_campaign, user, step)
+        step.action.new(user: user, step: step).deliver_now
+      end
+
+      private
+
+      # From ActionMailer: "deserialize" the mailer class name by hand in case
+      # another argument (like a Global ID reference) raised
+      # DeserializationError.
+      def campaign_class
+        if (campaign = (arguments_serialized? && Array(@serialized_arguments).first) || Array(arguments).first)
+          campaign.constantize
+        end
+      end
+
+      def handle_exception_with_campaign_class(exception)
+        if (klass = campaign_class)
+          klass.handle_exception(exception)
+        else
+          raise exception
+        end
+      end
+    end
+  end
+end

data/lib/heya/config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module Heya
+  class Config < OpenStruct
+    def initialize
+      super(
+        user_type: "User",
+        campaigns: OpenStruct.new(
+          priority: [],
+          default_options: {}
+        ),
+      )
+    end
+  end
+end

data/lib/heya/engine.rb

@@ -1,5 +1,19 @@
+# frozen_string_literal: true
+
 module Heya
   class Engine < ::Rails::Engine
     isolate_namespace Heya
+
+    initializer "heya.reload_campaigns" do |app|
+      app.reloader.to_run do
+        Heya.campaigns.clear
+      end
+    end
+
+    config.to_prepare do
+      Dir.glob(Rails.root + "app/campaigns/*.rb").each do |c|
+        require_dependency(c)
+      end
+    end
   end
 end

data/lib/heya/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Heya
-  VERSION = '0.0.1'
+  VERSION = "0.1.0"
 end

data/lib/tasks/heya_tasks.rake

@@ -1,4 +1,8 @@
-# desc "Explaining what the task does"
-# task :heya do
-#   # Task goes here
-# end
+# frozen_string_literal: true
+
+namespace :heya do
+  desc "Send campaign emails"
+  task scheduler: :environment do
+    Heya::Campaigns::Scheduler.new.run
+  end
+end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: heya
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Joshua Wood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-12 00:00:00.000000000 Z
+date: 2020-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -38,13 +44,32 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "Heya \U0001F44B"
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: Heya is a customer communication and automation framework for Ruby on
+  Rails. It's as robust as the hosted alternatives, without the integration and compliance
+  nightmare.
 email:
 - josh@honeybadger.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
+- README.md
 - Rakefile
 - app/assets/config/heya_manifest.js
 - app/assets/javascripts/heya/application.js
@@ -53,15 +78,41 @@ files:
 - app/helpers/heya/application_helper.rb
 - app/jobs/heya/application_job.rb
 - app/mailers/heya/application_mailer.rb
+- app/mailers/heya/campaign_mailer.rb
 - app/models/heya/application_record.rb
+- app/models/heya/campaign_membership.rb
+- app/models/heya/campaign_receipt.rb
 - app/views/layouts/heya/application.html.erb
+- app/views/layouts/heya/campaign_mailer.html.erb
+- app/views/layouts/heya/campaign_mailer.text.erb
 - config/routes.rb
+- lib/generators/heya/campaign/USAGE
+- lib/generators/heya/campaign/campaign_generator.rb
+- lib/generators/heya/campaign/templates/application_campaign.rb.tt
+- lib/generators/heya/campaign/templates/campaign.rb.tt
+- lib/generators/heya/campaign/templates/message.html.erb.tt
+- lib/generators/heya/campaign/templates/message.md.erb.tt
+- lib/generators/heya/campaign/templates/message.text.erb.tt
+- lib/generators/heya/install/USAGE
+- lib/generators/heya/install/install_generator.rb
+- lib/generators/heya/install/templates/initializer.rb.tt
+- lib/generators/heya/install/templates/migration.rb.tt
 - lib/heya.rb
+- lib/heya/campaigns/action.rb
+- lib/heya/campaigns/actions/block.rb
+- lib/heya/campaigns/actions/email.rb
+- lib/heya/campaigns/base.rb
+- lib/heya/campaigns/queries.rb
+- lib/heya/campaigns/scheduler.rb
+- lib/heya/campaigns/step.rb
+- lib/heya/campaigns/step_action_job.rb
+- lib/heya/config.rb
 - lib/heya/engine.rb
 - lib/heya/version.rb
 - lib/tasks/heya_tasks.rake
-homepage: https://www.honeybadger.io
-licenses: []
+homepage: https://github.com/honeybadger-io/heya
+licenses:
+- Prosperity Public License
 metadata: {}
 post_install_message: 
 rdoc_options: []