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

data/lib/usps/imis/mapper.rb

@@ -2,12 +2,7 @@
 
 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],
@@ -17,85 +12,19 @@ module Usps
         mm_updated: %w[ABC_ASC_Individual_Demog MMS_Updated]
       }.freeze
 
-      # The parent +Api+ object
-      #
       attr_reader :api
 
-      # Tagged logger
-      #
-      attr_reader :logger
-
-      # A new instance of +Mapper+
-      #
       def initialize(api = nil, imis_id: nil)
         @api = api || Api.new
         @api.imis_id = imis_id if imis_id
-        @logger ||= Imis.logger('Mapper')
       end
 
-      # Get a member's data for a specific field by arbitrary field name
-      #
-      # Does not require knowing which business object / iMIS-specific field name to use
-      #
-      # Only available for fields defined in +FIELD_MAPPING+
-      #
-      # @param field_key [Symbol] Internal name of the field
-      #
-      # @return Value of the field
-      #
-      def get_field(field_key)
-        missing_mapping!(field_key) unless FIELD_MAPPING.key?(field_key.to_sym)
-
-        business_object_name, field = FIELD_MAPPING[field_key]
-        api.on(business_object_name)[field]
-      end
-      alias fetch get_field
-      alias [] get_field
-
-      # Get specific fields by arbitrary field names
-      #
-      # @param names [Array<String>] Internal name of the fields
-      #
-      # @return [Array] Values of the field
-      #
-      def get_fields(*fields)
-        business_objects = {}
-
-        fields.map do |field_key|
-          business_object_name, field = FIELD_MAPPING[field_key.to_sym]
-
-          business_objects[business_object_name] ||= []
-          business_objects[business_object_name] << field
-        end
-
-        business_objects.flat_map do |business_object_name, fields|
-          api.on(business_object_name).get_fields(*fields)
-        end
-      end
-      alias fetch_all get_fields
-
-      # Update a member's data for a specific field by arbitrary field name
-      #
-      # Does not require knowing which business object / iMIS-specific field name to use
-      #
-      # Only available for fields defined in +FIELD_MAPPING+
-      #
-      # @param field_key [Symbol] Internal name of the field
-      #
-      # @return Value of the field
-      #
-      def put_field(field_key, value) = update(field_key => value)
-      alias []= put_field
-
       # 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 fields defined in +FIELD_MAPPING+
-      #
-      # @param data [Hash] Conforms to pattern +{ field_key => value }+
+      # Only available for previously-mapped fields
       #
-      # @return [Array<Usps::Imis::Data>] Response data from the API for each internal update request
+      #  `data` is a hash of shape { field_key => value }
       #
       def update(data)
         updates = data.each_with_object({}) do |(field_key, value), hash|
@@ -106,35 +35,37 @@ module Usps
         end
 
         updates.map do |business_object_name, field_updates|
-          api.on(business_object_name).put_fields(field_updates)
+          api.put_fields(business_object_name, field_updates)
         end
       end
 
-      # Ruby 3.5 instance variable filter
-      #
-      def instance_variables_to_inspect = instance_variables - %i[@api @logger]
-
     private
 
-      def map_update(field_key)
-        missing_mapping!(field_key) unless FIELD_MAPPING.key?(field_key.to_sym)
-
-        business_object_name, field = FIELD_MAPPING[field_key.to_sym]
-        yield(business_object_name, field)
+      def map_update(field_name)
+        if FIELD_MAPPING.key?(field_name.to_sym)
+          business_object_name, field = FIELD_MAPPING[field_name.to_sym]
+          yield(business_object_name, field)
+        else
+          missing_mapping(field_name)
+        end
       end
 
-      def missing_mapping!(field_key)
+      def missing_mapping(field_name)
         unless ENV['TESTING']
           # :nocov:
-          "Mapper does not know how to handle field \"#{field_key}\".\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"
-            .split("\n")
-            .each { logger.warn(it) }
+          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 Errors::MapperError.new({ field_key: })
+        raise(
+          Error::Mapper,
+          "Unrecognized field: \"#{field_name}\". " \
+          'Please report what data you are attempting to work with to ITCom leadership.'
+        )
       end
     end
   end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    module Panel
+      class BasePanel
+        attr_reader :api
+
+        def initialize(api = nil, imis_id: nil)
+          @api = api || Api.new
+          @api.imis_id = imis_id if imis_id
+        end
+
+        def get(ordinal)
+          api.get(business_object, url_id: "~#{api.imis_id}|#{ordinal}")
+        end
+
+        def create(data)
+          api.post(business_object, payload(data), url_id: '')
+        end
+
+        def update(data)
+          api.put(business_object, payload(data), url_id: "~#{api.imis_id}|#{data[:ordinal]}")
+        end
+
+        def destroy(ordinal)
+          api.delete(business_object, url_id: "~#{api.imis_id}|#{ordinal}")
+        end
+
+      private
+
+        def business_object
+          raise Error::Api, "#{self.class.name} must implement #business_object"
+        end
+
+        def payload(_data)
+          raise Error::Api, "#{self.class.name} must implement #payload(data)"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    module Panel
+      class Education < BasePanel
+      private
+
+        def business_object
+          'ABC_ASC_Educ'
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def payload(data)
+          identity_type =
+            'System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib'
+
+          {
+            '$type' => 'Asi.Soa.Core.DataContracts.GenericEntityData, Asi.Contracts',
+            'EntityTypeName' => 'ABC_ASC_EDUC',
+            'PrimaryParentEntityTypeName' => 'Party',
+            'Identity' => {
+              '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
+              'EntityTypeName' => 'ABC_ASC_EDUC',
+              'IdentityElements' => {
+                '$type' => identity_type,
+                '$values' => [api.imis_id, data[:ordinal]&.to_s].compact
+              }
+            },
+            'PrimaryParentIdentity' => {
+              '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
+              'EntityTypeName' => 'Party',
+              'IdentityElements' => {
+                '$type' => identity_type,
+                '$values' => [api.imis_id]
+              }
+            },
+            'Properties' => {
+              '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyDataCollection, Asi.Contracts',
+              '$values' => [
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'ID',
+                  'Value' => api.imis_id
+                },
+                (
+                  if data[:ordinal]
+                    {
+                      '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                      'Name' => 'Ordinal',
+                      'Value' => {
+                        '$type' => 'System.Int32',
+                        '$value' => data[:ordinal]
+                      }
+                    }
+                  end
+                ),
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'ABC_EDUC_THRU_DATE',
+                  'Value' => data[:thru_date] || '0001-01-01T00:00:00'
+                },
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'ABC_ECertificate',
+                  'Value' => data[:certificate]
+                },
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'ABC_Educ_Description',
+                  'Value' => data[:description]
+                },
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'ABC_Educ_Effective_Date',
+                  'Value' => data[:effective_date]
+                },
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'ABC_Educ_Source_System',
+                  'Value' => data[:source]
+                },
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'ABC_Educ_Transaction_Date',
+                  'Value' => Time.now.strftime('%Y-%m-%dT%H:%I:%S')
+                },
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'ABC_Other_Code',
+                  'Value' => data[:code]
+                },
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'ABC_Product_Code',
+                  'Value' => data[:type_code]
+                },
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'ABC_TYPE',
+                  'Value' => data[:abc_type_code] || 'EDUC'
+                }
+              ].compact
+            }
+          }
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+    end
+  end
+end

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

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    module Panel
+      class Vsc < BasePanel
+      private
+
+        def business_object
+          'ABC_ASC_Vessel_Safety_Checks'
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def payload(data)
+          identity_type =
+            'System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib'
+
+          {
+            '$type' => 'Asi.Soa.Core.DataContracts.GenericEntityData, Asi.Contracts',
+            'EntityTypeName' => 'ABC_ASC_Vessel_Safety_Checks',
+            'PrimaryParentEntityTypeName' => 'Party',
+            'Identity' => {
+              '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
+              'EntityTypeName' => 'ABC_ASC_Vessel_Safety_Checks',
+              'IdentityElements' => {
+                '$type' => identity_type,
+                '$values' => [api.imis_id, data[:ordinal]&.to_s].compact
+              }
+            },
+            'PrimaryParentIdentity' => {
+              '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
+              'EntityTypeName' => 'Party',
+              'IdentityElements' => {
+                '$type' => identity_type,
+                '$values' => [api.imis_id]
+              }
+            },
+            'Properties' => {
+              '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyDataCollection, Asi.Contracts',
+              '$values' => [
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'ID',
+                  'Value' => api.imis_id
+                },
+                (
+                  if data[:ordinal]
+                    {
+                      '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                      'Name' => 'Ordinal',
+                      'Value' => {
+                        '$type' => 'System.Int32',
+                        '$value' => data[:ordinal]
+                      }
+                    }
+                  end
+                ),
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'Source_System',
+                  'Value' => 'Manual ITCom Entry'
+                },
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'ABC_ECertificate',
+                  'Value' => data[:certificate]
+                },
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'Activity_Type',
+                  'Value' => 'VSC'
+                },
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'Description',
+                  'Value' => 'Vessel Safety Checks'
+                },
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'Effective_Date',
+                  'Value' => "#{data[:year]}-12-01T00:00:00"
+                },
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'Quantity',
+                  'Value' => {
+                    '$type' => 'System.Int32',
+                    '$value' => data[:count]
+                  }
+                },
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'Thru_Date',
+                  'Value' => "#{data[:year]}-12-31T00:00:00"
+                },
+                {
+                  '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+                  'Name' => 'Transaction_Date',
+                  'Value' => Time.now.strftime('%Y-%m-%dT%H:%M:%S')
+                }
+              ].compact
+            }
+          }
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+    end
+  end
+end

data/lib/usps/imis/version.rb

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

data/lib/usps/imis.rb

@@ -3,59 +3,44 @@
 # Core dependencies
 require 'net/https'
 require 'json'
-require 'yaml'
 require 'time'
 require 'cgi'
 
-require 'active_support/core_ext/string/inflections'
-require 'active_support/core_ext/object/to_query'
-require 'active_support/core_ext/enumerable'
-require 'active_support/string_inquirer'
-require 'logger'
-require 'active_support/isolated_execution_state' # Fix costant loading issue with TaggedLogging
-require 'active_support/tagged_logging'
-
-require 'dotenv/load'
+# Extensions
+# :nocov:
+require 'ext/hash' unless defined?(Rails)
+# :nocov:
 
 # Internal requires
 require_relative 'imis/config'
-require_relative 'imis/error'
+require_relative 'imis/error/api'
+require_relative 'imis/error/mapper'
+require_relative 'imis/error/response'
 require_relative 'imis/api'
-require_relative 'imis/properties'
-require_relative 'imis/panels'
-require_relative 'imis/mocks'
-require_relative 'imis/version'
+require_relative 'imis/mapper'
+require_relative 'imis/panel/base_panel'
+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
-      alias config configuration
 
-      # Used to define a block of configuration settings
-      #
-      # @return The updated configuration object
-      #
       def configure
         yield(configuration) if block_given?
         configuration
       end
 
-      # Logger (with optional nested tags) to write to
-      #
-      def logger(*) = configuration.logger.tagged(*)
+      # def mock!(value = true)
+      #   @mock = value
+      # end
 
-      # Gem version
-      #
-      def version = Gem::Version.new(VERSION)
+      # def mock
+      #   @mock || false
+      # end
     end
   end
 end

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

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+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
+    before { api.imis_id = 31092 }
+
+    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
+    it 'sends an update from put' do
+      expect(
+        api.with(31092) { put_fields('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 }) }
+      ).to be_a(Hash)
+    end
+
+    it 'sends an update from update' do
+      expect(api.with(31092) { update(mm: 15) }.first).to be_a(Hash)
+    end
+
+    it 'uses a panel correctly' do
+      expect(api.with(6374) { panels.vsc.get(1433) }).to be_a(Hash)
+    end
+  end
+
+  describe '#inspect' do
+    it 'is configured to exclude the token instance variable' do
+      expect(api.instance_variables_to_inspect).not_to include(:@token)
+    end
+
+    it 'does not show the token instance variable' do
+      pending 'Requires Ruby 3.5' if Gem::Version.new(RUBY_VERSION) < Gem::Version.new(3.5)
+
+      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