heya 0.0.1 → 0.4.0

data/Rakefile

@@ -1,31 +1,31 @@
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Heya'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "Heya"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
 APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load 'rails/tasks/engine.rake'
+load "rails/tasks/engine.rake"
 
-load 'rails/tasks/statistics.rake'
+load "rails/tasks/statistics.rake"
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 

data/app/mailers/heya/application_mailer.rb

@@ -1,6 +1,4 @@
 module Heya
   class ApplicationMailer < ActionMailer::Base
-    default from: 'from@example.com'
-    layout 'mailer'
   end
 end

data/app/mailers/heya/campaign_mailer.rb

@@ -0,0 +1,52 @@
+module Heya
+  class CampaignMailer < ApplicationMailer
+    layout "heya/campaign_mailer"
+
+    def build
+      user = params.fetch(:user)
+      step = params.fetch(:step)
+
+      campaign_name = step.campaign_name.underscore
+      step_name = step.name.underscore
+
+      from = step.params.fetch("from")
+      reply_to = step.params.fetch("reply_to", nil)
+
+      subject = step.params.fetch("subject") {
+        I18n.t("#{campaign_name}.#{step_name}.subject", **attributes_for(user))
+      }
+      subject = subject.call(user) if subject.respond_to?(:call)
+
+      instance_variable_set(:"@#{user.model_name.element}", user)
+
+      mail(
+        from: from,
+        reply_to: reply_to,
+        to: user.email,
+        subject: subject,
+        template_path: "heya/campaign_mailer/#{campaign_name}",
+        template_name: step_name
+      )
+    end
+
+    protected
+
+    def attributes_for(user)
+      if user.respond_to?(:heya_attributes)
+        user.heya_attributes.symbolize_keys
+      else
+        {}
+      end
+    end
+
+    def _prefixes
+      @_prefixes_with_campaign_path ||= begin
+        if params.is_a?(Hash) && (campaign_name = params[:step]&.campaign&.name&.underscore)
+          super | ["heya/campaign_mailer/#{campaign_name}"]
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/app/models/heya/campaign_membership.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Heya
+  class CampaignMembership < ApplicationRecord
+    belongs_to :user, polymorphic: true
+
+    before_create do
+      self.last_sent_at = Time.now
+    end
+
+    scope :with_steps, -> {
+      joins(
+        %(INNER JOIN "heya_steps" ON "heya_steps".gid = "heya_campaign_memberships".step_gid)
+      )
+    }
+
+    scope :active, -> {
+      priority_gids = Heya.config.campaigns.priority.map { |c| (c.is_a?(String) ? c.constantize : c).gid }
+      where(<<~SQL, priority_gids: priority_gids)
+        "heya_campaign_memberships".concurrent = TRUE
+        OR "heya_campaign_memberships"."campaign_gid" IN (
+          SELECT
+            "active_membership"."campaign_gid"
+          FROM
+            "heya_campaign_memberships" as "active_membership"
+          WHERE
+            "active_membership"."concurrent" = FALSE
+            AND
+            (
+              "active_membership".user_type = "heya_campaign_memberships".user_type
+              AND
+              "active_membership".user_id = "heya_campaign_memberships".user_id
+            )
+          ORDER BY
+            array_position(ARRAY[:priority_gids], "active_membership".campaign_gid::text) ASC,
+            "active_membership".created_at ASC
+          LIMIT 1
+        )
+      SQL
+    }
+
+    scope :upcoming, -> {
+      with_steps
+        .active
+        .order(
+          Arel.sql(
+            %("heya_campaign_memberships".last_sent_at + make_interval(secs := "heya_steps".wait) DESC)
+          )
+        )
+    }
+
+    scope :to_process, ->(now: Time.now, user: nil) {
+      upcoming
+        .where(<<~SQL, now: now.utc, user_type: user&.class&.base_class&.name, user_id: user&.id)
+          ("heya_campaign_memberships".last_sent_at <= (TIMESTAMP :now - make_interval(secs := "heya_steps".wait)))
+          AND (
+            (:user_type IS NULL OR :user_id IS NULL)
+            OR (
+              "heya_campaign_memberships".user_type = :user_type
+              AND
+              "heya_campaign_memberships".user_id = :user_id
+            )
+          )
+        SQL
+    }
+
+    def self.migrate_next_step!
+      find_each do |membership|
+        campaign = GlobalID::Locator.locate(membership.campaign_gid)
+        receipt = campaign && CampaignReceipt.where(user: membership.user, step_gid: campaign.steps.map(&:gid)).order("created_at desc").first
+
+        next_step = if receipt
+          last_step = GlobalID::Locator.locate(receipt.step_gid)
+          current_index = campaign.steps.index(last_step)
+          campaign.steps[current_index + 1]
+        else
+          campaign&.steps&.first
+        end
+
+        if next_step
+          membership.update(step_gid: next_step.gid)
+        else
+          membership.destroy
+        end
+      end
+
+      CampaignReceipt.where(sent_at: nil).destroy_all
+    end
+  end
+end

data/app/models/heya/campaign_receipt.rb

@@ -0,0 +1,5 @@
+module Heya
+  class CampaignReceipt < ApplicationRecord
+    belongs_to :user, polymorphic: true
+  end
+end

data/app/views/layouts/heya/campaign_mailer.html.erb

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      .message-content { max-width: 600px; }
+      .message-content div { padding-bottom: 10px; }
+      .message-content img { max-width: 100%; height: auto; }
+      p {
+        margin-bottom: 1em;
+      }
+    </style>
+  </head>
+
+  <body>
+    <div class="message-content">
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/app/views/layouts/heya/campaign_mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/lib/generators/heya/campaign/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Generate a new campaign
+
+Example:
+    rails generate heya:campaign Onboarding first:0 second:2.days third
+
+    This will create:
+        app/campaigns/onboarding_campaign.rb
+        app/views/heya/campaign_mailer/onboarding_campaign/first.text.erb
+        app/views/heya/campaign_mailer/onboarding_campaign/first.html.erb
+        app/views/heya/campaign_mailer/onboarding_campaign/second.text.erb
+        app/views/heya/campaign_mailer/onboarding_campaign/second.html.erb
+        app/views/heya/campaign_mailer/onboarding_campaign/third.text.erb
+        app/views/heya/campaign_mailer/onboarding_campaign/third.html.erb

data/lib/generators/heya/campaign/campaign_generator.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+class Heya::CampaignGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  argument :steps, type: :array, default: []
+
+  def copy_campaign_template
+    application_campaign = "app/campaigns/application_campaign.rb"
+    unless File.exist?(application_campaign)
+      template File.expand_path("../install/templates/application_campaign.rb", __dir__), application_campaign
+    end
+    template "campaign.rb", "app/campaigns/#{file_name.underscore}_campaign.rb"
+  end
+
+  def copy_view_templates
+    selection =
+      if defined?(Maildown)
+        puts <<~MSG
+          What type of views would you like to generate?
+            1. Multipart (text/html)
+            2. Maildown (markdown)
+        MSG
+
+        ask(">")
+      else
+        "1"
+      end
+
+    template_method =
+      case selection
+      when "1"
+        method(:action_mailer_template)
+      when "2"
+        method(:maildown_template)
+      else
+        abort "Error: must be a number [1-2]"
+      end
+
+    steps.each do |step|
+      step, _wait = step.split(":")
+      @step = step
+      template_method.call(step)
+    end
+  end
+
+  def copy_test_templates
+    if preview_path
+      template "preview.rb", preview_path.join("#{file_name.underscore}_campaign_preview.rb")
+    end
+  end
+
+  private
+
+  def action_mailer_template(step)
+    template "message.text.erb", "app/views/heya/campaign_mailer/#{file_name.underscore}_campaign/#{step.underscore.to_sym}.text.erb"
+    template "message.html.erb", "app/views/heya/campaign_mailer/#{file_name.underscore}_campaign/#{step.underscore.to_sym}.html.erb"
+  end
+
+  def maildown_template(step)
+    template "message.md.erb", "app/views/heya/campaign_mailer/#{file_name.underscore}_campaign/#{step.underscore.to_sym}.md.erb"
+  end
+
+  def preview_path
+    @preview_path ||= if ActionMailer::Base.preview_path.present?
+      Pathname(ActionMailer::Base.preview_path).sub(Rails.root.to_s, ".")
+    end
+  end
+end

data/lib/generators/heya/campaign/templates/campaign.rb.tt

@@ -0,0 +1,4 @@
+class <%= file_name.camelcase %>Campaign < ApplicationCampaign<% steps.each do |step| %><% step, wait = step.split(":") %>
+  step :<%= step.underscore.to_sym %>,<%= wait.presence ? "\n    wait: #{wait}," : "" %>
+    subject: "<%= step.humanize %>"
+<% end %>end

data/lib/generators/heya/campaign/templates/message.html.erb.tt

@@ -0,0 +1 @@
+This is the <%= @step.downcase %> messsage.

data/lib/generators/heya/campaign/templates/message.md.erb.tt

@@ -0,0 +1 @@
+This is the <%= @step.downcase %> messsage.

data/lib/generators/heya/campaign/templates/message.text.erb.tt

@@ -0,0 +1 @@
+This is the <%= @step.downcase %> messsage.

data/lib/generators/heya/campaign/templates/preview.rb.tt

@@ -0,0 +1,12 @@
+# Preview all emails at http://localhost:3000/rails/mailers/
+class <%= file_name.camelcase %>CampaignPreview < ActionMailer::Preview<% steps.each do |step| %><% step, wait = step.split(":") %>
+  def <%= step %>
+    <%= file_name.camelcase %>Campaign.<%= step %>(user)
+  end
+<% end %>
+  private
+
+  def user
+    <%= Heya.config.user_type %>.where(id: params[:user_id]).first || <%= Heya.config.user_type %>.first || <%= Heya.config.user_type %>.new(email: "user@example.com").freeze
+  end
+end

data/lib/generators/heya/install/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Install Heya initializer and migrations
+
+Example:
+    rails generate heya:install
+
+    This will create:
+        db/migrate/*_create_heya_campaign_receipts.heya.rb
+        db/migrate/*_create_heya_campaign_memberships.heya.rb
+        config/initializers/heya.rb

data/lib/generators/heya/install/install_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class Heya::InstallGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  source_root File.expand_path("templates", __dir__)
+
+  def copy_migrations
+    migration_template "migration.rb", "db/migrate/create_heya_tables.rb"
+  end
+
+  def copy_initializer_file
+    copy_file "initializer.rb", "config/initializers/heya.rb"
+  end
+
+  def copy_application_campaign_template
+    template "application_campaign.rb", "app/campaigns/application_campaign.rb"
+  end
+
+  def self.next_migration_number(dirname)
+    next_migration_number = current_migration_number(dirname) + 1
+    ActiveRecord::Migration.next_migration_number(next_migration_number)
+  end
+end

data/lib/generators/heya/install/templates/application_campaign.rb.tt

@@ -0,0 +1,3 @@
+class ApplicationCampaign < Heya::Campaigns::Base
+  default from: "from@example.com"
+end

data/lib/generators/heya/install/templates/initializer.rb.tt

@@ -0,0 +1,16 @@
+Heya.configure do |config|
+  # The name of the model you want to use with Heya.
+  config.user_type = "User"
+
+  # The default options to use when processing campaign steps.
+  # config.campaigns.default_options = {from: "user@example.com"}
+
+  # Campaign priority. When a user is added to multiple campaigns, they are
+  # sent in this order. Campaigns are sent in the order that the users were
+  # added if no priority is configured.
+  # config.campaings.priority = [
+  #   "FirstCampaign",
+  #   "SecondCampaign",
+  #   "ThirdCampaign"
+  # ]
+end

data/lib/generators/heya/install/templates/migration.rb.tt

@@ -0,0 +1,29 @@
+class CreateHeyaTables < ActiveRecord::Migration[<%= ActiveRecord::VERSION::MAJOR %>.<%= ActiveRecord::VERSION::MINOR %>]
+  def change
+    create_table :heya_campaign_memberships do |t|
+      t.references :user, null: false, polymorphic: true, index: false
+
+      t.string :campaign_gid, null: false
+      t.string :step_gid, null: false
+      t.boolean :concurrent, null: false, default: false
+
+      t.datetime :last_sent_at, null: false
+
+      t.timestamps
+    end
+
+    add_index :heya_campaign_memberships, [:user_type, :user_id, :campaign_gid], unique: true, name: :user_campaign_idx
+
+    create_table :heya_campaign_receipts do |t|
+      t.references :user, null: false, polymorphic: true, index: false
+
+      t.string :step_gid, null: false
+
+      t.datetime :sent_at
+
+      t.timestamps
+    end
+
+    add_index :heya_campaign_receipts, [:user_type, :user_id, :step_gid], unique: true, name: :user_step_idx
+  end
+end

data/lib/heya.rb

@@ -1,5 +1,49 @@
+# frozen_string_literal: true
+
+require "heya/version"
+require "heya/active_record_extension"
 require "heya/engine"
+require "heya/config"
+require "heya/campaigns/action"
+require "heya/campaigns/actions/email"
+require "heya/campaigns/actions/block"
+require "heya/campaigns/base"
+require "heya/campaigns/queries"
+require "heya/campaigns/scheduler"
+require "heya/campaigns/step"
+require "heya/campaigns/step_action_job"
 
 module Heya
-  # Your code goes here...
+  extend self
+
+  attr_accessor :campaigns
+  self.campaigns = []
+
+  def register_campaign(klass)
+    campaigns.push(klass) unless campaigns.include?(klass)
+  end
+
+  def unregister_campaign(klass)
+    campaigns.delete(klass)
+  end
+
+  def configure
+    yield(config) if block_given?
+    config
+  end
+
+  def config
+    @config ||= Config.new
+  end
+
+  def in_segments?(user, *segments)
+    return false if segments.any? { |s| !in_segment?(user, s) }
+    true
+  end
+
+  def in_segment?(user, segment)
+    return true if segment.nil?
+    return user.send(segment) if segment.is_a?(Symbol)
+    segment.call(user)
+  end
 end