postmark 1.14.0 → 1.15.0

data/spec/unit/postmark/error_spec.rb

@@ -106,6 +106,15 @@ describe(Postmark::ApiInputError) do
   end
 end
 
+describe Postmark::InvalidTemplateError do
+  subject(:error) { Postmark::InvalidTemplateError.new(:foo => 'bar') }
+
+  it 'is created with a response' do
+    expect(error.message).to start_with('Failed to render the template.')
+    expect(error.postmark_response).to eq(:foo => 'bar')
+  end
+end
+
 describe(Postmark::TimeoutError) do
   it { is_expected.to be_a(Postmark::Error) }
   specify { expect(subject.retry?).to be true }
@@ -129,6 +138,10 @@ describe(Postmark::UnexpectedHttpResponseError) do
   it { is_expected.to be_a(Postmark::Error) }
 end
 
+describe(Postmark::MailAdapterError) do
+  it { is_expected.to be_a(Postmark::Error) }
+end
+
 describe(Postmark::InactiveRecipientError) do
   describe '.parse_recipients' do
     let(:recipients) do

data/spec/unit/postmark/handlers/mail_spec.rb

@@ -10,42 +10,74 @@ describe Mail::Postmark do
     end
   end
 
-  it "can be set as delivery_method" do
+  before do
     message.delivery_method Mail::Postmark
   end
 
-  it "wraps Postmark.send_through_postmark" do
-    allow_any_instance_of(Postmark::ApiClient).to receive(:deliver_message).with(message)
-    message.delivery_method Mail::Postmark
-    message.deliver
-  end
+  subject(:handler) { message.delivery_method }
 
-  it "returns self by default" do
-    allow_any_instance_of(Postmark::ApiClient).to receive(:deliver_message).with(message)
+  it "can be set as delivery_method" do
     message.delivery_method Mail::Postmark
-    message.deliver.should eq message
-  end
 
-  it "returns the actual response if :return_response setting is present" do
-    allow_any_instance_of(Postmark::ApiClient).to receive(:deliver_message).with(message)
-    message.delivery_method Mail::Postmark, :return_response => true
-    message.deliver.should eq message
+    is_expected.to be_a(Mail::Postmark)
   end
 
-  it "allows setting the api token" do
-    message.delivery_method Mail::Postmark, :api_token => 'api-token'
-    message.delivery_method.settings[:api_token].should == 'api-token'
-  end
+  describe '#deliver!' do
+    it "returns self by default" do
+      expect_any_instance_of(Postmark::ApiClient).to receive(:deliver_message).with(message)
+      message.deliver.should eq message
+    end
+
+    it "returns the actual response if :return_response setting is present" do
+      expect_any_instance_of(Postmark::ApiClient).to receive(:deliver_message).with(message)
+      message.delivery_method Mail::Postmark, :return_response => true
+      message.deliver.should eq message
+    end
+
+    it "allows setting the api token" do
+      message.delivery_method Mail::Postmark, :api_token => 'api-token'
+      message.delivery_method.settings[:api_token].should == 'api-token'
+    end
+
+    it 'uses provided API token' do
+      message.delivery_method Mail::Postmark, :api_token => 'api-token'
+      expect(Postmark::ApiClient).to receive(:new).with('api-token', {}).and_return(double(:deliver_message => true))
+      message.deliver
+    end
+
+    it 'uses API token provided as legacy api_key' do
+      message.delivery_method Mail::Postmark, :api_key => 'api-token'
+      expect(Postmark::ApiClient).to receive(:new).with('api-token', {}).and_return(double(:deliver_message => true))
+      message.deliver
+    end
 
-  it 'uses provided API token' do
-    message.delivery_method Mail::Postmark, :api_token => 'api-token'
-    expect(Postmark::ApiClient).to receive(:new).with('api-token', {}).and_return(double(:deliver_message => true))
-    message.deliver
+    context 'when sending a pre-rendered message' do
+      it "uses ApiClient#deliver_message to send the message" do
+        expect_any_instance_of(Postmark::ApiClient).to receive(:deliver_message).with(message)
+        message.deliver
+      end
+    end
+
+    context 'when sending a Postmark template' do
+      let(:message) do
+        Mail.new do
+          from            "sheldon@bigbangtheory.com"
+          to              "lenard@bigbangtheory.com"
+          template_alias  "hello"
+          template_model  :name => "Sheldon"
+        end
+      end
+
+      it 'uses ApiClient#deliver_message_with_template to send the message' do
+        expect_any_instance_of(Postmark::ApiClient).to receive(:deliver_message_with_template).with(message)
+        message.deliver
+      end
+    end
   end
 
-  it 'uses API token provided as legacy api_key' do
-    message.delivery_method Mail::Postmark, :api_key => 'api-token'
-    expect(Postmark::ApiClient).to receive(:new).with('api-token', {}).and_return(double(:deliver_message => true))
-    message.deliver
+  describe '#api_client' do
+    subject { handler.api_client }
+
+    it { is_expected.to be_a(Postmark::ApiClient) }
   end
-end
+end

data/spec/unit/postmark/mail_message_converter_spec.rb

@@ -164,6 +164,15 @@ 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 == {
         "From" => "sheldon@bigbangtheory.com",
@@ -225,6 +234,14 @@ describe Postmark::MailMessageConverter do
         "ReplyTo" => 'Penny The Neighbor <penny@bigbangtheory.com>'}
   end
 
+  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

data/spec/unit/postmark/message_extensions/mail_spec.rb

@@ -24,6 +24,15 @@ describe Mail::Message 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
+
   let(:mail_message_with_bogus_headers) do
     mail_message.header['Return-Path'] = 'bounce@wildbit.com'
     mail_message.header['From'] = 'info@wildbit.com'
@@ -239,4 +248,109 @@ describe Mail::Message do
     # See mail_message_converter_spec.rb
   end
 
+  describe '#templated?' do
+    specify { expect(mail_message).to_not be_templated }
+    specify { expect(templated_message).to be_templated }
+  end
+
+  describe '#prerender' do
+    let(:model) { templated_message.template_model }
+    let(:model_text) { model[:name] }
+
+    let(:template_response) do
+      {
+        :html_body => '<html><body>{{ name }}</body></html>',
+        :text_body => '{{ name }}'
+      }
+    end
+
+    let(:successful_render_response) do
+      {
+        :all_content_is_valid => true,
+        :subject => {
+          :rendered_content => 'Subject'
+        },
+        :text_body => {
+          :rendered_content => model_text
+        },
+        :html_body => {
+          :rendered_content => "<html><body>#{model_text}</body></html>"
+        }
+      }
+    end
+
+    let(:failed_render_response) do
+      {
+        :all_content_is_valid => false,
+        :subject => {
+          :rendered_content => 'Subject'
+        },
+        :text_body => {
+          :rendered_content => model_text
+        },
+        :html_body => {
+          :rendered_content => nil,
+          :validation_errors => [
+            { :message => 'The syntax for this template is invalid.', :line => 1, :character_position => 1 }
+          ]
+        }
+      }
+    end
+
+    subject(:rendering) { message.prerender }
+
+    context 'when called on a non-templated message' do
+      let(:message) { mail_message }
+
+      it 'raises a Postmark::Error' do
+        expect { rendering }.to raise_error(Postmark::Error, /Cannot prerender/)
+      end
+    end
+
+    context 'when called on a templated message' do
+      let(:message) { templated_message }
+
+      before do
+        message.delivery_method delivery_method
+      end
+
+      context 'and using a non-Postmark delivery method' do
+        let(:delivery_method) { Mail::SMTP }
+
+        specify { expect { rendering }.to raise_error(Postmark::MailAdapterError) }
+      end
+
+      context 'and using a Postmark delivery method' do
+        let(:delivery_method) { Mail::Postmark }
+
+        before do
+          expect_any_instance_of(Postmark::ApiClient).
+            to receive(:get_template).with(message.template_alias).
+            and_return(template_response)
+          expect_any_instance_of(Postmark::ApiClient).
+            to receive(:validate_template).with(template_response.merge(:test_render_model => model)).
+            and_return(render_response)
+        end
+
+        context 'and rendering succeeds' do
+          let(:render_response) { successful_render_response }
+
+          it 'sets HTML and Text parts to rendered values' do
+            expect { rendering }.
+              to change { message.subject }.to(render_response[:subject][:rendered_content]).
+              and change { message.body_text }.to(render_response[:text_body][:rendered_content]).
+              and change { message.body_html }.to(render_response[:html_body][:rendered_content])
+          end
+        end
+
+        context 'and rendering fails' do
+          let(:render_response) { failed_render_response }
+
+          it 'raises Postmark::InvalidTemplateError' do
+            expect { rendering }.to raise_error(Postmark::InvalidTemplateError)
+          end
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Petyo Ivanov
@@ -10,10 +10,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-22 00:00:00.000000000 Z
+date: 2019-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -27,13 +27,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: mail
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -41,7 +41,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mail
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -97,6 +97,7 @@ files:
 - lib/postmark/response_parsers/yajl.rb
 - lib/postmark/version.rb
 - postmark.gemspec
+- postmark.png
 - spec/data/empty.gif
 - spec/integration/account_api_client_spec.rb
 - spec/integration/api_client_hashes_spec.rb
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.7
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Official Postmark API wrapper.