usps-imis-api 0.4.3 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e49829b6dee8973f1de4b275516060ced7b426cedd00fe7e4ccaba5e29efc52
-  data.tar.gz: 8558346d33b416f3d58f9fa5047b925f580c8d8d5123463c6fe137335ddd93d7
+  metadata.gz: 602e95212148a4087db86d19ff47a8680d8a83a488331129588292150a00b0f2
+  data.tar.gz: 95ef0ede88acad9e0b66b5ac1b1bce88801604229f6a54b848ca4349fca34536
 SHA512:
-  metadata.gz: 89f31684df0cb6001fa31966eec99bf8ec9e9dbdab86ae8213a43200f23bf306b204bc9ecb61d9f6ac066869387e4ba048923af1a77b4c7dd1dec59a9cb9b215
-  data.tar.gz: 376cc34e675f9caadd5c985733b28ea2e93d4ba3752de8d9fd843d3a15866280f3075138a275be47dfd77d06bb24f2ba81cad8527308060a1e8893befbe5381e
+  metadata.gz: 8be9f80db96ff34ca7a40f459825a0537a4e1007a1ac6939eefae392133cbdca479b0b11099b0daab2c59690f83b9cfd7a0dfbbb9ed6e0b55090466bc3239f30
+  data.tar.gz: 7b502a0e9a7f7ce84ae79b17c1a945e2b01680dd7c4a4ff583d08bb6d08db32f6e6537c4c2d05f2e99ffb342cd1d35079119c38d7e750bd075992b59737d1a4f

data/.gitignore

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

data/.simplecov

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+SimpleCov.start do
+  enable_coverage :branch
+  primary_coverage :branch
+
+  add_filter '/spec'
+end

data/Gemfile.lock

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

data/lib/usps/imis/api.rb

@@ -2,14 +2,40 @@
 
 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
 
+      # 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,12 +43,18 @@ 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)
         @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']
@@ -34,6 +66,13 @@ module Usps
       #
       # This should be used with methods that do not change the value of `imis_id`
       #
+      # @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
@@ -44,6 +83,11 @@ module Usps
 
       # 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 +97,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 +110,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 +126,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 +142,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 +156,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 +170,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

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
@@ -23,6 +29,8 @@ module Usps
         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.rb

@@ -3,24 +3,40 @@
 module Usps
   module Imis
     module Error
+      # Base error class for all internal exceptions
+      #
       class Api < StandardError
+        # Additional call-specific metadata to pass through to Bugsnag
+        #
         attr_accessor :metadata
 
+        # A new instance of +Error::Api+
+        #
+        # @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
-
-          warn inspect if ENV.fetch('IMIS_ERROR_LOG_TO_STDERR', 'false') == 'true'
         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 == {} ? {} : { api: metadata }
+          metadata == {} ? {} : base_metadata
         end
 
       private
 
         def base_metadata
-          { api: {} }
+          { api: metadata }
         end
       end
     end

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

@@ -3,6 +3,8 @@
 module Usps
   module Imis
     module Error
+      # Exception raised by a +Mapper+
+      #
       class Mapper < Api; end
     end
   end

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

@@ -3,23 +3,53 @@
 module Usps
   module Imis
     module Error
+      # Exception raised due to receiving an error response from the API
+      #
       class Response < Api
+        # [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 +Error::Response+ 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 +Error::Response+
+        #
+        # @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.",
@@ -47,6 +77,8 @@ module Usps
               :unprocessable_entity # validation error
             when /^50\d$/
               :internal_server_error # error within iMIS
+            else
+              response.code
             end
         end
 

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|
@@ -52,11 +64,13 @@ module Usps
 
       def missing_mapping(field_name)
         unless ENV['TESTING']
+          # :nocov:
           warn(
             "Mapper does not know how to handle field \"#{field_name}\".\n\n" \
             'You can use api.put_fields(business_object_name, { field_name => value })  ' \
             "if you know the business object and iMIS-specific field name.\n\n"
           )
+          # :nocov:
         end
 
         raise(

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

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 = '0.4.3'
+    VERSION = '0.4.5'
   end
 end

data/lib/usps/imis.rb

@@ -7,7 +7,9 @@ require 'time'
 require 'cgi'
 
 # Extensions
+# :nocov:
 require 'ext/hash' unless defined?(Rails)
+# :nocov:
 
 # Internal requires
 require_relative 'imis/config'
@@ -21,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

@@ -5,10 +5,36 @@ require 'spec_helper'
 describe Usps::Imis::Api do
   let(:api) { described_class.new }
 
+  describe '#initialize' do
+    it 'skips authentication' do
+      # rubocop:disable RSpec/AnyInstance
+      expect_any_instance_of(described_class).not_to receive(:authenticate)
+      # rubocop:enable RSpec/AnyInstance
+
+      described_class.new(skip_authentication: true)
+    end
+
+    it 'stores the initial imis_id' do
+      api = described_class.new(imis_id: 42)
+
+      expect(api.imis_id).to eq('42')
+    end
+  end
+
   describe '#imis_id_for' do
     it 'gets the iMIS ID' do
       expect(api.imis_id_for('E231625')).to eq('31092')
     end
+
+    context 'with a query error' do
+      before { allow(api).to receive(:query).and_raise('Stub') }
+
+      it 'wraps errors' do
+        expect { api.imis_id_for('E231625') }.to raise_error(
+          Usps::Imis::Error::Api, 'Member not found'
+        )
+      end
+    end
   end
 
   describe '#put' do
@@ -17,6 +43,29 @@ describe Usps::Imis::Api do
     it 'sends an update' do
       expect(api.put_fields('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 })).to be_a(Hash)
     end
+
+    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.
+          Something went wrong
+        WARNING
+      end
+
+      before do
+        error = Struct.new(:code, :body).new('500', 'Something went wrong')
+
+        # rubocop:disable RSpec/AnyInstance
+        allow_any_instance_of(Net::HTTP).to receive(:request).and_return(error)
+        # rubocop:enable RSpec/AnyInstance
+      end
+
+      it 'wraps the error' do
+        expect { api.put_fields('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 }) }.to raise_error(
+          Usps::Imis::Error::Api, warning_text
+        )
+      end
+    end
   end
 
   describe '#with' do
@@ -46,4 +95,49 @@ describe Usps::Imis::Api do
       expect(api.inspect).not_to match(/ @token="/)
     end
   end
+
+  describe '#authorize' do
+    before { allow(api).to receive(:authenticate) }
+
+    it 'automatically refreshes an expired token' do
+      api.instance_variable_set(:@token_expiration, Time.now - 60)
+
+      request = Net::HTTP::Put.new('/')
+      api.send(:authorize, request)
+
+      expect(api).to have_received(:authenticate)
+    end
+  end
+
+  describe '#filter_fields' do
+    let(:expected) do
+      {
+        'Properties' => {
+          '$values' => [
+            { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
+            { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
+            { 'Name' => 'Stub String', 'Value' => 'other' }
+          ]
+        }
+      }
+    end
+
+    before do
+      allow(api).to receive(:get).and_return({
+        'Properties' => {
+          '$values' => [
+            { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
+            { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
+            { 'Name' => 'Stub String', 'Value' => 'something' }
+          ]
+        }
+      })
+    end
+
+    it 'formats fields correctly' do
+      updated = api.send(:filter_fields, 'Stub', { 'Stub Integer' => 43, 'Stub String' => 'other' })
+
+      expect(updated).to eq(expected)
+    end
+  end
 end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis::Config do
+  let(:config) { described_class.new }
+
+  it 'sets values on initialize' do
+    config = described_class.new { |c| c.environment = 'test' }
+
+    expect(config.environment).to eq('test')
+  end
+
+  describe '#hostname' do
+    context 'with production environment' do
+      before { config.environment = 'production' }
+
+      it 'returns the production hostname' do
+        expect(config.hostname).to eq(described_class::IMIS_ROOT_URL_PROD)
+      end
+    end
+
+    context 'with unrecognized environment' do
+      before { config.environment = 'nothing' }
+
+      it 'raises an error' do
+        expect { config.hostname }.to raise_error(
+          Usps::Imis::Error::Api, 'Unexpected API environment: nothing'
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis::Error::Api do
+  it 'builds Bugsnag metadata' do
+    error = described_class.new('Example', something: :else)
+
+    expect(error.bugsnag_meta_data).to eq(api: { something: :else })
+  end
+
+  it 'ignores Bugsnag metadata with none provided' do
+    error = described_class.new('Example')
+
+    expect(error.bugsnag_meta_data).to eq({})
+  end
+end

data/spec/lib/usps/imis/error/response_spec.rb

@@ -5,15 +5,103 @@ require 'spec_helper'
 ApiResponseStub = Struct.new(:code, :body)
 
 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.
-      Body of the API response error
-    WARNING
+  let(:error) { described_class.from(response) }
+
+  describe 'error codes' do
+    context 'with a 400' do
+      let(:response) { ApiResponseStub.new('400', 'body') }
+
+      it 'builds the Bugsnag metadata correctly' do
+        expect(error.bugsnag_meta_data).to eq(api: { status: :bad_request, body: 'body' })
+      end
+    end
+
+    context 'with a 401' do
+      let(:response) { ApiResponseStub.new('401', 'body') }
+
+      it 'builds the Bugsnag metadata correctly' do
+        expect(error.bugsnag_meta_data).to eq(api: { status: :unauthorized, body: 'body' })
+      end
+    end
+
+    context 'with a 404' do
+      let(:response) { ApiResponseStub.new('404', 'body') }
+
+      it 'builds the Bugsnag metadata correctly' do
+        expect(error.bugsnag_meta_data).to eq(api: { status: :not_found, body: 'body' })
+      end
+    end
+
+    context 'with a 422' do
+      let(:response) { ApiResponseStub.new('422', 'body') }
+
+      it 'builds the Bugsnag metadata correctly' do
+        expect(error.bugsnag_meta_data).to eq(api: { status: :unprocessable_entity, body: 'body' })
+      end
+    end
+
+    context 'with a 500' do
+      let(:response) { ApiResponseStub.new('500', 'body') }
+
+      it 'builds the Bugsnag metadata correctly' do
+        expect(error.bugsnag_meta_data).to eq(api: { status: :internal_server_error, body: 'body' })
+      end
+    end
+
+    context 'with a 429' do
+      let(:response) { ApiResponseStub.new('429', 'body') }
+
+      it 'builds the Bugsnag metadata correctly' do
+        expect(error.bugsnag_meta_data).to eq(api: { status: '429', body: 'body' })
+      end
+    end
+  end
+
+  context 'with a string response body' 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.
+        Body of the API response error
+      WARNING
+    end
+
+    it 'builds the correct message' do
+      expect(error.message).to eq(warning_text)
+    end
   end
 
-  it 'handles an API response correctly' do
-    expect(described_class.from(response).message).to eq(warning_text)
+  context 'with an invalid_grant hash response body' do
+    let(:response_body) do
+      { 'error' => 'invalid_grant', 'error_description' => 'description' }
+    end
+    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.
+        description
+      WARNING
+    end
+
+    it 'builds the correct message' do
+      expect(error.message).to eq(warning_text)
+    end
+  end
+
+  context 'with a generic hash response body' do
+    let(:response_body) do
+      { 'error' => 'summary', 'error_description' => 'description' }
+    end
+    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.
+        #{response_body}
+      WARNING
+    end
+
+    it 'builds the correct message' do
+      expect(error.message).to eq(warning_text)
+    end
   end
 end

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

@@ -5,6 +5,14 @@ require 'spec_helper'
 describe Usps::Imis::Mapper do
   let(:api) { described_class.new.api }
 
+  describe 'initialize with imis_id' do
+    it 'stores the initial imis_id' do
+      mapper = described_class.new(imis_id: 42)
+
+      expect(mapper.api.imis_id).to eq('42')
+    end
+  end
+
   describe '#update' do
     before { api.imis_id = 31092 }
 

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Usps
+  module Imis
+    module Panel
+      class InvalidPanel < BasePanel; end
+
+      class InvalidPanelWithBusinessObject < BasePanel
+      private
+
+        def business_object = 'Something'
+      end
+    end
+  end
+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'
+    )
+  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::Panel::InvalidPanelWithBusinessObject must implement #payload(data)'
+    )
+  end
+end

data/spec/lib/usps/imis_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis do
+  it 'returns configuration from configure without a block' do
+    described_class.configuration.environment = 'development'
+
+    expect(described_class.configure.environment).to eq('development')
+  end
+end

data/spec/spec_helper.rb

@@ -3,10 +3,7 @@
 require 'bundler/setup'
 Bundler.setup
 require 'simplecov'
-SimpleCov.start do
-  add_filter '/spec'
-end
-# SimpleCov.minimum_coverage(100)
+SimpleCov.minimum_coverage(line: 100, branch: 100)
 
 require 'dotenv/load'
 require 'usps/imis'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.5
 platform: ruby
 authors:
 - Julian Fiander
@@ -20,6 +20,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".simplecov"
 - Gemfile
 - Gemfile.lock
 - Rakefile
@@ -39,10 +40,14 @@ files:
 - lib/usps/imis/panel/vsc.rb
 - 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/mapper_spec.rb
+- spec/lib/usps/imis/panel/base_panel_spec.rb
 - spec/lib/usps/imis/panel/education_spec.rb
 - spec/lib/usps/imis/panel/vsc_spec.rb
+- spec/lib/usps/imis_spec.rb
 - spec/spec_helper.rb
 - usps-imis-api.gemspec
 homepage: http://rubygems.org/gems/usps-imis-api