usps-imis-api 1.0.0.pre.rc.1 → 1.0.0.pre.rc.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 591c0f59f5d39e06c011116940615588936cef78dfb8e497670909d5654c61b8
-  data.tar.gz: 2f667e0e06d05a519bff31e6387452dc896aa4204443ceb3ae43d1dab8f2eaf0
+  metadata.gz: 927a6d408196ed631d013daac7854beb5b0c27b7b138a454c0078af710cad204
+  data.tar.gz: 8d747f8023487b5fa1d2e4fc50a3aa5d26676cc99c818849b6fa9af205a8e50b
 SHA512:
-  metadata.gz: 622f9629c46f876901542639099e7544d28d932121e7a9bd09513fcdb0c756e2727f6b69aad8ead5606dd36803a80d9f66f2e2c5e4e6cc08fe7133fc799023de
-  data.tar.gz: 07ffc1e12820b524083e68d054e23eb976fcd7a16cf48fdbf7d64fe25a5d75b4083e2e6aafd7e6a19671ecaa9a7e2b33240a7bd4aa6d487f4f83fb14316c5aae
+  metadata.gz: b87668b7e37cfa951b729ef0c01b580055b0d48076f6ffab10bff81e0d47ad255df3718e3c63daece6c0a2fc256506eb9ceefec0bed564ce09b1c5bc4e8ba116
+  data.tar.gz: e0c08859e7e890887267d13166023ef903355ed70416bd83e856d143de0eab6753d78c0b976acdcc3356144bd3ae92a95ebef43233c6b40a89b17315bb29de0e

data/.gitignore

@@ -2,3 +2,4 @@ coverage/
 tmp/
 .env
 *.gem
+.yardoc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (1.0.0.pre.rc.1)
+    usps-imis-api (1.0.0.pre.rc.3)
 
 GEM
   remote: https://rubygems.org/

data/lib/usps/imis/api.rb

@@ -2,14 +2,44 @@
 
 module Usps
   module Imis
+    # The core API wrapper
+    #
     class Api
+      # Endpoint for (re-)authentication requests
+      #
       AUTHENTICATION_PATH = 'Token'
+
+      # Endpoint for general API requests
+      #
       API_PATH = 'api'
+
+      # Endpoint for IQA query requests
+      #
       QUERY_PATH = 'api/Query'
-      PANELS = Struct.new(:vsc, :education)
 
-      attr_reader :token, :token_expiration, :imis_id
+      # API bearer token
+      #
+      attr_reader :token
 
+      # Expiration time for the API bearer token
+      #
+      # Used to automatically re-authenticate as needed
+      #
+      attr_reader :token_expiration
+
+      # Currently selected iMIS ID for API requests
+      #
+      attr_reader :imis_id
+
+      # Whether to lock changes to the selected iMIS ID
+      #
+      attr_reader :lock_imis_id
+
+      # A new instance of +Api+
+      #
+      # @param skip_authentication [bool] Skip authentication on initialization (used for tests)
+      # @param imis_id [Integer, String] iMIS ID to select immediately on initialization
+      #
       def initialize(skip_authentication: false, imis_id: nil)
         authenticate unless skip_authentication
         self.imis_id = imis_id if imis_id
@@ -17,33 +47,60 @@ module Usps
 
       # Manually set the current ID, if you already have it for a given member
       #
+      # @param id [Integer, String] iMIS ID to select for future requests
+      #
       def imis_id=(id)
+        raise Error::ApiError, 'Cannot change iMIS ID while locked' if lock_imis_id
+
         @imis_id = id.to_i.to_s
       end
 
       # Convert a member's certificate number into an iMIS ID number
       #
+      # @param certificate [String] Certificate number to lookup the corresponding iMIS ID for
+      #
+      # @return [String] Corresponding iMIS ID
+      #
       def imis_id_for(certificate)
-        result = query(Imis.configuration.imis_id_query_name, { certificate: })
-        @imis_id = result['Items']['$values'][0]['ID']
-      rescue StandardError
-        raise Error::Api, 'Member not found'
+        raise Error::ApiError, 'Cannot change iMIS ID while locked' if lock_imis_id
+
+        begin
+          result = query(Imis.configuration.imis_id_query_name, { certificate: })
+          @imis_id = result['Items']['$values'][0]['ID']
+        rescue StandardError
+          raise Error::ApiError, 'Member not found'
+        end
       end
 
       # Run requests as DSL, with specific iMIS ID only maintained for this scope
       #
-      # This should be used with methods that do not change the value of `imis_id`
+      # While in this block, changes to the value of +imis_id+ are not allowed
+      #
+      # @param id [Integer, String] iMIS ID to select for requests within the block
+      #
+      # @example
+      #   with(12345) do
+      #     update(mm: 15)
+      #   end
       #
       def with(id, &)
         old_id = imis_id
         self.imis_id = id
+
+        @lock_imis_id = true
         instance_eval(&)
       ensure
+        @lock_imis_id = false
         self.imis_id = old_id
       end
 
       # Get a business object for the current member
       #
+      # @param business_object_name [String] Name of the business object
+      # @param url_id [String] Override the ID param of the URL (e.g. used for Panels)
+      #
+      # @return [Hash] Response data from the API
+      #
       def get(business_object_name, url_id: nil)
         uri = uri_for(business_object_name, url_id:)
         request = Net::HTTP::Get.new(uri)
@@ -53,7 +110,11 @@ module Usps
 
       # Update only specific fields on a business object for the current member
       #
-      #   fields - hash of shape: { field_name => new_value }
+      # @param business_object_name [String] Name of the business object
+      # @param fields [Hash] Conforms to pattern +{ field_key => value }+
+      # @param url_id [String] Override the ID param of the URL (e.g. used for Panels)
+      #
+      # @return [Hash] Response data from the API
       #
       def put_fields(business_object_name, fields, url_id: nil)
         updated = filter_fields(business_object_name, fields)
@@ -62,6 +123,12 @@ module Usps
 
       # Update a business object for the current member
       #
+      # @param business_object_name [String] Name of the business object
+      # @param body [Hash] Full raw API object data
+      # @param url_id [String] Override the ID param of the URL (e.g. used for Panels)
+      #
+      # @return [Hash] Response data from the API
+      #
       def put(business_object_name, body, url_id: nil)
         uri = uri_for(business_object_name, url_id:)
         request = Net::HTTP::Put.new(uri)
@@ -72,6 +139,12 @@ module Usps
 
       # Create a business object for the current member
       #
+      # @param business_object_name [String] Name of the business object
+      # @param body [Hash] Full raw API object data
+      # @param url_id [String] Override the ID param of the URL (e.g. used for Panels)
+      #
+      # @return [Hash] Response data from the API
+      #
       def post(business_object_name, body, url_id: nil)
         uri = uri_for(business_object_name, url_id:)
         request = Net::HTTP::Post.new(uri)
@@ -82,7 +155,10 @@ module Usps
 
       # Remove a business object for the current member
       #
-      # Returns empty string on success
+      # @param business_object_name [String] Name of the business object
+      # @param url_id [String] Override the ID param of the URL (e.g. used for Panels)
+      #
+      # @return [String] Error response body from the API, or empty string on success
       #
       def delete(business_object_name, url_id: nil)
         uri = uri_for(business_object_name, url_id:)
@@ -93,8 +169,10 @@ module Usps
 
       # Run an IQA Query
       #
-      #   query_name   - the full path of the query in IQA, e.g. `$/_ABC/Fiander/iMIS_ID`
-      #   query_params - hash of shape: { param_name => param_value }
+      # @param query_name [String] Full path of the query in IQA, e.g. +$/_ABC/Fiander/iMIS_ID+
+      # @query_params [Hash] Conforms to pattern +{ param_name => param_value }+
+      #
+      # @return [Hash] Response data from the API
       #
       def query(query_name, query_params = {})
         query_params[:QueryName] = query_name
@@ -105,21 +183,30 @@ module Usps
         JSON.parse(result.body)
       end
 
+      # An instance of Mapper, using this instance as its parent +Api+
+      #
       def mapper
         @mapper ||= Mapper.new(self)
       end
 
+      # Convenience accessor for available Panel objects, each using this instance as its parent
+      # +Api+
+      #
       def panels
-        @panels ||= PANELS.new(
+        @panels ||= Struct.new(:vsc, :education).new(
           Panel::Vsc.new(self),
           Panel::Education.new(self)
         )
       end
 
+      # Convenience alias for updating mapped fields
+      #
       def update(data)
         mapper.update(data)
       end
 
+      # Ruby 3.5 instance variable filter
+      #
       def instance_variables_to_inspect = %i[@token_expiration @imis_id]
 
     private
@@ -154,7 +241,7 @@ module Usps
 
       def submit(uri, request)
         client(uri).request(request).tap do |result|
-          raise Error::Response.from(result) unless result.is_a?(Net::HTTPSuccess)
+          raise Error::ResponseError.from(result) unless result.is_a?(Net::HTTPSuccess)
         end
       end
 

data/lib/usps/imis/config.rb

@@ -2,6 +2,8 @@
 
 module Usps
   module Imis
+    # API Configuration
+    #
     class Config
       IMIS_ROOT_URL_PROD = 'https://portal.americasboatingclub.org'
       IMIS_ROOT_URL_DEV = 'https://abcdev.imiscloud.com'
@@ -12,6 +14,10 @@ module Usps
         yield self if block_given?
       end
 
+      # Environment-specific API endpoint hostname
+      #
+      # @return The API hostname for the current environment
+      #
       def hostname
         case environment.to_sym
         when :production
@@ -19,10 +25,12 @@ module Usps
         when :development
           IMIS_ROOT_URL_DEV
         else
-          raise Error::Api, "Unexpected API environment: #{environment}"
+          raise Error::ApiError, "Unexpected API environment: #{environment}"
         end
       end
 
+      # Ruby 3.5 instance variable filter
+      #
       def instance_variables_to_inspect = %i[@environment @imis_id_query_name @username]
     end
   end

data/lib/usps/imis/error/api_error.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    module Error
+      # Base error class for all internal exceptions
+      #
+      class ApiError < StandardError
+        # Additional call-specific metadata to pass through to Bugsnag
+        #
+        attr_accessor :metadata
+
+        # A new instance of +ApiError+
+        #
+        # @param message [String] The base exception message
+        # @param metadata [Hash] Additional call-specific metadata to pass through to Bugsnag
+        #
+        def initialize(message, metadata = {})
+          super(message)
+          @metadata = metadata
+        end
+
+        # Additional metadata to include in Bugsnag reports
+        #
+        # Can include fields at the top level, which will be shows on the custom tab
+        #
+        # Can include fields nested under a top-level key, which will be shown on a tab with the
+        # top-level key as its name
+        #
+        # @return [Hash]
+        #
+        def bugsnag_meta_data
+          metadata == {} ? {} : base_metadata
+        end
+
+      private
+
+        def base_metadata
+          { api: metadata }
+        end
+      end
+    end
+  end
+end

data/lib/usps/imis/error/{mapper.rb → mapper_error.rb}

@@ -3,7 +3,9 @@
 module Usps
   module Imis
     module Error
-      class Mapper < Api; end
+      # Exception raised by a +Mapper+
+      #
+      class MapperError < ApiError; end
     end
   end
 end

data/lib/usps/imis/error/{response.rb → response_error.rb}

@@ -3,23 +3,53 @@
 module Usps
   module Imis
     module Error
-      class Response < Api
+      # Exception raised due to receiving an error response from the API
+      #
+      class ResponseError < ApiError
+        # [Net::HTTPResponse] The response received from the API
+        #
         attr_reader :response
+
+        # [Hash] Additional call-specific metadata to pass through to Bugsnag
+        #
         attr_accessor :metadata
 
+        # Create a new instance of +ResponseError+ from an API response
+        #
+        # @param response [Net::HTTPResponse] The response received from the API
+        #
         def self.from(response)
           new(nil, response)
         end
 
+        # Create a new instance of +ResponseError+
+        #
+        # @param _message Ignored
+        # @param response [Net::HTTPResponse] The response received from the API
+        # @param metadata [Hash] Additional call-specific metadata to pass through to Bugsnag
+        #
         def initialize(_message, response, metadata = {})
           @response = response
           super(message, metadata)
         end
 
+        # Additional metadata to include in Bugsnag reports
+        #
+        # Can include fields at the top level, which will be shows on the +custom+ tab
+        #
+        # Can include fields nested under a top-level key, which will be shown on a tab with the
+        # top-level key as its name
+        #
+        # @return [Hash]
+        #
         def bugsnag_meta_data
           base_metadata.tap { |m| m[:api].merge!(metadata) }
         end
 
+        # Auto-formatted exception message, based on the provided API response
+        #
+        # @return [String] The exception message
+        #
         def message
           [
             "#{self.class.name}: [#{status.to_s.upcase}] The iMIS API returned an error.",

data/lib/usps/imis/mapper.rb

@@ -2,7 +2,12 @@
 
 module Usps
   module Imis
+    # Specific known fields mapping to facilitate updating across multiple
+    # business objects.
+    #
     class Mapper
+      # List of known mapped fields
+      #
       FIELD_MAPPING = {
         grade: %w[ABC_ASC_Individual_Demog Grade],
         edpro: %w[ABC_ASC_Individual_Demog Educ_Proficiency],
@@ -12,19 +17,26 @@ module Usps
         mm_updated: %w[ABC_ASC_Individual_Demog MMS_Updated]
       }.freeze
 
+      # The parent +Api+ object
+      #
       attr_reader :api
 
+      # A new instance of +Mapper+
+      #
       def initialize(api = nil, imis_id: nil)
         @api = api || Api.new
         @api.imis_id = imis_id if imis_id
       end
 
       # Update a member's data on multiple affected business objects by arbitrary field names
+      #
       # Does not require knowing which business object / iMIS-specific field name to use
       #
-      # Only available for previously-mapped fields
+      # Only available for fields defined in +FIELD_MAPPING+
+      #
+      # @param data [Hash] Conforms to pattern +{ field_key => value }+
       #
-      #  `data` is a hash of shape { field_key => value }
+      # @return [Array<Hash>] Response data from the API for each internal update request
       #
       def update(data)
         updates = data.each_with_object({}) do |(field_key, value), hash|
@@ -62,7 +74,7 @@ module Usps
         end
 
         raise(
-          Error::Mapper,
+          Error::MapperError,
           "Unrecognized field: \"#{field_name}\". " \
           'Please report what data you are attempting to work with to ITCom leadership.'
         )

data/lib/usps/imis/panel/base_panel.rb

@@ -3,7 +3,11 @@
 module Usps
   module Imis
     module Panel
+      # Base class for configuring Panels
+      #
       class BasePanel
+        # The parent +Api+ object
+        #
         attr_reader :api
 
         def initialize(api = nil, imis_id: nil)
@@ -11,18 +15,35 @@ module Usps
           @api.imis_id = imis_id if imis_id
         end
 
+        # Get a specific object from the Panel
+        #
+        # @param ordinal [Integer] The ordinal identifier for the desired object
+        #
         def get(ordinal)
           api.get(business_object, url_id: "~#{api.imis_id}|#{ordinal}")
         end
 
+        # Create a new object in the Panel
+        #
+        # @param data [Hash] The record data for the desired object
+        #
         def create(data)
           api.post(business_object, payload(data), url_id: '')
         end
 
+        # Update an existing object in the Panel
+        #
+        # @param data [Hash] The record data for the desired object -- including the required
+        #                    +ordinal+ identifier
+        #
         def update(data)
           api.put(business_object, payload(data), url_id: "~#{api.imis_id}|#{data[:ordinal]}")
         end
 
+        # Remove a specific object from the Panel
+        #
+        # @param ordinal [Integer] The ordinal identifier for the desired object
+        #
         def destroy(ordinal)
           api.delete(business_object, url_id: "~#{api.imis_id}|#{ordinal}")
         end
@@ -30,11 +51,11 @@ module Usps
       private
 
         def business_object
-          raise Error::Api, "#{self.class.name} must implement #business_object"
+          raise Error::ApiError, "#{self.class.name} must implement #business_object"
         end
 
         def payload(_data)
-          raise Error::Api, "#{self.class.name} must implement #payload(data)"
+          raise Error::ApiError, "#{self.class.name} must implement #payload(data)"
         end
       end
     end

data/lib/usps/imis/panel/education.rb

@@ -3,6 +3,8 @@
 module Usps
   module Imis
     module Panel
+      # Panel for accessing the Educational completions business object
+      #
       class Education < BasePanel
       private
 

data/lib/usps/imis/panel/vsc.rb

@@ -3,6 +3,8 @@
 module Usps
   module Imis
     module Panel
+      # Panel for accessing the annual VSC completed counts business object
+      #
       class Vsc < BasePanel
       private
 

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '1.0.0-rc.1'
+    VERSION = '1.0.0-rc.3'
   end
 end

data/lib/usps/imis.rb

@@ -13,9 +13,9 @@ require 'ext/hash' unless defined?(Rails)
 
 # Internal requires
 require_relative 'imis/config'
-require_relative 'imis/error/api'
-require_relative 'imis/error/mapper'
-require_relative 'imis/error/response'
+require_relative 'imis/error/api_error'
+require_relative 'imis/error/mapper_error'
+require_relative 'imis/error/response_error'
 require_relative 'imis/api'
 require_relative 'imis/mapper'
 require_relative 'imis/panel/base_panel'
@@ -23,24 +23,26 @@ require_relative 'imis/panel/vsc'
 require_relative 'imis/panel/education'
 
 module Usps
+  # API wrapper for interacting with iMIS
+  #
   module Imis
     class << self
+      # Accessor for configuration values
+      #
+      # @return The configuration object
+      #
       def configuration
         @configuration ||= Config.new
       end
 
+      # Used to define a block of configuration settings
+      #
+      # @return The updated configuration object
+      #
       def configure
         yield(configuration) if block_given?
         configuration
       end
-
-      # def mock!(value = true)
-      #   @mock = value
-      # end
-
-      # def mock
-      #   @mock || false
-      # end
     end
   end
 end

data/spec/lib/usps/imis/api_spec.rb

@@ -31,7 +31,7 @@ describe Usps::Imis::Api do
 
       it 'wraps errors' do
         expect { api.imis_id_for('E231625') }.to raise_error(
-          Usps::Imis::Error::Api, 'Member not found'
+          Usps::Imis::Error::ApiError, 'Member not found'
         )
       end
     end
@@ -47,7 +47,7 @@ describe Usps::Imis::Api do
     context 'when receiving a response error' do
       let(:warning_text) do
         <<~WARNING.chomp
-          Usps::Imis::Error::Response: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
+          Usps::Imis::Error::ResponseError: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
           Something went wrong
         WARNING
       end
@@ -62,7 +62,7 @@ describe Usps::Imis::Api do
 
       it 'wraps the error' do
         expect { api.put_fields('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 }) }.to raise_error(
-          Usps::Imis::Error::Api, warning_text
+          Usps::Imis::Error::ApiError, warning_text
         )
       end
     end
@@ -82,6 +82,18 @@ describe Usps::Imis::Api do
     it 'uses a panel correctly' do
       expect(api.with(6374) { panels.vsc.get(1433) }).to be_a(Hash)
     end
+
+    it 'blocks calling imis_id=' do
+      expect do
+        api.with(31092) { self.imis_id = 31092 }
+      end.to raise_error(Usps::Imis::Error::ApiError, 'Cannot change iMIS ID while locked')
+    end
+
+    it 'blocks calling imis_id_for' do
+      expect do
+        api.with(31092) { imis_id_for('E231625') }
+      end.to raise_error(Usps::Imis::Error::ApiError, 'Cannot change iMIS ID while locked')
+    end
   end
 
   describe '#inspect' do

data/spec/lib/usps/imis/config_spec.rb

@@ -25,7 +25,7 @@ describe Usps::Imis::Config do
 
       it 'raises an error' do
         expect { config.hostname }.to raise_error(
-          Usps::Imis::Error::Api, 'Unexpected API environment: nothing'
+          Usps::Imis::Error::ApiError, 'Unexpected API environment: nothing'
         )
       end
     end

data/spec/lib/usps/imis/error/{api_spec.rb → api_error_spec.rb}

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe Usps::Imis::Error::Api do
+describe Usps::Imis::Error::ApiError do
   it 'builds Bugsnag metadata' do
     error = described_class.new('Example', something: :else)
 

data/spec/lib/usps/imis/error/{response_spec.rb → response_error_spec.rb}

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 ApiResponseStub = Struct.new(:code, :body)
 
-describe Usps::Imis::Error::Response do
+describe Usps::Imis::Error::ResponseError do
   let(:error) { described_class.from(response) }
 
   describe 'error codes' do
@@ -61,7 +61,7 @@ describe Usps::Imis::Error::Response do
     let(:response) { ApiResponseStub.new('500', 'Body of the API response error') }
     let(:warning_text) do
       <<~WARNING.chomp
-        Usps::Imis::Error::Response: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
+        Usps::Imis::Error::ResponseError: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
         Body of the API response error
       WARNING
     end
@@ -78,7 +78,7 @@ describe Usps::Imis::Error::Response do
     let(:response) { ApiResponseStub.new('500', response_body) }
     let(:warning_text) do
       <<~WARNING.chomp
-        Usps::Imis::Error::Response: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
+        Usps::Imis::Error::ResponseError: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
         description
       WARNING
     end
@@ -95,7 +95,7 @@ describe Usps::Imis::Error::Response do
     let(:response) { ApiResponseStub.new('500', response_body) }
     let(:warning_text) do
       <<~WARNING.chomp
-        Usps::Imis::Error::Response: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
+        Usps::Imis::Error::ResponseError: [INTERNAL_SERVER_ERROR] The iMIS API returned an error.
         #{response_body}
       WARNING
     end

data/spec/lib/usps/imis/mapper_spec.rb

@@ -22,7 +22,7 @@ describe Usps::Imis::Mapper do
 
     it 'raises for unmapped updates' do
       expect { api.mapper.update(something: 'anything') }.to raise_error(
-        Usps::Imis::Error::Mapper,
+        Usps::Imis::Error::MapperError,
         'Unrecognized field: "something". ' \
         'Please report what data you are attempting to work with to ITCom leadership.'
       )

data/spec/lib/usps/imis/panel/base_panel_spec.rb

@@ -19,13 +19,13 @@ end
 describe Usps::Imis::Panel::BasePanel do
   it 'requires #business_object to be defined' do
     expect { Usps::Imis::Panel::InvalidPanel.new.get(1) }.to raise_error(
-      Usps::Imis::Error::Api, 'Usps::Imis::Panel::InvalidPanel must implement #business_object'
+      Usps::Imis::Error::ApiError, 'Usps::Imis::Panel::InvalidPanel must implement #business_object'
     )
   end
 
   it 'requires #payload(data) to be defined' do
     expect { Usps::Imis::Panel::InvalidPanelWithBusinessObject.new.create({}) }.to raise_error(
-      Usps::Imis::Error::Api,
+      Usps::Imis::Error::ApiError,
       'Usps::Imis::Panel::InvalidPanelWithBusinessObject must implement #payload(data)'
     )
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc.1
+  version: 1.0.0.pre.rc.3
 platform: ruby
 authors:
 - Julian Fiander
@@ -31,9 +31,9 @@ files:
 - lib/usps/imis.rb
 - lib/usps/imis/api.rb
 - lib/usps/imis/config.rb
-- lib/usps/imis/error/api.rb
-- lib/usps/imis/error/mapper.rb
-- lib/usps/imis/error/response.rb
+- lib/usps/imis/error/api_error.rb
+- lib/usps/imis/error/mapper_error.rb
+- lib/usps/imis/error/response_error.rb
 - lib/usps/imis/mapper.rb
 - lib/usps/imis/panel/base_panel.rb
 - lib/usps/imis/panel/education.rb
@@ -41,8 +41,8 @@ files:
 - lib/usps/imis/version.rb
 - spec/lib/usps/imis/api_spec.rb
 - spec/lib/usps/imis/config_spec.rb
-- spec/lib/usps/imis/error/api_spec.rb
-- spec/lib/usps/imis/error/response_spec.rb
+- spec/lib/usps/imis/error/api_error_spec.rb
+- spec/lib/usps/imis/error/response_error_spec.rb
 - spec/lib/usps/imis/mapper_spec.rb
 - spec/lib/usps/imis/panel/base_panel_spec.rb
 - spec/lib/usps/imis/panel/education_spec.rb

data/lib/usps/imis/error/api.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Error
-      class Api < StandardError
-        attr_accessor :metadata
-
-        def initialize(message, metadata = {})
-          super(message)
-          @metadata = metadata
-        end
-
-        def bugsnag_meta_data
-          metadata == {} ? {} : base_metadata
-        end
-
-      private
-
-        def base_metadata
-          { api: metadata }
-        end
-      end
-    end
-  end
-end