smailer 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2e3772412ea4ae474b3e81fdb40a1b283b4c483
-  data.tar.gz: 8c99e9cb73c3c259d97127c0c8f612eb8e779dab
+  metadata.gz: 6bf1b2eaf8471b07434e71803ce46eb6d971ad81
+  data.tar.gz: 3c761ccfcf13f68a90d57590c541e3935b6895dd
 SHA512:
-  metadata.gz: c65340fc1022af2ddcd1b21d71f4246fea5eef4ac4981f13c7a971889cce38709226acff5d293620fd1b328bffc2b35eedfec188ea80bcf661f8731fb9f012b3
-  data.tar.gz: 3790bc6d1bf551eb588cec59da2ae1b00969780e3609550b2b7e9570e8824db185884d4a79412d66b43e74e834eb5b37c042ae0da874bb5761b780eef7f04567
+  metadata.gz: 6b98a822ebfcce95f8ece649ed0b99a3522dc8e2c924e7fa8faf8f55f706bc8d97cc55d15e54b5b83c13877f07dcb0393ec8b5437644137d07721b40a0d3389f
+  data.tar.gz: 58cde2ebfc9c01c7d2d5d36655e50143f815157a9c72c51ef21c98318081f1d061d9c8be48474bab319d1787624f2742e72f54ea3be4e03870259c357d128294

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## Version v0.8.1
+
+- Adds support for 'reply-to'
+
+**Major Bug Fixes:**
+
+- `QueuedMail.new(to: …, from: …, mail_campaign: …)` will work as expected 9ff2d80
+- `QueuedMail#body_text=` now works as expected
+
 ## Version v0.8.0
 
 - Adds support for one-off emails to be send via the same queueing mechanism.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smailer (0.7.8)
+    smailer (0.8.1)
       bounce_email (~> 0.2)
       mail (~> 2.3)
 

data/README.md

@@ -68,6 +68,7 @@ Here is an example how you could proceed with creating and issuing a newsletter:
     # create a corresponding mail campaign
     campaign_params = {
       :from      => 'noreply@example.org',
+      :reply_to  => 'contact@example.org',
       :subject   => 'My First Campaign!',
       :body_html => '<h1>Hello</h1><p>World</p>',
       :body_text => 'Hello, world!',
@@ -105,9 +106,9 @@ You can send one-off emails that each have a different mail template:
     # Changing the campaign now won't change anything in the one-off queued mails.
 
     # Sending two mails to the same person for a single campaign:
-    campaign.queued_mails.create! :to => 'subscriber@domain.com', :body_html => 'second custom body', :body_text => 'second custom body', require_uniqueness => false
+    campaign.queued_mails.create! :to => 'subscriber@domain.com', :body_html => 'second custom body', :body_text => 'second custom body', :require_uniqueness => false
 
-You can change the `from`, `subject`, `body_html`, `body_text` and you can also call `add_attachment`. For more info check [Smailer::Models::QueuedMail](lib/smailer/models/queued_mail.rb).
+You can change the `from`, `reply_to`, `subject`, `body_html`, `body_text` and you can also call `add_attachment`. For more info check [Smailer::Models::QueuedMail](lib/smailer/models/queued_mail.rb).
 
 ### Attachments
 

data/generators/smailer/templates/migration.rb.erb

@@ -62,6 +62,7 @@ class CreateSmailerTables < ActiveRecord::Migration
       t.text     "body_text"
       t.datetime "created_at"
       t.datetime "updated_at"
+      t.string   "reply_to"
     end
 
     add_index "mail_templates", ["mail_campaign_id"], :name => "index_mail_templates_on_mail_campaign_id"

data/lib/generators/smailer/templates/migration.rb.erb

@@ -62,6 +62,7 @@ class CreateSmailerTables < ActiveRecord::Migration
       t.text     "body_text"
       t.datetime "created_at"
       t.datetime "updated_at"
+      t.string   "reply_to"
     end
 
     add_index "mail_templates", ["mail_campaign_id"], :name => "index_mail_templates_on_mail_campaign_id"

data/lib/smailer/models/mail_campaign.rb

@@ -13,15 +13,15 @@ module Smailer
 
       has_one :mail_template, :dependent => :destroy, :autosave => true, :inverse_of => :mail_campaign
 
-      delegate :from,  :subject,  :body_html,  :body_text,  :to => :my_mail_template, :allow_nil => true
-      delegate :from=, :subject=, :body_html=, :body_text=, :to => :my_mail_template
+      delegate :from,  :reply_to,  :subject,  :body_html,  :body_text,  :to => :my_mail_template, :allow_nil => true
+      delegate :from=, :reply_to=, :subject=, :body_html=, :body_text=, :to => :my_mail_template
 
       validates_presence_of :mailing_list_id, :from
       validates_numericality_of :mailing_list_id, :unsubscribe_methods, :only_integer => true, :allow_nil => true
       validates_length_of :from, :subject, :maximum => 255, :allow_nil => true
 
       unless Smailer::Compatibility.rails_4?
-        attr_accessible :mailing_list_id, :from, :subject, :body_html, :body_text
+        attr_accessible :mailing_list_id, :from, :reply_to, :subject, :body_html, :body_text
       end
 
       def add_unsubscribe_method(method_specification)

data/lib/smailer/models/queued_mail.rb

@@ -16,7 +16,7 @@ module Smailer
       validates_length_of :to, :last_error, :maximum => 255, :allow_nil => true
 
       unless Smailer::Compatibility.rails_4?
-        attr_accessible :mail_campaign_id, :to, :from, :subject, :body_html, :body_text, :require_uniqueness
+        attr_accessible :mail_campaign, :mail_campaign_id, :to, :from, :reply_to, :subject, :body_html, :body_text, :require_uniqueness
       end
 
       before_validation :initialize_message_key
@@ -25,8 +25,8 @@ module Smailer
       before_save :nullify_false_require_uniqueness
 
       delegate :mailing_list, :to => :mail_campaign, :allow_nil => true
-      delegate :from, :subject, :to => :active_mail_template, :allow_nil => true
-      delegate :from=, :subject=, :body_html=, :body_text, :to => :my_mail_template
+      delegate :from,  :reply_to,  :subject,  :to => :active_mail_template, :allow_nil => true
+      delegate :from=, :reply_to=, :subject=, :body_html=, :body_text=, :to => :my_mail_template
 
       def body_html
         interpolate active_mail_template.body_html
@@ -49,6 +49,22 @@ module Smailer
         my_mail_template.attachments.build(:filename => filename, :path => path)
       end
 
+      def mail_campaign_id=(campaign_id)
+        write_attribute(:mail_campaign_id, campaign_id)
+
+        fill_from_campaign_template
+
+        mail_campaign_id
+      end
+
+      def mail_campaign=(campaign)
+        write_attribute(:mail_campaign_id, campaign.try(:id))
+
+        fill_from_campaign_template
+
+        mail_campaign
+      end
+
       protected
 
       def active_mail_template
@@ -58,16 +74,21 @@ module Smailer
       def my_mail_template
         return mail_template if mail_template.present?
 
-        build_mail_template.tap do |template|
-          if mail_campaign.present?
-            campaign_template = mail_campaign.mail_template
+        build_mail_template.tap { fill_from_campaign_template }
+      end
+
+      def fill_from_campaign_template
+        if mail_campaign.present? and mail_template.present?
+          campaign_template = mail_campaign.mail_template
 
-            template.from      = campaign_template.from
-            template.subject   = campaign_template.subject
-            template.body_html = campaign_template.body_html
-            template.body_text = campaign_template.body_text
+          mail_template.from      ||= campaign_template.from
+          mail_template.reply_to  ||= campaign_template.reply_to
+          mail_template.subject   ||= campaign_template.subject
+          mail_template.body_html ||= campaign_template.body_html
+          mail_template.body_text ||= campaign_template.body_text
 
-            template.attachments = campaign_template.attachments.map(&:dup)
+          if mail_template.attachments.blank?
+            mail_template.attachments = campaign_template.attachments.map(&:dup)
           end
         end
       end

data/lib/smailer/tasks/send.rb

@@ -47,9 +47,10 @@ module Smailer
         items_to_process.each do |queue_item|
           # try to send the email
           mail = Mail.new do
-            from    queue_item.from
-            to      queue_item.to
-            subject queue_item.subject
+            from     queue_item.from
+            reply_to queue_item.reply_to if queue_item.reply_to.present?
+            to       queue_item.to
+            subject  queue_item.subject
             queue_item.attachments.each do |attachment|
               cached_attachments[attachment.id] ||= attachment.body
               add_file :filename => attachment.filename,

data/lib/smailer/version.rb

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

data/spec/factories/models.rb

@@ -4,8 +4,9 @@ FactoryGirl.define do
   end
 
   factory :mail_template, class: Smailer::Models::MailTemplate do
-    from    { generate(:email) }
-    subject 'Hi there'
+    from      { generate(:email) }
+    reply_to  { generate(:email) }
+    subject   'Hi there'
     body_html '<h1>Hi there</h1>'
     body_text 'Hi there'
   end

data/spec/features/issuing_a_newsletter_spec.rb

@@ -14,6 +14,7 @@ describe 'Issuing a newsletter' do
       # create a corresponding mail campaign
       campaign_params = {
         :from      => 'noreply@example.org',
+        :reply_to  => 'contact@example.org',
         :subject   => 'My First Campaign!',
         :body_html => '<h1>Hello</h1><p>World</p>',
         :body_text => 'Hello, world!',

data/spec/features/{sending_oneoff_emails.rb → sending_oneoff_emails_spec.rb}

@@ -17,7 +17,7 @@ describe 'Sending one-off emails' do
       # 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
+      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
@@ -33,8 +33,8 @@ describe 'Sending one-off emails' do
 
       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.from).to      eq(campaign.from)
+      expect(second_mail.subject).to   eq(campaign.subject)
       expect(second_mail.body_html).to eq('<h1>second custom body</h1>')
       expect(second_mail.body_text).to eq('second custom body')
     end

data/spec/models/mail_campaign_spec.rb

@@ -7,8 +7,9 @@ describe Smailer::Models::MailCampaign do
 
       mail_campaign.mailing_list = FactoryGirl.create(:mailing_list)
 
-      mail_campaign.from = '"test" <test@example.com>'
-      mail_campaign.subject = 'This is my test'
+      mail_campaign.from      = '"test" <test@example.com>'
+      mail_campaign.reply_to  = '"contacts" <contacts@example.com>'
+      mail_campaign.subject   = 'This is my test'
       mail_campaign.body_html = 'Hello html'
       mail_campaign.body_text = 'Hello text'
 
@@ -23,6 +24,14 @@ describe Smailer::Models::MailCampaign do
       expect(Smailer::Models::MailCampaign.count).to eq(1)
       expect(Smailer::Models::MailTemplate.count).to eq(1)
       expect(Smailer::Models::MailAttachment.count).to eq(1)
+
+      mail_campaign.reload
+
+      expect(mail_campaign.from).to      eq ('"test" <test@example.com>')
+      expect(mail_campaign.reply_to).to  eq ('"contacts" <contacts@example.com>')
+      expect(mail_campaign.subject).to   eq ('This is my test')
+      expect(mail_campaign.body_html).to eq ('Hello html')
+      expect(mail_campaign.body_text).to eq ('Hello text')
     end
   end
 end

data/spec/models/queued_mail_spec.rb

@@ -1,6 +1,29 @@
 require 'spec_helper'
 
 describe Smailer::Models::QueuedMail do
+  describe '.new' do
+    it 'will fill the mail_template from the mail_campaign as expected' do
+      mail_campaign = FactoryGirl.create(:mail_campaign, :subject => 'Campaign subject', :from => 'from@campaign.com')
+
+      queued_mail = Smailer::Models::QueuedMail.new(
+        :to        => 'someone@world.com',
+        :reply_to  => 'reply@world.com',
+        :body_html => 'Custom html body',
+        :body_text => 'Custom text body',
+        :mail_campaign => mail_campaign
+      )
+
+      queued_mail.valid?
+      expect(queued_mail.errors).to be_blank
+
+      expect(queued_mail.from).to      eq('from@campaign.com')
+      expect(queued_mail.subject).to   eq('Campaign subject')
+      expect(queued_mail.reply_to).to  eq('reply@world.com')
+      expect(queued_mail.body_html).to eq('Custom html body')
+      expect(queued_mail.body_text).to eq('Custom text body')
+    end
+  end
+
   describe '#save' do
     it 'could be made only with mail_campaign and to (recipient)' do
       mail_campaign = FactoryGirl.create(:mail_campaign)
@@ -25,40 +48,91 @@ describe Smailer::Models::QueuedMail do
       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)
+    describe 'when changing the mail_template' do
+      [
+        {:from      => 'sender@example.com'},
+        {:reply_to  => 'reply@example.com'},
+        {:subject   => 'MY NEW SUBJECT'},
+        {:body_html => 'NEW HTML BODY'},
+        {:body_text => 'NEW TEXT BODY'},
+      ].each do |changes|
+        it "would copy the mail_campaign template and modify the copy - changing #{changes}" 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'
+
+          changes.each do |key, value|
+            queued_mail.public_send("#{key}=", value)
+          end
+
+          queued_mail.save!
+
+          mail_campaign.reload
+          queued_mail.reload
+
+          expect(queued_mail.from).to      eq(changes[:from]      || mail_campaign.from)
+          expect(queued_mail.reply_to).to  eq(changes[:reply_to]  || mail_campaign.reply_to)
+          expect(queued_mail.body_html).to eq(changes[:body_html] || mail_campaign.body_html)
+          expect(queued_mail.body_text).to eq(changes[:body_text] || mail_campaign.body_text)
+          expect(queued_mail.subject).to   eq(changes[:subject]   || mail_campaign.subject)
+
+          expect(queued_mail.attachments).to be_present
+          expect(mail_campaign.attachments).to be_present
+          expect(queued_mail.attachments.first.filename).to eq(mail_campaign.attachments.first.filename)
+          expect(queued_mail.attachments.first.path).to eq(mail_campaign.attachments.first.path)
+
+          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
+
+      it "would copy the mail_campaign template when adding an attachment" 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.add_attachment('bar.pdf', '/tmp/bar.pdf')
+
+        queued_mail.save!
+
+        mail_campaign.reload
+        queued_mail.reload
+
+        expect(queued_mail.from).to      eq(mail_campaign.from)
+        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.filename).to eq(mail_campaign.attachments.first.filename)
+        expect(queued_mail.attachments.first.path).to eq(mail_campaign.attachments.first.path)
+        expect(queued_mail.attachments.last.filename).to eq('bar.pdf')
+        expect(queued_mail.attachments.last.path).to eq('/tmp/bar.pdf')
+
+        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(3)
+        expect(Smailer::Models::QueuedMail.count).to eq(1)
+      end
     end
   end
 

data/upgrading/migrations/smailer_v0_8_0_to_v0_8_1.rb

@@ -0,0 +1,9 @@
+class SmailerV080ToV081 < ActiveRecord::Migration
+  def self.up
+    add_column :mail_templates, :reply_to, :string
+  end
+
+  def self.down
+    remove_column :mail_templates, :reply_to
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smailer
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Dimitar Dimitrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-26 00:00:00.000000000 Z
+date: 2015-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,11 +133,12 @@ files:
 - spec/factories/common.rb
 - spec/factories/models.rb
 - spec/features/issuing_a_newsletter_spec.rb
-- spec/features/sending_oneoff_emails.rb
+- spec/features/sending_oneoff_emails_spec.rb
 - spec/models/mail_campaign_spec.rb
 - spec/models/queued_mail_spec.rb
 - spec/spec_helper.rb
 - upgrading/migrations/smailer_v0_7_3_to_v0_8_0.rb
+- upgrading/migrations/smailer_v0_8_0_to_v0_8_1.rb
 homepage: http://github.com/livebg/smailer
 licenses: []
 metadata: {}