usps-imis-api 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 602e95212148a4087db86d19ff47a8680d8a83a488331129588292150a00b0f2
-  data.tar.gz: 95ef0ede88acad9e0b66b5ac1b1bce88801604229f6a54b848ca4349fca34536
+  metadata.gz: 1febbdb28781a5589ce97b66eb071728aef8b8e81991970854620c9fc128cf54
+  data.tar.gz: cc5aeb7ddab766c885d4bb009b1fa9afcdaa8f71d68b56f2e86861c12f8eda72
 SHA512:
-  metadata.gz: 8be9f80db96ff34ca7a40f459825a0537a4e1007a1ac6939eefae392133cbdca479b0b11099b0daab2c59690f83b9cfd7a0dfbbb9ed6e0b55090466bc3239f30
-  data.tar.gz: 7b502a0e9a7f7ce84ae79b17c1a945e2b01680dd7c4a4ff583d08bb6d08db32f6e6537c4c2d05f2e99ffb342cd1d35079119c38d7e750bd075992b59737d1a4f
+  metadata.gz: '09fdb03097ef67813356bf1a4378f53827bcacc3c8115fb9128ce0f2a8dcdceb26aafc3296b8132468860906ac3884965c53b4e47729aa8dc0a964a13346717e'
+  data.tar.gz: 3703f4325f53afde2c9350c4382d0cbfeb4d53489275c866a1041749ba5324d7833c4a3fe14f11e70bcd3a1729981f2b3b3befcd3a603a5ab5703a03ae6a9cc5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (0.4.5)
+    usps-imis-api (0.5.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/usps/imis/api.rb

@@ -59,7 +59,7 @@ module Usps
         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, 'Member not found'
       end
 
       # Run requests as DSL, with specific iMIS ID only maintained for this scope
@@ -228,7 +228,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

@@ -25,7 +25,7 @@ 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
 

data/lib/usps/imis/error/{api.rb → api_error.rb}

@@ -5,12 +5,12 @@ module Usps
     module Error
       # Base error class for all internal exceptions
       #
-      class Api < StandardError
+      class ApiError < StandardError
         # Additional call-specific metadata to pass through to Bugsnag
         #
         attr_accessor :metadata
 
-        # A new instance of +Error::Api+
+        # A new instance of +ApiError+
         #
         # @param message [String] The base exception message
         # @param metadata [Hash] Additional call-specific metadata to pass through to Bugsnag

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

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

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

@@ -5,7 +5,7 @@ module Usps
     module Error
       # Exception raised due to receiving an error response from the API
       #
-      class Response < Api
+      class ResponseError < ApiError
         # [Net::HTTPResponse] The response received from the API
         #
         attr_reader :response
@@ -14,7 +14,7 @@ module Usps
         #
         attr_accessor :metadata
 
-        # Create a new instance of +Error::Response+ from an API response
+        # Create a new instance of +ResponseError+ from an API response
         #
         # @param response [Net::HTTPResponse] The response received from the API
         #
@@ -22,7 +22,7 @@ module Usps
           new(nil, response)
         end
 
-        # Create a new instance of +Error::Response+
+        # Create a new instance of +ResponseError+
         #
         # @param _message Ignored
         # @param response [Net::HTTPResponse] The response received from the API

data/lib/usps/imis/mapper.rb

@@ -74,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

@@ -51,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/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.4.5'
+    VERSION = '0.5.0'
   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'

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

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: 0.4.5
+  version: 0.5.0
 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