RubyGems - heya - Versions diffs - 0.0.1 → 0.1.0 - Mend

heya 0.0.1 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (36) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +11 -0
data/LICENSE +85 -0
data/README.md +418 -0
data/Rakefile +14 -14
data/app/mailers/heya/application_mailer.rb +0 -2
data/app/mailers/heya/campaign_mailer.rb +25 -0
data/app/models/heya/campaign_membership.rb +9 -0
data/app/models/heya/campaign_receipt.rb +5 -0
data/app/views/layouts/heya/campaign_mailer.html.erb +20 -0
data/app/views/layouts/heya/campaign_mailer.text.erb +1 -0
data/lib/generators/heya/campaign/USAGE +14 -0
data/lib/generators/heya/campaign/campaign_generator.rb +53 -0
data/lib/generators/heya/campaign/templates/application_campaign.rb.tt +3 -0
data/lib/generators/heya/campaign/templates/campaign.rb.tt +7 -0
data/lib/generators/heya/campaign/templates/message.html.erb.tt +1 -0
data/lib/generators/heya/campaign/templates/message.md.erb.tt +1 -0
data/lib/generators/heya/campaign/templates/message.text.erb.tt +1 -0
data/lib/generators/heya/install/USAGE +10 -0
data/lib/generators/heya/install/install_generator.rb +20 -0
data/lib/generators/heya/install/templates/initializer.rb.tt +16 -0
data/lib/generators/heya/install/templates/migration.rb.tt +28 -0
data/lib/heya.rb +44 -1
data/lib/heya/campaigns/action.rb +27 -0
data/lib/heya/campaigns/actions/block.rb +24 -0
data/lib/heya/campaigns/actions/email.rb +15 -0
data/lib/heya/campaigns/base.rb +151 -0
data/lib/heya/campaigns/queries.rb +118 -0
data/lib/heya/campaigns/scheduler.rb +49 -0
data/lib/heya/campaigns/step.rb +24 -0
data/lib/heya/campaigns/step_action_job.rb +34 -0
data/lib/heya/config.rb +17 -0
data/lib/heya/engine.rb +14 -0
data/lib/heya/version.rb +3 -1
data/lib/tasks/heya_tasks.rake +8 -4
metadata +58 -7

data/Rakefile CHANGED

@@ -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 CHANGED

@@ -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 ADDED

@@ -0,0 +1,25 @@
+module Heya
+  class CampaignMailer < ApplicationMailer
+    layout "heya/campaign_mailer"
+    def build
+      user = params.fetch(:user)
+      step = params.fetch(:step)
+      campaign = step.campaign
+      from = step.params.fetch("from")
+      reply_to = step.params.fetch("reply_to", nil)
+      subject = step.params.fetch("subject")
+      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.underscore}",
+        template_name: step.name.underscore
+      )
+    end
+  end
+end

data/app/models/heya/campaign_membership.rb ADDED

@@ -0,0 +1,9 @@
+module Heya
+  class CampaignMembership < ApplicationRecord
+    belongs_to :user, polymorphic: true
+    before_create do
+      self.last_sent_at = Time.now
+    end
+  end
+end

data/app/models/heya/campaign_receipt.rb ADDED

@@ -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 ADDED

@@ -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 ADDED

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

data/lib/generators/heya/campaign/USAGE ADDED

@@ -0,0 +1,14 @@
+Description:
+    Generate a new campaign
+Example:
+    rails generate heya:campaign Onboarding first second 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 ADDED

@@ -0,0 +1,53 @@
+# 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
+    template "application_campaign.rb", "app/campaigns/application_campaign.rb"
+    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 = step
+      template_method.call(step)
+    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
+end

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

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

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

@@ -0,0 +1,7 @@
+class <%= file_name.camelcase %>Campaign < ApplicationCampaign
+<% steps.each do |step| %>
+  step :<%= step.underscore.to_sym %>,
+    subject: "<%= step.humanize %> Message"
+<% end -%>
+end

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

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

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

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

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

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

data/lib/generators/heya/install/USAGE ADDED

@@ -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 ADDED

@@ -0,0 +1,20 @@
+# 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 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/initializer.rb.tt ADDED

@@ -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 ADDED

@@ -0,0 +1,28 @@
+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.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 CHANGED

@@ -1,5 +1,48 @@
+# frozen_string_literal: true
+require "heya/version"
 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

data/lib/heya/campaigns/action.rb ADDED

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module Heya
+  module Campaigns
+    class Action
+      def initialize(user:, step:)
+        @user, @step = user, step
+      end
+      attr_reader :user, :step
+      def build
+        raise NotImplementedError, "Please implement #build on subclass of Heya::Campaigns::Action."
+      end
+      def deliver_now
+        build.deliver
+      end
+      def deliver_later
+        StepActionJob
+          .set(queue: step.queue)
+          .perform_later(step.campaign.class.name, user, step)
+      end
+    end
+  end
+end

data/lib/heya/campaigns/actions/block.rb ADDED

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Heya
+  module Campaigns
+    module Actions
+      class Block < Action
+        class Execution
+          def initialize(user:, step:, &block)
+            @user, @step, @block = user, step, block
+          end
+          def deliver
+            instance_exec(@user, @step, &@block)
+          end
+        end
+        def build
+          block = step.params.fetch("block")
+          Execution.new(user: user, step: step, &block)
+        end
+      end
+    end
+  end
+end

data/lib/heya/campaigns/actions/email.rb ADDED

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Heya
+  module Campaigns
+    module Actions
+      class Email < Action
+        def build
+          CampaignMailer
+            .with(user: user, step: step)
+            .build
+        end
+      end
+    end
+  end
+end

data/lib/heya/campaigns/base.rb ADDED

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+require "active_support/descendants_tracker"
+module Heya
+  module Campaigns
+    # {Campaigns::Base} provides a Ruby DSL for building campaign sequences.
+    # Multiple actions are supported; the default is email.
+    class Base
+      extend ActiveSupport::DescendantsTracker
+      include Singleton
+      include GlobalID::Identification
+      def initialize
+        self.steps = []
+      end
+      delegate :name, :__segments, to: :class
+      alias id name
+      # Returns String GlobalID.
+      def gid
+        to_gid(app: "heya").to_s
+      end
+      def add(user, restart: false, concurrent: false, send_now: true)
+        return false unless Heya.in_segments?(user, *__segments)
+        restart && CampaignReceipt
+          .where(user: user, step_gid: steps.map(&:gid))
+          .delete_all
+        CampaignMembership.where(user: user, campaign_gid: gid, concurrent: concurrent).first_or_create!
+        if send_now && (step = steps.first) && step.wait <= 0
+          Scheduler.process(self, step, user)
+        end
+        true
+      end
+      def remove(user)
+        CampaignMembership.where(user: user, campaign_gid: gid).delete_all
+        true
+      end
+      def users
+        base_class = user_class.base_class
+        user_class
+          .joins(
+            sanitize_sql_array([
+              "inner join heya_campaign_memberships on heya_campaign_memberships.user_type = ? and heya_campaign_memberships.user_id = #{base_class.table_name}.id and heya_campaign_memberships.campaign_gid = ?",
+              base_class.name,
+              gid
+            ])
+          ).all
+      end
+      def user_class
+        @user_class ||= self.class.user_type.constantize
+      end
+      attr_accessor :steps
+      private
+      delegate :sanitize_sql_array, to: ActiveRecord::Base
+      class_attribute :__defaults, default: {}.freeze
+      class_attribute :__segments, default: [].freeze
+      class_attribute :__user_type, default: nil
+      STEP_ATTRS = {
+        action: Actions::Email,
+        wait: 2.days,
+        segment: nil,
+        queue: "heya"
+      }.freeze
+      class << self
+        def inherited(campaign)
+          Heya.register_campaign(campaign)
+          Heya.unregister_campaign(campaign.superclass)
+          super
+        end
+        def find(_id)
+          instance
+        end
+        def handle_exception(exception)
+          raise exception
+        end
+        delegate :steps, :add, :remove, :users, :gid, :user_class, to: :instance
+        def default(**params)
+          self.__defaults = __defaults.merge(params).freeze
+        end
+        def user_type(value = nil)
+          if value.present?
+            self.__user_type = value.is_a?(String) ? value.to_s : value.name
+          end
+          __user_type || Heya.config.user_type
+        end
+        def segment(arg = nil, &block)
+          if block_given?
+            self.__segments = ([block] | __segments).freeze
+          elsif arg
+            self.__segments = ([arg] | __segments).freeze
+          end
+        end
+        def step(name, **opts, &block)
+          if block_given?
+            opts[:block] ||= block
+            opts[:action] ||= Actions::Block
+          end
+          opts =
+            STEP_ATTRS
+              .merge(Heya.config.campaigns.default_options)
+              .merge(__defaults)
+              .merge(opts)
+          attrs = opts.select { |k, _| STEP_ATTRS.key?(k) }
+          attrs[:params] = opts.reject { |k, _| STEP_ATTRS.key?(k) }.stringify_keys
+          attrs[:id] = "#{self.name}/#{name}"
+          attrs[:name] = name.to_s
+          attrs[:position] = steps.size
+          attrs[:campaign] = instance
+          step = Step.new(attrs)
+          method_name = :"#{step.name.underscore}"
+          raise "Invalid step name: #{step.name}\n  Step names must not conflict with method names on Heya::Campaigns::Base" if respond_to?(method_name)
+          define_singleton_method method_name do |user|
+            step.action.new(user: user, step: step).build
+          end
+          steps << step
+          step
+        end
+      end
+    end
+  end
+end