postmark 1.21.2 → 1.21.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 968a770c1ef1003b30c635a730caed027ed4579fae5a4c7ab8644996d2925440
-  data.tar.gz: 824ebb1f5ca038484a5077108df96cbbed072829c2dfd6fbc634f29d299e1675
+  metadata.gz: 6b42f4ec6b9f264b0ecdd3b4f6189a68f85436af6953c869d4b5e20d4d08abde
+  data.tar.gz: a755605d53ffd4b8ba7f1707b42e97592eb93510968898854456e1ad368f40c2
 SHA512:
-  metadata.gz: a4a0bd9ac21b0a25fc377d70dd8d28c07dcb02886f51465d0879d2f1bb24bf8c5628cfc396b6cf6244f3a252fe5e17f7d7d4c10020764036884c1a9b99f3cf0b
-  data.tar.gz: 732d2a94875cfa132167aca0fcbd551279610a88d87fab34f23a116a568b0ba738e825e09b0b366ed8cb48e2c6bcd2d1b786d08ee8b1e93b35f3f172d911eee1
+  metadata.gz: 5b6a7eaec4d234210f99e12ab0bf2301a42e3fcd21f6a369640b3dd032a0a3ba25e1f6a3afd1bcbebceac227802c8e4cea945951923a83c7191154f66ec23512
+  data.tar.gz: 35d6d11418ad06fe1e363e9ac794c3cdab319d827a7f4f12b49a3572d04be0f115638880e6ac475b0a9298e2ada84b8055e247c7fe058c2bb3c4fbf6bb748506

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/CHANGELOG.rdoc

@@ -1,5 +1,21 @@
 = Changelog
 
+== 1.21.6
+
+* Improved error handling for email sending related to invalid email addresses
+
+== 1.21.5
+
+* Added support for archiving/unarchiving message streams
+
+== 1.21.4
+
+* Fixed Postmark::ApiClient#deliver_messages_with_templates (#104)
+
+== 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

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 © 2020 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.21.2
+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|
@@ -351,6 +352,14 @@ module Postmark
       format_response(http_client.patch("message-streams/#{id}", data))
     end
 
+    def archive_message_stream(id)
+      format_response http_client.post("message-streams/#{id}/archive")
+    end
+
+    def unarchive_message_stream(id)
+      format_response http_client.post("message-streams/#{id}/unarchive")
+    end
+
     def dump_suppressions(stream_id, options = {})
       _, batch = load_batch("message-streams/#{stream_id}/suppressions/dump", 'Suppressions', options)
       batch

data/lib/postmark/error.rb

@@ -30,9 +30,8 @@ module Postmark
     def initialize(status_code = 500, body = '', parsed_body = {})
       self.parsed_body = parsed_body
       self.status_code = status_code.to_i
-      message = parsed_body.fetch(
-        'Message',
-        "The Postmark API responded with HTTP status #{status_code}.")
+      self.body = body
+      message = parsed_body.fetch('Message', "The Postmark API responded with HTTP status #{status_code}.")
 
       super(message)
     end
@@ -44,6 +43,7 @@ module Postmark
 
   class ApiInputError < HttpServerError
     INACTIVE_RECIPIENT = 406
+    INVALID_EMAIL_ADDRESS = 300
 
     attr_accessor :error_code
 
@@ -52,7 +52,9 @@ module Postmark
 
       case error_code
       when INACTIVE_RECIPIENT
-        InactiveRecipientError.new(INACTIVE_RECIPIENT, body, parsed_body)
+        InactiveRecipientError.new(error_code, body, parsed_body)
+      when INVALID_EMAIL_ADDRESS
+        InvalidEmailAddressError.new(error_code, body, parsed_body)
       else
         new(error_code, body, parsed_body)
       end
@@ -68,6 +70,8 @@ module Postmark
     end
   end
 
+  class InvalidEmailAddressError < ApiInputError; end
+
   class InactiveRecipientError < ApiInputError
     attr_reader :recipients
 

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 = {})
@@ -107,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/version.rb

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

data/postmark.gemspec

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

data/spec/unit/postmark/api_client_spec.rb

@@ -201,7 +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(:emails_json) {Postmark::Json.encode(:Messages => emails)}
     let(:response) {[{}, {}, {}]}
     let(:messages) { Array.new(3) { templated_message } }
 
@@ -606,10 +606,14 @@ describe Postmark::ApiClient do
   end
 
   describe "#server_info" do
-    let(:response) {{"Name" => "Testing",
-                     "Color" => "blue",
-                     "InboundHash" => "c2425d77f74f8643e5f6237438086c81",
-                     "SmtpApiActivated" => true}}
+    let(:response) {
+      {
+        "Name" => "Testing",
+        "Color" => "blue",
+        "InboundHash" => "c2425d77f74f8643e5f6237438086c81",
+        "SmtpApiActivated" => true
+      }
+    }
 
     it 'requests server info from Postmark and converts it to ruby format' do
       expect(http_client).to receive(:get).with('server') {response}
@@ -618,10 +622,14 @@ describe Postmark::ApiClient do
   end
 
   describe "#update_server_info" do
-    let(:response) {{"Name" => "Testing",
-                     "Color" => "blue",
-                     "InboundHash" => "c2425d77f74f8643e5f6237438086c81",
-                     "SmtpApiActivated" => false}}
+    let(:response) {
+      {
+        "Name" => "Testing",
+        "Color" => "blue",
+        "InboundHash" => "c2425d77f74f8643e5f6237438086c81",
+        "SmtpApiActivated" => false
+      }
+    }
     let(:update) {{:smtp_api_activated => false}}
 
     it 'updates server info in Postmark and converts it to ruby format' do
@@ -1148,6 +1156,62 @@ describe Postmark::ApiClient do
     }
   end
 
+  describe '#archive_message_stream' do
+    subject { api_client.archive_message_stream(stream_id) }
+
+    let(:stream_id) { 'my-stream'}
+    let(:server_id) { 123 }
+    let(:purge_date) { '2030-08-30T12:30:00.00-04:00' }
+    let(:api_endpoint) { "message-streams/#{stream_id}/archive" }
+    let(:api_response) {{ 'ID' => stream_id, 'ServerID' => server_id, 'ExpectedPurgeDate' => purge_date  }}
+
+    before do
+      allow(http_client).to receive(:post).with(api_endpoint) { api_response }
+    end
+
+    it 'calls the API endpoint' do
+      expect(http_client).to receive(:post).with(api_endpoint)
+      subject
+    end
+
+    it 'transforms the API response' do
+      expect(subject).to eq({ :id => stream_id, :server_id => server_id, :expected_purge_date => purge_date })
+    end
+  end
+
+  describe '#unarchive_message_stream' do
+    subject { api_client.unarchive_message_stream(stream_id) }
+
+    let(:stream_id) { 'my-stream'}
+    let(:server_id) { 123 }
+    let(:api_endpoint) { "message-streams/#{stream_id}/unarchive" }
+    let(:api_response) { 
+      { 'ID' => stream_id, 'ServerID' => server_id, 'Name' => 'My Stream',
+        'Description' => 'My test stream.', 'MessageStreamType' => 'Transactional',
+        'CreatedAt' => '2030-08-30T12:30:00.00-04:00', 'UpdatedAt' => '2030-09-30T12:30:00.00-04:00',
+        'ArchivedAt'=> nil, 'ExpectedPurgeDate' => nil,
+        'SubscriptionManagementConfiguration' => { 'UnsubscribeHandlingType' => 'None' } }
+    }
+
+    before do
+      allow(http_client).to receive(:post).with(api_endpoint) { api_response }
+    end
+
+    it 'calls the API endpoint' do
+      expect(http_client).to receive(:post).with(api_endpoint)
+      subject
+    end
+
+    it 'transforms the API response' do
+      expect(subject).to eq({ :id => stream_id, :server_id => server_id, :name => 'My Stream',
+                              :description => 'My test stream.', :message_stream_type => 'Transactional',
+                              :created_at => '2030-08-30T12:30:00.00-04:00',
+                              :updated_at => '2030-09-30T12:30:00.00-04:00',
+                              :archived_at => nil , :expected_purge_date => nil ,
+                              :subscription_management_configuration => { 'UnsubscribeHandlingType' => 'None' }})
+    end
+  end
+
   describe '#create_suppressions' do
     let(:email_addresses) { nil }
     let(:message_stream_id) { 'outbound' }

data/spec/unit/postmark/error_spec.rb

@@ -97,6 +97,13 @@ describe(Postmark::ApiInputError) do
         it_behaves_like 'api input error'
       end
 
+      context '300' do
+        let(:code) {Postmark::ApiInputError::INVALID_EMAIL_ADDRESS}
+
+        it {is_expected.to be_a(Postmark::InvalidEmailAddressError)}
+        it_behaves_like 'api input error'
+      end
+
       context 'others' do
         let(:code) {'9999'}
 
@@ -142,6 +149,33 @@ describe(Postmark::MailAdapterError) do
   it {is_expected.to be_a(Postmark::Error)}
 end
 
+describe(Postmark::InvalidEmailAddressError) do
+  describe '.new' do
+    let(:response) {{'Message' => message}}
+
+    subject do
+      Postmark::InvalidEmailAddressError.new(
+        Postmark::ApiInputError::INVALID_EMAIL_ADDRESS, Postmark::Json.encode(response), response)
+    end
+
+    let(:message) do
+      "Error parsing 'To': Illegal email address 'johne.xample.com'. It must contain the '@' symbol."
+    end
+
+    it 'body is set' do
+      expect(subject.body).to eq(Postmark::Json.encode(response))
+    end
+
+    it 'parsed body is set' do
+      expect(subject.parsed_body).to eq(response)
+    end
+
+    it 'error code is set' do
+      expect(subject.error_code).to eq(Postmark::ApiInputError::INVALID_EMAIL_ADDRESS)
+    end
+  end
+end
+
 describe(Postmark::InactiveRecipientError) do
   describe '.parse_recipients' do
     let(:recipients) do
@@ -209,6 +243,18 @@ describe(Postmark::InactiveRecipientError) do
     it 'parses recipients from json payload' do
       expect(subject.recipients).to eq([address])
     end
+
+    it 'body is set' do
+      expect(subject.body).to eq(Postmark::Json.encode(response))
+    end
+
+    it 'parsed body is set' do
+      expect(subject.parsed_body).to eq(response)
+    end
+
+    it 'error code is set' do
+      expect(subject.error_code).to eq(Postmark::ApiInputError::INACTIVE_RECIPIENT)
+    end
   end
 end
 

data/spec/unit/postmark/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

metadata

@@ -1,16 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.21.2
+  version: 1.21.6
 platform: ruby
 authors:
+- Tomek Maszkowski
+- Igor Balos
+- Artem Chistyakov
+- Nick Hammond
 - Petyo Ivanov
 - Ilya Sabanin
-- Artem Chistyakov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-09 00:00:00.000000000 Z
+date: 2021-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -56,23 +59,24 @@ dependencies:
         version: '0'
 description: Use this gem to send emails through Postmark HTTP API and retrieve info
   about bounces.
-email: ilya@wildbit.com
+email: tomek@wildbit.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - 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,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.7
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Official Postmark API wrapper.

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