Merge pull request #320 from EasyPost/fix_error_handling

fix: error parsing

Author: Justintime50

CHANGELOG.md

@@ -3,6 +3,10 @@
 ## Next Release (minor)
 
 - Adds Ruby 3.4 support
+- Fixes error parsing
+  - Allows for alternative format of `errors` field
+  - Corrects available properties of an `EasyPostError` and `ApiError` (`code` and `field` removed from `EasyPostError`, `message` unfurled and explicitly added to `ApiError`)
+  - Removes unused `Error` model
 - Corrects the HTTP verb for updating a brand from `GET` to `PATCH`
 - Removes the deprecated `create_list` tracker endpoint function as it is no longer available via API
 

Makefile

@@ -21,7 +21,7 @@ docs:
 	bundle exec rdoc lib -o docs --title "EasyPost Ruby Docs"
 
 ## install-styleguide - Import the style guides (Unix only)
-install-styleguide: | update-examples-submodule
+install-styleguide: | init-examples-submodule
 	sh examples/symlink_directory_files.sh examples/style_guides/ruby .
 
 ## init-examples-submodule - Initialize the examples submodule

lib/easypost/client.rb

@@ -76,7 +76,7 @@ def initialize(api_key:, read_timeout: 60, open_timeout: 30, api_base: 'https://
   # @param endpoint [String] URI path of the resource
   # @param params [Object] (nil) object to be used as the request parameters
   # @param api_version [String] the version of API to hit
-  # @raise [EasyPost::Error] if the response has a non-2xx status code
+  # @raise [EasyPost::Errors::EasyPostError] if the response has a non-2xx status code
   # @return [Hash] JSON object parsed from the response body
   def make_request(
     method,

lib/easypost/connection.rb

@@ -7,7 +7,7 @@
   # @param path [String] URI path of the resource
   # @param requested_api_key [String] ({EasyPost.api_key}) key set Authorization header.
   # @param body [String] (nil) body of the request
-  # @raise [EasyPost::Error] if the response has a non-2xx status code
+  # @raise [EasyPost::Errors::EasyPostError] if the response has a non-2xx status code
   # @return [Hash] JSON object parsed from the response body
   def call(method, path, api_key = nil, body = nil)
     raise EasyPost::Errors::MissingParameterError.new('api_key') if api_key.nil?

lib/easypost/errors/api/api_error.rb

@@ -4,10 +4,13 @@
 require 'easypost/constants'
 
 class EasyPost::Errors::ApiError < EasyPost::Errors::EasyPostError
-  attr_reader :status_code, :code, :errors
+  attr_reader :message, :status_code, :code, :errors
 
   def initialize(message, status_code = nil, error_code = nil, sub_errors = nil)
     super message
+    message_list = []
+    EasyPost::Errors::ApiError.collect_error_messages(message, message_list)
+    @message = message_list.join(', ')
     @status_code = status_code
     @code = error_code
     @errors = sub_errors
@@ -46,12 +49,9 @@ def self.handle_api_error(response)
     # Try to parse the response body as JSON
     begin
       error_data = JSON.parse(response.body)['error']
-
       error_message = error_data['message']
       error_type = error_data['code']
-      errors = error_data['errors']&.map do |error|
-        EasyPost::Models::Error.from_api_error_response(error)
-      end
+      errors = error_data['errors']
     rescue StandardError
       error_message = response.code.to_s
       error_type = EasyPost::Constants::API_ERROR_DETAILS_PARSING_ERROR

lib/easypost/models.rb

@@ -14,7 +14,6 @@ module EasyPost::Models
 require_relative 'models/customs_info'
 require_relative 'models/customs_item'
 require_relative 'models/end_shipper'
-require_relative 'models/error'
 require_relative 'models/event'
 require_relative 'models/insurance'
 require_relative 'models/order'

lib/easypost/models/error.rb

@@ -28,7 +28,23 @@
       address = client.address.create(address_data)
 
       expect(address).to be_an_instance_of(EasyPost::Models::Address)
+
+      # Delivery verification assertions
       expect(address.verifications.delivery.success).to be false
+      # TODO: details is not deserializing correctly, related to the larger "double EasyPostObject" wrapping issue
+      # expect(address.verifications.delivery.details).to be_empty
+      expect(address.verifications.delivery.errors[0].code).to eq('E.ADDRESS.NOT_FOUND')
+      expect(address.verifications.delivery.errors[0].field).to eq('address')
+      expect(address.verifications.delivery.errors[0].suggestion).to be nil
+      expect(address.verifications.delivery.errors[0].message).to eq('Address not found')
+
+      # Zip4 verification assertions
+      expect(address.verifications.zip4.success).to be false
+      expect(address.verifications.zip4.details).to be nil
+      expect(address.verifications.zip4.errors[0].code).to eq('E.ADDRESS.NOT_FOUND')
+      expect(address.verifications.zip4.errors[0].field).to eq('address')
+      expect(address.verifications.zip4.errors[0].suggestion).to be nil
+      expect(address.verifications.zip4.errors[0].message).to eq('Address not found')
     end
 
     it 'creates an address with verify_strict param' do