sparkpost_rails 1.0.1 → 1.1.0

data/spec/bcc_recipients_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "BCC Recipients" do
+
+    context "single bcc recipient, no cc recipients" do
+      it "handles email only" do
+        test_email = Mailer.test_email bcc: "bcc@example.com"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com"}}, {address: {email: "bcc@example.com", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:content]).not_to include(:headers)
+      end
+
+      it "handles name and email" do
+        test_email = Mailer.test_email to: "Joe Test <to1@example.com>, Sam Test <to2@example.com>", bcc: "Brock Test <bcc@example.com>"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com", name: "Joe Test"}}, {address: {email: "to2@example.com", name: "Sam Test"}}, {address: {email: "bcc@example.com", name: "Brock Test", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content]).not_to include(:headers)
+      end
+    end
+
+    context "multiple bcc recipients, no cc recipientsa" do
+      it "handles email only" do
+        test_email = Mailer.test_email bcc: "bcc1@example.com, bcc2@example.com"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com"}}, {address: {email: "bcc1@example.com", header_to: "to@example.com"}}, {address: {email: "bcc2@example.com", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:content]).not_to include(:headers)
+      end
+
+      it "handles name and email" do
+        test_email = Mailer.test_email to: "Joe Test <to@example.com>", bcc: "Brock Test <bcc1@example.com>, Brack Test <bcc2@example.com>"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com", name: "Joe Test"}}, {address: {email: "bcc1@example.com", name: "Brock Test", header_to: "to@example.com"}}, {address: {email: "bcc2@example.com", name: "Brack Test", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:content]).not_to include(:headers)
+      end
+
+      it "handles mix of email only and name/email" do
+        test_email = Mailer.test_email to: "Joe Test <to@example.com>", bcc: "Brock Test <bcc1@example.com>, bcc2@example.com"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com", name: "Joe Test"}}, {address: {email: "bcc1@example.com", name: "Brock Test", header_to: "to@example.com"}}, {address: {email: "bcc2@example.com", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:content]).not_to include(:headers)
+      end
+    end
+
+    context "bcc and cc recipients" do
+      it "handles email only" do
+        test_email = Mailer.test_email to: "to1@example.com, to2@example.com", cc: "cc@example.com", bcc: "bcc@example.com"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com"}}, {address: {email: "to2@example.com"}}, {address: {email: "cc@example.com", header_to: "to1@example.com"}}, {address: {email: "bcc@example.com", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc@example.com"]})
+      end
+
+      it "handles name and email" do
+        test_email = Mailer.test_email to: "Joe Test <to1@example.com>, Sam Test <to2@example.com>", cc: "Carl Test <cc@example.com>", bcc: "Brock Test <bcc@example.com>"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com", name: "Joe Test"}}, {address: {email: "to2@example.com", name: "Sam Test"}}, {address: {email: "cc@example.com", name: "Carl Test", header_to: "to1@example.com"}}, {address: {email: "bcc@example.com", name: "Brock Test", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc@example.com"]})
+      end
+
+      it "handles mix of email only and name/email" do
+        test_email = Mailer.test_email to: "Joe Test <to1@example.com>, to2@example.com", cc: "cc1@example.com, Chris Test <cc2@example.com>", bcc: "Brock Test <bcc1@example.com>, bcc2@example.com"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com", name: "Joe Test"}}, {address: {email: "to2@example.com"}}, {address: {email: "cc1@example.com", header_to: "to1@example.com"}}, {address: {email: "cc2@example.com", name: "Chris Test", header_to: "to1@example.com"}}, {address: {email: "bcc1@example.com", name: "Brock Test", header_to: "to1@example.com"}}, {address: {email: "bcc2@example.com", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc1@example.com", "cc2@example.com"]})
+      end
+    end
+  end
+end

data/spec/campaign_id_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    SparkPostRails.configuration.set_defaults
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Campaign ID" do
+    it "handles campaign id in the configuration" do
+      SparkPostRails.configure do |c|
+        c.campaign_id = "ABCD1234"
+      end
+
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:campaign_id]).to eq("ABCD1234")
+    end
+
+    it "handles campaign id on an individual message" do
+      test_email = Mailer.test_email sparkpost_data: {campaign_id: "My Campaign"}
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:campaign_id]).to eq("My Campaign")
+    end
+
+    it "handles the value on an individual message overriding configuration" do
+      SparkPostRails.configure do |c|
+        c.campaign_id = "ABCD1234"
+      end
+
+      test_email = Mailer.test_email sparkpost_data: {campaign_id: "My Campaign"}
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:campaign_id]).to eq("My Campaign")
+    end
+
+    it "handles the value on an individual message of nil overriding configuration" do
+      SparkPostRails.configure do |c|
+        c.campaign_id = "ABCD1234"
+      end
+
+      test_email = Mailer.test_email sparkpost_data: {campaign_id: nil}
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data.has_key?(:campaign_id)).to eq(false)
+    end
+
+    it "handles a default setting of none" do
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data.has_key?(:campaign_id)).to eq(false)
+    end
+
+  end
+end
+
+

data/spec/cc_recipients_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "CC Recipients" do
+    context "single to recipient and single cc recipient" do
+      it "handles email only" do
+        test_email = Mailer.test_email cc: "cc@example.com"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com"}}, {address: {email: "cc@example.com", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc@example.com"]})
+      end
+
+      it "handles name and email" do
+        test_email = Mailer.test_email to: "Joe Test <to@example.com>", cc: "Carl Test <cc@example.com>"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com", name: "Joe Test"}}, {address: {email: "cc@example.com", name: "Carl Test", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc@example.com"]})
+      end
+    end
+
+    context "single to recipient and multiple cc recipients" do
+      it "handles email only" do
+        test_email = Mailer.test_email cc: "cc1@example.com, cc2@example.com"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com"}}, {address: {email: "cc1@example.com", header_to: "to@example.com"}}, {address: {email: "cc2@example.com", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc1@example.com", "cc2@example.com"]})
+      end
+
+      it "handles name and email" do
+        test_email = Mailer.test_email to: "Joe Test <to@example.com>", cc: "Carl Test <cc1@example.com>, Chris Test <cc2@example.com>"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com", name: "Joe Test"}}, {address: {email: "cc1@example.com", name: "Carl Test", header_to: "to@example.com"}}, {address: {email: "cc2@example.com", name: "Chris Test", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc1@example.com", "cc2@example.com"]})
+      end
+
+      it "handles mix of email only and name/email" do
+        test_email = Mailer.test_email to: "Joe Test <to@example.com>", cc: "Carl Test <cc1@example.com>, cc2@example.com"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to@example.com", name: "Joe Test"}}, {address: {email: "cc1@example.com", name: "Carl Test", header_to: "to@example.com"}}, {address: {email: "cc2@example.com", header_to: "to@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc1@example.com", "cc2@example.com"]})
+      end
+    end
+
+    context "multiple to recipients with single cc recipient" do
+      it "handles email only" do
+        test_email = Mailer.test_email to: "to1@example.com, to2@example.com", cc: "cc@example.com"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com"}}, {address: {email: "to2@example.com"}}, {address: {email: "cc@example.com", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc@example.com"]})
+      end
+
+      it "handles name and email" do
+        test_email = Mailer.test_email to: "Joe Test <to1@example.com>, Sam Test <to2@example.com>", cc: "Carl Test <cc@example.com>"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com", name: "Joe Test"}}, {address: {email: "to2@example.com", name: "Sam Test"}}, {address: {email: "cc@example.com", name: "Carl Test", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc@example.com"]})
+      end
+    end
+
+    context "multiple to recipients with multiple cc recipients" do
+      it "handles email only" do
+        test_email = Mailer.test_email to: "to1@example.com, to2@example.com", cc: "cc1@example.com, cc2@example.com"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com"}}, {address: {email: "to2@example.com"}}, {address: {email: "cc1@example.com", header_to: "to1@example.com"}}, {address: {email: "cc2@example.com", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc1@example.com", "cc2@example.com"]})
+      end
+
+      it "handles name and email" do
+        test_email = Mailer.test_email to: "Joe Test <to1@example.com>, Sam Test <to2@example.com>", cc: "Carl Test <cc1@example.com>, Chris Test <cc2@example.com>"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com", name: "Joe Test"}}, {address: {email: "to2@example.com", name: "Sam Test"}}, {address: {email: "cc1@example.com", name: "Carl Test", header_to: "to1@example.com"}}, {address: {email: "cc2@example.com", name: "Chris Test", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc1@example.com", "cc2@example.com"]})
+      end
+
+      it "handles mix of email only and name/email for to recipients" do
+        test_email = Mailer.test_email to: "Joe Test <to1@example.com>, to2@example.com", cc: "cc1@example.com, Chris Test <cc2@example.com>"
+        @delivery_method.deliver!(test_email)
+
+        expect(@delivery_method.data[:recipients]).to eq([{address: {email: "to1@example.com", name: "Joe Test"}}, {address: {email: "to2@example.com"}}, {address: {email: "cc1@example.com", header_to: "to1@example.com"}}, {address: {email: "cc2@example.com", name: "Chris Test", header_to: "to1@example.com"}}])
+        expect(@delivery_method.data[:content][:headers]).to eq({cc: ["cc1@example.com", "cc2@example.com"]})
+      end
+    end
+  end
+end

data/spec/click_tracking_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    SparkPostRails.configuration.set_defaults
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Click Tracking" do
+    it "handles click tracking enabled in the configuration" do
+      SparkPostRails.configure do |c|
+        c.track_clicks = true
+      end
+
+      test_email = Mailer.test_email
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:click_tracking]).to eq(true)
+    end
+
+    it "handles click tracking enabled on an individual message" do
+      test_email = Mailer.test_email sparkpost_data: {track_clicks: true}
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:click_tracking]).to eq(true)
+    end
+
+    it "handles the value on an individual message overriding configuration" do
+      SparkPostRails.configure do |c|
+        c.track_clicks = true
+      end
+
+      test_email = Mailer.test_email sparkpost_data: {track_clicks: false}
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:click_tracking]).to eq(false)
+    end
+
+    it "handles a default setting of 'false'" do
+      test_email = Mailer.test_email
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:click_tracking]).to eq(false)
+    end
+
+  end
+end
+
+

data/spec/{content_spec.rb → inline_content_spec.rb}

@@ -6,7 +6,7 @@ describe SparkPostRails::DeliveryMethod do
     @delivery_method = SparkPostRails::DeliveryMethod.new
   end
 
-  context "Content" do
+  context "Inline Content" do
     it "sets the subject" do
       test_email = Mailer.test_email
       @delivery_method.deliver!(test_email)
@@ -29,6 +29,14 @@ describe SparkPostRails::DeliveryMethod do
       expect(@delivery_method.data[:content][:text]).to eq("Hello, Testing!")
       expect(@delivery_method.data[:content][:html]).to eq("<h1>Hello, Testing!</h1>")
     end
+
+    it "should not include template details" do
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:content].has_key?(:template_id)).to eq(false)
+      expect(@delivery_method.data[:content].has_key?(:use_draft_template)).to eq(false)
+    end
   end
 end
 

data/spec/open_tracking_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    SparkPostRails.configuration.set_defaults
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Open Tracking" do
+    it "handles open tracking enabled in the configuration" do
+      SparkPostRails.configure do |c|
+        c.track_opens = true
+      end
+
+      test_email = Mailer.test_email
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:open_tracking]).to eq(true)
+    end
+
+    it "handles open tracking enabled on an individual message" do
+      test_email = Mailer.test_email sparkpost_data: {track_opens: true}
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:open_tracking]).to eq(true)
+    end
+
+    it "handles the value on an individual message overriding configuration" do
+      SparkPostRails.configure do |c|
+        c.track_opens = true
+      end
+
+      test_email = Mailer.test_email sparkpost_data: {track_opens: false}
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:open_tracking]).to eq(false)
+    end
+
+    it "handles a default setting of 'false'" do
+      test_email = Mailer.test_email
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:options][:open_tracking]).to eq(false)
+    end
+
+  end
+end
+
+

data/spec/recipients_list_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Recipients List" do
+
+    it "handles a list_id" do
+      test_email = Mailer.test_email sparkpost_data: {recipient_list_id: "List1"}
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:recipients]).to eq({list_id: "List1"})
+    end
+
+    it "ignores any CC addresses" do
+      test_email = Mailer.test_email cc: "cc@example.com", sparkpost_data: {recipient_list_id: "List1"}
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:recipients]).to eq({list_id: "List1"})
+      expect(@delivery_method.data[:content].has_key?(:headers)).to eq(false)
+    end
+
+    it "ignores any BCC addresses" do
+      test_email = Mailer.test_email bcc: "cc@example.com", sparkpost_data: {recipient_list_id: "List1"}
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:recipients]).to eq({list_id: "List1"})
+    end
+  end
+
+end

data/spec/return_path_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe SparkPostRails::DeliveryMethod do
+
+  before(:each) do
+    SparkPostRails.configuration.set_defaults
+    @delivery_method = SparkPostRails::DeliveryMethod.new
+  end
+
+  context "Return Path" do
+    it "handles return path set in the configuration" do
+      SparkPostRails.configure do |c|
+        c.return_path = "BOUNCE-EMAIL@EXAMPLE.COM"
+      end
+
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:return_path]).to eq('BOUNCE-EMAIL@EXAMPLE.COM')
+    end
+
+    it "handles return path on an individual message" do
+      test_email = Mailer.test_email return_path: "bounce@example.com"
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:return_path]).to eq('bounce@example.com')
+    end
+
+    it "handles the value on an individual message overriding configuration" do
+      SparkPostRails.configure do |c|
+        c.return_path = "BOUNCE-EMAIL@EXAMPLE.COM"
+      end
+
+      test_email = Mailer.test_email return_path: "bounce@example.com"
+
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data[:return_path]).to eq('bounce@example.com')
+    end
+
+    it "handles a default setting of none" do
+      test_email = Mailer.test_email
+      @delivery_method.deliver!(test_email)
+
+      expect(@delivery_method.data.has_key?(:return_path)).to eq(false)
+    end
+
+  end
+end