postmark 1.22.3 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef3cc236986909ab3ad5351bb3642a525f5d0a7826a270d35e9eadde0f37021b
-  data.tar.gz: 824731c2567364402cc9866c0f0da8abcbd974809fb9e237238c8581da72f8f8
+  metadata.gz: 36d183adb014f24f30c12f04f65d01d9a4565e46bac544fcf499f1834d98b15f
+  data.tar.gz: 23d80a64a061b7bce98a7040a0b64b7e56611aea995894764d201e5ee71fdf69
 SHA512:
-  metadata.gz: 9ef7a11422e2415ec69c1614d77a12d89b3b2fd94f7ba5d9ddb56c6e7671b4213de9b1480c8840125f65ef00eadbca6f56e265fcf9dd5ae82d17f224f56f1a98
-  data.tar.gz: c3d90f8162206e6174bc9edd141164a8349288f36504e019d69a34a7eb8d1aa822d71e80319bfdef22cf028fde5b9f6d0ae5b4d9b866f054a55a481164c1c4ff
+  metadata.gz: a132d891995e587fc6324cbed9626799a7919f0314b4402910593e47afb02281b25fd6b8971a20197774dd37d48c7221389047699b9cbf98a2cdfecce3e247b6
+  data.tar.gz: 26b78de0eefb4c6055e2edee3f787ddab17c49f49fbbd4e8bf02100f85202cc46d57ff4c140617f0c1cd7c325875e602fc952c8b9a528a9ad9feed25ee9d76b1

data/CHANGELOG.rdoc

@@ -1,5 +1,11 @@
 = Changelog
 
+== 1.24.0
+* Added configurable warnings when referencing deprecated classes.
+
+== 1.23.0
+* Deprecated `InvalidEmailAddressError`. New name is `InvalidEmailRequestError`.
+
 == 1.22.3
 * Increased default timeout values
 

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.

data/VERSION

@@ -1 +1 @@
-1.22.3
+1.24.0

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
 
@@ -43,7 +45,7 @@ module Postmark
 
   class ApiInputError < HttpServerError
     INACTIVE_RECIPIENT = 406
-    INVALID_EMAIL_ADDRESS = 300
+    INVALID_EMAIL_REQUEST = 300
 
     attr_accessor :error_code
 
@@ -53,8 +55,8 @@ module Postmark
       case error_code
       when INACTIVE_RECIPIENT
         InactiveRecipientError.new(error_code, body, parsed_body)
-      when INVALID_EMAIL_ADDRESS
-        InvalidEmailAddressError.new(error_code, body, parsed_body)
+      when INVALID_EMAIL_REQUEST
+        InvalidEmailRequestError.new(error_code, body, parsed_body)
       else
         new(error_code, body, parsed_body)
       end
@@ -70,7 +72,7 @@ module Postmark
     end
   end
 
-  class InvalidEmailAddressError < ApiInputError; end
+  class InvalidEmailRequestError < ApiInputError; end
 
   class InactiveRecipientError < ApiInputError
     attr_reader :recipients
@@ -126,7 +128,10 @@ module Postmark
   class UnexpectedHttpResponseError < HttpServerError; end
 
   # Backwards compatible aliases
-  DeliveryError = Error
-  InvalidMessageError = ApiInputError
-  UnknownError = UnexpectedHttpResponseError
+  Deprecations.add_constants(
+    :DeliveryError => Error,
+    :InvalidMessageError => ApiInputError,
+    :UnknownError => UnexpectedHttpResponseError,
+    :InvalidEmailAddressError => InvalidEmailRequestError
+  )
 end

data/lib/postmark/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = '1.22.3'
+  VERSION = '1.24.0'
 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/error_spec.rb

@@ -98,9 +98,9 @@ describe(Postmark::ApiInputError) do
       end
 
       context '300' do
-        let(:code) {Postmark::ApiInputError::INVALID_EMAIL_ADDRESS}
+        let(:code) {Postmark::ApiInputError::INVALID_EMAIL_REQUEST}
 
-        it {is_expected.to be_a(Postmark::InvalidEmailAddressError)}
+        it {is_expected.to be_a(Postmark::InvalidEmailRequestError)}
         it_behaves_like 'api input error'
       end
 
@@ -149,13 +149,13 @@ describe(Postmark::MailAdapterError) do
   it {is_expected.to be_a(Postmark::Error)}
 end
 
-describe(Postmark::InvalidEmailAddressError) do
+describe(Postmark::InvalidEmailRequestError) do
   describe '.new' do
     let(:response) {{'Message' => message}}
 
     subject do
-      Postmark::InvalidEmailAddressError.new(
-        Postmark::ApiInputError::INVALID_EMAIL_ADDRESS, Postmark::Json.encode(response), response)
+      Postmark::InvalidEmailRequestError.new(
+        Postmark::ApiInputError::INVALID_EMAIL_REQUEST, Postmark::Json.encode(response), response)
     end
 
     let(:message) do
@@ -171,7 +171,7 @@ describe(Postmark::InvalidEmailAddressError) do
     end
 
     it 'error code is set' do
-      expect(subject.error_code).to eq(Postmark::ApiInputError::INVALID_EMAIL_ADDRESS)
+      expect(subject.error_code).to eq(Postmark::ApiInputError::INVALID_EMAIL_REQUEST)
     end
   end
 end
@@ -274,3 +274,9 @@ describe(Postmark::UnknownError) do
     expect(subject.class).to eq(Postmark::UnexpectedHttpResponseError)
   end
 end
+
+describe(Postmark::InvalidEmailAddressError) do
+  it 'is an alias for backwards compatibility' do
+    expect(subject.class).to eq(Postmark::InvalidEmailRequestError)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.22.3
+  version: 1.24.0
 platform: ruby
 authors:
 - Tomek Maszkowski
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2023-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -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