postmark 1.21.4 → 1.21.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27b284da8c78da623e294bfea463e876cf18e370d395b681548af71a0071afe8
-  data.tar.gz: f12aba5cb688c265455578d011d6f917d405dac949003d2286fec6949c79367d
+  metadata.gz: bd56ea1117c73ce9a8f60d4dc81dd29f3b409efe1f362a534cb6a9b16a67dc60
+  data.tar.gz: 245374f9fb1752254c9c32aeff3ee0139b4b5bce4d252ce40c4f9d2627db42f7
 SHA512:
-  metadata.gz: d8881a25fa5bec51bdb8b2db632f3a5a3d1aa1457dd13df1d6e274758b8c4da992cc74ad2b512e4dc771a23c3fafba197bc5c9a979302032114fc5486f49a98d
-  data.tar.gz: e9be7104643c2b9e9ec7fff821af17675afccb51dfe717e72cd1975e6cdf713f322302a18e3df16943e53976e11bb0d80adb5e685faaeff98ff9ec4d1dafaa2c
+  metadata.gz: 17ad62b39034c58dfa35b9aeb296d609b35d786ae1c752abe07df6be4bf7743ecac1a9d83675e1ed860f7e01354bdc9761ccf742fbfe60c5bdd4016fbb831d9b
+  data.tar.gz: a3a0792f2525acc786627d7f16b0faa453b9608397a88d270a2bdcf61da3a00549a6bfb0eb92096f1015825fe4813fa5d62c1ba5b591bc675761c65fa2f38fac

data/.ruby-gemset

@@ -0,0 +1 @@
+postmark-gem

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6

data/CHANGELOG.rdoc

@@ -1,5 +1,21 @@
 = Changelog
 
+== 1.21.8
+
+* Fixed passing and receiving SubscriptionManagementConfiguration when creating/updating message streams (#94).
+
+== 1.21.7
+
+* Improved parsing recipients with Postmark::InactiveRecipientError.parse_recipients method
+
+== 1.21.6
+
+* Improved error handling for email sending related to invalid email addresses
+
+== 1.21.5
+
+* Added support for archiving/unarchiving message streams
+
 == 1.21.4
 
 * Fixed Postmark::ApiClient#deliver_messages_with_templates (#104)

data/RELEASE.md

@@ -1,5 +1,6 @@
 New versions of the gem are cut by the Postmark team, this is a quick guide to ensuring a smooth release.
 
+1. Determine the next version of the gem by following the [SemVer](https://semver.org/) guidelines.
 1. Verify all builds are passing on CircleCI for your branch.
 1. Merge in your branch to master.
 1. Update VERSION and lib/postmark/version.rb with the new version.

data/VERSION

@@ -1 +1 @@
-1.21.4
+1.21.8

data/lib/postmark/api_client.rb

@@ -38,7 +38,7 @@ module Postmark
         response, error = take_response_of { http_client.post("email", data) }
         update_message(message, response)
         raise error if error
-        format_response(response, true)
+        format_response(response, :compatible => true)
       end
     end
 
@@ -51,7 +51,7 @@ module Postmark
         response, error = take_response_of { http_client.post("email/withTemplate", data) }
         update_message(message, response)
         raise error if error
-        format_response(response, true)
+        format_response(response, :compatible => true)
       end
     end
 
@@ -95,7 +95,7 @@ module Postmark
     end
 
     def delivery_stats
-      response = format_response(http_client.get("deliverystats"), true)
+      response = format_response(http_client.get("deliverystats"), :compatible => true)
 
       if response[:bounces]
         response[:bounces] = format_response(response[:bounces])
@@ -343,13 +343,21 @@ module Postmark
     end
 
     def create_message_stream(attributes = {})
-      data = serialize(HashHelper.to_postmark(attributes))
-      format_response(http_client.post('message-streams', data))
+      data = serialize(HashHelper.to_postmark(attributes, :deep => true))
+      format_response(http_client.post('message-streams', data), :deep => true)
     end
 
     def update_message_stream(id, attributes)
-      data = serialize(HashHelper.to_postmark(attributes))
-      format_response(http_client.patch("message-streams/#{id}", data))
+      data = serialize(HashHelper.to_postmark(attributes, :deep => true))
+      format_response(http_client.patch("message-streams/#{id}", data), :deep => true)
+    end
+
+    def archive_message_stream(id)
+      format_response http_client.post("message-streams/#{id}/archive")
+    end
+
+    def unarchive_message_stream(id)
+      format_response http_client.post("message-streams/#{id}/unarchive")
     end
 
     def dump_suppressions(stream_id, options = {})

data/lib/postmark/client.rb

@@ -60,13 +60,16 @@ module Postmark
       [e.full_response || {}, e]
     end
 
-    def format_response(response, compatible = false)
+    def format_response(response, options = {})
       return {} unless response
 
+      compatible = options.fetch(:compatible, false)
+      deep = options.fetch(:deep, false)
+
       if response.kind_of? Array
-        response.map { |entry| Postmark::HashHelper.to_ruby(entry, compatible) }
+        response.map { |entry| Postmark::HashHelper.to_ruby(entry, :compatible => compatible, :deep => deep) }
       else
-        Postmark::HashHelper.to_ruby(response, compatible)
+        Postmark::HashHelper.to_ruby(response, :compatible => compatible, :deep => deep)
       end
     end
 

data/lib/postmark/error.rb

@@ -30,9 +30,8 @@ module Postmark
     def initialize(status_code = 500, body = '', parsed_body = {})
       self.parsed_body = parsed_body
       self.status_code = status_code.to_i
-      message = parsed_body.fetch(
-        'Message',
-        "The Postmark API responded with HTTP status #{status_code}.")
+      self.body = body
+      message = parsed_body.fetch('Message', "The Postmark API responded with HTTP status #{status_code}.")
 
       super(message)
     end
@@ -44,6 +43,7 @@ module Postmark
 
   class ApiInputError < HttpServerError
     INACTIVE_RECIPIENT = 406
+    INVALID_EMAIL_ADDRESS = 300
 
     attr_accessor :error_code
 
@@ -52,7 +52,9 @@ module Postmark
 
       case error_code
       when INACTIVE_RECIPIENT
-        InactiveRecipientError.new(INACTIVE_RECIPIENT, body, parsed_body)
+        InactiveRecipientError.new(error_code, body, parsed_body)
+      when INVALID_EMAIL_ADDRESS
+        InvalidEmailAddressError.new(error_code, body, parsed_body)
       else
         new(error_code, body, parsed_body)
       end
@@ -68,12 +70,14 @@ module Postmark
     end
   end
 
+  class InvalidEmailAddressError < ApiInputError; end
+
   class InactiveRecipientError < ApiInputError
     attr_reader :recipients
 
     PATTERNS = [/^Found inactive addresses: (.+?)\.$/.freeze,
-                /^Found inactive addresses: (.+?)\.$/.freeze,
-                /these inactive addresses: (.+?)\. Inactive/.freeze].freeze
+                /these inactive addresses: (.+?)\. Inactive/.freeze,
+                /these inactive addresses: (.+?)\.?$/].freeze
 
     def self.parse_recipients(message)
       PATTERNS.each do |p|

data/lib/postmark/helpers/hash_helper.rb

@@ -3,22 +3,47 @@ module Postmark
 
     extend self
 
-    def to_postmark(hash)
-      hash.inject({}) { |m, (k,v)| m[Inflector.to_postmark(k)] = v; m }
+    def to_postmark(object, options = {})
+      deep = options.fetch(:deep, false)
+
+      case object
+      when Hash
+        object.reduce({}) do |m, (k, v)|
+          m.tap do |h|
+            h[Inflector.to_postmark(k)] = deep ? to_postmark(v, options) : v
+          end
+        end
+      when Array
+        deep ? object.map { |v| to_postmark(v, options) } : object
+      else
+        object
+      end
     end
 
-    def to_ruby(hash, compatible = false)
-      formatted = hash.inject({}) { |m, (k,v)| m[Inflector.to_ruby(k)] = v; m }
-
-      if compatible
-        formatted.merge!(hash)
-        enhance_with_compatibility_warning(formatted)
+    def to_ruby(object, options = {})
+      compatible = options.fetch(:compatible, false)
+      deep = options.fetch(:deep, false)
+
+      case object
+      when Hash
+        object.reduce({}) do |m, (k, v)|
+          m.tap do |h|
+            h[Inflector.to_ruby(k)] = deep ? to_ruby(v, options) : v
+          end
+        end.tap do |result|
+          if compatible
+            result.merge!(object)
+            enhance_with_compatibility_warning(result)
+          end
+        end
+      when Array
+        deep ? object.map { |v| to_ruby(v, options) } : object
+      else
+        object
       end
-
-      formatted
     end
 
-    protected
+    private
 
     def enhance_with_compatibility_warning(hash)
       def hash.[](key)

data/lib/postmark/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = '1.21.4'
+  VERSION = '1.21.8'
 end

data/postmark.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.platform         = Gem::Platform::RUBY
   s.license          = 'MIT'
 
-  s.authors          = ["Petyo Ivanov", "Ilya Sabanin", "Artem Chistyakov"]
-  s.email            = "ilya@wildbit.com"
+  s.authors          = ["Tomek Maszkowski", "Igor Balos", "Artem Chistyakov", "Nick Hammond", "Petyo Ivanov", "Ilya Sabanin"]
+  s.email            = "tomek@wildbit.com"
   s.extra_rdoc_files = ["LICENSE", "README.md"]
   s.rdoc_options     = ["--charset=UTF-8"]
 

data/spec/unit/postmark/api_client_spec.rb

@@ -606,10 +606,14 @@ describe Postmark::ApiClient do
   end
 
   describe "#server_info" do
-    let(:response) {{"Name" => "Testing",
-                     "Color" => "blue",
-                     "InboundHash" => "c2425d77f74f8643e5f6237438086c81",
-                     "SmtpApiActivated" => true}}
+    let(:response) {
+      {
+        "Name" => "Testing",
+        "Color" => "blue",
+        "InboundHash" => "c2425d77f74f8643e5f6237438086c81",
+        "SmtpApiActivated" => true
+      }
+    }
 
     it 'requests server info from Postmark and converts it to ruby format' do
       expect(http_client).to receive(:get).with('server') {response}
@@ -618,10 +622,14 @@ describe Postmark::ApiClient do
   end
 
   describe "#update_server_info" do
-    let(:response) {{"Name" => "Testing",
-                     "Color" => "blue",
-                     "InboundHash" => "c2425d77f74f8643e5f6237438086c81",
-                     "SmtpApiActivated" => false}}
+    let(:response) {
+      {
+        "Name" => "Testing",
+        "Color" => "blue",
+        "InboundHash" => "c2425d77f74f8643e5f6237438086c81",
+        "SmtpApiActivated" => false
+      }
+    }
     let(:update) {{:smtp_api_activated => false}}
 
     it 'updates server info in Postmark and converts it to ruby format' do
@@ -1065,7 +1073,10 @@ describe Postmark::ApiClient do
       {
         :name => 'My Stream',
         :id => 'my-stream',
-        :message_stream_type => 'Broadcasts'
+        :message_stream_type => 'Broadcasts',
+        :subscription_management_configuration => {
+          :unsubscribe_handling_type => 'Custom'
+        }
       }
     end
 
@@ -1075,7 +1086,10 @@ describe Postmark::ApiClient do
         'Id' => 'my-stream',
         'MessageStreamType' => 'Broadcasts',
         'ServerId' => 222,
-        'CreatedAt' => '2020-04-01T03:33:33.333-03:00'
+        'CreatedAt' => '2020-04-01T03:33:33.333-03:00',
+        'SubscriptionManagementConfiguration' => {
+          'UnsubscribeHandlingType' => 'Custom'
+        }
       }
     end
 
@@ -1089,7 +1103,10 @@ describe Postmark::ApiClient do
              json_representation_of({
                'Name' => 'My Stream',
                'Id' => 'my-stream',
-               'MessageStreamType' => 'Broadcasts'
+               'MessageStreamType' => 'Broadcasts',
+               'SubscriptionManagementConfiguration' => {
+                 'UnsubscribeHandlingType' => 'Custom'
+               }
              }))
       subject
     end
@@ -1100,7 +1117,10 @@ describe Postmark::ApiClient do
         :name => 'My Stream',
         :server_id => 222,
         :message_stream_type => 'Broadcasts',
-        :created_at => '2020-04-01T03:33:33.333-03:00'
+        :created_at => '2020-04-01T03:33:33.333-03:00',
+        :subscription_management_configuration => {
+          :unsubscribe_handling_type => 'Custom'
+        }
       )
     }
   end
@@ -1110,7 +1130,10 @@ describe Postmark::ApiClient do
 
     let(:attrs) do
       {
-        :name => 'My Stream XXX'
+        :name => 'My Stream XXX',
+        :subscription_management_configuration => {
+          :unsubscribe_handling_type => 'Custom'
+        }
       }
     end
 
@@ -1120,7 +1143,10 @@ describe Postmark::ApiClient do
         'Id' => 'xxx',
         'MessageStreamType' => 'Broadcasts',
         'ServerId' => 222,
-        'CreatedAt' => '2020-04-01T03:33:33.333-03:00'
+        'CreatedAt' => '2020-04-01T03:33:33.333-03:00',
+        'SubscriptionManagementConfiguration' => {
+          'UnsubscribeHandlingType' => 'Custom'
+        }
       }
     end
 
@@ -1132,7 +1158,10 @@ describe Postmark::ApiClient do
       expect(http_client).to receive(:patch).
         with('message-streams/xxx',
              match_json({
-               :Name => 'My Stream XXX',
+               'Name' => 'My Stream XXX',
+               'SubscriptionManagementConfiguration' => {
+                 'UnsubscribeHandlingType' => 'Custom'
+               }
              }))
       subject
     end
@@ -1143,11 +1172,70 @@ describe Postmark::ApiClient do
         :name => 'My Stream XXX',
         :server_id => 222,
         :message_stream_type => 'Broadcasts',
-        :created_at => '2020-04-01T03:33:33.333-03:00'
+        :created_at => '2020-04-01T03:33:33.333-03:00',
+        :subscription_management_configuration => {
+          :unsubscribe_handling_type => 'Custom'
+        }
       )
     }
   end
 
+  describe '#archive_message_stream' do
+    subject { api_client.archive_message_stream(stream_id) }
+
+    let(:stream_id) { 'my-stream'}
+    let(:server_id) { 123 }
+    let(:purge_date) { '2030-08-30T12:30:00.00-04:00' }
+    let(:api_endpoint) { "message-streams/#{stream_id}/archive" }
+    let(:api_response) {{ 'ID' => stream_id, 'ServerID' => server_id, 'ExpectedPurgeDate' => purge_date  }}
+
+    before do
+      allow(http_client).to receive(:post).with(api_endpoint) { api_response }
+    end
+
+    it 'calls the API endpoint' do
+      expect(http_client).to receive(:post).with(api_endpoint)
+      subject
+    end
+
+    it 'transforms the API response' do
+      expect(subject).to eq({ :id => stream_id, :server_id => server_id, :expected_purge_date => purge_date })
+    end
+  end
+
+  describe '#unarchive_message_stream' do
+    subject { api_client.unarchive_message_stream(stream_id) }
+
+    let(:stream_id) { 'my-stream'}
+    let(:server_id) { 123 }
+    let(:api_endpoint) { "message-streams/#{stream_id}/unarchive" }
+    let(:api_response) { 
+      { 'ID' => stream_id, 'ServerID' => server_id, 'Name' => 'My Stream',
+        'Description' => 'My test stream.', 'MessageStreamType' => 'Transactional',
+        'CreatedAt' => '2030-08-30T12:30:00.00-04:00', 'UpdatedAt' => '2030-09-30T12:30:00.00-04:00',
+        'ArchivedAt'=> nil, 'ExpectedPurgeDate' => nil,
+        'SubscriptionManagementConfiguration' => { 'UnsubscribeHandlingType' => 'None' } }
+    }
+
+    before do
+      allow(http_client).to receive(:post).with(api_endpoint) { api_response }
+    end
+
+    it 'calls the API endpoint' do
+      expect(http_client).to receive(:post).with(api_endpoint)
+      subject
+    end
+
+    it 'transforms the API response' do
+      expect(subject).to eq({ :id => stream_id, :server_id => server_id, :name => 'My Stream',
+                              :description => 'My test stream.', :message_stream_type => 'Transactional',
+                              :created_at => '2030-08-30T12:30:00.00-04:00',
+                              :updated_at => '2030-09-30T12:30:00.00-04:00',
+                              :archived_at => nil , :expected_purge_date => nil ,
+                              :subscription_management_configuration => { 'UnsubscribeHandlingType' => 'None' }})
+    end
+  end
+
   describe '#create_suppressions' do
     let(:email_addresses) { nil }
     let(:message_stream_id) { 'outbound' }

data/spec/unit/postmark/error_spec.rb

@@ -97,6 +97,13 @@ describe(Postmark::ApiInputError) do
         it_behaves_like 'api input error'
       end
 
+      context '300' do
+        let(:code) {Postmark::ApiInputError::INVALID_EMAIL_ADDRESS}
+
+        it {is_expected.to be_a(Postmark::InvalidEmailAddressError)}
+        it_behaves_like 'api input error'
+      end
+
       context 'others' do
         let(:code) {'9999'}
 
@@ -142,6 +149,33 @@ describe(Postmark::MailAdapterError) do
   it {is_expected.to be_a(Postmark::Error)}
 end
 
+describe(Postmark::InvalidEmailAddressError) do
+  describe '.new' do
+    let(:response) {{'Message' => message}}
+
+    subject do
+      Postmark::InvalidEmailAddressError.new(
+        Postmark::ApiInputError::INVALID_EMAIL_ADDRESS, Postmark::Json.encode(response), response)
+    end
+
+    let(:message) do
+      "Error parsing 'To': Illegal email address 'johne.xample.com'. It must contain the '@' symbol."
+    end
+
+    it 'body is set' do
+      expect(subject.body).to eq(Postmark::Json.encode(response))
+    end
+
+    it 'parsed body is set' do
+      expect(subject.parsed_body).to eq(response)
+    end
+
+    it 'error code is set' do
+      expect(subject.error_code).to eq(Postmark::ApiInputError::INVALID_EMAIL_ADDRESS)
+    end
+  end
+end
+
 describe(Postmark::InactiveRecipientError) do
   describe '.parse_recipients' do
     let(:recipients) do
@@ -161,6 +195,12 @@ describe(Postmark::InactiveRecipientError) do
       it {is_expected.to eq(recipients.take(1))}
     end
 
+    context 'i/n inactive, n > 1, i < n - new message format' do
+      let(:message) { "Message OK, but will not deliver to these inactive addresses: #{recipients[0...2].join(', ')}" }
+
+      it {is_expected.to eq(recipients.take(2))}
+    end
+
     context 'i/n inactive, n > 1, i < n' do
       let(:message) do
         'Message OK, but will not deliver to these inactive addresses: ' \
@@ -209,6 +249,18 @@ describe(Postmark::InactiveRecipientError) do
     it 'parses recipients from json payload' do
       expect(subject.recipients).to eq([address])
     end
+
+    it 'body is set' do
+      expect(subject.body).to eq(Postmark::Json.encode(response))
+    end
+
+    it 'parsed body is set' do
+      expect(subject.parsed_body).to eq(response)
+    end
+
+    it 'error code is set' do
+      expect(subject.error_code).to eq(Postmark::ApiInputError::INACTIVE_RECIPIENT)
+    end
   end
 end
 

data/spec/unit/postmark/helpers/hash_helper_spec.rb

@@ -2,32 +2,119 @@ require 'spec_helper'
 
 describe Postmark::HashHelper do
   describe ".to_postmark" do
-    let(:source) { {:from => "support@postmarkapp.com", :reply_to => "contact@wildbit.com"} }
-    let(:target) { {"From" => "support@postmarkapp.com", "ReplyTo" => "contact@wildbit.com"} }
+    let(:source) do
+      {
+        :level_one => {
+          :level_two => {
+            :level_three => [{ :array_item => 1 }]
+          }
+        }
+      }
+    end
+
+    describe 'default behaviour' do
+      let(:target) do
+        {
+          'LevelOne' => {
+            :level_two => {
+              :level_three => [{ :array_item => 1 }]
+            }
+          }
+        }
+      end
+
+      it 'does not convert nested elements' do
+        expect(subject.to_postmark(source)).to eq(target)
+      end
+    end
+
+    describe 'deep conversion' do
+      let(:target) do
+        {
+          'LevelOne' => {
+            'LevelTwo' => {
+              'LevelThree' => [{ 'ArrayItem' => 1 }]
+            }
+          }
+        }
+      end
 
-    it 'converts Hash keys to Postmark format' do
-      expect(subject.to_postmark(source)).to eq target
+      it 'converts nested elements when requested' do
+        expect(subject.to_postmark(source, :deep => true)).to eq(target)
+      end
     end
 
-    it 'acts idempotentely' do
-      expect(subject.to_postmark(target)).to eq target
+    it 'leaves CamelCase keys untouched' do
+      expect(subject.to_postmark('ReplyTo' => 'alice@example.com')).to eq('ReplyTo' => 'alice@example.com')
     end
   end
 
   describe ".to_ruby" do
-    let(:source) { {"From" => "support@postmarkapp.com", "ReplyTo" => "contact@wildbit.com"} }
-    let(:target) { {:from => "support@postmarkapp.com", :reply_to => "contact@wildbit.com"} }
+    let(:source) do
+      {
+        'LevelOne' => {
+          'LevelTwo' => {
+            'LevelThree' => [{ 'ArrayItem' => 1 }]
+          }
+        }
+      }
+    end
 
-    it 'converts Hash keys to Ruby format' do
-      expect(subject.to_ruby(source)).to eq target
+    describe 'default behaviour' do
+      let(:target) do
+        {
+          :level_one => {
+            'LevelTwo' => {
+              'LevelThree' => [{ 'ArrayItem' => 1 }]
+            }
+          }
+        }
+      end
+
+      it 'does not convert nested elements' do
+        expect(subject.to_ruby(source)).to eq(target)
+      end
     end
 
-    it 'has compatible mode' do
-      expect(subject.to_ruby(source, true)).to eq target.merge(source)
+    describe 'deep conversion' do
+      let(:target) do
+        {
+          :level_one => {
+            :level_two => {
+              :level_three => [{ :array_item => 1 }]
+            }
+          }
+        }
+      end
+
+      it 'converts nested elements when requested' do
+        expect(subject.to_ruby(source, :deep => true)).to eq(target)
+      end
+    end
+
+    describe 'compatibility mode' do
+      let(:target) do
+        {
+          :level_one => {
+            'LevelTwo' => {
+              'LevelThree' => [{ 'ArrayItem' => 1 }]
+            }
+          },
+          'LevelOne' => {
+            'LevelTwo' => {
+              'LevelThree' => [{ 'ArrayItem' => 1 }]
+            }
+          }
+        }
+      end
+
+      it 'preserves the original structure' do
+        expect(subject.to_ruby(source, :compatible => true)).to eq target
+      end
     end
 
-    it 'acts idempotentely' do
-      expect(subject.to_ruby(target)).to eq target
+    it 'leaves symbol keys untouched' do
+      expect(subject.to_ruby(:reply_to => 'alice@example.com')).to eq(:reply_to => 'alice@example.com')
     end
   end
 end

metadata

@@ -1,16 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.21.4
+  version: 1.21.8
 platform: ruby
 authors:
+- Tomek Maszkowski
+- Igor Balos
+- Artem Chistyakov
+- Nick Hammond
 - Petyo Ivanov
 - Ilya Sabanin
-- Artem Chistyakov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+date: 2021-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -56,7 +59,7 @@ dependencies:
         version: '0'
 description: Use this gem to send emails through Postmark HTTP API and retrieve info
   about bounces.
-email: ilya@wildbit.com
+email: tomek@wildbit.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -68,6 +71,8 @@ files:
 - ".gitignore"
 - ".rake_tasks"
 - ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
 - CHANGELOG.rdoc
 - CONTRIBUTING.md
 - Gemfile