postmark 1.21.3 → 1.21.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb0f51e437e4831ac7fe011e089ac51c00984a614f48f31e94cce6233331f3bd
-  data.tar.gz: 599f2b99b5a8bca7a5761c560feddac36cd252a2232431008c3eabc1ef3375b0
+  metadata.gz: b2bd2c9a288c0f4baa7f2f076d91151a0835b8b168c76e6b1938d5aee972d118
+  data.tar.gz: 5f8ef5865ba91468d5d413f111af5f195adaf0c44983749605e7e015d9b79eb3
 SHA512:
-  metadata.gz: 7f16405603d847f6e8b4124a7da3c478db38555196016d59cb743c4d63f154e512ffac6d9db74702340e19cfa2afdb04965fdcb3436ab92c62f031d2d2b7ba0b
-  data.tar.gz: 6429f12e770e5a305f2bcb705cff501c48ebeb45be85dbd78f44e32cc4b5312abd0d6d9789c5c29e7cb3fca411a4e1a748a34fdc35e703862202e7c72851a0be
+  metadata.gz: ba8d2597f8502259ef996c647d08f5264e6c677aa4d3e0e697156442b35fe6a1503b914f156b83a627dadaf4cdb64e3e159049d2031e52c675ff721b960abc16
+  data.tar.gz: 538224ea9fa9c537f9671a5f9de5bfb1a7dc9078f531b6ef8fc8f1c02aa64fda4e82e8031ad5da37abcaeb793b65fd4b5b541e6329181e8e0e21af8d05d0fc93

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.7
+
+* Improved parsing recipients with Postmark::InactiveRecipientError.parse_recipients method
+
+== 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.

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

@@ -1,6 +1,6 @@
 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 Travis for your branch.
+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.

data/VERSION

@@ -1 +1 @@
-1.21.3
+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,12 +70,14 @@ module Postmark
     end
   end
 
+  class InvalidEmailAddressError < ApiInputError; end
+
   class InactiveRecipientError < ApiInputError
     attr_reader :recipients
 
     PATTERNS = [/^Found inactive addresses: (.+?)\.$/.freeze,
-                /^Found inactive addresses: (.+?)\.$/.freeze,
-                /these inactive addresses: (.+?)\. Inactive/.freeze].freeze
+                /these inactive addresses: (.+?)\. Inactive/.freeze,
+                /these inactive addresses: (.+?)\.?$/].freeze
 
     def self.parse_recipients(message)
       PATTERNS.each do |p|

data/lib/postmark/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = '1.21.3'
+  VERSION = '1.21.7'
 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
@@ -161,6 +195,12 @@ describe(Postmark::InactiveRecipientError) do
       it {is_expected.to eq(recipients.take(1))}
     end
 
+    context 'i/n inactive, n > 1, i < n - new message format' do
+      let(:message) { "Message OK, but will not deliver to these inactive addresses: #{recipients[0...2].join(', ')}" }
+
+      it {is_expected.to eq(recipients.take(2))}
+    end
+
     context 'i/n inactive, n > 1, i < n' do
       let(:message) do
         'Message OK, but will not deliver to these inactive addresses: ' \
@@ -209,6 +249,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
 

metadata

@@ -1,16 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.21.3
+  version: 1.21.7
 platform: ruby
 authors:
+- Tomek Maszkowski
+- Igor Balos
+- Artem Chistyakov
+- Nick Hammond
 - Petyo Ivanov
 - Ilya Sabanin
-- Artem Chistyakov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2021-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -56,18 +59,18 @@ 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
@@ -147,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: "XJkpUbAC1N6vcL/bUvqX2Mx8OKXpr/3zwqhjGiWhrSGKmQJUNnK4TEGFjnb1TBncZvW5cBRD0oX1Tt7gAu4o8C6sldVf35hB5FQsEyQrgSN4s95uLHuTW9EQisiQS6kzPLbkUmsMIQhIlfNGKQ5tRzRQstip81E8a0Emth3Y9EQ="
-    # POSTMARK_CI_SENDER=?
-    - secure: "bOoU3WEFur/SqwTY0m0aGqy8v8AZfZtFFHNYsU/BtAppZXj378CiktvJGj+cz/KMqFEWyJKNzchFOfZa45Q9Xor/QbTqkBriTOz3Ff7gQpmuPfLSvWRQSLRmbRFgr0Dk8QCTTtfnNtnajxMUyGfxwCiMo+l3EEAqjtLpN+Gja20="
-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