postmark 1.10.0 → 1.11.0

data/spec/unit/postmark/bounce_spec.rb

@@ -43,11 +43,11 @@ describe Postmark::Bounce do
     end
 
     it 'allows to activate the bounce' do
-      subject.can_activate?.should be_true
+      subject.can_activate?.should be true
     end
 
     it 'has an available dump' do
-      subject.dump_available?.should be_true
+      subject.dump_available?.should be true
     end
 
     its(:type) { should eq bounce_data[:type] }
@@ -69,11 +69,11 @@ describe Postmark::Bounce do
     end
 
     it 'allows to activate the bounce' do
-      subject.can_activate?.should be_true
+      subject.can_activate?.should be true
     end
 
     it 'has an available dump' do
-      subject.dump_available?.should be_true
+      subject.dump_available?.should be true
     end
 
     its(:type) { should eq bounce_data[:type] }
@@ -93,7 +93,7 @@ describe Postmark::Bounce do
     let(:api_client) { Postmark.api_client }
 
     it "calls #dump_bounce on shared api_client instance" do
-      Postmark.api_client.should_receive(:dump_bounce).with(bounce.id) { response }
+      expect(Postmark.api_client).to receive(:dump_bounce).with(bounce.id) { response }
       bounce.dump.should == bounce_body
     end
 
@@ -104,7 +104,7 @@ describe Postmark::Bounce do
     let(:api_client) { Postmark.api_client }
 
     it "calls #activate_bounce on shared api_client instance" do
-      api_client.should_receive(:activate_bounce).with(bounce.id) { bounce_data }
+      expect(api_client).to receive(:activate_bounce).with(bounce.id) { bounce_data }
       bounce.activate.should be_a Postmark::Bounce
     end
 
@@ -114,7 +114,7 @@ describe Postmark::Bounce do
     let(:api_client) { Postmark.api_client }
 
     it "calls #get_bounce on shared api_client instance" do
-      api_client.should_receive(:get_bounce).with(42) { bounce_data }
+      expect(api_client).to receive(:get_bounce).with(42) { bounce_data }
       Postmark::Bounce.find(42).should be_a Postmark::Bounce
     end
   end
@@ -125,8 +125,8 @@ describe Postmark::Bounce do
     let(:api_client) { Postmark.api_client }
 
     it "calls #get_bounces on shared api_client instance" do
-      api_client.should_receive(:get_bounces) { response }
-      Postmark::Bounce.all.should have(3).bounces
+      expect(api_client).to receive(:get_bounces) { response }
+      Postmark::Bounce.all.count.should eq(3)
     end
 
   end
@@ -137,7 +137,7 @@ describe Postmark::Bounce do
     let(:tags) { ["tag1", "tag2"] }
 
     it "calls #get_bounced_tags on shared api_client instance" do
-      api_client.should_receive(:get_bounced_tags) { tags }
+      expect(api_client).to receive(:get_bounced_tags) { tags }
       Postmark::Bounce.tags.should == tags
     end
   end

data/spec/unit/postmark/error_spec.rb

@@ -0,0 +1,218 @@
+require 'spec_helper'
+
+describe(Postmark::Error) do
+  it { is_expected.to be_a(StandardError) }
+end
+
+describe(Postmark::HttpClientError) do
+  it { is_expected.to be_a(Postmark::Error) }
+  specify { expect(subject.retry?).to be true }
+end
+
+describe(Postmark::HttpServerError) do
+  it { is_expected.to be_a(Postmark::Error) }
+
+  describe '.build' do
+    context 'picks an appropriate subclass for code' do
+      subject { Postmark::HttpServerError.build(code, Postmark::Json.encode({})) }
+
+      context '401' do
+        let(:code) { '401' }
+
+        it { is_expected.to be_a(Postmark::InvalidApiKeyError) }
+        its(:status_code) { is_expected.to eq 401 }
+      end
+
+      context '422' do
+        let(:code) { '422' }
+
+        it { is_expected.to be_a(Postmark::ApiInputError) }
+        its(:status_code) { is_expected.to eq 422 }
+      end
+
+      context '500' do
+        let(:code) { '500' }
+
+        it { is_expected.to be_a(Postmark::InternalServerError) }
+        its(:status_code) { is_expected.to eq 500 }
+      end
+
+      context 'others' do
+        let(:code) { '999' }
+
+        it { is_expected.to be_a(Postmark::UnexpectedHttpResponseError) }
+        its(:status_code) { is_expected.to eq code.to_i }
+      end
+    end
+  end
+
+  describe '#retry?' do
+    it 'is true for 5XX status codes' do
+      (500...600).each do |code|
+        expect(Postmark::HttpServerError.new(code).retry?).to be true
+      end
+    end
+
+    it 'is false for other codes except 5XX' do
+      [200, 300, 400].each do |code|
+        expect(Postmark::HttpServerError.new(code).retry?).to be false
+      end
+    end
+  end
+
+  describe '#message ' do
+    it 'uses "Message" field on postmark response if available' do
+      data = { 'Message' => 'Postmark error message' }
+      error = Postmark::HttpServerError.new(502, Postmark::Json.encode(data), data)
+      expect(error.message).to eq data['Message']
+    end
+
+    it 'falls back to a message generated from status code' do
+      error = Postmark::HttpServerError.new(502, '<html>')
+      expect(error.message).to match(/The Postmark API responded with HTTP status \d+/)
+    end
+  end
+end
+
+describe(Postmark::ApiInputError) do
+  describe '.build' do
+    context 'picks an appropriate subclass for error code' do
+      let(:response) { { 'ErrorCode' => code } }
+
+      subject do
+        Postmark::ApiInputError.build(Postmark::Json.encode(response), response)
+      end
+
+      shared_examples_for 'api input error' do
+        its(:status_code) { is_expected. to eq 422 }
+        specify { expect(subject.retry?).to be false }
+        it { is_expected.to be_a(Postmark::ApiInputError) }
+        it { is_expected.to be_a(Postmark::HttpServerError) }
+      end
+
+      context '406' do
+        let(:code) { Postmark::ApiInputError::INACTIVE_RECIPIENT }
+
+        it { is_expected.to be_a(Postmark::InactiveRecipientError) }
+        it_behaves_like 'api input error'
+      end
+
+      context 'others' do
+        let(:code) { '9999' }
+
+        it_behaves_like 'api input error'
+      end
+    end
+  end
+end
+
+describe(Postmark::TimeoutError) do
+  it { is_expected.to be_a(Postmark::Error) }
+  specify { expect(subject.retry?).to be true }
+end
+
+describe(Postmark::UnknownMessageType) do
+  it 'exists for backward compatibility' do
+    is_expected.to be_a(Postmark::Error)
+  end
+end
+
+describe(Postmark::InvalidApiKeyError) do
+  it { is_expected.to be_a(Postmark::Error) }
+end
+
+describe(Postmark::InternalServerError) do
+  it { is_expected.to be_a(Postmark::Error) }
+end
+
+describe(Postmark::UnexpectedHttpResponseError) do
+  it { is_expected.to be_a(Postmark::Error) }
+end
+
+describe(Postmark::InactiveRecipientError) do
+  describe '.parse_recipients' do
+    let(:recipients) do
+      %w(nothing@wildbit.com noth.ing+2@wildbit.com noth.ing+2-1@wildbit.com)
+    end
+
+    subject { Postmark::InactiveRecipientError.parse_recipients(message) }
+
+    context '1/1 inactive' do
+      let(:message) do
+        'You tried to send to a recipient that has been marked as ' \
+        "inactive.\nFound inactive addresses: #{recipients[0]}.\n" \
+        'Inactive recipients are ones that have generated a hard ' \
+        'bounce or a spam complaint.'
+      end
+
+      it { is_expected.to eq(recipients.take(1)) }
+    end
+
+    context 'i/n inactive, n > 1, i < n' do
+      let(:message) do
+        'Message OK, but will not deliver to these inactive addresses: ' \
+        "#{recipients[0...2].join(', ')}. Inactive recipients are ones that " \
+        'have generated a hard bounce or a spam complaint.'
+      end
+
+      it { is_expected.to eq(recipients.take(2)) }
+    end
+
+    context 'n/n inactive, n > 1' do
+      let(:message) do
+        'You tried to send to recipients that have all been marked as ' \
+        "inactive.\nFound inactive addresses: #{recipients.join(', ')}.\n" \
+        'Inactive recipients are ones that have generated a hard bounce or a spam complaint.'
+      end
+
+      it { is_expected.to eq(recipients) }
+    end
+
+    context 'unknown error format' do
+      let(:message) { recipients.join(', ') }
+
+      it { is_expected.to eq([]) }
+    end
+  end
+
+  describe '.new' do
+    let(:address) { 'user@example.org' }
+    let(:response) { { 'Message' => message } }
+
+    subject do
+      Postmark::InactiveRecipientError.new(
+        Postmark::ApiInputError::INACTIVE_RECIPIENT,
+        Postmark::Json.encode(response),
+        response)
+    end
+
+    let(:message) do
+      'You tried to send to a recipient that has been marked as ' \
+      "inactive.\nFound inactive addresses: #{address}.\n" \
+      'Inactive recipients are ones that have generated a hard ' \
+      'bounce or a spam complaint.'
+    end
+
+    it 'parses recipients from json payload' do
+      expect(subject.recipients).to eq([address])
+    end
+  end
+end
+
+describe(Postmark::DeliveryError) do
+  it 'is an alias to Error for backwards compatibility' do
+    expect(subject.class).to eq(Postmark::Error)
+  end
+end
+
+describe(Postmark::InvalidMessageError) do
+  it 'is an alias to Error for backwards compatibility' do
+    expect(subject.class).to eq(Postmark::ApiInputError)
+  end
+end
+
+describe(Postmark::UnknownError) do
+  it 'is an alias for backwards compatibility' do
+    expect(subject.class).to eq(Postmark::UnexpectedHttpResponseError)
+  end
+end

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

@@ -15,19 +15,19 @@ describe Mail::Postmark do
   end
 
   it "wraps Postmark.send_through_postmark" do
-    Postmark::ApiClient.any_instance.should_receive(:deliver_message).with(message)
+    allow_any_instance_of(Postmark::ApiClient).to receive(:deliver_message).with(message)
     message.delivery_method Mail::Postmark
     message.deliver
   end
 
   it "returns self by default" do
-    Postmark::ApiClient.any_instance.should_receive(:deliver_message).with(message)
+    allow_any_instance_of(Postmark::ApiClient).to receive(:deliver_message).with(message)
     message.delivery_method Mail::Postmark
     message.deliver.should eq message
   end
 
   it "returns the actual response if :return_response setting is present" do
-    Postmark::ApiClient.any_instance.should_receive(:deliver_message).with(message)
+    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
   end
@@ -39,13 +39,13 @@ describe Mail::Postmark do
 
   it 'uses provided API token' do
     message.delivery_method Mail::Postmark, :api_token => 'api-token'
-    Postmark::ApiClient.should_receive(:new).with('api-token', {}).and_return(double(:deliver_message => true))
+    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'
-    Postmark::ApiClient.should_receive(:new).with('api-token', {}).and_return(double(:deliver_message => true))
+    expect(Postmark::ApiClient).to receive(:new).with('api-token', {}).and_return(double(:deliver_message => true))
     message.deliver
   end
 end

data/spec/unit/postmark/http_client_spec.rb

@@ -36,7 +36,7 @@ describe Postmark::HttpClient do
     its(:api_key) { should eq api_token }
     its(:host) { should eq 'api.postmarkapp.com' }
     its(:port) { should eq 443 }
-    its(:secure) { should be_true }
+    its(:secure) { should be true }
     its(:path_prefix) { should eq '/' }
     its(:http_read_timeout) { should eq 15 }
     its(:http_open_timeout) { should eq 5 }
@@ -128,8 +128,7 @@ describe Postmark::HttpClient do
     end
 
     it "raises a custom error when the request times out" do
-      subject.http.should_receive(:post).at_least(:once).
-                                             and_raise(Timeout::Error)
+      expect(subject.http).to receive(:post).at_least(:once).and_raise(Timeout::Error)
       expect { subject.post(target_path) }.to raise_error Postmark::TimeoutError
     end
 
@@ -170,7 +169,7 @@ describe Postmark::HttpClient do
     end
 
     it "raises a custom error when the request times out" do
-      subject.http.should_receive(:get).at_least(:once).and_raise(Timeout::Error)
+      expect(subject.http).to receive(:get).at_least(:once).and_raise(Timeout::Error)
       expect { subject.get(target_path) }.to raise_error Postmark::TimeoutError
     end
 
@@ -211,7 +210,7 @@ describe Postmark::HttpClient do
     end
 
     it "raises a custom error when the request times out" do
-      subject.http.should_receive(:put).at_least(:once).and_raise(Timeout::Error)
+      expect(subject.http).to receive(:put).at_least(:once).and_raise(Timeout::Error)
       expect { subject.put(target_path) }.to raise_error Postmark::TimeoutError
     end
 

data/spec/unit/postmark/mail_message_converter_spec.rb

@@ -311,6 +311,12 @@ describe Postmark::MailMessageConverter do
           "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
 
   it 'correctly decodes unicode in messages transfered as quoted-printable' do

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

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Mail::Message do
   before do
-    Kernel.stub(:warn)
+    allow(Kernel).to receive(:warn)
   end
 
   let(:mail_message) do
@@ -147,7 +147,7 @@ describe Mail::Message do
     end
 
     it "is deprecated" do
-      Kernel.should_receive(:warn).with(/deprecated/)
+      expect(Kernel).to receive(:warn).with(/deprecated/)
       mail_message.postmark_attachments = attached_hash
     end
   end
@@ -161,12 +161,12 @@ describe Mail::Message do
                            'Content' => ''} }
 
     before do
-      attached_file.stub(:is_a?) { |arg| arg == File ? true : false }
-      attached_file.stub(:path) { '/tmp/file.jpeg' }
+      allow(attached_file).to receive(:is_a?) { |arg| arg == File ? true : false }
+      allow(attached_file).to receive(:path) { '/tmp/file.jpeg' }
     end
 
     it "supports multiple attachment formats" do
-      IO.should_receive(:read).with("/tmp/file.jpeg").and_return("")
+      expect(IO).to receive(:read).with("/tmp/file.jpeg").and_return("")
 
       mail_message.postmark_attachments = [attached_hash, attached_file]
       attachments = mail_message.export_attachments
@@ -177,7 +177,7 @@ describe Mail::Message do
 
     it "is deprecated" do
       mail_message.postmark_attachments = attached_hash
-      Kernel.should_receive(:warn).with(/deprecated/)
+      expect(Kernel).to receive(:warn).with(/deprecated/)
       mail_message.postmark_attachments
     end
   end

data/spec/unit/postmark_spec.rb

@@ -99,7 +99,7 @@ describe Postmark do
     context "when shared client instance does not exist" do
 
       it 'creates a new instance of Postmark::ApiClient' do
-        Postmark::ApiClient.should_receive(:new).
+        allow(Postmark::ApiClient).to receive(:new).
                             with(api_token,
                                  :secure => secure,
                                  :proxy_host => proxy_host,
@@ -127,12 +127,12 @@ describe Postmark do
     end
 
     it 'delegates the method to the shared api client instance' do
-      api_client.should_receive(:deliver_message).with(message)
+      allow(api_client).to receive(:deliver_message).with(message)
       subject.deliver_message(message)
     end
 
     it 'is also accessible as .send_through_postmark' do
-      api_client.should_receive(:deliver_message).with(message)
+      allow(api_client).to receive(:deliver_message).with(message)
       subject.send_through_postmark(message)
     end
   end
@@ -146,7 +146,7 @@ describe Postmark do
     end
 
     it 'delegates the method to the shared api client instance' do
-      api_client.should_receive(:deliver_messages).with(message)
+      allow(api_client).to receive(:deliver_messages).with(message)
       subject.deliver_messages(message)
     end
   end
@@ -159,7 +159,7 @@ describe Postmark do
     end
 
     it 'delegates the method to the shared api client instance' do
-      api_client.should_receive(:delivery_stats)
+      allow(api_client).to receive(:delivery_stats)
       subject.delivery_stats
     end
   end