postmark 1.21.7 → 1.21.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2bd2c9a288c0f4baa7f2f076d91151a0835b8b168c76e6b1938d5aee972d118
-  data.tar.gz: 5f8ef5865ba91468d5d413f111af5f195adaf0c44983749605e7e015d9b79eb3
+  metadata.gz: bd56ea1117c73ce9a8f60d4dc81dd29f3b409efe1f362a534cb6a9b16a67dc60
+  data.tar.gz: 245374f9fb1752254c9c32aeff3ee0139b4b5bce4d252ce40c4f9d2627db42f7
 SHA512:
-  metadata.gz: ba8d2597f8502259ef996c647d08f5264e6c677aa4d3e0e697156442b35fe6a1503b914f156b83a627dadaf4cdb64e3e159049d2031e52c675ff721b960abc16
-  data.tar.gz: 538224ea9fa9c537f9671a5f9de5bfb1a7dc9078f531b6ef8fc8f1c02aa64fda4e82e8031ad5da37abcaeb793b65fd4b5b541e6329181e8e0e21af8d05d0fc93
+  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,9 @@
 = 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

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,13 @@ 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)

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/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.7'
+  VERSION = '1.21.8'
 end

data/spec/unit/postmark/api_client_spec.rb

@@ -1073,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
 
@@ -1083,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
 
@@ -1097,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
@@ -1108,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
@@ -1118,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
 
@@ -1128,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
 
@@ -1140,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
@@ -1151,7 +1172,10 @@ 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

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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.21.7
+  version: 1.21.8
 platform: ruby
 authors:
 - Tomek Maszkowski
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-22 00:00:00.000000000 Z
+date: 2021-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -71,6 +71,8 @@ files:
 - ".gitignore"
 - ".rake_tasks"
 - ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
 - CHANGELOG.rdoc
 - CONTRIBUTING.md
 - Gemfile
@@ -150,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.7
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
 summary: Official Postmark API wrapper.