postmark 1.19.1 → 1.21.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20c1b305ba06294fd478ce804a8fbfac8a217516fb3b053225d5f260a0e24f49
-  data.tar.gz: fddfe4e8bbd434f92e823a61e1fa3bac960dfc4ddfac4e0b42ab04aff2224e80
+  metadata.gz: 968a770c1ef1003b30c635a730caed027ed4579fae5a4c7ab8644996d2925440
+  data.tar.gz: 824ebb1f5ca038484a5077108df96cbbed072829c2dfd6fbc634f29d299e1675
 SHA512:
-  metadata.gz: b2ffb7acc3d6fde2f183f2985bbc022278f30b9d13d4beb13e4fbfd407764d5eb2cfb69e016cb036a5842ababacdc027dabaf776b54366914884e5a30bd24381
-  data.tar.gz: 3b9f6a9174457ee092b47bc3cfa7f32f508c56a77f2e6e471dea7d686c4d70324fb9db409461c20fafb908dc4ff35d012bd00e0242cb0c50a58a0e62d61bcb48
+  metadata.gz: a4a0bd9ac21b0a25fc377d70dd8d28c07dcb02886f51465d0879d2f1bb24bf8c5628cfc396b6cf6244f3a252fe5e17f7d7d4c10020764036884c1a9b99f3cf0b
+  data.tar.gz: 732d2a94875cfa132167aca0fcbd551279610a88d87fab34f23a116a568b0ba738e825e09b0b366ed8cb48e2c6bcd2d1b786d08ee8b1e93b35f3f172d911eee1

data/.gitignore

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

data/.travis.yml

@@ -14,6 +14,9 @@ rvm:
   - 2.1.9
   - 2.2.5
   - 2.3.1
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
 matrix:
   include:
     - rvm: 1.8.7

data/CHANGELOG.rdoc

@@ -1,5 +1,37 @@
 = Changelog
 
+== 1.21.2
+
+* Ensure sending via message stream uses the correct message stream
+
+== 1.21.1
+
+* Fixed Postmark::ApiClient#get_message_streams
+
+== 1.21.0
+
+* Added support for message streams and suppressions
+
+== 1.20.0
+
+* Removed deprecated trigger endpoints
+
+== 1.19.2
+
+Allow possibility to change TLS version for HTTP client.
+
+== 1.19.1
+
+Bounce tags endoint removed, since it's no longer supported by API.
+
+== 1.19.0
+
+Webhooks management support is added.
+
+== 1.18.0
+
+Custom headers with any type of character casing is supported now.
+
 == 1.17.0
 
 * Update sent email message properly and not altering it's Message-ID with Postmark unique message id.

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/VERSION

@@ -1 +1 @@
-1.17.0
+1.21.2

data/lib/postmark/api_client.rb

@@ -197,11 +197,6 @@ module Postmark
       format_response http_client.get("triggers/#{type}/#{id}")
     end
 
-    def update_trigger(type, id, options)
-      data = serialize(HashHelper.to_postmark(options))
-      format_response http_client.put("triggers/#{type}/#{id}", data)
-    end
-
     def delete_trigger(type, id)
       type = Postmark::Inflector.to_postmark(type).downcase
       format_response http_client.delete("triggers/#{type}/#{id}")
@@ -333,6 +328,44 @@ module Postmark
       format_response http_client.delete("webhooks/#{id}")
     end
 
+    def get_message_streams(options = {})
+      _, batch = load_batch('message-streams', 'MessageStreams', options)
+      batch
+    end
+
+    def message_streams(options = {})
+      find_each('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/http_client.rb

@@ -6,7 +6,9 @@ module Postmark
     attr_accessor :api_token
     attr_reader :http, :secure, :proxy_host, :proxy_port, :proxy_user,
                 :proxy_pass, :host, :port, :path_prefix,
-                :http_open_timeout, :http_read_timeout, :auth_header_name
+                :http_open_timeout, :http_read_timeout, :http_ssl_version,
+                :auth_header_name
+
     alias_method :api_key, :api_token
     alias_method :api_key=, :api_token=
 
@@ -16,7 +18,8 @@ module Postmark
       :secure => true,
       :path_prefix => '/',
       :http_read_timeout => 15,
-      :http_open_timeout => 5
+      :http_open_timeout => 5,
+      :http_ssl_version => :TLSv1
     }
 
     def initialize(api_token, options = {})
@@ -34,6 +37,10 @@ module Postmark
       do_request { |client| client.put(url_path(path), data, headers) }
     end
 
+    def patch(path, data = '')
+      do_request { |client| client.patch(url_path(path), data, headers) }
+    end
+
     def get(path, query = {})
       do_request { |client| client.get(url_path(path + to_query_string(query)), headers) }
     end
@@ -100,7 +107,7 @@ module Postmark
       http.read_timeout = self.http_read_timeout
       http.open_timeout = self.http_open_timeout
       http.use_ssl = !!self.secure
-      http.ssl_version = :TLSv1 if http.respond_to?(:ssl_version=)
+      http.ssl_version = self.http_ssl_version if http.respond_to?(:ssl_version=)
       http
     end
   end

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,15 @@ module Mail
       @template_model = model
     end
 
+    def message_stream(val = nil)
+      self.message_stream = val unless val.nil?
+      header['MESSAGE-STREAM'].to_s
+    end
+
+    def message_stream=(val)
+      header['MESSAGE-STREAM'] = val
+    end
+
     def templated?
       !!template_alias
     end
@@ -182,6 +191,7 @@ module Mail
         attachment   to
         track-opens  track-links
         postmark-template-alias
+        message-stream
       ]
     end
 

data/lib/postmark/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = '1.19.1'
+  VERSION = '1.21.2'
 end

data/spec/integration/api_client_resources_spec.rb

@@ -14,22 +14,6 @@ describe 'Accessing server resources using the API' do
     }
   }
 
-  context 'Triggers API' do
-    let(:unique_token) {rand(36 ** 32).to_s(36)}
-
-    it 'can be used to manage tag triggers via the API' do
-      trigger = api_client.create_trigger(:tags, :match_name => "gemtest_#{unique_token}", :track_opens => true)
-      api_client.update_trigger(:tags, trigger[:id], :match_name => "pre_#{trigger[:match_name]}")
-      updated = api_client.get_trigger(:tags, trigger[:id])
-
-      expect(updated[:id]).to eq(trigger[:id])
-      expect(updated[:match_name]).not_to eq(trigger[:id])
-      expect(api_client.triggers(:tags).map {|t| t[:id]}).to include(trigger[:id])
-
-      api_client.delete_trigger(:tags, trigger[:id])
-    end
-  end
-
   context 'Messages API' do
     def with_retries(max_retries = 20, wait_seconds = 3)
       yield
@@ -69,4 +53,4 @@ describe 'Accessing server resources using the API' do
       }.not_to raise_error
     end
   end
-end
+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,24 +517,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#create_trigger' do
-    let(:http_client) {subject.http_client}
-
-    context 'tags' do
-      let(:options) {{:foo => 'bar'}}
-      let(:response) {{'Foo' => 'Bar'}}
-
-      it 'performs a POST request to /triggers/tags with given options' do
-        allow(http_client).to receive(:post).with('triggers/tags',
-                                                  {'Foo' => 'bar'}.to_json)
-        subject.create_trigger(:tags, options)
-      end
-
-      it 'symbolizes response keys' do
-        allow(http_client).to receive(:post).and_return(response)
-        expect(subject.create_trigger(:tags, options)).to eq(:foo => 'Bar')
-      end
-    end
-
     context 'inbound rules' do
       let(:options) {{:rule => 'example.com'}}
       let(:response) {{'Rule' => 'example.com'}}
@@ -572,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
@@ -586,26 +548,7 @@ describe Postmark::ApiClient do
     end
   end
 
-  describe '#update_trigger' do
-    let(:http_client) {subject.http_client}
-    let(:options) {{:foo => 'bar'}}
-    let(:id) {42}
-
-    it 'performs a PUT request to /triggers/tags/:id' do
-      allow(http_client).to receive(:put).with("triggers/tags/#{id}",
-                                               {'Foo' => 'bar'}.to_json)
-      subject.update_trigger(:tags, id, options)
-    end
-
-    it 'symbolizes response keys' do
-      allow(http_client).to receive(:put).and_return('Foo' => 'Bar')
-      expect(subject.update_trigger(:tags, id, options)).to eq(:foo => 'Bar')
-    end
-  end
-
   describe '#delete_trigger' do
-    let(:http_client) {subject.http_client}
-
     context 'tags' do
       let(:id) {42}
 
@@ -619,7 +562,7 @@ describe Postmark::ApiClient do
         expect(subject.delete_trigger(:tags, id)).to eq(:foo => 'Bar')
       end
     end
-    
+
     context 'inbound rules' do
       let(:id) {42}
 
@@ -636,19 +579,8 @@ describe Postmark::ApiClient do
   end
 
   describe '#get_triggers' do
-    let(:http_client) {subject.http_client}
     let(:options) {{:offset => 5}}
 
-    context 'tags' do
-      let(:response) {{'Tags' => [], 'TotalCount' => 0}}
-
-      it 'performs a GET request to /triggers/tags' do
-        allow(http_client).to receive(:get).with('triggers/tags', options) {response}
-        expect(subject.get_triggers(:tags, options)).to be_an(Array)
-        expect(subject.get_triggers(:tags, options).count).to be_zero
-      end
-    end
-
     context 'inbound rules' do
       let(:response) {{'InboundRules' => [], 'TotalCount' => 0}}
 
@@ -674,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",
@@ -687,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",
@@ -701,7 +631,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#get_templates' do
-    let(:http_client) {subject.http_client}
     let(:response) do
       {
           'TotalCount' => 31,
@@ -745,7 +674,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#get_template' do
-    let(:http_client) {subject.http_client}
     let(:response) do
       {
           'Name' => 'Template Name',
@@ -770,7 +698,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#create_template' do
-    let(:http_client) {subject.http_client}
     let(:response) do
       {
           'TemplateId' => 123,
@@ -792,7 +719,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#update_template' do
-    let(:http_client) {subject.http_client}
     let(:response) do
       {
           'TemplateId' => 123,
@@ -814,7 +740,6 @@ describe Postmark::ApiClient do
   end
 
   describe '#delete_template' do
-    let(:http_client) {subject.http_client}
     let(:response) do
       {
           'ErrorCode' => 0,
@@ -832,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
         {
@@ -929,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
@@ -954,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,
@@ -1014,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}
@@ -1048,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}
@@ -1083,4 +1002,295 @@ describe Postmark::ApiClient do
       expect(first_day).to have_key(:sent)
     end
   end
+
+  describe '#get_message_streams' do
+    subject(:result) { api_client.get_message_streams(:offset => 22, :count => 33) }
+
+    before do
+      allow(http_client).to receive(:get).
+        with('message-streams', :offset => 22, :count => 33).
+        and_return({ 'TotalCount' => 1, 'MessageStreams' => [{'Name' => 'abc'}]})
+    end
+
+    it { is_expected.to be_an(Array) }
+
+    describe 'returned item' do
+      subject { result.first }
+
+      it { is_expected.to match(:name => 'abc') }
+    end
+  end
+
+  describe '#message_streams' do
+    subject { api_client.message_streams }
+
+    it { is_expected.to be_kind_of(Enumerable) }
+
+    it 'requests data at /message-streams' do
+      allow(http_client).to receive(:get).
+        with('message-streams', anything).
+        and_return('TotalCount' => 1, 'MessageStreams' => [{}])
+      expect(subject.first(5).count).to eq(1)
+    end
+  end
+
+  describe '#get_message_stream' do
+    subject(:result) { api_client.get_message_stream(123) }
+
+    before do
+      allow(http_client).to receive(:get).
+        with('message-streams/123').
+        and_return({
+          'Id' => 'xxx',
+          'Name' => 'My Stream',
+          'ServerID' => 321,
+          'MessageStreamType' => 'Transactional'
+        })
+    end
+
+    it {
+      is_expected.to match(
+        :id => 'xxx',
+        :name => 'My Stream',
+        :server_id => 321,
+        :message_stream_type => 'Transactional'
+      )
+    }
+  end
+
+  describe '#create_message_stream' do
+    subject { api_client.create_message_stream(attrs) }
+
+    let(:attrs) do
+      {
+        :name => 'My Stream',
+        :id => 'my-stream',
+        :message_stream_type => 'Broadcasts'
+      }
+    end
+
+    let(:response) do
+      {
+        'Name' => 'My Stream',
+        'Id' => 'my-stream',
+        'MessageStreamType' => 'Broadcasts',
+        'ServerId' => 222,
+        'CreatedAt' => '2020-04-01T03:33:33.333-03:00'
+      }
+    end
+
+    before do
+      allow(http_client).to receive(:post) { response }
+    end
+
+    specify do
+      expect(http_client).to receive(:post).
+        with('message-streams',
+             json_representation_of({
+               'Name' => 'My Stream',
+               'Id' => 'my-stream',
+               'MessageStreamType' => 'Broadcasts'
+             }))
+      subject
+    end
+
+    it {
+      is_expected.to match(
+        :id => 'my-stream',
+        :name => 'My Stream',
+        :server_id => 222,
+        :message_stream_type => 'Broadcasts',
+        :created_at => '2020-04-01T03:33:33.333-03:00'
+      )
+    }
+  end
+
+  describe '#update_message_stream' do
+    subject { api_client.update_message_stream('xxx', attrs) }
+
+    let(:attrs) do
+      {
+        :name => 'My Stream XXX'
+      }
+    end
+
+    let(:response) do
+      {
+        'Name' => 'My Stream XXX',
+        'Id' => 'xxx',
+        'MessageStreamType' => 'Broadcasts',
+        'ServerId' => 222,
+        'CreatedAt' => '2020-04-01T03:33:33.333-03:00'
+      }
+    end
+
+    before do
+      allow(http_client).to receive(:patch) { response }
+    end
+
+    specify do
+      expect(http_client).to receive(:patch).
+        with('message-streams/xxx',
+             match_json({
+               :Name => 'My Stream XXX',
+             }))
+      subject
+    end
+
+    it {
+      is_expected.to match(
+        :id => 'xxx',
+        :name => 'My Stream XXX',
+        :server_id => 222,
+        :message_stream_type => 'Broadcasts',
+        :created_at => '2020-04-01T03:33:33.333-03:00'
+      )
+    }
+  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/http_client_spec.rb

@@ -29,6 +29,7 @@ describe Postmark::HttpClient do
     it { expect(subject).to respond_to(:path_prefix) }
     it { expect(subject).to respond_to(:http_open_timeout) }
     it { expect(subject).to respond_to(:http_read_timeout) }
+    it { expect(subject).to respond_to(:http_ssl_version) }
   end
 
   context "when it is created without options" do
@@ -41,7 +42,7 @@ describe Postmark::HttpClient do
     its(:http_read_timeout) { is_expected.to eq 15 }
     its(:http_open_timeout) { is_expected.to eq 5 }
 
-    it 'uses TLS encryption', :skip_ruby_version => ['1.8.7'] do
+    it 'use default TLS encryption', :skip_ruby_version => ['1.8.7'] do
       http_client = subject.http
       expect(http_client.ssl_version).to eq :TLSv1
     end
@@ -58,6 +59,7 @@ describe Postmark::HttpClient do
     let(:path_prefix) { "/provided/path/prefix" }
     let(:http_open_timeout) { 42 }
     let(:http_read_timeout) { 42 }
+    let(:http_ssl_version) { :TLSv1_2}
 
     subject { Postmark::HttpClient.new(api_token,
                                        :secure => secure,
@@ -69,7 +71,8 @@ describe Postmark::HttpClient do
                                        :port => port,
                                        :path_prefix => path_prefix,
                                        :http_open_timeout => http_open_timeout,
-                                       :http_read_timeout => http_read_timeout) }
+                                       :http_read_timeout => http_read_timeout,
+                                       :http_ssl_version => http_ssl_version) }
 
     its(:api_token) { is_expected.to eq api_token }
     its(:api_key) { is_expected.to eq api_token }
@@ -83,6 +86,7 @@ describe Postmark::HttpClient do
     its(:path_prefix) { is_expected.to eq path_prefix }
     its(:http_open_timeout) { is_expected.to eq http_open_timeout }
     its(:http_read_timeout) { is_expected.to eq http_read_timeout }
+    its(:http_ssl_version) { is_expected.to eq http_ssl_version }
 
     it 'uses port 80 for plain HTTP connections' do
       expect(Postmark::HttpClient.new(api_token, :secure => false).port).to eq(80)

data/spec/unit/postmark/mail_message_converter_spec.rb

@@ -173,7 +173,7 @@ describe Postmark::MailMessageConverter do
   end
 
   it 'converts plain text messages correctly' do
-    expect(subject.new(mail_message).run).to eq ({
+    expect(subject.new(mail_message).run).to eq({
         "From" => "sheldon@bigbangtheory.com",
         "Subject" => "Hello!",
         "TextBody" => "Hello Sheldon!",
@@ -181,7 +181,7 @@ describe Postmark::MailMessageConverter do
   end
 
   it 'converts tagged text messages correctly' do
-    expect(subject.new(tagged_mail_message).run).to eq ({
+    expect(subject.new(tagged_mail_message).run).to eq({
         "From" => "sheldon@bigbangtheory.com",
         "Subject" => "Hello!",
         "TextBody" => "Hello Sheldon!",
@@ -190,14 +190,14 @@ describe Postmark::MailMessageConverter do
   end
 
   it 'converts plain text messages without body correctly' do
-    expect(subject.new(mail_message_without_body).run).to eq ({
+    expect(subject.new(mail_message_without_body).run).to eq({
         "From" => "sheldon@bigbangtheory.com",
         "Subject" => "Hello!",
         "To" => "lenard@bigbangtheory.com"})
   end
 
   it 'converts html messages correctly' do
-    expect(subject.new(mail_html_message).run).to eq ({
+    expect(subject.new(mail_html_message).run).to eq({
         "From" => "sheldon@bigbangtheory.com",
         "Subject" => "Hello!",
         "HtmlBody" => "<b>Hello Sheldon!</b>",
@@ -205,7 +205,7 @@ describe Postmark::MailMessageConverter do
   end
 
   it 'converts multipart messages correctly' do
-    expect(subject.new(mail_multipart_message).run).to eq ({
+    expect(subject.new(mail_multipart_message).run).to eq({
         "From" => "sheldon@bigbangtheory.com",
         "Subject" => "Hello!",
         "HtmlBody" => "<b>Hello Sheldon!</b>",
@@ -214,7 +214,7 @@ describe Postmark::MailMessageConverter do
   end
 
   it 'converts messages with attachments correctly' do
-    expect(subject.new(mail_message_with_attachment).run).to eq ({
+    expect(subject.new(mail_message_with_attachment).run).to eq({
         "From" => "sheldon@bigbangtheory.com",
         "Subject" => "Hello!",
         "Attachments" => [{"Name" => "empty.gif",
@@ -225,7 +225,7 @@ describe Postmark::MailMessageConverter do
   end
 
   it 'converts messages with named addresses correctly' do
-    expect(subject.new(mail_message_with_named_addresses).run).to eq ({
+    expect(subject.new(mail_message_with_named_addresses).run).to eq({
         "From" => "Sheldon <sheldon@bigbangtheory.com>",
         "Subject" => "Hello!",
         "TextBody" => "Hello Sheldon!",
@@ -244,7 +244,7 @@ describe Postmark::MailMessageConverter do
   context 'open tracking' do
     context 'setup inside of mail' do
       it 'converts open tracking enabled messages correctly' do
-        expect(subject.new(mail_message_with_open_tracking).run).to eq ({
+        expect(subject.new(mail_message_with_open_tracking).run).to eq({
             "From" => "sheldon@bigbangtheory.com",
             "Subject" => "Hello!",
             "HtmlBody" => "<b>Hello Sheldon!</b>",
@@ -253,7 +253,7 @@ describe Postmark::MailMessageConverter do
       end
 
       it 'converts open tracking disabled messages correctly' do
-        expect(subject.new(mail_message_with_open_tracking_disabled).run).to eq ({
+        expect(subject.new(mail_message_with_open_tracking_disabled).run).to eq({
             "From" => "sheldon@bigbangtheory.com",
             "Subject" => "Hello!",
             "HtmlBody" => "<b>Hello Sheldon!</b>",
@@ -264,7 +264,7 @@ describe Postmark::MailMessageConverter do
 
     context 'setup with tracking variable' do
       it 'converts open tracking enabled messages correctly' do
-        expect(subject.new(mail_message_with_open_tracking_set_variable).run).to eq ({
+        expect(subject.new(mail_message_with_open_tracking_set_variable).run).to eq({
             "From" => "sheldon@bigbangtheory.com",
             "Subject" => "Hello!",
             "HtmlBody" => "<b>Hello Sheldon!</b>",
@@ -273,7 +273,7 @@ describe Postmark::MailMessageConverter do
       end
 
       it 'converts open tracking disabled messages correctly' do
-        expect(subject.new(mail_message_with_open_tracking_disabled_set_variable).run).to eq ({
+        expect(subject.new(mail_message_with_open_tracking_disabled_set_variable).run).to eq({
             "From" => "sheldon@bigbangtheory.com",
             "Subject" => "Hello!",
             "HtmlBody" => "<b>Hello Sheldon!</b>",
@@ -285,7 +285,7 @@ describe Postmark::MailMessageConverter do
 
   context 'link tracking' do
     it 'converts html and text link tracking enabled messages correctly' do
-      expect(subject.new(mail_message_with_link_tracking_all).run).to eq ({
+      expect(subject.new(mail_message_with_link_tracking_all).run).to eq({
           "From" => "sheldon@bigbangtheory.com",
           "Subject" => "Hello!",
           "HtmlBody" => "<b>Hello Sheldon!</b>",
@@ -294,7 +294,7 @@ describe Postmark::MailMessageConverter do
     end
 
     it 'converts html only link tracking enabled messages correctly' do
-      expect(subject.new(mail_message_with_link_tracking_html).run).to eq ({
+      expect(subject.new(mail_message_with_link_tracking_html).run).to eq({
           "From" => "sheldon@bigbangtheory.com",
           "Subject" => "Hello!",
           "HtmlBody" => "<b>Hello Sheldon!</b>",
@@ -303,7 +303,7 @@ describe Postmark::MailMessageConverter do
     end
 
     it 'converts text only link tracking enabled messages correctly' do
-      expect(subject.new(mail_message_with_link_tracking_text).run).to eq ({
+      expect(subject.new(mail_message_with_link_tracking_text).run).to eq({
           "From" => "sheldon@bigbangtheory.com",
           "Subject" => "Hello!",
           "HtmlBody" => "<b>Hello Sheldon!</b>",
@@ -374,4 +374,20 @@ 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(subject.new(mail_message).run).not_to include('MessageStream') }
+    end
+
+    context 'when set' do
+      before do
+        mail_message.message_stream = 'weekly-newsletter'
+      end
+
+      it 'passes message stream to the API call' do
+        expect(subject.new(mail_message).run).to include('MessageStream' => 'weekly-newsletter')
+      end
+    end
+  end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.19.1
+  version: 1.21.2
 platform: ruby
 authors:
 - Petyo Ivanov
 - Ilya Sabanin
 - Artem Chistyakov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-12 00:00:00.000000000 Z
+date: 2020-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -146,8 +146,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.7
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Official Postmark API wrapper.
 test_files: