postmark 1.23.0 → 1.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfce0fc58365a91800f896d2d16c8d62d1a601f7a1a8d5350c6270cae3f12be3
-  data.tar.gz: 3d8b2761c884f6ca1f3c81efe7c30dda1432b6d7da740d18d6cc55f5cc062d23
+  metadata.gz: a058959694917a357c1620516b215963717924485075b241ce7ceb23115619bd
+  data.tar.gz: 672e034cbbaa506c5bca5ae7acc229a190d88abb061461f3ddb4e6613c8b2b0f
 SHA512:
-  metadata.gz: 4082d74e41c4d74378f4e46bb43d0b8dd967489125865cd9379fbc3928dfd0be7369408cfcdcc6a979822739b8734045fba8a66021591848dff801286ef183d9
-  data.tar.gz: 5c93b937e1749584f52c1a1f5e0a4a9eabc6ea579e02c26f20d709ea5b89873d666acd6b8c2e7733a5e18885df370c1f2ca26e9c96c23cc44448d95c4f0da309
+  metadata.gz: 4161edf7a3ef04545b54824271677f618ac691c3dc6c332d7f507585b338fd2878572b8f4e12102367266a5226b64d758f6a1ff26e426040c9c538b710ee622f
+  data.tar.gz: af9c996569b7e3a3b31bb37f2623803877ec84179fb8f791a53002730b513919077ad26e28e3fa544b0b1cff60b276d9d762966901ffdfbcf015080f59145b3c

data/CHANGELOG.rdoc

@@ -1,5 +1,11 @@
 = Changelog
 
+== 1.24.1
+* Fixed support for text/calendar attachments by using content_type instead of mime_type.
+
+== 1.24.0
+* Added configurable warnings when referencing deprecated classes.
+
 == 1.23.0
 * Deprecated `InvalidEmailAddressError`. New name is `InvalidEmailRequestError`.
 

data/README.md

@@ -48,6 +48,15 @@ Without Bundler:
 gem install postmark
 ```
 
+## Deprecations
+
+Deprecations can be either silenced or set to raise using:
+
+```rb
+Postmark::Deprecations.behavior = :silence
+Postmark::Deprecations.behavior = :raise
+```
+
 ## Note on Patches/Pull Requests
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) file for details.
@@ -64,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.23.0
+1.24.1

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/deprecations.rb

@@ -0,0 +1,35 @@
+module Postmark
+  def self.const_missing(const_name)
+    replacement = Deprecations.deprecated_constants.fetch(const_name, nil) || super
+    Deprecations.report("DEPRECATION WARNING: the class #{const_name} is deprecated. Use #{replacement} instead.")
+    replacement
+  end
+
+  module Deprecations
+    DEFAULT_BEHAVIORS = {
+      :raise => lambda { |message| raise message },
+      :log => lambda { |message| warn message },
+      :silence => lambda { |message| },
+    }
+
+    def self.report(message)
+      DEFAULT_BEHAVIORS.fetch(behavior).call(message)
+    end
+
+    def self.deprecated_constants
+      @deprecated_constants ||= {}
+    end
+
+    def self.behavior
+      @behavior ||= :log
+    end
+
+    def self.behavior=(behavior)
+      @behavior = behavior
+    end
+
+    def self.add_constants(mappings)
+      deprecated_constants.merge!(mappings)
+    end
+  end
+end

data/lib/postmark/error.rb

@@ -1,3 +1,5 @@
+require 'postmark/deprecations'
+
 module Postmark
   class Error < ::StandardError; end
 
@@ -126,8 +128,10 @@ module Postmark
   class UnexpectedHttpResponseError < HttpServerError; end
 
   # Backwards compatible aliases
-  DeliveryError = Error
-  InvalidMessageError = ApiInputError
-  UnknownError = UnexpectedHttpResponseError
-  InvalidEmailAddressError = InvalidEmailRequestError
+  Deprecations.add_constants(
+    :DeliveryError => Error,
+    :InvalidMessageError => ApiInputError,
+    :UnknownError => UnexpectedHttpResponseError,
+    :InvalidEmailAddressError => InvalidEmailRequestError
+  )
 end

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.23.0'
+  VERSION = '1.24.1'
 end

data/spec/spec_helper.rb

@@ -15,6 +15,8 @@ require File.join(File.expand_path(File.dirname(__FILE__)), 'support', 'shared_e
 require File.join(File.expand_path(File.dirname(__FILE__)), 'support', 'custom_matchers.rb')
 require File.join(File.expand_path(File.dirname(__FILE__)), 'support', 'helpers.rb')
 
+Postmark::Deprecations.behavior = :silence
+
 if ENV['JSONGEM']
   # `JSONGEM=Yajl rake spec`
   Postmark.response_parser_class = ENV['JSONGEM'].to_sym

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

@@ -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.23.0
+  version: 1.24.1
 platform: ruby
 authors:
 - Tomek Maszkowski
@@ -10,10 +10,10 @@ authors:
 - Nick Hammond
 - Petyo Ivanov
 - Ilya Sabanin
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-23 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -59,7 +59,7 @@ dependencies:
         version: '0'
 description: Use this gem to send emails through Postmark HTTP API and retrieve info
   about bounces.
-email:
+email: 
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -88,6 +88,7 @@ files:
 - lib/postmark/api_client.rb
 - lib/postmark/bounce.rb
 - lib/postmark/client.rb
+- lib/postmark/deprecations.rb
 - lib/postmark/error.rb
 - lib/postmark/handlers/mail.rb
 - lib/postmark/helpers/hash_helper.rb
@@ -153,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.7
 requirements: []
 rubygems_version: 3.1.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Official Postmark API wrapper.
 test_files: