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

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    module Error
+      class Response < Api
+        attr_reader :response
+        attr_accessor :metadata
+
+        def self.from(response)
+          new(nil, response)
+        end
+
+        def initialize(_message, response, metadata = {})
+          @response = response
+          super(message, metadata)
+        end
+
+        def bugsnag_meta_data
+          base_metadata.tap { |m| m[:api].merge!(metadata) }
+        end
+
+        def message
+          [
+            "#{self.class.name}: [#{status.to_s.upcase}] The iMIS API returned an error.",
+            (metadata.inspect if metadata != {}),
+            body
+          ].compact.join("\n")
+        end
+
+      private
+
+        def base_metadata
+          { api: { status:, body: } }
+        end
+
+        def status
+          @status ||=
+            case response.code
+            when '400'
+              :bad_request
+            when '401'
+              :unauthorized # RequestVerificationToken invalid
+            when '404'
+              :not_found
+            when '422'
+              :unprocessable_entity # validation error
+            when /^50\d$/
+              :internal_server_error # error within iMIS
+            else
+              response.code
+            end
+        end
+
+        def response_body
+          @response_body ||= JSON.parse(response.body)
+        rescue StandardError
+          @response_body ||= response.body
+        end
+
+        def body
+          return response_body unless response_body.is_a?(Hash)
+
+          case response_body['error']
+          when 'invalid_grant'
+            response_body['error_description']
+          else
+            # Unknown error type: just use the raw response
+            response.body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/usps/imis/mapper.rb

@@ -2,15 +2,9 @@
 
 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],
-        boc: %w[ABC_ASC_Individual_Demog BOC_Grade],
         edpro: %w[ABC_ASC_Individual_Demog Educ_Proficiency],
         edach: %w[ABC_ASC_Individual_Demog Educ_Achievement],
         vessel_examiner: %w[ABC_ASC_Individual_Demog Vol_Vessel_Examiner],
@@ -18,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 [String, 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.to_sym]
-        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, object_fields|
-          api.on(business_object_name).get_fields(*object_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|
@@ -107,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.15.2'
+    VERSION = '1.0.0-rc.1'
   end
 end

data/lib/usps/imis.rb

@@ -1,56 +1,46 @@
 # frozen_string_literal: true
 
-require_relative 'imis/dependencies'
+# Core dependencies
+require 'net/https'
+require 'json'
+require 'time'
+require 'cgi'
 
-# Shared infrastructure (used by multiple files below)
-require_relative 'imis/helpers'
-require_relative 'imis/requests'
-require_relative 'imis/logger_formatter'
-require_relative 'imis/logger_helpers'
-require_relative 'imis/base_data'
-require_relative 'imis/data'
-require_relative 'imis/party_data'
+# 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/blank_object'
-require_relative 'imis/models'
-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