postmark 1.23.0 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfce0fc58365a91800f896d2d16c8d62d1a601f7a1a8d5350c6270cae3f12be3
-  data.tar.gz: 3d8b2761c884f6ca1f3c81efe7c30dda1432b6d7da740d18d6cc55f5cc062d23
+  metadata.gz: 36d183adb014f24f30c12f04f65d01d9a4565e46bac544fcf499f1834d98b15f
+  data.tar.gz: 23d80a64a061b7bce98a7040a0b64b7e56611aea995894764d201e5ee71fdf69
 SHA512:
-  metadata.gz: 4082d74e41c4d74378f4e46bb43d0b8dd967489125865cd9379fbc3928dfd0be7369408cfcdcc6a979822739b8734045fba8a66021591848dff801286ef183d9
-  data.tar.gz: 5c93b937e1749584f52c1a1f5e0a4a9eabc6ea579e02c26f20d709ea5b89873d666acd6b8c2e7733a5e18885df370c1f2ca26e9c96c23cc44448d95c4f0da309
+  metadata.gz: a132d891995e587fc6324cbed9626799a7919f0314b4402910593e47afb02281b25fd6b8971a20197774dd37d48c7221389047699b9cbf98a2cdfecce3e247b6
+  data.tar.gz: 26b78de0eefb4c6055e2edee3f787ddab17c49f49fbbd4e8bf02100f85202cc46d57ff4c140617f0c1cd7c325875e602fc952c8b9a528a9ad9feed25ee9d76b1

data/CHANGELOG.rdoc

@@ -1,5 +1,8 @@
 = Changelog
 
+== 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.

data/VERSION

@@ -1 +1 @@
-1.23.0
+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
 
@@ -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/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = '1.23.0'
+  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.24.0
 platform: ruby
 authors:
 - Tomek Maszkowski
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-23 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