postmark 1.24.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36d183adb014f24f30c12f04f65d01d9a4565e46bac544fcf499f1834d98b15f
-  data.tar.gz: 23d80a64a061b7bce98a7040a0b64b7e56611aea995894764d201e5ee71fdf69
+  metadata.gz: b36e7eff4dabb977637da4527446a61f1f5b1907b0d327fefee9b9068f9ee874
+  data.tar.gz: c65b4c7bb6b1e7529f3b202d93e0898fdb51a067ae8496a8c8ae04b0eca9eb48
 SHA512:
-  metadata.gz: a132d891995e587fc6324cbed9626799a7919f0314b4402910593e47afb02281b25fd6b8971a20197774dd37d48c7221389047699b9cbf98a2cdfecce3e247b6
-  data.tar.gz: 26b78de0eefb4c6055e2edee3f787ddab17c49f49fbbd4e8bf02100f85202cc46d57ff4c140617f0c1cd7c325875e602fc952c8b9a528a9ad9feed25ee9d76b1
+  metadata.gz: 122e2d925a0dcff98d93fbd60d11db94c5e8f443b73cf67a20eea839a07fd4955fcf0e782a1e49bc3ee9abf0593f8d513a957e6541bc6774ecfb1b1268d152d9
+  data.tar.gz: 7db9801b4d8cbdb47c6d8b277d03871ea40ccacb62df06e10169f61cf3368c416e41699a65cfd0f667e0889df7c88e796b0ae4fbac30832a84644644ff63bfdf

data/.circleci/config.yml

@@ -9,11 +9,25 @@ workflows:
       - unit-tests:
           matrix:
             parameters:
-              version: ["2", "2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7"]
+              version: [
+                "circleci/ruby:2",
+                "circleci/ruby:2.1",
+                "circleci/ruby:2.2",
+                "circleci/ruby:2.3",
+                "circleci/ruby:2.4",
+                "circleci/ruby:2.5",
+                "circleci/ruby:2.6",
+                "circleci/ruby:2.7",
+                "cimg/ruby:3.2"
+              ]
       - unit-tests-legacy:
           matrix:
             parameters:
-              version: ["kneip/ree-1.8.7-2012.02","ruby:1.9.3","circleci/jruby:9"]
+              version: [
+                "kneip/ree-1.8.7-2012.02",
+                "ruby:1.9.3",
+                "circleci/jruby:9"
+              ]
 
 orbs:
   ruby: circleci/ruby@0.1.2
@@ -25,21 +39,16 @@ jobs:
       version:
         type: string
     docker:
-      - image: circleci/ruby:<< parameters.version >>
+      - image: << parameters.version >>
     steps:
       - checkout
-      - run:
-          name: Versions
-          command: |
-            echo "ruby: $(ruby --version)"
+      - check_version
 
       - run:
           name: Install dependencies
           command: bundle install
 
-      - run:
-          name: Run tests
-          command: bundle exec rake spec
+      - run_tests
 
   unit-tests-legacy:
     parallelism: 1
@@ -52,10 +61,7 @@ jobs:
       - image: << parameters.version >>
     steps:
       - checkout
-      - run:
-          name: Versions
-          command: |
-            echo "ruby: $(ruby --version)"
+      - check_version
 
       - run:
           name: Install dependencies
@@ -63,6 +69,19 @@ jobs:
             gem install bundler --version 1.17.3
             bundle install
 
+      - run_tests
+
+commands:
+  check_version:
+    steps:
+      - run:
+          name: Check Ruby version
+          command: |
+            echo "ruby: $(ruby --version)"
+  run_tests:
+    steps:
       - run:
           name: Run tests
           command: bundle exec rake spec
+      - store_test_results:
+          path: test-results

data/.ruby-version

@@ -1 +1 @@
-ruby-2.7.5
+ruby-3.2.2

data/CHANGELOG.rdoc

@@ -1,5 +1,12 @@
 = Changelog
 
+== 1.25.0
+* Add support for https://postmarkapp.com/developer/api/data-removals-api
+
+== 1.24.1
+* Fixed support for text/calendar attachments by using content_type instead of mime_type.
+* Added missing fields to Bounce
+
 == 1.24.0
 * Added configurable warnings when referencing deprecated classes.
 

data/Gemfile

@@ -4,7 +4,7 @@ source "http://rubygems.org"
 gemspec
 
 group :test do
-  gem 'rspec', '~> 3.7'
+  gem 'rspec', '~> 3.7', "< 3.10" # until https://github.com/rspec/rspec-support/pull/537 gets merged
   gem 'rspec-its', '~> 1.2'
   gem 'fakeweb', :git => 'https://github.com/chrisk/fakeweb.git'
   gem 'fakeweb-matcher'

data/README.md

@@ -73,8 +73,8 @@ Refer to the [LICENSE](https://github.com/ActiveCampaign/postmark-gem/blob/main/
 
 ## Tests
 
-The [integration tests](https://github.com/ActiveCampaign/postmark-gem/tree/main/spec/integration) currently use a real  test email address, configured via `POSTMARK_CI_RECIPIENT`. The credentials for it can be found in the internal 1password vault under `Postmark - Ruby - Client Library - Account`.
+The [integration tests](https://github.com/ActiveCampaign/postmark-gem/tree/main/spec/integration) currently use a real  test email address, configured via `POSTMARK_CI_RECIPIENT`.
 
 ## Copyright
 
-Copyright © 2022 ActiveCampaign LLC.
+Copyright © 2023 ActiveCampaign LLC.

data/VERSION

@@ -1 +1 @@
-1.24.0
+1.25.0

data/gemfiles/Gemfile.legacy

@@ -10,7 +10,9 @@ group :test do
   gem 'rspec-its', '~> 1.2'
   gem 'fakeweb', :git => 'https://github.com/chrisk/fakeweb.git'
   gem 'fakeweb-matcher'
+  gem 'mail', '~> 2.7.0'
   gem 'mime-types', '~> 1.25.1'
+  gem 'mini_mime', '< 1.1.4'
   gem 'activesupport', '~> 3.2.0'
   gem 'i18n', '~> 0.6.0'
   gem 'yajl-ruby', '~> 1.0', '< 1.4.0', :platforms => [:mingw, :mswin, :ruby]

data/lib/postmark/account_api_client.rb

@@ -145,6 +145,13 @@ module Postmark
       batch
     end
 
-  end
+    def get_data_removal_status(id)
+      format_response(http_client.get("data-removals/#{id}"))
+    end
 
+    def request_data_removal(attributes = {})
+      data = serialize(HashHelper.to_postmark(attributes))
+      format_response(http_client.post('data-removals', data))
+    end
+  end
 end

data/lib/postmark/bounce.rb

@@ -3,7 +3,8 @@ require 'time'
 module Postmark
   class Bounce
 
-    attr_reader :email, :bounced_at, :type, :description, :details, :name, :id, :server_id, :tag, :message_id, :subject
+    attr_reader :email, :bounced_at, :type, :description, :details, :name, :id, :server_id, :tag, :message_id, :subject,
+      :message_stream, :content
 
     def initialize(values = {})
       values = Postmark::HashHelper.to_ruby(values)
@@ -20,6 +21,9 @@ module Postmark
       @can_activate = values[:can_activate]
       @message_id = values[:message_id]
       @subject = values[:subject]
+      @server_id = values[:server_id]
+      @message_stream = values[:message_stream]
+      @content = values[:content]
     end
 
     def inactive?

data/lib/postmark/message_extensions/mail.rb

@@ -171,12 +171,12 @@ module Mail
 
     def export_native_attachments
       attachments.map do |attachment|
-        basics = {"Name" => attachment.filename,
-                  "Content" => pack_attachment_data(attachment.body.decoded),
-                  "ContentType" => attachment.mime_type}
-        specials = attachment.inline? ? {'ContentID' => attachment.url} : {}
-
-        basics.update(specials)
+        {
+          "Name" => attachment.filename,
+          "Content" => pack_attachment_data(attachment.body.decoded),
+          "ContentType" => attachment.content_type,
+          "ContentID" => attachment.inline? ? attachment.url : nil
+        }.delete_if { |_k, v| v.nil? }
       end
     end
 

data/lib/postmark/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = '1.24.0'
+  VERSION = '1.25.0'
 end

data/postmark.gemspec

@@ -34,6 +34,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency "json"
 
-  s.add_development_dependency "mail", "~> 2.7.0" # https://github.com/mikel/mail/pull/1539
+  s.add_development_dependency "mail"
   s.add_development_dependency "rake"
 end

data/spec/integration/account_api_client_spec.rb

@@ -105,4 +105,20 @@ describe 'Account API client usage' do
     # delete
     expect { subject.delete_server(new_server[:id]) }.not_to raise_error
   end
+
+  it 'manages data removals' do
+    # create
+    data_removal_status = subject.request_data_removal(
+      'requested_by' => 'sender@postmarkapp.com',
+      'requested_for' => 'test@example.com',
+      'notify_when_completed' => false
+    )
+
+    expect(data_removal_status[:status]).to eq('Pending')
+
+    # get
+    fetched_data_removal_status = subject.get_data_removal_status(data_removal_status[:id])
+
+    expect(fetched_data_removal_status[:id]).to eq(data_removal_status[:id])
+  end
 end

data/spec/unit/postmark/account_api_client_spec.rb

@@ -728,5 +728,46 @@ describe Postmark::AccountApiClient do
       end
     end
 
+    describe '#get_data_removal_status' do
+      let(:response) {
+        {
+          "ID" => 42,
+          "Status" => "Done"
+        }
+      }
+
+      it 'performs a GET request to /data-removals/:id endpoint' do
+        allow(subject.http_client).to receive(:get).
+          with('data-removals/42').and_return(response)
+        subject.get_data_removal_status(42)
+      end
+
+      it 'formats the keys of returned response' do
+        allow(subject.http_client).to receive(:get).and_return(response)
+        keys = subject.get_data_removal_status(42).keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be true
+      end
+    end
+
+    describe '#request_data_removal' do
+      let(:response) {
+        {
+          "ID" => 42,
+          "Status" => "Done"
+        }
+      }
+
+      it 'performs a POST request to /data-removals endpoint' do
+        allow(subject.http_client).to receive(:post).
+          with('data-removals', an_instance_of(String)).and_return(response)
+        subject.request_data_removal(:foo => 'bar')
+      end
+
+      it 'formats the keys of returned response' do
+        allow(subject.http_client).to receive(:post).and_return(response)
+        keys = subject.request_data_removal(:foo => 'bar').keys
+        expect(keys.all? { |k| k.is_a?(Symbol) }).to be true
+      end
+    end
   end
 end

data/spec/unit/postmark/bounce_spec.rb

@@ -12,6 +12,10 @@ describe Postmark::Bounce do
                        :inactive => false,
                        :can_activate => true,
                        :id => 42,
+                       :server_id => 12345,
+                       :tag => "TEST_TAG",
+                       :message_stream => "my-message-stream",
+                       :content => "THE CONTENT",
                        :subject => "Hello from our app!"} }
   let(:bounce_data_postmark) { Postmark::HashHelper.to_postmark(bounce_data) }
   let(:bounces_data) { [bounce_data, bounce_data, bounce_data] }
@@ -31,6 +35,8 @@ describe Postmark::Bounce do
     it { expect(subject).to respond_to(:tag) }
     it { expect(subject).to respond_to(:message_id) }
     it { expect(subject).to respond_to(:subject) }
+    it { expect(subject).to respond_to(:message_stream) }
+    it { expect(subject).to respond_to(:content) }
   end
 
   context "given a bounce created from bounce_data" do
@@ -55,6 +61,10 @@ describe Postmark::Bounce do
     its(:bounced_at) { is_expected.to eq Time.parse(bounce_data[:bounced_at]) }
     its(:id) { is_expected.to eq bounce_data[:id] }
     its(:subject) { is_expected.to eq bounce_data[:subject] }
+    its(:message_stream) { is_expected.to eq bounce_data[:message_stream] }
+    its(:server_id) { is_expected.to eq bounce_data[:server_id] }
+    its(:tag) { is_expected.to eq bounce_data[:tag] }
+    its(:content) { is_expected.to eq bounce_data[:content] }
 
   end
 

data/spec/unit/postmark/mail_message_converter_spec.rb

@@ -118,8 +118,8 @@ describe Postmark::MailMessageConverter do
       from "sheldon@bigbangtheory.com"
       to "lenard@bigbangtheory.com"
       subject "Hello!"
-      body "Hello Sheldon!"
       add_file empty_gif_path
+      body "Hello Sheldon!"
     end
   end
 
@@ -219,7 +219,7 @@ describe Postmark::MailMessageConverter do
         "Subject" => "Hello!",
         "Attachments" => [{"Name" => "empty.gif",
                            "Content" => encoded_empty_gif_data,
-                           "ContentType" => "image/gif"}],
+                           "ContentType" => "image/gif; filename=empty.gif"}],
         "TextBody" => "Hello Sheldon!",
         "To" => "lenard@bigbangtheory.com"})
   end

data/spec/unit/postmark/message_extensions/mail_spec.rb

@@ -183,7 +183,7 @@ describe Mail::Message do
     let(:exported_data) {
       {'Name' => 'face.jpeg',
        'Content' => "YmluYXJ5ZGF0YWhlcmU=\n",
-       'ContentType' => 'image/jpeg'}
+       'ContentType' => 'image/jpeg; filename=face.jpeg'}
     }
 
     context 'given a regular attachment' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.25.0
 platform: ruby
 authors:
 - Tomek Maszkowski
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-07 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -33,16 +33,16 @@ dependencies:
   name: mail
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.7
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Official Postmark API wrapper.