postmark 1.20.0 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 587a749e850a9a9fc2e70087fd13fa79d926844246f8030942d116ac6fbbcaec
-  data.tar.gz: 20fc00b9b8b59d45afe4722abd859cc4248f63ce487d190167aec0b957bd3c76
+  metadata.gz: 4ecfd4ac720289669cf67d8f13816bec20b985796dc9413e9e34271bbd3ece81
+  data.tar.gz: f42b2d7331f764f3552cd002e0876ea8da8aad4ebc6f56d14504d5c80d96d8c2
 SHA512:
-  metadata.gz: d4049417165d062f7d923a0b84e1c4b31791930e24c6c58d1171bbc0cb189cdbbe53736ee720b994c2a467d94afba7225512c39975f6fcd7d56d63b7c7cc567e
-  data.tar.gz: 7fce7304875e3a7877a73e697450fb82bfbdb2404a44337dfe6591e099476e7d57ead59ce9e30182f01825b4cfc7ca61ff49a1871cf9368b13bf74fe39753e05
+  metadata.gz: 2f7953e239dcb2b78970694e9c0423d1f2ca3439cafb418e83f47ba24dfe535fece7f7b853986b8f7bb460826f9af3517750cb7e919f71deec4b463734aaed42
+  data.tar.gz: 18d9b5e906b072d8c7e9b832190637290b134ac06e1a66ec299294c07a0cbf1017f932bb65eb4de38448b33a9c245eced584e9eb0665f824be60c72f06ed1e75

data/.gitignore

@@ -7,3 +7,4 @@ pkg/*
 .idea
 bin/*
 *.swp
+.DS_Store

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 = Changelog
 
+== 1.21.0
+
+* Added support for message streams and suppressions
+
 == 1.20.0
 
 * Removed deprecated trigger endpoints

data/README.md

@@ -62,4 +62,4 @@ Refer to the [LICENSE](https://github.com/wildbit/postmark-gem/blob/master/LICEN
 
 ## Copyright
 
-Copyright © 2018 Wildbit LLC. 
+Copyright © 2020 Wildbit LLC.

data/lib/postmark/api_client.rb

@@ -328,6 +328,39 @@ module Postmark
       format_response http_client.delete("webhooks/#{id}")
     end
 
+    def get_message_streams(options = {})
+      load_batch('message-streams', 'MessageStreams', options)
+    end
+
+    def get_message_stream(id)
+      format_response(http_client.get("message-streams/#{id}"))
+    end
+
+    def create_message_stream(attributes = {})
+      data = serialize(HashHelper.to_postmark(attributes))
+      format_response(http_client.post('message-streams', data))
+    end
+
+    def update_message_stream(id, attributes)
+      data = serialize(HashHelper.to_postmark(attributes))
+      format_response(http_client.patch("message-streams/#{id}", data))
+    end
+
+    def dump_suppressions(stream_id, options = {})
+      _, batch = load_batch("message-streams/#{stream_id}/suppressions/dump", 'Suppressions', options)
+      batch
+    end
+
+    def create_suppressions(stream_id, email_addresses)
+      data = serialize(:Suppressions => Array(email_addresses).map { |e| HashHelper.to_postmark(:email_address => e) })
+      format_response(http_client.post("message-streams/#{stream_id}/suppressions", data))
+    end
+
+    def delete_suppressions(stream_id, email_addresses)
+      data = serialize(:Suppressions => Array(email_addresses).map { |e| HashHelper.to_postmark(:email_address => e) })
+      format_response(http_client.post("message-streams/#{stream_id}/suppressions/delete", data))
+    end
+
     protected
 
     def in_batches(messages)

data/lib/postmark/mail_message_converter.rb

@@ -34,7 +34,8 @@ module Postmark
         'TrackLinks' => (::Postmark::Inflector.to_postmark(@message.track_links) unless @message.track_links.empty?),
         'Metadata' => @message.metadata,
         'TemplateAlias' => @message.template_alias,
-        'TemplateModel' => @message.template_model
+        'TemplateModel' => @message.template_model,
+        'MessageStream' => @message.message_stream
       }
     end
 

data/lib/postmark/message_extensions/mail.rb

@@ -72,6 +72,12 @@ module Mail
       @template_model = model
     end
 
+    attr_writer :message_stream
+    def message_stream(val = nil)
+      self.message_stream = val unless val.nil?
+      @message_stream
+    end
+
     def templated?
       !!template_alias
     end

data/lib/postmark/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = '1.20.0'
+  VERSION = '1.21.0'
 end

data/spec/support/custom_matchers.rb

@@ -33,6 +33,10 @@ RSpec::Matchers.define :json_representation_of do |x|
   match { |actual| Postmark::Json.decode(actual) == x }
 end
 
+RSpec::Matchers.define :match_json do |x|
+  match { |actual| Postmark::Json.encode(x) == actual }
+end
+
 RSpec::Matchers.define :be_serialized_to do |json|
   match do |mail_message|
     Postmark.convert_message_to_options_hash(mail_message) == JSON.parse(json)

data/spec/unit/postmark/api_client_spec.rb

@@ -18,9 +18,9 @@ describe Postmark::ApiClient do
       template_model  :name => "Sheldon"
     end
   end
+  let(:http_client) {api_client.http_client}
 
-  let(:api_client) {Postmark::ApiClient.new(api_token)}
-  subject {api_client}
+  subject(:api_client) {Postmark::ApiClient.new(api_token)}
 
   context "attr readers" do
     it { expect(subject).to respond_to(:http_client) }
@@ -62,7 +62,6 @@ describe Postmark::ApiClient do
   describe "#deliver" do
     let(:email) {Postmark::MessageHelper.to_postmark(message_hash)}
     let(:email_json) {Postmark::Json.encode(email)}
-    let(:http_client) {subject.http_client}
     let(:response) {{"MessageID" => 42}}
 
     it 'converts message hash to Postmark format and posts it to /email' do
@@ -86,7 +85,6 @@ describe Postmark::ApiClient do
     let(:email) {Postmark::MessageHelper.to_postmark(message_hash)}
     let(:emails) {[email, email, email]}
     let(:emails_json) {Postmark::Json.encode(emails)}
-    let(:http_client) {subject.http_client}
     let(:response) {[{'ErrorCode' => 0}, {'ErrorCode' => 0}, {'ErrorCode' => 0}]}
 
     it 'turns array of messages into a JSON document and posts it to /email/batch' do
@@ -104,7 +102,6 @@ describe Postmark::ApiClient do
   describe "#deliver_message" do
     let(:email) {message.to_postmark_hash}
     let(:email_json) {Postmark::Json.encode(email)}
-    let(:http_client) {subject.http_client}
 
     it 'raises an error when given a templated message' do
       expect { subject.deliver_message(templated_message) }.
@@ -139,7 +136,6 @@ describe Postmark::ApiClient do
   describe "#deliver_message_with_template" do
     let(:email) {templated_message.to_postmark_hash}
     let(:email_json) {Postmark::Json.encode(email)}
-    let(:http_client) {subject.http_client}
 
     it 'raises an error when given a non-templated message' do
       expect { subject.deliver_message_with_template(message) }.
@@ -175,7 +171,6 @@ describe Postmark::ApiClient do
     let(:email) {message.to_postmark_hash}
     let(:emails) {[email, email, email]}
     let(:emails_json) {Postmark::Json.encode(emails)}
-    let(:http_client) {subject.http_client}
     let(:response) {[{}, {}, {}]}
 
     it 'raises an error when given a templated message' do
@@ -207,7 +202,6 @@ describe Postmark::ApiClient do
     let(:email) {templated_message.to_postmark_hash}
     let(:emails) {[email, email, email]}
     let(:emails_json) {Postmark::Json.encode(emails)}
-    let(:http_client) {subject.http_client}
     let(:response) {[{}, {}, {}]}
     let(:messages) { Array.new(3) { templated_message } }
 
@@ -237,7 +231,6 @@ describe Postmark::ApiClient do
   end
 
   describe "#delivery_stats" do
-    let(:http_client) {subject.http_client}
     let(:response) {{"Bounces" => [{"Foo" => "Bar"}]}}
 
     it 'requests data at /deliverystats' do
@@ -276,8 +269,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#get_messages' do
-    let(:http_client) {subject.http_client}
-
     context 'given outbound' do
       let(:response) {{"TotalCount" => 1, "Messages" => [{}]}}
 
@@ -325,7 +316,6 @@ describe Postmark::ApiClient do
 
   describe '#get_message' do
     let(:id) {'8ad0e8b0-xxxx-xxxx-951d-223c581bb467'}
-    let(:http_client) {subject.http_client}
     let(:response) {{"To" => "leonard@bigbangtheory.com"}}
 
     context 'given outbound' do
@@ -349,7 +339,6 @@ describe Postmark::ApiClient do
 
   describe '#dump_message' do
     let(:id) {'8ad0e8b0-xxxx-xxxx-951d-223c581bb467'}
-    let(:http_client) {subject.http_client}
     let(:response) {{"Body" => "From: <leonard@bigbangtheory.com> \r\n ..."}}
 
     context 'given outbound' do
@@ -387,7 +376,6 @@ describe Postmark::ApiClient do
   end
 
   describe "#get_bounces" do
-    let(:http_client) {subject.http_client}
     let(:options) {{:foo => :bar}}
     let(:response) {{"Bounces" => []}}
 
@@ -399,7 +387,6 @@ describe Postmark::ApiClient do
   end
 
   describe "#get_bounce" do
-    let(:http_client) {subject.http_client}
     let(:id) {42}
 
     it 'requests a single bounce by ID at /bounces/:id' do
@@ -409,7 +396,6 @@ describe Postmark::ApiClient do
   end
 
   describe "#dump_bounce" do
-    let(:http_client) {subject.http_client}
     let(:id) {42}
 
     it 'requests a specific bounce data at /bounces/:id/dump' do
@@ -419,7 +405,6 @@ describe Postmark::ApiClient do
   end
 
   describe "#activate_bounce" do
-    let(:http_client) {subject.http_client}
     let(:id) {42}
     let(:response) {{"Bounce" => {}}}
 
@@ -456,7 +441,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#get_opens' do
-    let(:http_client) {subject.http_client}
     let(:options) {{:offset => 5}}
     let(:response) {{'Opens' => [], 'TotalCount' => 0}}
 
@@ -468,7 +452,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#get_clicks' do
-    let(:http_client) {subject.http_client}
     let(:options) {{:offset => 5}}
     let(:response) {{'Clicks' => [], 'TotalCount' => 0}}
 
@@ -480,7 +463,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#get_opens_by_message_id' do
-    let(:http_client) {subject.http_client}
     let(:message_id) {42}
     let(:options) {{:offset => 5}}
     let(:response) {{'Opens' => [], 'TotalCount' => 0}}
@@ -493,7 +475,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#get_clicks_by_message_id' do
-    let(:http_client) {subject.http_client}
     let(:message_id) {42}
     let(:options) {{:offset => 5}}
     let(:response) {{'Clicks' => [], 'TotalCount' => 0}}
@@ -536,8 +517,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#create_trigger' do
-    let(:http_client) {subject.http_client}
-
     context 'inbound rules' do
       let(:options) {{:rule => 'example.com'}}
       let(:response) {{'Rule' => 'example.com'}}
@@ -556,7 +535,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#get_trigger' do
-    let(:http_client) {subject.http_client}
     let(:id) {42}
 
     it 'performs a GET request to /triggers/tags/:id' do
@@ -571,8 +549,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#delete_trigger' do
-    let(:http_client) {subject.http_client}
-
     context 'tags' do
       let(:id) {42}
 
@@ -603,7 +579,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#get_triggers' do
-    let(:http_client) {subject.http_client}
     let(:options) {{:offset => 5}}
 
     context 'inbound rules' do
@@ -631,7 +606,6 @@ describe Postmark::ApiClient do
   end
 
   describe "#server_info" do
-    let(:http_client) {subject.http_client}
     let(:response) {{"Name" => "Testing",
                      "Color" => "blue",
                      "InboundHash" => "c2425d77f74f8643e5f6237438086c81",
@@ -644,7 +618,6 @@ describe Postmark::ApiClient do
   end
 
   describe "#update_server_info" do
-    let(:http_client) {subject.http_client}
     let(:response) {{"Name" => "Testing",
                      "Color" => "blue",
                      "InboundHash" => "c2425d77f74f8643e5f6237438086c81",
@@ -658,7 +631,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#get_templates' do
-    let(:http_client) {subject.http_client}
     let(:response) do
       {
           'TotalCount' => 31,
@@ -702,7 +674,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#get_template' do
-    let(:http_client) {subject.http_client}
     let(:response) do
       {
           'Name' => 'Template Name',
@@ -727,7 +698,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#create_template' do
-    let(:http_client) {subject.http_client}
     let(:response) do
       {
           'TemplateId' => 123,
@@ -749,7 +719,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#update_template' do
-    let(:http_client) {subject.http_client}
     let(:response) do
       {
           'TemplateId' => 123,
@@ -771,7 +740,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#delete_template' do
-    let(:http_client) {subject.http_client}
     let(:response) do
       {
           'ErrorCode' => 0,
@@ -789,8 +757,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#validate_template' do
-    let(:http_client) {subject.http_client}
-
     context 'when template is valid' do
       let(:response) do
         {
@@ -886,7 +852,6 @@ describe Postmark::ApiClient do
 
   describe "#deliver_with_template" do
     let(:email) {Postmark::MessageHelper.to_postmark(message_hash)}
-    let(:http_client) {subject.http_client}
     let(:response) {{"MessageID" => 42}}
 
     it 'converts message hash to Postmark format and posts it to /email/withTemplate' do
@@ -911,7 +876,6 @@ describe Postmark::ApiClient do
   describe '#deliver_in_batches_with_templates' do
     let(:max_batch_size) {50}
     let(:factor) {3.5}
-    let(:http_client) {subject.http_client}
     let(:postmark_response) do
       {
           'ErrorCode' => 0,
@@ -971,7 +935,6 @@ describe Postmark::ApiClient do
           "BounceRate" => 10.406,
       }
     end
-    let(:http_client) {subject.http_client}
 
     it 'converts response to ruby format' do
       expect(http_client).to receive(:get).with('stats/outbound', {:tag => 'foo'}) {response}
@@ -1005,7 +968,6 @@ describe Postmark::ApiClient do
           "Sent" => 615
       }
     end
-    let(:http_client) {subject.http_client}
 
     it 'converts response to ruby format' do
       expect(http_client).to receive(:get).with('stats/outbound/sends', {:tag => 'foo'}) {response}
@@ -1040,4 +1002,150 @@ describe Postmark::ApiClient do
       expect(first_day).to have_key(:sent)
     end
   end
+
+  describe '#create_suppressions' do
+    let(:email_addresses) { nil }
+    let(:message_stream_id) { 'outbound' }
+
+    subject { api_client.create_suppressions(message_stream_id, email_addresses) }
+
+    context '1 email address as string' do
+      let(:email_addresses) { 'A@example.com' }
+
+      specify do
+        expect(http_client).to receive(:post).
+          with('message-streams/outbound/suppressions',
+               match_json({
+                 :Suppressions => [
+                   { :EmailAddress => 'A@example.com' }
+                 ]}))
+        subject
+      end
+    end
+
+    context '1 email address as string & non-default stream' do
+      let(:email_addresses) { 'A@example.com' }
+      let(:message_stream_id) { 'xxxx' }
+
+      specify do
+        expect(http_client).to receive(:post).
+          with('message-streams/xxxx/suppressions',
+               match_json({
+                 :Suppressions => [
+                   { :EmailAddress => 'A@example.com' }
+                 ]}))
+        subject
+      end
+    end
+
+    context '1 email address as array of strings' do
+      let(:email_addresses) { ['A@example.com'] }
+
+      specify do
+        expect(http_client).to receive(:post).
+          with('message-streams/outbound/suppressions',
+               match_json({
+                 :Suppressions => [
+                   { :EmailAddress => 'A@example.com' }
+                 ]}))
+        subject
+      end
+    end
+
+    context 'many email addresses as array of strings' do
+      let(:email_addresses) { ['A@example.com', 'B@example.com'] }
+
+      specify do
+        expect(http_client).to receive(:post).
+          with('message-streams/outbound/suppressions',
+               match_json({
+                 :Suppressions => [
+                   { :EmailAddress => 'A@example.com' },
+                   { :EmailAddress => 'B@example.com' }
+                 ]}))
+        subject
+      end
+    end
+  end
+
+  describe '#delete_suppressions' do
+    let(:email_addresses) { nil }
+    let(:message_stream_id) { 'outbound' }
+
+    subject { api_client.delete_suppressions(message_stream_id, email_addresses) }
+
+    context '1 email address as string' do
+      let(:email_addresses) { 'A@example.com' }
+
+      specify do
+        expect(http_client).to receive(:post).
+          with('message-streams/outbound/suppressions/delete',
+               match_json({
+                 :Suppressions => [
+                   { :EmailAddress => 'A@example.com' },
+                 ]}))
+        subject
+      end
+    end
+
+    context '1 email address as string & non-default stream' do
+      let(:email_addresses) { 'A@example.com' }
+      let(:message_stream_id) { 'xxxx' }
+
+      specify do
+        expect(http_client).to receive(:post).
+          with('message-streams/xxxx/suppressions/delete',
+               match_json({
+                 :Suppressions => [
+                   { :EmailAddress => 'A@example.com' }
+                 ]}))
+        subject
+      end
+    end
+
+    context '1 email address as array of strings' do
+      let(:email_addresses) { ['A@example.com'] }
+
+      specify do
+        expect(http_client).to receive(:post).
+          with('message-streams/outbound/suppressions/delete',
+               match_json({
+                 :Suppressions => [
+                   { :EmailAddress => 'A@example.com' }
+                 ]}))
+        subject
+      end
+    end
+
+    context 'many email addresses as array of strings' do
+      let(:email_addresses) { ['A@example.com', 'B@example.com'] }
+
+      specify do
+        expect(http_client).to receive(:post).
+          with('message-streams/outbound/suppressions/delete',
+               match_json({
+                :Suppressions => [
+                  { :EmailAddress => 'A@example.com' },
+                  { :EmailAddress => 'B@example.com' }
+                ]}))
+        subject
+      end
+    end
+  end
+
+  describe '#dump_suppressions' do
+    let(:message_stream_id) { 'xxxx' }
+
+    subject { api_client.dump_suppressions(message_stream_id, :count => 123) }
+
+    before do
+      allow(http_client).to receive(:get).and_return({'TotalCount' => 0, 'Suppressions' => []})
+    end
+
+    specify do
+      expect(http_client).to receive(:get).
+        with('message-streams/xxxx/suppressions/dump', { :count => 123, :offset => 0 })
+      subject
+    end
+  end
 end

data/spec/unit/postmark/mail_message_converter_spec.rb

@@ -374,4 +374,16 @@ describe Postmark::MailMessageConverter do
       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(mail_message.to_postmark_hash.keys).not_to include('MessageStream') }
+    end
+
+    context 'when set' do
+      before { mail_message.message_stream = 'weekly-newsletter' }
+
+      specify { expect(mail_message.to_postmark_hash).to include('MessageStream' => 'weekly-newsletter') }
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.20.0
+  version: 1.21.0
 platform: ruby
 authors:
 - Petyo Ivanov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-12 00:00:00.000000000 Z
+date: 2020-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json