maily_herald 0.0.1 → 0.8.0

data/spec/dummy/config/locales/maily_herald.en.yml

@@ -0,0 +1,28 @@
+en:
+  activerecord:
+    attributes:
+      one_time_mailing: 
+        name: Name
+        context_name: Context
+        sequence: Sequence
+        conditions: Conditions
+        title: Title
+        from: Sender
+        relative_delay: Delay
+        template: Template
+      periodical_mailing: 
+        name: Name
+        context_name: Context
+        sequence: Sequence
+        conditions: Conditions
+        title: Title
+        from: Sender
+        relative_delay: Delay
+        template: Template
+      sequence: 
+        name: Name
+        context_name: Context
+        mode: Mode
+        start: Start date
+        start_var: Start variable (evaluated)
+        period: Period

data/spec/dummy/db/migrate/20130723074347_create_users.rb

@@ -0,0 +1,18 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string      :name
+      t.string      :email
+      t.boolean     :weekly_notifications, default: true
+      t.boolean     :active, default: true
+
+      t.timestamps
+    end
+
+    create_table :products do |t|
+      t.string      :name
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,82 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20150205120443) do
+
+  create_table "maily_herald_dispatches", :force => true do |t|
+    t.string   "type",                                          :null => false
+    t.integer  "sequence_id"
+    t.integer  "list_id",                                       :null => false
+    t.text     "conditions"
+    t.text     "start_at"
+    t.string   "mailer_name"
+    t.string   "name",                                          :null => false
+    t.string   "title"
+    t.string   "subject"
+    t.string   "from"
+    t.string   "state",                 :default => "disabled"
+    t.text     "template"
+    t.integer  "absolute_delay"
+    t.integer  "period"
+    t.boolean  "override_subscription"
+    t.datetime "created_at",                                    :null => false
+    t.datetime "updated_at",                                    :null => false
+  end
+
+  add_index "maily_herald_dispatches", ["name"], :name => "index_maily_herald_dispatches_on_name", :unique => true
+
+  create_table "maily_herald_lists", :force => true do |t|
+    t.string "name",         :null => false
+    t.string "title"
+    t.string "context_name"
+  end
+
+  create_table "maily_herald_logs", :force => true do |t|
+    t.integer  "entity_id",     :null => false
+    t.string   "entity_type",   :null => false
+    t.string   "entity_email"
+    t.integer  "mailing_id"
+    t.string   "status",        :null => false
+    t.text     "data"
+    t.datetime "processing_at"
+  end
+
+  create_table "maily_herald_subscriptions", :force => true do |t|
+    t.integer  "entity_id",                       :null => false
+    t.integer  "list_id",                         :null => false
+    t.string   "entity_type",                     :null => false
+    t.string   "token",                           :null => false
+    t.text     "settings"
+    t.text     "data"
+    t.boolean  "active",       :default => false, :null => false
+    t.datetime "delivered_at"
+    t.datetime "created_at",                      :null => false
+    t.datetime "updated_at",                      :null => false
+  end
+
+  create_table "products", :force => true do |t|
+    t.string   "name"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
+  create_table "users", :force => true do |t|
+    t.string   "name"
+    t.string   "email"
+    t.boolean  "weekly_notifications", :default => true
+    t.boolean  "active",               :default => true
+    t.datetime "created_at",                             :null => false
+    t.datetime "updated_at",                             :null => false
+  end
+
+end

data/spec/factories/products.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :product do
+    sequence(:name)  {|n| "Product #{n}"}
+  end
+end

data/spec/factories/users.rb

@@ -0,0 +1,11 @@
+FactoryGirl.define do
+  factory :user do
+    sequence(:name)  {|n| "John #{n}"}
+    sequence(:email)  {|n| "john#{n}@doe.com"}
+    active true
+
+    factory :inactive_user do
+      active false
+    end
+  end
+end

data/spec/lib/context_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe MailyHerald::Context do
+  describe "setup" do
+    before(:each) do
+      @user = FactoryGirl.create :user
+      @mailing = MailyHerald.one_time_mailing :test_mailing
+      @list = @mailing.list
+      @context = @list.context
+    end
+
+    describe "with subscription" do
+      before(:each) do
+        @list.subscribe! @user
+        @subscription = @mailing.subscription_for @user
+        @drop = @context.drop_for @user, @subscription
+      end
+
+      it "should get valid context" do
+        @context.should be_a(MailyHerald::Context)
+      end
+
+      it "should resolve attributes properly" do
+        @drop["user"].should be_a(MailyHerald::Context::Drop)
+        @drop["user"]["name"].should eq(@user.name)
+        @drop["user"]["properties"]["prop1"].should eq(@user.name[0])
+      end
+
+      it "should resolve subscription attributes properly" do
+        @drop["subscription"].should be_a(MailyHerald::Subscription)
+      end
+    end
+  end
+
+  it "should handle both destination procs and strings" do
+    @user = FactoryGirl.create :user
+    context = MailyHerald.context :all_users
+    context.destination_for(@user).should eq(@user.email)
+    context.destination_attribute.should be_nil
+  end
+end

data/spec/lib/maily_herald_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe MailyHerald do
+  describe "setup" do
+    before(:each) do
+      @user = FactoryGirl.create :user
+    end
+
+    it "should extend context entity models" do
+      MailyHerald.context(:all_users).model.name.should eq(User.name)
+      User.included_modules.should include(MailyHerald::ModelExtensions)
+
+      @user.should respond_to(:maily_herald_subscriptions)
+
+      @user.maily_herald_subscriptions.length.should be_zero
+    end
+
+    it "should create mailings from initializer" do
+      mailing = MailyHerald.one_time_mailing(:test_mailing)
+      mailing.should be_a MailyHerald::Mailing
+      mailing.should_not be_a_new_record
+    end
+
+    it "should create sequences from initializer" do
+      sequence = MailyHerald.sequence(:newsletters)
+      sequence.should be_a MailyHerald::Sequence
+      sequence.should_not be_a_new_record
+
+      sequence.mailings.length.should eq(3)
+    end
+  end
+end

data/spec/lib/utils_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe MailyHerald::Utils do
+  describe MailyHerald::Utils::MarkupEvaluator do
+    before(:each) do
+      @mailing = MailyHerald.one_time_mailing :test_mailing
+      @user = FactoryGirl.create :user
+      @list = @mailing.list
+      @list.subscribe!(@user)
+      @subscription = @mailing.subscription_for(@user)
+      @evaluator = MailyHerald::Utils::MarkupEvaluator.new(@list.context.drop_for(@user, @subscription))
+    end
+
+    it "should validate syntax" do
+      @mailing.conditions = "foo bar"
+      expect {@evaluator.evaluate_conditions(@mailing.conditions)}.to raise_error(Liquid::Error)
+      expect {MailyHerald::Utils::MarkupEvaluator.test_conditions(@mailing.conditions)}.to raise_error(Liquid::Error)
+    end
+
+    pending "should validate numerical conditions" do
+      @mailing.conditions = "(2 * 3) - 1"
+      @evaluator.evaluate_conditions(@mailing.conditions).should be_falsy
+      expect {@mailing.test_conditions}.not_to raise_error(Liquid::Error)
+
+      @mailing.conditions = "2 == 3"
+      @evaluator.evaluate_conditions(@mailing.conditions).should be_falsy
+      expect {@mailing.test_conditions}.not_to raise_error(Liquid::Error)
+
+      @mailing.conditions = "1 * 2 + 3"
+      @evaluator.evaluate_conditions(@mailing.conditions).should be_truthy
+      expect {@mailing.test_conditions}.not_to raise_error(Liquid::Error)
+    end
+
+    it "should provide model conditions syntax validation" do
+      @mailing.conditions = "foo bar"
+      @mailing.should_not be_valid
+    end
+
+    it "should evaluate attributes" do
+      expect(@evaluator.evaluate_variable("user.created_at")).to eq(@user.created_at)
+    end
+
+    it "should evaluate attributes without subscription" do
+      @evaluator = MailyHerald::Utils::MarkupEvaluator.new(@list.context.drop_for(@user, nil))
+      expect(@evaluator.evaluate_variable("user.created_at")).to eq(@user.created_at)
+    end
+  end
+end

data/spec/mailers/maily_herald/mailer_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe MailyHerald::Mailer do
+  before(:each) do
+    @entity = FactoryGirl.create :user
+    @mailing = MailyHerald.dispatch(:sample_mail)
+    @list = @mailing.list
+  end
+
+  describe "without subscription" do
+    it "should not deliver" do
+      MailyHerald::Log.delivered.count.should eq(0)
+
+      TestMailer.sample_mail(@entity).deliver
+
+      MailyHerald::Log.delivered.count.should eq(0)
+    end
+  end
+
+  describe "with subscription" do
+    before(:each) do
+      @list.subscribe! @entity
+    end
+
+    it "should deliver" do
+      MailyHerald::Log.delivered.count.should eq(0)
+
+      TestMailer.sample_mail(@entity).deliver
+
+      MailyHerald::Log.delivered.count.should eq(1)
+    end
+  end
+
+  # missing mailers are how handled silently (bypassing Maily)
+  #it "should handle missing mailer" do
+    #expect { TestMailer.sample_mail_error(@entity).deliver }.to raise_error
+  #end
+end

data/spec/models/maily_herald/list_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe MailyHerald::List do
+  before(:each) do
+    @entity = FactoryGirl.create :user
+    @product = FactoryGirl.create :product
+
+    @list = MailyHerald.list(:generic_list)
+    @list2 = MailyHerald::List.new
+    @list2.context_name = :all_users
+    @list2.name = "another_list"
+
+    expect(@list).to be_kind_of(MailyHerald::List)
+    expect(@list2.save).to be_truthy
+  end
+
+  after(:each) do
+    @list2.destroy
+  end
+
+  it "should handle subscripions" do
+    expect(@list.subscribed?(@entity)).to be_falsy
+    expect(@list.subscribe!(@entity)).to be_kind_of(MailyHerald::Subscription)
+    expect(@list.subscribed?(@entity)).to be_truthy
+    expect(@list.unsubscribe!(@entity)).to be_kind_of(MailyHerald::Subscription)
+    expect(@list.subscribed?(@entity)).to be_falsy
+  end
+
+  it "should not allow other models" do
+    @list.subscribe! @entity
+    expect(@list.subscribed?(@entity)).to be_truthy
+    expect{@list.subscribe! @product}.to raise_error(ActiveRecord::RecordInvalid)
+  end
+
+  it "should return valid subscribers" do
+    expect(@list.subscribers).to be_empty
+    expect(@list2.subscribers).to be_empty
+
+    expect(@list.subscribe!(@entity)).to be_kind_of(MailyHerald::Subscription)
+    expect(@list.subscribers.first).to eq(@entity)
+    expect(@list.potential_subscribers).to be_empty
+    expect(@list2.subscribers).to be_empty
+    expect(@list2.potential_subscribers.first).to eq(@entity)
+  end
+
+  it "should fetch all logs for list" do
+    @list.subscribe!(@entity)
+    expect(@list.subscribers.first).to eq(@entity)
+
+    @mailing = MailyHerald.one_time_mailing(:test_mailing)
+    @mailing.run
+
+    expect(@list.logs).to include(@mailing.logs.first)
+  end
+
+  it "should be lockable" do
+    @list = MailyHerald.list :locked_list
+    expect(@list).to be_locked
+    expect(@list.save).to be_falsy
+    expect(@list.errors.messages).to include(:base)
+    @list.destroy
+    expect(@list).not_to be_destroyed
+  end
+end

data/spec/models/maily_herald/log_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe MailyHerald::Log do
+  before(:each) do
+    @mailing = MailyHerald.periodical_mailing(:weekly_summary)
+    @entity = FactoryGirl.create :user
+  end
+
+  describe "Associations" do
+    it "should have proper scopes" do
+      log = MailyHerald::Log.create_for @mailing, @entity, {status: :delivered}
+      log.should be_valid
+      log.entity.should eq(@entity)
+      log.mailing.should eq(@mailing)
+
+      MailyHerald::Log.for_entity(@entity).should include(log)
+      MailyHerald::Log.for_mailing(@mailing).should include(log)
+
+      MailyHerald::Log.for_entity(@entity).for_mailing(@mailing).last.should eq(log)
+    end
+  end
+
+  it "should have proper scopes" do
+    log1 = MailyHerald::Log.create_for @mailing, @entity, {status: :delivered}
+    log2 = MailyHerald::Log.create_for @mailing, @entity, {status: :delivered}
+    expect(MailyHerald::Log.count).to eq(2)
+
+    log1.update_attribute(:status, :skipped)
+    MailyHerald::Log.count.should eq(2)
+    MailyHerald::Log.skipped.count.should eq(1)
+
+    log1.update_attribute(:status, :error)
+    MailyHerald::Log.count.should eq(2)
+    MailyHerald::Log.error.count.should eq(1)
+  end
+end

data/spec/models/maily_herald/mailing_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe MailyHerald::Mailing do
+  describe "Validations" do
+    it "should validate template syntax" do
+      @mailing = MailyHerald.one_time_mailing :test_mailing
+      @mailing.should be_valid
+      @mailing.template = "foo {{ bar"
+      @mailing.should_not be_valid
+      @mailing.errors.messages.keys.should include(:template)
+      @mailing.errors.messages[:template].should_not be_empty
+    end
+
+    it "should validate conditions syntax" do
+      @mailing = MailyHerald.one_time_mailing :test_mailing
+      @mailing.should be_valid
+      @mailing.conditions = "foo {{ bar"
+      @mailing.should_not be_valid
+      @mailing.errors.messages.keys.should include(:conditions)
+      @mailing.errors.messages[:conditions].should_not be_empty
+    end
+  end
+  
+  describe "Locking" do
+    it "should produce valiadtion errors" do
+      @mailing = MailyHerald.dispatch :locked_mailing
+      expect(@mailing).to be_locked
+      expect(@mailing.save).to be_falsy
+      expect(@mailing.errors.messages).to include(:base)
+      @mailing.destroy
+      expect(@mailing).not_to be_destroyed
+    end
+  end
+end