postmark 1.20.0 → 1.21.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 587a749e850a9a9fc2e70087fd13fa79d926844246f8030942d116ac6fbbcaec
-  data.tar.gz: 20fc00b9b8b59d45afe4722abd859cc4248f63ce487d190167aec0b957bd3c76
+  metadata.gz: 27b284da8c78da623e294bfea463e876cf18e370d395b681548af71a0071afe8
+  data.tar.gz: f12aba5cb688c265455578d011d6f917d405dac949003d2286fec6949c79367d
 SHA512:
-  metadata.gz: d4049417165d062f7d923a0b84e1c4b31791930e24c6c58d1171bbc0cb189cdbbe53736ee720b994c2a467d94afba7225512c39975f6fcd7d56d63b7c7cc567e
-  data.tar.gz: 7fce7304875e3a7877a73e697450fb82bfbdb2404a44337dfe6591e099476e7d57ead59ce9e30182f01825b4cfc7ca61ff49a1871cf9368b13bf74fe39753e05
+  metadata.gz: d8881a25fa5bec51bdb8b2db632f3a5a3d1aa1457dd13df1d6e274758b8c4da992cc74ad2b512e4dc771a23c3fafba197bc5c9a979302032114fc5486f49a98d
+  data.tar.gz: e9be7104643c2b9e9ec7fff821af17675afccb51dfe717e72cd1975e6cdf713f322302a18e3df16943e53976e11bb0d80adb5e685faaeff98ff9ec4d1dafaa2c

data/.circleci/config.yml

@@ -0,0 +1,68 @@
+# In order for builds to pass, in CircleCI you must have following environment variables setub:
+# POSTMARK_API_KEY,POSTMARK_ACCOUNT_API_KEY,POSTMARK_CI_RECIPIENT,POSTMARK_CI_SENDER
+
+version: 2.1
+
+workflows:
+  ruby-tests:
+    jobs:
+      - unit-tests:
+          matrix:
+            parameters:
+              version: ["2", "2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7"]
+      - unit-tests-legacy:
+          matrix:
+            parameters:
+              version: ["kneip/ree-1.8.7-2012.02","ruby:1.9.3","circleci/jruby:9"]
+
+orbs:
+  ruby: circleci/ruby@0.1.2
+
+jobs:
+  unit-tests:
+    parallelism: 1
+    parameters:
+      version:
+        type: string
+    docker:
+      - image: circleci/ruby:<< parameters.version >>
+    steps:
+      - checkout
+      - run:
+          name: Versions
+          command: |
+            echo "ruby: $(ruby --version)"
+
+      - run:
+          name: Install dependencies
+          command: bundle install
+
+      - run:
+          name: Run tests
+          command: bundle exec rake spec
+
+  unit-tests-legacy:
+    parallelism: 1
+    environment:
+      BUNDLE_GEMFILE: ./gemfiles/Gemfile.legacy
+    parameters:
+      version:
+        type: string
+    docker:
+      - image: << parameters.version >>
+    steps:
+      - checkout
+      - run:
+          name: Versions
+          command: |
+            echo "ruby: $(ruby --version)"
+
+      - run:
+          name: Install dependencies
+          command: |
+            gem install bundler --version 1.17.3
+            bundle install
+
+      - run:
+          name: Run tests
+          command: bundle exec rake spec

data/.gitignore

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

data/CHANGELOG.rdoc

@@ -1,5 +1,25 @@
 = Changelog
 
+== 1.21.4
+
+* Fixed Postmark::ApiClient#deliver_messages_with_templates (#104)
+
+== 1.21.3
+
+* Remove default SSL version setting and rely on Net::HTTP/OpenSSL default.
+
+== 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

data/README.md

@@ -3,7 +3,8 @@
 </a>
 
 # Postmark Ruby Gem
-[![Build Status](https://travis-ci.org/wildbit/postmark-gem.svg?branch=master)](https://travis-ci.org/wildbit/postmark-gem) [![Code Climate](https://codeclimate.com/github/wildbit/postmark-gem/badges/gpa.svg)](https://codeclimate.com/github/wildbit/postmark-gem)
+[![Build Status](https://circleci.com/gh/wildbit/postmark-gem.svg?style=shield)](https://circleci.com/gh/wildbit/postmark-gem)
+[![Code Climate](https://codeclimate.com/github/wildbit/postmark-gem/badges/gpa.svg)](https://codeclimate.com/github/wildbit/postmark-gem)
 [![License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://www.opensource.org/licenses/MIT)
 [![Gem Version](https://badge.fury.io/rb/postmark.svg)](https://badge.fury.io/rb/postmark)
 
@@ -62,4 +63,4 @@ Refer to the [LICENSE](https://github.com/wildbit/postmark-gem/blob/master/LICEN
 
 ## Copyright
 
-Copyright © 2018 Wildbit LLC. 
+Copyright © 2021 Wildbit LLC.

data/RELEASE.md

@@ -0,0 +1,12 @@
+New versions of the gem are cut by the Postmark team, this is a quick guide to ensuring a smooth release.
+
+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.
+1. Update CHANGELOG.rdoc with a brief description of the changes.
+1. Commit to git with a comment of "Bump version to x.y.z".
+1. run `rake release` - This will push to github(with the version tag) and rubygems with the version in lib/postmark/version.rb.
+  *Note that if you're on Bundler 1.17 there's a bug that hides the prompt for your OTP. If it hangs after adding the tag then it's asking for your OTP, enter your OTP and press Enter. Bundler 2.x and beyond resolved this issue. *
+1. Verify the new version is on [github](https://github.com/wildbit/postmark-gem) and [rubygems](https://rubygems.org/gems/postmark).
+1. Create a new release for the version on [Github releases](https://github.com/wildbit/postmark-gem/releases).
+1. Add or update any related content to the [wiki](https://github.com/wildbit/postmark-gem/wiki).

data/VERSION

@@ -1 +1 @@
-1.20.0
+1.21.4

data/lib/postmark/api_client.rb

@@ -81,7 +81,8 @@ module Postmark
       end
 
       in_batches(messages) do |batch, offset|
-        data = serialize(batch.map { |m| m.to_postmark_hash })
+        mapped = batch.map { |m| m.to_postmark_hash }
+        data = serialize(:Messages => mapped)
 
         with_retries do
           http_client.post("email/batchWithTemplates", data).tap do |response|
@@ -328,6 +329,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

@@ -18,8 +18,7 @@ module Postmark
       :secure => true,
       :path_prefix => '/',
       :http_read_timeout => 15,
-      :http_open_timeout => 5,
-      :http_ssl_version => :TLSv1
+      :http_open_timeout => 5
     }
 
     def initialize(api_token, options = {})
@@ -37,6 +36,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
@@ -103,7 +106,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 = self.http_ssl_version if http.respond_to?(:ssl_version=)
+      http.ssl_version = self.http_ssl_version if self.http_ssl_version && 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.20.0'
+  VERSION = '1.21.4'
 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
@@ -206,8 +201,7 @@ describe Postmark::ApiClient do
   describe "#deliver_messages_with_templates" 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(:emails_json) {Postmark::Json.encode(:Messages => emails)}
     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,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

@@ -42,9 +42,9 @@ describe Postmark::HttpClient do
     its(:http_read_timeout) { is_expected.to eq 15 }
     its(:http_open_timeout) { is_expected.to eq 5 }
 
-    it 'use default TLS encryption', :skip_ruby_version => ['1.8.7'] do
+    it 'does not provide a default which utilizes the Net::HTTP default', :skip_ruby_version => ['1.8.7'] do
       http_client = subject.http
-      expect(http_client.ssl_version).to eq :TLSv1
+      expect(http_client.ssl_version).to eq nil
     end
   end
 
@@ -140,7 +140,7 @@ describe Postmark::HttpClient do
                                               :status => [ "485", "Custom HTTP response status" ])
       expect { subject.post(target_path) }.to raise_error Postmark::UnknownError
     end
-    
+
   end
 
   describe "#get" do
@@ -180,7 +180,7 @@ describe Postmark::HttpClient do
                                              :status => [ "485", "Custom HTTP response status" ])
       expect { subject.get(target_path) }.to raise_error Postmark::UnknownError
     end
-    
+
   end
 
   describe "#put" do
@@ -223,4 +223,4 @@ describe Postmark::HttpClient do
       expect { subject.put(target_path) }.to raise_error Postmark::UnknownError
     end
   end
-end
+end

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.20.0
+  version: 1.21.4
 platform: ruby
 authors:
 - Petyo Ivanov
 - Ilya Sabanin
 - Artem Chistyakov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-12 00:00:00.000000000 Z
+date: 2021-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -63,16 +63,17 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
+- ".circleci/config.yml"
 - ".document"
 - ".gitignore"
 - ".rake_tasks"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.rdoc
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
+- RELEASE.md
 - Rakefile
 - VERSION
 - gemfiles/Gemfile.legacy
@@ -146,8 +147,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.0.8
+signing_key:
 specification_version: 4
 summary: Official Postmark API wrapper.
 test_files:

data/.travis.yml

@@ -1,31 +0,0 @@
-env:
-  global:
-    # POSTMARK_API_KEY=?
-    - secure: "ee7WQAGh7zOcoLYYx1k+542cU2R9jovnypCgyKTaBWMtdes3He4NksJGgp3PSgiPOjpYiqncXYZitgo/gKL8cYjtgcP8o/TKbzmHMTHEbD2LRWfIJ6sr4DiGYT1sjKvTLhVhSIh+WVcIXK9X3V5e6VIUfo14RMj6owHD6qv8Bjc="
-    # POSTMARK_ACCOUNT_API_KEY=?
-    - secure: "lau1m+ws6T5LBiRXwd+Q0b20Wjh62W/nHnCmzOSZc2+V97XTldl3MCJdXNV7J6X7O9CzFabcAG8FSbGGwPRiyhY/qhxkYSc/9pWE8RUjyCjbw5q2RzZQelMKizyKU92eOjd6jQw/wDSZcww1OceW/pgdRjqEo21Pk6XH2yzLAd8="
-    # POSTMARK_CI_RECIPIENT=?
-    - secure: "YnccT2MM+hIfwxl1WtcTk48q+D9XY7p6FTHkeJbUoaT9PFXQqXyUCQpwk5wYAwzZbVWG/CgH4PitWyRbWBP6kAqYKlsnAkQip0FNjs0DbK0SH9YvcFFSDZsTAl9yfwSxlgnBZHGZ49LO3yISMPUOdNn1QmaF4Ndpl4hiycH7UA8="
-    # POSTMARK_CI_SENDER=?
-    - secure: "Cz/KfiXkd90GQr+47LunlZnal8clrRpKmZUd9K161RYd5bfkL+P6SnEmhMprwdzomUBqIcqleR9HjmECey2V/Zd9V8vtBaLVZ5CoeMTkz3Tu6SllfmpymkcuJKf7GGizs97gmhPMlJd9iMukL6eqW4/1C9HW0cLZFB/jlzqFHpE="
-language: ruby
-rvm:
-  - 2.0.0
-  - 2.1.9
-  - 2.2.5
-  - 2.3.1
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
-matrix:
-  include:
-    - rvm: 1.8.7
-      dist: precise
-      gemfile: gemfiles/Gemfile.legacy
-    - rvm: 1.9.3
-      gemfile: gemfiles/Gemfile.legacy
-    - rvm: jruby-19mode
-      jdk: oraclejdk8
-      dist: trusty
-      gemfile: gemfiles/Gemfile.legacy
-script: bundle exec rake spec