postmark 1.8.1 → 1.21.3

data/spec/unit/postmark/inflector_spec.rb

@@ -1,35 +1,33 @@
 require 'spec_helper'
 
 describe Postmark::Inflector do
-
   describe ".to_postmark" do
     it 'converts rubyish underscored format to camel cased symbols accepted by the Postmark API' do
-      subject.to_postmark(:foo_bar).should == 'FooBar'
-      subject.to_postmark(:_bar).should == 'Bar'
-      subject.to_postmark(:really_long_long_long_long_symbol).should == 'ReallyLongLongLongLongSymbol'
-      subject.to_postmark(:foo_bar_1).should == 'FooBar1'
+      expect(subject.to_postmark(:foo_bar)).to eq 'FooBar'
+      expect(subject.to_postmark(:_bar)).to eq 'Bar'
+      expect(subject.to_postmark(:really_long_long_long_long_symbol)).to eq 'ReallyLongLongLongLongSymbol'
+      expect(subject.to_postmark(:foo_bar_1)).to eq 'FooBar1'
     end
 
     it 'accepts strings as well' do
-      subject.to_postmark('foo_bar').should == 'FooBar'
+      expect(subject.to_postmark('foo_bar')).to eq 'FooBar'
     end
 
     it 'acts idempotentely' do
-      subject.to_postmark('FooBar').should == 'FooBar'
+      expect(subject.to_postmark('FooBar')).to eq 'FooBar'
     end
   end
 
   describe ".to_ruby" do
     it 'converts camel cased symbols returned by the Postmark API to underscored Ruby symbols' do
-      subject.to_ruby('FooBar').should == :foo_bar
-      subject.to_ruby('LongTimeAgoInAFarFarGalaxy').should == :long_time_ago_in_a_far_far_galaxy
-      subject.to_ruby('MessageID').should == :message_id
+      expect(subject.to_ruby('FooBar')).to eq :foo_bar
+      expect(subject.to_ruby('LongTimeAgoInAFarFarGalaxy')).to eq :long_time_ago_in_a_far_far_galaxy
+      expect(subject.to_ruby('MessageID')).to eq :message_id
     end
 
     it 'acts idempotentely' do
-      subject.to_ruby(:foo_bar).should == :foo_bar
-      subject.to_ruby(:foo_bar_1).should == :foo_bar_1
+      expect(subject.to_ruby(:foo_bar)).to eq :foo_bar
+      expect(subject.to_ruby(:foo_bar_1)).to eq :foo_bar_1
     end
   end
-
 end

data/spec/unit/postmark/json_spec.rb

@@ -6,8 +6,8 @@ describe Postmark::Json do
   shared_examples "json parser" do
     it 'encodes and decodes data correctly' do
       hash = Postmark::Json.decode(Postmark::Json.encode(data))
-      hash.should have_key("bar")
-      hash.should have_key("foo")
+      expect(hash).to have_key("bar")
+      expect(hash).to have_key("foo")
     end
   end
 

data/spec/unit/postmark/mail_message_converter_spec.rb

@@ -2,109 +2,154 @@
 require 'spec_helper'
 
 describe Postmark::MailMessageConverter do
-
-  subject { Postmark::MailMessageConverter }
+  subject {Postmark::MailMessageConverter}
 
   let(:mail_message) do
     Mail.new do
-      from    "sheldon@bigbangtheory.com"
-      to      "lenard@bigbangtheory.com"
+      from "sheldon@bigbangtheory.com"
+      to "lenard@bigbangtheory.com"
       subject "Hello!"
-      body    "Hello Sheldon!"
+      body "Hello Sheldon!"
     end
   end
 
   let(:mail_html_message) do
-    mail = Mail.new do
-      from          "sheldon@bigbangtheory.com"
-      to            "lenard@bigbangtheory.com"
-      subject       "Hello!"
+    Mail.new do
+      from "sheldon@bigbangtheory.com"
+      to "lenard@bigbangtheory.com"
+      subject "Hello!"
+      content_type 'text/html; charset=UTF-8'
+      body "<b>Hello Sheldon!</b>"
+    end
+  end
+
+  let(:mail_message_with_open_tracking) do
+    Mail.new do
+      from "sheldon@bigbangtheory.com"
+      to "lenard@bigbangtheory.com"
+      subject "Hello!"
       content_type 'text/html; charset=UTF-8'
       body "<b>Hello Sheldon!</b>"
+      track_opens true
     end
   end
 
-  let(:mail_message_with_tracking) do
-    mail = Mail.new do
-      from          "sheldon@bigbangtheory.com"
-      to            "lenard@bigbangtheory.com"
-      subject       "Hello!"
-      content_type  'text/html; charset=UTF-8'
-      body          "<b>Hello Sheldon!</b>"
-      track_opens   true
+  let(:mail_message_with_open_tracking_disabled) do
+    Mail.new do
+      from "sheldon@bigbangtheory.com"
+      to "lenard@bigbangtheory.com"
+      subject "Hello!"
+      content_type 'text/html; charset=UTF-8'
+      body "<b>Hello Sheldon!</b>"
+      track_opens false
     end
   end
 
+  let(:mail_message_with_open_tracking_set_variable) do
+    mail = mail_html_message
+    mail.track_opens = true
+    mail
+  end
+
+  let(:mail_message_with_open_tracking_disabled_set_variable) do
+    mail = mail_html_message
+    mail.track_opens = false
+    mail
+  end
+
+  let(:mail_message_with_link_tracking_all) do
+    mail = mail_html_message
+    mail.track_links :html_and_text
+    mail
+  end
+
+  let(:mail_message_with_link_tracking_html) do
+    mail = mail_html_message
+    mail.track_links = :html_only
+    mail
+  end
+
+  let(:mail_message_with_link_tracking_text) do
+    mail = mail_html_message
+    mail.track_links = :text_only
+    mail
+  end
+
+  let(:mail_message_with_link_tracking_none) do
+    mail = mail_html_message
+    mail.track_links = :none
+    mail
+  end
 
   let(:tagged_mail_message) do
     Mail.new do
-      from    "sheldon@bigbangtheory.com"
-      to      "lenard@bigbangtheory.com"
+      from "sheldon@bigbangtheory.com"
+      to "lenard@bigbangtheory.com"
       subject "Hello!"
-      body    "Hello Sheldon!"
-      tag     "sheldon"
+      body "Hello Sheldon!"
+      tag "sheldon"
     end
   end
 
   let(:mail_message_without_body) do
     Mail.new do
-      from    "sheldon@bigbangtheory.com"
-      to      "lenard@bigbangtheory.com"
+      from "sheldon@bigbangtheory.com"
+      to "lenard@bigbangtheory.com"
       subject "Hello!"
     end
   end
 
   let(:mail_multipart_message) do
-    mail = Mail.new do
-      from          "sheldon@bigbangtheory.com"
-      to            "lenard@bigbangtheory.com"
-      subject       "Hello!"
+    Mail.new do
+      from "sheldon@bigbangtheory.com"
+      to "lenard@bigbangtheory.com"
+      subject "Hello!"
       text_part do
-        body        "Hello Sheldon!"
+        body "Hello Sheldon!"
       end
       html_part do
-        body        "<b>Hello Sheldon!</b>"
+        body "<b>Hello Sheldon!</b>"
       end
     end
   end
 
   let(:mail_message_with_attachment) do
     Mail.new do
-      from    "sheldon@bigbangtheory.com"
-      to      "lenard@bigbangtheory.com"
+      from "sheldon@bigbangtheory.com"
+      to "lenard@bigbangtheory.com"
       subject "Hello!"
-      body    "Hello Sheldon!"
+      body "Hello Sheldon!"
       add_file empty_gif_path
     end
   end
 
   let(:mail_message_with_named_addresses) do
     Mail.new do
-      from    "Sheldon <sheldon@bigbangtheory.com>"
-      to      "\"Leonard Hofstadter\" <leonard@bigbangtheory.com>"
+      from "Sheldon <sheldon@bigbangtheory.com>"
+      to "\"Leonard Hofstadter\" <leonard@bigbangtheory.com>"
       subject "Hello!"
-      body    "Hello Sheldon!"
+      body "Hello Sheldon!"
       reply_to '"Penny The Neighbor" <penny@bigbangtheory.com>'
     end
   end
 
   let(:mail_message_quoted_printable) do
     Mail.new do
-      from    "Sheldon <sheldon@bigbangtheory.com>"
-      to      "\"Leonard Hofstadter\" <leonard@bigbangtheory.com>"
+      from "Sheldon <sheldon@bigbangtheory.com>"
+      to "\"Leonard Hofstadter\" <leonard@bigbangtheory.com>"
       subject "Hello!"
       content_type 'text/plain; charset=utf-8'
       content_transfer_encoding 'quoted-printable'
-      body    'Он здесь бывал: еще не в галифе.'
+      body 'Он здесь бывал: еще не в галифе.'
       reply_to '"Penny The Neighbor" <penny@bigbangtheory.com>'
     end
   end
 
   let(:multipart_message_quoted_printable) do
     Mail.new do
-      from          "sheldon@bigbangtheory.com"
-      to            "lenard@bigbangtheory.com"
-      subject       "Hello!"
+      from "sheldon@bigbangtheory.com"
+      to "lenard@bigbangtheory.com"
+      subject "Hello!"
       text_part do
         content_type 'text/plain; charset=utf-8'
         content_transfer_encoding 'quoted-printable'
@@ -118,107 +163,231 @@ describe Postmark::MailMessageConverter do
     end
   end
 
+  let(:templated_message) do
+    Mail.new do
+      from "sheldon@bigbangtheory.com"
+      to "lenard@bigbangtheory.com"
+      template_alias "hello"
+      template_model :name => "Sheldon"
+    end
+  end
+
   it 'converts plain text messages correctly' do
-    subject.new(mail_message).run.should == {
+    expect(subject.new(mail_message).run).to eq({
         "From" => "sheldon@bigbangtheory.com",
         "Subject" => "Hello!",
         "TextBody" => "Hello Sheldon!",
-        "To" => "lenard@bigbangtheory.com",
-        'TrackOpens' => false}
+        "To" => "lenard@bigbangtheory.com"})
   end
 
   it 'converts tagged text messages correctly' do
-    subject.new(tagged_mail_message).run.should == {
+    expect(subject.new(tagged_mail_message).run).to eq({
         "From" => "sheldon@bigbangtheory.com",
         "Subject" => "Hello!",
         "TextBody" => "Hello Sheldon!",
         "Tag" => "sheldon",
-        "To"=>"lenard@bigbangtheory.com",
-        'TrackOpens' => false}
+        "To" => "lenard@bigbangtheory.com"})
   end
 
   it 'converts plain text messages without body correctly' do
-    subject.new(mail_message_without_body).run.should == {
+    expect(subject.new(mail_message_without_body).run).to eq({
         "From" => "sheldon@bigbangtheory.com",
         "Subject" => "Hello!",
-        "To" => "lenard@bigbangtheory.com",
-        'TrackOpens' => false}
+        "To" => "lenard@bigbangtheory.com"})
   end
 
   it 'converts html messages correctly' do
-    subject.new(mail_html_message).run.should == {
+    expect(subject.new(mail_html_message).run).to eq({
         "From" => "sheldon@bigbangtheory.com",
         "Subject" => "Hello!",
         "HtmlBody" => "<b>Hello Sheldon!</b>",
-        "To" => "lenard@bigbangtheory.com",
-        'TrackOpens' => false}
+        "To" => "lenard@bigbangtheory.com"})
   end
 
   it 'converts multipart messages correctly' do
-    subject.new(mail_multipart_message).run.should == {
+    expect(subject.new(mail_multipart_message).run).to eq({
         "From" => "sheldon@bigbangtheory.com",
         "Subject" => "Hello!",
         "HtmlBody" => "<b>Hello Sheldon!</b>",
         "TextBody" => "Hello Sheldon!",
-        "To" => "lenard@bigbangtheory.com",
-        'TrackOpens' => false}
+        "To" => "lenard@bigbangtheory.com"})
   end
 
   it 'converts messages with attachments correctly' do
-    subject.new(mail_message_with_attachment).run.should == {
+    expect(subject.new(mail_message_with_attachment).run).to eq({
         "From" => "sheldon@bigbangtheory.com",
         "Subject" => "Hello!",
-        "Attachments" => [{"Name"=>"empty.gif",
-                           "Content"=>encoded_empty_gif_data,
-                           "ContentType"=>"image/gif"}],
-        "TextBody"=>"Hello Sheldon!",
-        "To"=>"lenard@bigbangtheory.com",
-        'TrackOpens' => false}
+        "Attachments" => [{"Name" => "empty.gif",
+                           "Content" => encoded_empty_gif_data,
+                           "ContentType" => "image/gif"}],
+        "TextBody" => "Hello Sheldon!",
+        "To" => "lenard@bigbangtheory.com"})
   end
 
   it 'converts messages with named addresses correctly' do
-    subject.new(mail_message_with_named_addresses).run.should == {
+    expect(subject.new(mail_message_with_named_addresses).run).to eq({
         "From" => "Sheldon <sheldon@bigbangtheory.com>",
         "Subject" => "Hello!",
         "TextBody" => "Hello Sheldon!",
         "To" => "Leonard Hofstadter <leonard@bigbangtheory.com>",
-        "ReplyTo" => 'Penny The Neighbor <penny@bigbangtheory.com>',
-        'TrackOpens' => false
-    }
+        "ReplyTo" => 'Penny The Neighbor <penny@bigbangtheory.com>'})
   end
 
-  it 'recognizes when open tracking is enabled' do
-    subject.new(mail_message_with_tracking).run.should == {
-        "From" => "sheldon@bigbangtheory.com",
-        "Subject" => "Hello!",
-        "HtmlBody" => "<b>Hello Sheldon!</b>",
-        "To" => "lenard@bigbangtheory.com",
-        "TrackOpens" => true}
+  it 'convertes templated messages correctly' do
+    expect(subject.new(templated_message).run).to eq({
+                                                         "From" => "sheldon@bigbangtheory.com",
+                                                         "TemplateAlias" => "hello",
+                                                         "TemplateModel" => {:name => "Sheldon"},
+                                                         "To" => "lenard@bigbangtheory.com"})
+  end
+
+  context 'open tracking' do
+    context 'setup inside of mail' do
+      it 'converts open tracking enabled messages correctly' do
+        expect(subject.new(mail_message_with_open_tracking).run).to eq({
+            "From" => "sheldon@bigbangtheory.com",
+            "Subject" => "Hello!",
+            "HtmlBody" => "<b>Hello Sheldon!</b>",
+            "To" => "lenard@bigbangtheory.com",
+            "TrackOpens" => true})
+      end
+
+      it 'converts open tracking disabled messages correctly' do
+        expect(subject.new(mail_message_with_open_tracking_disabled).run).to eq({
+            "From" => "sheldon@bigbangtheory.com",
+            "Subject" => "Hello!",
+            "HtmlBody" => "<b>Hello Sheldon!</b>",
+            "To" => "lenard@bigbangtheory.com",
+            "TrackOpens" => false})
+      end
+    end
+
+    context 'setup with tracking variable' do
+      it 'converts open tracking enabled messages correctly' do
+        expect(subject.new(mail_message_with_open_tracking_set_variable).run).to eq({
+            "From" => "sheldon@bigbangtheory.com",
+            "Subject" => "Hello!",
+            "HtmlBody" => "<b>Hello Sheldon!</b>",
+            "To" => "lenard@bigbangtheory.com",
+            "TrackOpens" => true})
+      end
+
+      it 'converts open tracking disabled messages correctly' do
+        expect(subject.new(mail_message_with_open_tracking_disabled_set_variable).run).to eq({
+            "From" => "sheldon@bigbangtheory.com",
+            "Subject" => "Hello!",
+            "HtmlBody" => "<b>Hello Sheldon!</b>",
+            "To" => "lenard@bigbangtheory.com",
+            "TrackOpens" => false})
+      end
+    end
+  end
+
+  context 'link tracking' do
+    it 'converts html and text link tracking enabled messages correctly' do
+      expect(subject.new(mail_message_with_link_tracking_all).run).to eq({
+          "From" => "sheldon@bigbangtheory.com",
+          "Subject" => "Hello!",
+          "HtmlBody" => "<b>Hello Sheldon!</b>",
+          "To" => "lenard@bigbangtheory.com",
+          "TrackLinks" => 'HtmlAndText'})
+    end
+
+    it 'converts html only link tracking enabled messages correctly' do
+      expect(subject.new(mail_message_with_link_tracking_html).run).to eq({
+          "From" => "sheldon@bigbangtheory.com",
+          "Subject" => "Hello!",
+          "HtmlBody" => "<b>Hello Sheldon!</b>",
+          "To" => "lenard@bigbangtheory.com",
+          "TrackLinks" => 'HtmlOnly'})
+    end
+
+    it 'converts text only link tracking enabled messages correctly' do
+      expect(subject.new(mail_message_with_link_tracking_text).run).to eq({
+          "From" => "sheldon@bigbangtheory.com",
+          "Subject" => "Hello!",
+          "HtmlBody" => "<b>Hello Sheldon!</b>",
+          "To" => "lenard@bigbangtheory.com",
+          "TrackLinks" => 'TextOnly'})
+    end
+
+    it 'converts link tracking disabled messages correctly' do
+      expect(subject.new(mail_message_with_link_tracking_none).run).to eq ({
+          "From" => "sheldon@bigbangtheory.com",
+          "Subject" => "Hello!",
+          "HtmlBody" => "<b>Hello Sheldon!</b>",
+          "To" => "lenard@bigbangtheory.com",
+          "TrackLinks" => 'None'})
+    end
+
+    it 'converts link tracking options when set via header' do
+      msg = mail_html_message
+      msg[:track_links] = :html_and_text
+      expect(subject.new(msg).run).to include('TrackLinks' => 'HtmlAndText')
+    end
+  end
+
+  context 'metadata' do
+    it 'converts single metadata field' do
+      metadata = {:test => 'test'}
+      msg = mail_html_message
+      msg.metadata = metadata
+      expect(subject.new(msg).run).to include('Metadata' => metadata)
+    end
+
+    it 'converts unicode metadata field metadata' do
+      metadata = {:test => "Велик"}
+      msg = mail_html_message
+      msg.metadata = metadata
+      expect(subject.new(msg).run).to include('Metadata' => metadata)
+    end
+
+    it 'converts multiple metadata fields' do
+      metadata = {}
+      10.times {|i| metadata["test#{i + 1}"] = "t" * 80}
+      msg = mail_html_message
+      msg.metadata = metadata
+      expect(subject.new(msg).run).to include('Metadata' => metadata)
+    end
   end
 
   it 'correctly decodes unicode in messages transfered as quoted-printable' do
-    subject.new(mail_message_quoted_printable).run.should \
-      include('TextBody' => 'Он здесь бывал: еще не в галифе.')
+    expect(subject.new(mail_message_quoted_printable).run).to include('TextBody' => 'Он здесь бывал: еще не в галифе.')
   end
 
   it 'correctly decodes unicode in multipart quoted-printable messages' do
-    subject.new(multipart_message_quoted_printable).run.should \
-      include('TextBody' => 'Загадочное послание.',
-              'HtmlBody' => '<b>Загадочное послание.</b>')
+    expect(subject.new(multipart_message_quoted_printable).run).to include(
+                                                                       'TextBody' => 'Загадочное послание.',
+                                                                       'HtmlBody' => '<b>Загадочное послание.</b>')
   end
 
   context 'when bcc is empty' do
     it 'excludes bcc from message' do
       mail_message.bcc = nil
-      mail_message.to_postmark_hash.keys.should_not include('Bcc')
+      expect(mail_message.to_postmark_hash.keys).not_to include('Bcc')
     end
   end
 
   context 'when cc is empty' do
     it 'excludes cc from message' do
       mail_message.cc = nil
-      mail_message.to_postmark_hash.keys.should_not include('Cc')
+      expect(mail_message.to_postmark_hash.keys).not_to include('Cc')
     end
   end
 
+  describe 'passing message stream' do
+    context 'when not set' do
+      specify { expect(subject.new(mail_message).run).not_to include('MessageStream') }
+    end
+
+    context 'when set' do
+      before do
+        mail_message.message_stream = 'weekly-newsletter'
+      end
+
+      it 'passes message stream to the API call' do
+        expect(subject.new(mail_message).run).to include('MessageStream' => 'weekly-newsletter')
+      end
+    end
+  end
 end