Deprecate InvalidEmailAddressError (#134)

## What

- Renames `InvalidEmailAddressError` to `InvalidEmailRequestError`
- Closes #120
- Related to #119

## Why

This addresses some confusion around this error that can occur for a
number of reasons, and not just invalid email addresses, bringing it
more in sync with the [API
definition](https://postmarkapp.com/developer/api/overview#error-codes)

## How

For now this is just a straight rename with an alias provided for
backwards compatibility.
@tomazy let me know if there's anything you had in mind for this! 🙏

Author: balvig

CHANGELOG.rdoc

@@ -1,5 +1,8 @@
 = Changelog
 
+== 1.23.0
+* Deprecated `InvalidEmailAddressError`. New name is `InvalidEmailRequestError`.
+
 == 1.22.3
 * Increased default timeout values
 

VERSION

@@ -1 +1 @@
-1.22.3
+1.23.0

lib/postmark/error.rb

@@ -43,7 +43,7 @@ def retry?
 
   class ApiInputError < HttpServerError
     INACTIVE_RECIPIENT = 406
-    INVALID_EMAIL_ADDRESS = 300
+    INVALID_EMAIL_REQUEST = 300
 
     attr_accessor :error_code
 
@@ -53,8 +53,8 @@ def self.build(body, parsed_body)
       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 +70,7 @@ def retry?
     end
   end
 
-  class InvalidEmailAddressError < ApiInputError; end
+  class InvalidEmailRequestError < ApiInputError; end
 
   class InactiveRecipientError < ApiInputError
     attr_reader :recipients
@@ -129,4 +129,5 @@ class UnexpectedHttpResponseError < HttpServerError; end
   DeliveryError = Error
   InvalidMessageError = ApiInputError
   UnknownError = UnexpectedHttpResponseError
+  InvalidEmailAddressError = InvalidEmailRequestError
 end

lib/postmark/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = '1.22.3'
+  VERSION = '1.23.0'
 end

spec/unit/postmark/error_spec.rb

@@ -98,9 +98,9 @@
       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 @@
   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 @@
     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 @@ def all_recipients_inactive_message(addresses)
     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