usps-imis-api 0.11.26 → 0.11.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3e12835817725b251105021e66e0119f4a934bcce5e13d648b611875aff33dd
-  data.tar.gz: b01c567700f486cebd6cfabab0b7017fbcd351cd83bb47bfa38528ad3ed2a9f8
+  metadata.gz: 0c955b3a9fbb3332402a055df4c362098cdfb48ccdab24b68d12a11b5400e04d
+  data.tar.gz: f5bf791f4fcc5c69f65bdef290f2342537d2b4d0afec5ba9a5a02366dde68d4e
 SHA512:
-  metadata.gz: 763bd5cb2d6227333d54e135a66bfbe3a51abe236809c1cbd4a7252f3d4cfce3198e6a3d7235e88ee456bff1a7203ec161c62478abacdedac065643718a5ea66
-  data.tar.gz: 66784814074fb357d0b9afc665ba47c9f19091f0e537b85b351ad215e69960568d8ae73e19606b8e813dd1af04d261513b3f3573d4cead995202d97e64c54e57
+  metadata.gz: 58459a3b0ecfd22e76e14499767e6fa056eed31a1bbc95c2c84dc97936feb62791df4e4f43b5ac395ec0bfb1f639d51db69e1d3fe439a58c819d661704ac4588
+  data.tar.gz: ea91b6a28f59ca29b28a4676367b0b65288e2f4903ab2833a24aa0135f1e90fe305ffab8fe3ba6cd918d1338235ced2d49da4f3a478e9f2cd5511bec9484e676

data/lib/usps/imis/blank_object.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'requests'
+require_relative 'data'
+require_relative 'party_data'
+
+module Usps
+  module Imis
+    # Constructor for blank BusinessObject and BasePanel objects
+    #
+    class BlankObject
+      # The parent object
+      #
+      attr_reader :parent
+
+      def initialize(parent, ordinal = nil)
+        @parent = parent
+        @ordinal = ordinal
+      end
+
+      # Build a blank object for the current iMIS ID
+      #
+      def build(&) = payload_header.merge(Properties.build(parent.api.imis_id.to_s, @ordinal.to_s, &))
+
+    private
+
+      def identity_type = 'System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib'
+
+      def payload_header
+        {
+          '$type' => 'Asi.Soa.Core.DataContracts.GenericEntityData, Asi.Contracts',
+          'EntityTypeName' => parent.business_object_name,
+          'PrimaryParentEntityTypeName' => 'Party',
+          'Identity' => identity,
+          'PrimaryParentIdentity' => primary_parent_identity
+        }
+      end
+
+      def identity
+        {
+          '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
+          'EntityTypeName' => parent.business_object_name,
+          'IdentityElements' => {
+            '$type' => identity_type,
+            '$values' => [parent.api.imis_id.to_s, @ordinal&.to_s].compact
+          }
+        }
+      end
+
+      def primary_parent_identity
+        {
+          '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
+          'EntityTypeName' => 'Party',
+          'IdentityElements' => {
+            '$type' => identity_type,
+            '$values' => [parent.api.imis_id.to_s]
+          }
+        }
+      end
+    end
+  end
+end

data/lib/usps/imis/business_object.rb

@@ -6,7 +6,8 @@ require_relative 'party_data'
 
 module Usps
   module Imis
-    # DEV
+    # Configured accessor for a specific Business Object
+    #
     class BusinessObject
       include Requests
 
@@ -136,6 +137,15 @@ module Usps
       def delete = submit(uri, authorize(http_delete)).body == '' # rubocop:disable Naming/PredicateMethod
       alias destroy delete
 
+      # Build a blank object for the current iMIS ID
+      #
+      def blank_object(&) = BlankObject.new(self).build(&)
+
+      # Create a business object for the current member, starting with a blank object and building properties
+      #
+      def post_from_blank(&) = post(blank_object(&))
+      alias create_from_blank post_from_blank
+
       # Ruby 3.5 instance variable filter
       #
       def instance_variables_to_inspect = instance_variables - %i[@api @logger]

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

@@ -30,7 +30,7 @@ module Usps
         #
         # @return [Usps::Imis::Data, Array<Usps::Imis::Data>] Response data from the API
         #
-        def get(ordinal, *fields) = api.on(business_object, ordinal:).get(*fields)
+        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
@@ -40,7 +40,7 @@ module Usps
         #
         # @return Response data field value from the API
         #
-        def get_field(ordinal, field) = api.on(business_object, ordinal:).get_field(field)
+        def get_field(ordinal, field) = api.on(business_object_name, ordinal:).get_field(field)
         alias fetch get_field
         alias [] get_field
 
@@ -51,7 +51,7 @@ module Usps
         #
         # @return [Array] Response data from the API
         #
-        def get_fields(ordinal, *fields) = api.on(business_object, ordinal:).get_fields(*fields)
+        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
@@ -62,7 +62,7 @@ module Usps
         #
         # @return [Usps::Imis::Data] Response data from the API
         #
-        def put_field(ordinal, field, value) = api.on(business_object, ordinal:).put_field(field, value)
+        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
@@ -72,7 +72,7 @@ module Usps
         #
         # @return [Usps::Imis::Data] Response data from the API
         #
-        def put_fields(ordinal, fields) = api.on(business_object, ordinal:).put_fields(fields)
+        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
@@ -82,7 +82,7 @@ module Usps
         #
         # @return [Usps::Imis::Data] Response data from the API
         #
-        def put(data) = api.on(business_object, ordinal: data[:ordinal]).put(payload(data))
+        def put(data) = api.on(business_object_name, ordinal: data[:ordinal]).put(payload(data))
         alias update put
 
         # Create a new object in the Panel
@@ -91,7 +91,7 @@ module Usps
         #
         # @return [Usps::Imis::Data] Response data from the API
         #
-        def post(data) = api.on(business_object).post(payload(data))
+        def post(data) = api.on(business_object_name).post(payload(data))
         alias create post
 
         # Remove a specific object from the Panel
@@ -100,58 +100,24 @@ module Usps
         #
         # @return [true] Only on success response (i.e. blank string from the API)
         #
-        def delete(ordinal) = api.on(business_object, ordinal:).delete
+        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 business_object
-          raise Errors::PanelUnimplementedError.from(self.class.name, 'business_object')
-        end
-
         def payload(_data)
           raise Errors::PanelUnimplementedError.from(self.class.name, 'payload(data)')
         end
 
-        def payload_header(data)
-          {
-            '$type' => 'Asi.Soa.Core.DataContracts.GenericEntityData, Asi.Contracts',
-            'EntityTypeName' => business_object,
-            'PrimaryParentEntityTypeName' => 'Party',
-            'Identity' => identity(data[:ordinal]),
-            'PrimaryParentIdentity' => primary_parent_identity
-          }
-        end
-
-        def identity(ordinal = nil)
-          {
-            '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
-            'EntityTypeName' => business_object,
-            'IdentityElements' => {
-              '$type' => identity_type,
-              '$values' => [api.imis_id.to_s, ordinal&.to_s].compact
-            }
-          }
-        end
-
-        def primary_parent_identity
-          {
-            '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
-            'EntityTypeName' => 'Party',
-            'IdentityElements' => {
-              '$type' => identity_type,
-              '$values' => [api.imis_id.to_s]
-            }
-          }
-        end
-
-        def identity_type = 'System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib'
-
-        def build_payload(data, &) = payload_header(data).merge(Properties.build(&))
+        def build_payload(data, &) = BlankObject.new(self, data[:ordinal]).build(&)
       end
     end
   end

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

@@ -6,16 +6,12 @@ module Usps
       # Panel for accessing the Educational completions business object
       #
       class Education < BasePanel
-      private
+        def business_object_name = 'ABC_ASC_Educ'
 
-        def business_object
-          'ABC_ASC_Educ'
-        end
+      private
 
         def payload(data)
           build_payload(data) do |props|
-            props.add 'ID', api.imis_id.to_s
-            props.add 'Ordinal', data[:ordinal] if data[:ordinal]
             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]

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

@@ -6,16 +6,12 @@ module Usps
       # Panel for accessing the annual VSC completed counts business object
       #
       class Vsc < BasePanel
-      private
+        def business_object_name = 'ABC_ASC_Vessel_Safety_Checks'
 
-        def business_object
-          'ABC_ASC_Vessel_Safety_Checks'
-        end
+      private
 
         def payload(data)
           build_payload(data) do |props|
-            props.add 'ID', api.imis_id.to_s
-            props.add 'Ordinal', data[:ordinal] if data[:ordinal]
             props.add 'Source_System', 'Manual ITCom Entry'
             props.add 'ABC_ECertificate', data[:certificate]
             props.add 'Activity_Type', 'VSC'

data/lib/usps/imis/properties.rb

@@ -7,7 +7,10 @@ module Usps
     class Properties
       # Build the data for a new Properties field
       #
-      def self.build(&) = new.build(&)
+      # @param id [String] iMIS ID to include in the properties before running the block
+      # @param ordinal [String] Ordinal to include in the properties before running the block
+      #
+      def self.build(id = nil, ordinal = nil, &) = new.build(id, ordinal, &)
 
       # Wrap value in the API-internal type structure
       #
@@ -24,7 +27,15 @@ module Usps
 
       # Build the data for the Properties field
       #
-      def build
+      # @param id [String] iMIS ID to include in the properties before running the block
+      # @param ordinal [String] Ordinal to include in the properties before running the block
+      #
+      def build(id = nil, ordinal = nil)
+        @properties ||= []
+
+        add('ID', id) if id
+        add('Ordinal', ordinal) if ordinal
+
         yield(self)
 
         {
@@ -38,7 +49,6 @@ module Usps
       # Add an individual property to the field
       #
       def add(name, value)
-        @properties ||= []
         @properties << {
           '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
           'Name' => name,

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.11.26'
+    VERSION = '0.11.27'
   end
 end

data/lib/usps/imis.rb

@@ -22,6 +22,7 @@ require_relative 'imis/config'
 require_relative 'imis/error'
 require_relative 'imis/api'
 require_relative 'imis/properties'
+require_relative 'imis/blank_object'
 require_relative 'imis/panels'
 require_relative 'imis/mocks'
 require_relative 'imis/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.11.26
+  version: 0.11.27
 platform: ruby
 authors:
 - Julian Fiander
@@ -77,6 +77,7 @@ files:
 - lib/usps/imis.rb
 - lib/usps/imis/api.rb
 - lib/usps/imis/base_data.rb
+- lib/usps/imis/blank_object.rb
 - lib/usps/imis/business_object.rb
 - lib/usps/imis/command_line.rb
 - lib/usps/imis/command_line/interface.rb