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

data/lib/usps/imis/error.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    # Base error class for all internal exceptions
-    #
-    class Error < 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
-
-        Imis.logger(self.class.name).multiline(self.message, level: :error)
-      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
-
-require_relative 'errors/api_error'
-require_relative 'errors/config_error'
-require_relative 'errors/locked_id_error'
-require_relative 'errors/mapper_error'
-require_relative 'errors/missing_id_error'
-require_relative 'errors/not_found_error'
-require_relative 'errors/response_error'
-require_relative 'errors/panel_unimplemented_error'
-require_relative 'errors/unexpected_property_type_error'
-require_relative 'errors/command_line_error'

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

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Errors
-      # Generic exception raised from within the gem
-      #
-      class ApiError < Error; end
-    end
-  end
-end

data/lib/usps/imis/errors/command_line_error.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Errors
-      # Exception raised by the command line interface
-      #
-      class CommandLineError < Error; end
-    end
-  end
-end

data/lib/usps/imis/errors/config_error.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Errors
-      # Exception raised for invalid configuration
-      #
-      class ConfigError < Error; end
-    end
-  end
-end

data/lib/usps/imis/errors/locked_id_error.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Errors
-      # Exception raised when attempting to change the iMIS ID or Record ID while it is locked
-      #
-      class LockedIdError < Error
-        def initialize = super(message)
-
-        def message = 'Cannot change iMIS or Record ID while locked'
-      end
-    end
-  end
-end

data/lib/usps/imis/errors/mapper_error.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Errors
-      # Exception raised by a +Mapper+
-      #
-      class MapperError < Error
-        # Create a new instance of +MapperError+
-        #
-        # @param metadata [Hash] Additional call-specific metadata to pass through to Bugsnag
-        #
-        def initialize(metadata = {})
-          @metadata = metadata
-          super(message, metadata)
-        end
-
-        # Exception message including the unrecognized field
-        #
-        def message
-          <<~MESSAGE.chomp
-            Mapper does not recognize field: "#{metadata[:field_key]}".
-            Please report what data you are attempting to work with to ITCom leadership.
-          MESSAGE
-        end
-      end
-    end
-  end
-end

data/lib/usps/imis/errors/missing_id_error.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Errors
-      # Exception raised when attempting to access a +BusinessObject+ without an iMIS ID
-      #
-      class MissingIdError < Error
-        def initialize = super(message)
-
-        def message = 'Cannot access an individual Business Object without an iMIS ID'
-      end
-    end
-  end
-end

data/lib/usps/imis/errors/not_found_error.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Errors
-      # Exception raised when the requested object cannot be found
-      #
-      class NotFoundError < Error; end
-    end
-  end
-end

data/lib/usps/imis/errors/panel_unimplemented_error.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Errors
-      # Exception raised when a panel is missing required method definitions
-      #
-      class PanelUnimplementedError < Error
-        # Create a new instance of +PanelUnimplementedError+ from the class name and missing method
-        #
-        # @param class_name [String] Name of the Panel class that is missing a method definition
-        # @param method [String] Method definition that is not defined on the Panel
-        #
-        def self.from(class_name, method) = new(class_name, method)
-
-        # Create a new instance of +PanelUnimplementedError+
-        #
-        # @param class_name [String] Name of the Panel class that is missing a method definition
-        # @param method [String] Method definition that is not defined on the Panel
-        # @param metadata [Hash] Additional call-specific metadata to pass through to Bugsnag
-        #
-        def initialize(class_name, method, metadata = {})
-          @class_name = class_name
-          @method = method
-          super(message, metadata)
-        end
-
-        # Exception message including the undefined method
-        #
-        def message = "#{@class_name} must implement ##{@method}"
-      end
-    end
-  end
-end

data/lib/usps/imis/errors/response_error.rb

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Errors
-      # Exception raised due to receiving an error response from the API
-      #
-      class ResponseError < Error
-        # [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(response)
-
-        # Create a new instance of +ResponseError+
-        #
-        # @param response [Net::HTTPResponse] The response received from the API
-        # @param metadata [Hash] Additional call-specific metadata to pass through to Bugsnag
-        #
-        def initialize(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 { it[:api].merge!(metadata) }
-        end
-
-        # Auto-formatted exception message, based on the provided API response
-        #
-        # @return [String] The exception message
-        #
-        def message
-          [
-            "[#{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 metadata? = metadata != {} && !metadata.nil?
-
-        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
-            JSON.pretty_generate(response.body)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/usps/imis/errors/unexpected_property_type_error.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Errors
-      # Exception raised when attempting to wrap an unexpected property type
-      #
-      class UnexpectedPropertyTypeError < Error
-        # Create a new instance of +UnexpectedPropertyTypeError+ from an unexpected value
-        #
-        # @param value Unexpected value
-        #
-        def self.from(value) = new(value)
-
-        # Create a new instance of +UnexpectedPropertyTypeError+
-        #
-        # @param value Unexpected value
-        # @param metadata [Hash] Additional call-specific metadata to pass through to Bugsnag
-        #
-        def initialize(value, metadata = {})
-          @value = value
-          super(message, metadata)
-        end
-
-        # Exception message including the undefined method
-        #
-        def message = "Unexpected property type: #{@value.inspect}"
-      end
-    end
-  end
-end

data/lib/usps/imis/logger.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'logger_formatter'
-require_relative 'logger_helpers'
-
-module Usps
-  module Imis
-    # Formatted logger with additional helpers
-    #
-    class Logger < ::Logger
-      include LoggerHelpers
-
-      def initialize(...)
-        super
-        self.formatter = LoggerFormatter.new
-      end
-    end
-  end
-end

data/lib/usps/imis/logger_formatter.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    # Formats log statements
-    #
-    class LoggerFormatter < ::Logger::Formatter
-      include ::ActiveSupport::TaggedLogging::Formatter
-
-      def call(severity, time, _progname, message)
-        log_chunks = [
-          format('%-5s', severity.to_s),
-          "[#{$PROCESS_ID}]",
-          "[#{time.strftime('%Y-%m-%d %H:%M:%S %Z')}]",
-          'iMIS Ruby API',
-          '|',
-          formatted_tags,
-          '|',
-          message.to_s.sub(/^#{Regexp.escape(tags_text)}/, '')
-        ]
-        "#{log_chunks.join(' ')}\n"
-      end
-
-    private
-
-      def formatted_tags
-        tags = current_tags || []
-        tags&.any? ? tags.join(' | ') : ''
-      end
-    end
-  end
-end

data/lib/usps/imis/logger_helpers.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    # Formatted logger helpers
-    #
-    module LoggerHelpers
-      def multiline(string, level: :debug)
-        string.split("\n").each { public_send(level, it) }
-      end
-
-      def json(data)
-        hash = data.is_a?(String) ? JSON.parse(data) : data
-        tagged('JSON') { multiline(JSON.pretty_generate(hash)) }
-      rescue StandardError
-        multiline(data)
-      end
-    end
-  end
-end

data/lib/usps/imis/mocks/business_object.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Mocks
-      # Mock data response for testing
-      #
-      class BusinessObject
-        attr_reader :fields
-
-        def initialize(**fields)
-          @fields = fields.transform_keys(&:to_s)
-        end
-
-        def get
-          Usps::Imis::Properties.build do |props|
-            fields.each { |name, value| props.add(name, value) }
-          end
-        end
-        alias read get
-
-        def get_field(name) = fields[name]
-        alias fetch get_field
-        alias [] get_field
-
-        def get_fields(*field_names) = field_names.map { fields[it] }
-        alias fetch_all get_fields
-
-        def put_fields(data)
-          Usps::Imis::Properties.build do |props|
-            fields.merge(data.transform_keys(&:to_s)).each { |name, value| props.add(name, value) }
-          end
-        end
-        alias patch put_fields
-
-        def put(data) = data
-        alias update put
-
-        def post(data) = data
-        alias create post
-
-        def delete = ''
-        alias destroy delete
-      end
-    end
-  end
-end

data/lib/usps/imis/mocks.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'mocks/business_object'
-
-module Usps
-  module Imis
-    # Namespace for all Mocks
-    #
-    module Mocks; end
-  end
-end

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

@@ -1,125 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Panels
-      # Base class for configuring Panels
-      #
-      class BasePanel
-        # The parent +Api+ object
-        #
-        attr_reader :api
-
-        # Tagged logger
-        #
-        attr_reader :logger
-
-        def initialize(api = nil, imis_id: nil, record_id: nil)
-          @api = api || Api.new
-          @api.imis_id = imis_id if imis_id
-          @api.record_id = record_id if record_id
-          @logger ||= Imis.logger('Panel')
-        end
-
-        # Get a specific object from the Panel
-        #
-        # If +fields+ is provided, will return only those field values
-        #
-        # @param fields [String] Field names to return
-        #
-        # @param ordinal [Integer] The ordinal identifier for the desired object
-        #
-        # @return [Usps::Imis::Data, Array<Usps::Imis::Data>] Response data from the API
-        #
-        def get(ordinal, *fields) = api.on(business_object_name, ordinal:).get(*fields)
-        alias read get
-
-        # Get a single named field from a Panel for the current member
-        #
-        # @param ordinal [Integer] The ordinal identifier for the desired object
-        # @param field [String] Field name to return
-        #
-        # @return Response data field value from the API
-        #
-        def get_field(ordinal, field) = api.on(business_object_name, ordinal:).get_field(field)
-        alias fetch get_field
-        alias [] get_field
-
-        # Get named fields from a Panel for the current member
-        #
-        # @param ordinal [Integer] The ordinal identifier for the desired object
-        # @param fields [Array<String>] Field names to return
-        #
-        # @return [Array] Response data from the API
-        #
-        def get_fields(ordinal, *fields) = api.on(business_object_name, ordinal:).get_fields(*fields)
-        alias fetch_all get_fields
-
-        # Update a single named field on a business object for the current member
-        #
-        # @param ordinal [Integer] The ordinal identifier for the desired object
-        # @param field [String] Name of the field
-        # @param value Value of the field
-        #
-        # @return [Usps::Imis::Data] Response data from the API
-        #
-        def put_field(ordinal, field, value) = api.on(business_object_name, ordinal:).put_field(field, value)
-        alias []= put_field
-
-        # Update only specific fields on a Panel for the current member
-        #
-        # @param ordinal [Integer] The ordinal identifier for the desired object
-        # @param fields [Hash] Conforms to pattern +{ field_key => value }+
-        #
-        # @return [Usps::Imis::Data] Response data from the API
-        #
-        def put_fields(ordinal, fields) = api.on(business_object_name, ordinal:).put_fields(fields)
-        alias patch put_fields
-
-        # Update an existing object in the Panel
-        #
-        # @param data [Hash] The record data for the desired object -- including the required
-        #                    +ordinal+ identifier
-        #
-        # @return [Usps::Imis::Data] Response data from the API
-        #
-        def put(data) = api.on(business_object_name, ordinal: data[:ordinal]).put(payload(data))
-        alias update put
-
-        # Create a new object in the Panel
-        #
-        # @param data [Hash] The record data for the desired object
-        #
-        # @return [Usps::Imis::Data] Response data from the API
-        #
-        def post(data) = api.on(business_object_name).post(payload(data))
-        alias create post
-
-        # Remove a specific object from the Panel
-        #
-        # @param ordinal [Integer] The ordinal identifier for the desired object
-        #
-        # @return [true] Only on success response (i.e. blank string from the API)
-        #
-        def delete(ordinal) = api.on(business_object_name, ordinal:).delete
-        alias destroy delete
-
-        def business_object_name
-          raise Errors::PanelUnimplementedError.from(self.class.name, 'business_object_name')
-        end
-
-        # Ruby 3.5 instance variable filter
-        #
-        def instance_variables_to_inspect = instance_variables - %i[@api @logger]
-
-      private
-
-        def payload(_data)
-          raise Errors::PanelUnimplementedError.from(self.class.name, 'payload(data)')
-        end
-
-        def build_payload(data, &) = BlankObject.new(self, data[:ordinal]).build(&)
-      end
-    end
-  end
-end

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

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Panels
-      # Panel for accessing the Educational completions business object
-      #
-      class Education < BasePanel
-        def business_object_name = 'ABC_ASC_Educ'
-
-      private
-
-        def payload(data)
-          build_payload(data) do |props|
-            props.add 'ABC_EDUC_THRU_DATE', data[:thru_date] || '0001-01-01T00:00:00'
-            props.add 'ABC_ECertificate', data[:certificate]
-            props.add 'ABC_Educ_Description', data[:description]
-            props.add 'ABC_Educ_Effective_Date', data[:effective_date]
-            props.add 'ABC_Educ_Source_System', data[:source]
-            props.add 'ABC_Educ_Transaction_Date', Time.now
-            props.add 'ABC_Other_Code', data[:code]
-            props.add 'ABC_Product_Code', data[:type_code]
-            props.add 'ABC_TYPE', data[:abc_type_code] || 'EDUC'
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Usps
-  module Imis
-    module Panels
-      # Panel for accessing the annual VSC completed counts business object
-      #
-      class Vsc < BasePanel
-        def business_object_name = 'ABC_ASC_Vessel_Safety_Checks'
-
-      private
-
-        def payload(data)
-          build_payload(data) do |props|
-            props.add 'Source_System', 'Manual ITCom Entry'
-            props.add 'ABC_ECertificate', data[:certificate]
-            props.add 'Activity_Type', 'VSC'
-            props.add 'Description', 'Vessel Safety Checks'
-            props.add 'Effective_Date', "#{data[:year]}-12-01T00:00:00"
-            props.add 'Quantity', data[:count]
-            props.add 'Thru_Date', "#{data[:year]}-12-31T00:00:00"
-            props.add 'Transaction_Date', Time.now
-          end
-        end
-      end
-    end
-  end
-end

data/lib/usps/imis/panels.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'panels/base_panel'
-require_relative 'panels/vsc'
-require_relative 'panels/education'
-
-module Usps
-  module Imis
-    # Namespace for all Panels
-    #
-    module Panels
-      # Convenience accessor for available Panel objects
-      #
-      # @param api [Api] Parent to use for making requests
-      #
-      def self.all(api = Api.new)
-        panels = constants.reject { it == :BasePanel }
-
-        Struct
-          .new(*panels.map { it.to_s.underscore.to_sym })
-          .new(*panels.map { const_get(it).new(api) })
-      end
-    end
-  end
-end