smailer 0.7.8 → 0.8.0

data/lib/smailer/tasks/send.rb

@@ -50,7 +50,7 @@ module Smailer
             from    queue_item.from
             to      queue_item.to
             subject queue_item.subject
-            queue_item.mail_campaign.attachments.each do |attachment|
+            queue_item.attachments.each do |attachment|
               cached_attachments[attachment.id] ||= attachment.body
               add_file :filename => attachment.filename,
                        :content => cached_attachments[attachment.id]
@@ -114,4 +114,4 @@ module Smailer
       end
     end
   end
-end
+end

data/lib/smailer/version.rb

@@ -1,7 +1,7 @@
 module Smailer
   MAJOR = 0
-  MINOR = 7
-  PATCH = 8
+  MINOR = 8
+  PATCH = 0
 
   VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/setup-test-db

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+set -e
+
+cd ./spec/dummy/
+
+find ./db/migrate -type f -exec rm -i {} \; || true
+
+bundle install
+bundle exec rake db:test:purge
+
+./bin/rails g smailer:migration
+
+bundle exec rake db:migrate RAILS_ENV=test

data/spec/factories/common.rb

@@ -0,0 +1,4 @@
+FactoryGirl.define do
+  sequence(:name)  { |n| "Name-#{n}" }
+  sequence(:email) { |n| "user#{n}@example.com" }
+end

data/spec/factories/models.rb

@@ -0,0 +1,26 @@
+FactoryGirl.define do
+  factory :mailing_list, class: Smailer::Models::MailingList do
+    name { "Mailing List #{generate(:name)}" }
+  end
+
+  factory :mail_template, class: Smailer::Models::MailTemplate do
+    from    { generate(:email) }
+    subject 'Hi there'
+    body_html '<h1>Hi there</h1>'
+    body_text 'Hi there'
+  end
+
+  factory :mail_campaign, class: Smailer::Models::MailCampaign do
+    association :mailing_list
+
+    after(:build) do |mail_campaign|
+      mail_campaign.mail_template ||= FactoryGirl.build(:mail_template)
+    end
+  end
+
+  factory :queued_mail, class: Smailer::Models::QueuedMail do
+    association :mail_campaign
+
+    to { generate(:email) }
+  end
+end

data/spec/features/issuing_a_newsletter_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper.rb'
+
+describe 'Issuing a newsletter' do
+  describe 'the example from the readme' do
+    before do
+      # Required setup not from the readme
+      FactoryGirl.create(:mailing_list)
+    end
+
+    it 'works as expected' do
+      # locate the mailing list we'll be sending to
+      list = Smailer::Models::MailingList.first
+
+      # create a corresponding mail campaign
+      campaign_params = {
+        :from      => 'noreply@example.org',
+        :subject   => 'My First Campaign!',
+        :body_html => '<h1>Hello</h1><p>World</p>',
+        :body_text => 'Hello, world!',
+        :mailing_list_id => list.id,
+      }
+      campaign = Smailer::Models::MailCampaign.new campaign_params
+      campaign.add_unsubscribe_method :all
+
+      # Add attachments
+      campaign.add_attachment 'attachment.pdf', 'url_or_file_path_to_attachment'
+
+      campaign.save!
+
+      # enqueue mails to be sent out
+      subscribers = %w[
+        subscriber@domain.com
+        office@company.com
+        contact@store.com
+      ]
+      subscribers.each do |subscriber|
+        campaign.queued_mails.create! :to => subscriber
+      end
+
+      expect(Smailer::Models::MailCampaign.count).to eq(1)
+      expect(Smailer::Models::MailTemplate.count).to eq(1)
+      expect(Smailer::Models::MailAttachment.count).to eq(1)
+      expect(Smailer::Models::QueuedMail.count).to eq(3)
+
+      expect(campaign.from).to            eq(campaign_params[:from])
+      expect(campaign.subject).to         eq(campaign_params[:subject])
+      expect(campaign.body_html).to       eq(campaign_params[:body_html])
+      expect(campaign.body_text).to       eq(campaign_params[:body_text])
+      expect(campaign.mailing_list_id).to eq(campaign_params[:mailing_list_id])
+    end
+  end
+end

data/spec/features/sending_oneoff_emails.rb

@@ -0,0 +1,42 @@
+require 'spec_helper.rb'
+
+describe 'Sending one-off emails' do
+  describe 'the example from the readme' do
+    before do
+      # Required setup not from the readme
+      FactoryGirl.create(:mail_campaign)
+    end
+
+    it 'works as expected' do
+      campaign = Smailer::Models::MailCampaign.first
+
+      # The mail template is copied from the campaign and then you make you changes
+      # e.g. here the subject and from are copied from the campaign
+      campaign.queued_mails.create! :to => 'subscriber@domain.com', :body_html => '<h1>my custom body</h1>', :body_text => 'my custom body'
+
+      # if you change the campaign now it won't change the one-off queued_mails
+
+      # sending two mails to the same person
+      campaign.queued_mails.create! :to => 'subscriber@domain.com', :body_html => '<h1>second custom body</h1>', :body_text => 'second custom body', require_uniqueness => false
+
+      expect(Smailer::Models::MailCampaign.count).to eq(1)
+      expect(Smailer::Models::MailTemplate.count).to eq(3) # 1 for the campaign and 2 for the one-off emails
+      expect(Smailer::Models::MailAttachment.count).to eq(0)
+      expect(Smailer::Models::QueuedMail.count).to eq(2)
+
+      first_mail = campaign.queued_mails.first
+
+      expect(first_mail.from).to      eq(campaign.from)
+      expect(first_mail.subject).to   eq(campaign.subject)
+      expect(first_mail.body_html).to eq('<h1>my custom body</h1>')
+      expect(first_mail.body_text).to eq('my custom body')
+
+      second_mail = campaign.queued_mails.last
+
+      expect(second_mail.from).to      eq(campaign_params.from)
+      expect(second_mail.subject).to   eq(campaign_params.subject)
+      expect(second_mail.body_html).to eq('<h1>second custom body</h1>')
+      expect(second_mail.body_text).to eq('second custom body')
+    end
+  end
+end

data/spec/models/mail_campaign_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Smailer::Models::MailCampaign do
+  describe '#save' do
+    it 'works as expected' do
+      mail_campaign = Smailer::Models::MailCampaign.new
+
+      mail_campaign.mailing_list = FactoryGirl.create(:mailing_list)
+
+      mail_campaign.from = '"test" <test@example.com>'
+      mail_campaign.subject = 'This is my test'
+      mail_campaign.body_html = 'Hello html'
+      mail_campaign.body_text = 'Hello text'
+
+      mail_campaign.add_attachment 'foo.pdf', '/tmp/foo.pdf'
+
+      expect(Smailer::Models::MailCampaign.count).to eq(0)
+      expect(Smailer::Models::MailTemplate.count).to eq(0)
+      expect(Smailer::Models::MailAttachment.count).to eq(0)
+
+      mail_campaign.save!
+
+      expect(Smailer::Models::MailCampaign.count).to eq(1)
+      expect(Smailer::Models::MailTemplate.count).to eq(1)
+      expect(Smailer::Models::MailAttachment.count).to eq(1)
+    end
+  end
+end

data/spec/models/queued_mail_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+describe Smailer::Models::QueuedMail do
+  describe '#save' do
+    it 'could be made only with mail_campaign and to (recipient)' do
+      mail_campaign = FactoryGirl.create(:mail_campaign)
+
+      queued_mail = Smailer::Models::QueuedMail.new
+
+      queued_mail.mail_campaign = mail_campaign
+      queued_mail.to = 'test@example.com'
+
+      expect(Smailer::Models::MailCampaign.count).to eq(1)
+      expect(Smailer::Models::MailTemplate.count).to eq(1)
+      expect(Smailer::Models::QueuedMail.count).to eq(0)
+
+      queued_mail.save!
+
+      expect(Smailer::Models::MailCampaign.count).to eq(1)
+      expect(Smailer::Models::MailTemplate.count).to eq(1)
+      expect(Smailer::Models::QueuedMail.count).to eq(1)
+
+      queued_mail.reload
+
+      expect(queued_mail.to).to eq('test@example.com')
+    end
+
+    it 'would create its own template if you change any of the template attributes and will copy the mail_campaign template' do
+      mail_campaign = FactoryGirl.create(:mail_campaign)
+      mail_campaign.add_attachment 'foo.pdf', '/tmp/foo.pdf'
+      mail_campaign.save!
+
+      queued_mail = Smailer::Models::QueuedMail.new
+
+      queued_mail.mail_campaign = mail_campaign
+      queued_mail.to = 'text@example.com'
+
+      queued_mail.from = 'sender@example.com'
+
+      queued_mail.save!
+
+      mail_campaign.reload
+      queued_mail.reload
+
+      expect(queued_mail.from).to      eq('sender@example.com')
+      expect(queued_mail.body_html).to eq(mail_campaign.body_html)
+      expect(queued_mail.body_text).to eq(mail_campaign.body_text)
+      expect(queued_mail.subject).to   eq(mail_campaign.subject)
+
+      expect(queued_mail.attachments).to be_present
+      expect(mail_campaign.attachments).to be_present
+      expect(queued_mail.attachments.first.path).to eq(mail_campaign.attachments.first.path)
+      expect(queued_mail.attachments.first.filename).to eq(mail_campaign.attachments.first.filename)
+
+      expect(queued_mail.mail_template).to_not     eq(mail_campaign.mail_template)
+      expect(queued_mail.attachments.first).to_not eq(mail_campaign.attachments.first)
+
+      expect(Smailer::Models::MailCampaign.count).to eq(1)
+      expect(Smailer::Models::MailTemplate.count).to eq(2)
+      expect(Smailer::Models::MailAttachment.count).to eq(2)
+      expect(Smailer::Models::QueuedMail.count).to eq(1)
+    end
+  end
+
+  describe '#key' do
+    it 'is unique per email' do
+      mail_campaign = FactoryGirl.create(:mail_campaign)
+
+      queued_mail_1 = Smailer::Models::QueuedMail.new
+      queued_mail_1.mail_campaign = mail_campaign
+      queued_mail_1.to = 'text@example.com'
+
+      queued_mail_2 = Smailer::Models::QueuedMail.new
+      queued_mail_2.mail_campaign = mail_campaign
+      queued_mail_2.to = 'text@example.com'
+
+      expect(queued_mail_1.key).to_not eq(queued_mail_2.key)
+    end
+  end
+
+  describe '#require_uniqueness' do
+    it 'is required by default' do
+      mail_campaign = FactoryGirl.create(:mail_campaign)
+
+      queued_mail_1 = Smailer::Models::QueuedMail.new
+      queued_mail_1.mail_campaign = mail_campaign
+      queued_mail_1.to = 'text@example.com'
+      queued_mail_1.save!
+
+      queued_mail_2 = Smailer::Models::QueuedMail.new
+      queued_mail_2.mail_campaign = mail_campaign
+      queued_mail_2.to = 'text@example.com'
+
+      expect(queued_mail_2.save).to eq(false)
+      expect(queued_mail_2.errors[:to]).to be_present
+    end
+
+    it 'could be turned off by setting it to false' do
+      mail_campaign = FactoryGirl.create(:mail_campaign)
+
+      queued_mail_1 = Smailer::Models::QueuedMail.new
+      queued_mail_1.mail_campaign = mail_campaign
+      queued_mail_1.to = 'text@example.com'
+      queued_mail_1.save!
+
+      queued_mail_2 = Smailer::Models::QueuedMail.new
+      queued_mail_2.mail_campaign = mail_campaign
+      queued_mail_2.to = 'text@example.com'
+      queued_mail_2.require_uniqueness = false
+
+      expect(queued_mail_2.save).to eq(true)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -11,6 +11,9 @@ Spork.prefork do
   # in spec/support/ and its subdirectories.
   Dir[File.expand_path('../../spec/support/**/*.rb', __FILE__)].each {|f| require f }
 
+  FactoryGirl.definition_file_paths = [File.expand_path('../../spec/factories/', __FILE__)]
+  FactoryGirl.find_definitions
+
   # Checks for pending migrations before tests are run.
   # If you are not using ActiveRecord, you can remove this line.
   ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration)
@@ -43,11 +46,26 @@ Spork.prefork do
     #     --seed 1234
     config.order = "random"
 
-    config.before(:suite) { DatabaseCleaner.clean_with :truncation }
-    config.before(:each)  { DatabaseCleaner.strategy = :transaction }
-    config.before(:each)  { DatabaseCleaner.start }
-    config.after(:each)   { DatabaseCleaner.clean }
+    config.before(:suite) do
+      DatabaseCleaner.clean_with(:truncation)
+
+      begin
+        DatabaseCleaner.start
+        FactoryGirl.lint
+      ensure
+        DatabaseCleaner.clean
+      end
+    end
+
+    config.before(:each) do
+      DatabaseCleaner.strategy = :transaction
+
+      DatabaseCleaner.start
+    end
 
+    config.after(:each) do
+      DatabaseCleaner.clean
+    end
   end
 end
 

data/upgrading/migrations/smailer_v0_7_3_to_v0_8_0.rb

@@ -0,0 +1,106 @@
+class SmailerV073ToV080 < ActiveRecord::Migration
+  class MailCampaign < ActiveRecord::Base
+    has_one :mail_template
+    has_many :mail_attachments
+  end
+
+  class MailTemplate < ActiveRecord::Base
+    belongs_to :mail_campaign
+    belongs_to :queued_mail, :dependent => :destroy
+
+    has_many :mail_attachments
+  end
+
+  class MailAttachment < ActiveRecord::Base
+    belongs_to :mail_campaign
+    belongs_to :mail_template
+  end
+
+  class QueuedMail < ActiveRecord::Base
+    has_one :queued_mail
+  end
+
+  def self.up
+    create_table :mail_templates do |t|
+      t.references :mail_campaign
+      t.references :queued_mail
+
+      t.string :from
+      t.string :subject
+      t.text   :body_html
+      t.text   :body_text
+
+      t.timestamps
+    end
+
+    add_index :mail_templates, :mail_campaign_id
+    add_index :mail_templates, :queued_mail_id
+
+    rename_table :mail_campaign_attachments, :mail_attachments
+
+    add_column :mail_attachments, :mail_template_id, :integer
+    add_index :mail_attachments, :mail_template_id
+
+    MailCampaign.all.each do |mail_campaign|
+      mail_template = MailTemplate.new
+
+      mail_template.mail_campaign    = mail_campaign
+      mail_template.mail_attachments = mail_campaign.mail_attachments
+      mail_template.from             = mail_campaign.from
+      mail_template.subject          = mail_campaign.subject
+      mail_template.body_html        = mail_campaign.body_html
+      mail_template.body_text        = mail_campaign.body_text
+
+      mail_template.save!
+    end
+
+    remove_column :mail_attachments, :mail_campaign_id
+
+    remove_column :mail_campaigns, :from
+    remove_column :mail_campaigns, :subject
+    remove_column :mail_campaigns, :body_html
+    remove_column :mail_campaigns, :body_text
+
+    add_column :queued_mails, :require_uniqueness, :boolean, :default => true
+
+    remove_index :queued_mails, :name => 'index_queued_mails_on_mail_campain_id_and_to'
+    add_index    :queued_mails, [:mail_campaign_id, :to, :require_uniqueness], :name => 'index_queued_mails_uniqueness_for_to', :unique => true
+  end
+
+  def self.down
+    remove_index :queued_mails, :name => 'index_queued_mails_uniqueness_for_to'
+    add_index :queued_mails, [:mail_campaign_id, :to], :name => 'index_queued_mails_on_mail_campain_id_and_to', :unique => true
+
+    QueuedMail.destroy_all('require_uniqueness is null')
+
+    remove_column :queued_mails, :require_uniqueness
+
+    MailTemplate.destroy_all('queued_mail_id is not null')
+
+    add_column :mail_campaigns, :from, :string
+    add_column :mail_campaigns, :subject, :string
+    add_column :mail_campaigns, :body_html, :text
+    add_column :mail_campaigns, :body_text, :text
+
+    add_column :mail_attachments, :mail_campaign_id, :integer
+    add_index :mail_attachments, :mail_campaign_id
+
+    MailCampaign.all.each do |mail_campaign|
+      mail_template = mail_campaign.mail_template
+
+      mail_campaign.mail_attachments = mail_template.mail_attachments
+
+      mail_campaign.from      = mail_template.from
+      mail_campaign.subject   = mail_template.subject
+      mail_campaign.body_html = mail_template.body_html
+      mail_campaign.body_text = mail_template.body_text
+
+      mail_campaign.save!
+    end
+
+    remove_column :mail_attachments, :mail_template_id
+    rename_table :mail_attachments, :mail_campaign_attachments
+
+    drop_table :mail_templates
+  end
+end