usps-imis-api 0.6.4 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec6fd6190ca25775a69fca08cc8d16ba0177b6e34cd3643da1d07143720d607d
-  data.tar.gz: e73a5bf6dbc6f1d0daeab108bcd5a9ea86e925348562e25c76347a8e4c8a6b08
+  metadata.gz: ac6724a275018ca6e957f9342236882dde2232e1c6e9cf8f0f11e962e2ae5bb7
+  data.tar.gz: 196dc78c0f36f2921e79aba9cfd6157818932f62751475817f0b054cd2decc8d
 SHA512:
-  metadata.gz: 6eb831bd549f3f9b95d4cb731974c2232f2defa762014f2471f9fb88de6386f350c1e2b09a3398e29b2c103c079666df5eca835a7c57f716c2263d794f0c7176
-  data.tar.gz: c84a91ef84235ea7f472824626ef59d946b35e04fee52c34375cd1e002c52ed4a75b08d76a3bc40576a349cd6960fec1a6a4124465e1e1061d2c40cb832d9147
+  metadata.gz: 6ef1c062d0d887efcb0d9c0884e43df859d992f65546b16de6d359545c6f0fa92bc0d6d533c6dbca212e5fbdd47b1e3d1cd23e7a91b4af304ed4e95199e8cdb1
+  data.tar.gz: 1fe0de2b0c8f722afa9159779973ef9491f007dad2667cd18f2e863128d69c487f7a09801fba1c9bb0c0710c002e84396064d0a3a98c725f43b4d75f006ca907

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (0.6.4)
+    usps-imis-api (0.6.6)
       activesupport (~> 8.0)
 
 GEM

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

@@ -60,42 +60,77 @@ module Usps
           raise Error::ApiError, "#{self.class.name} must implement #payload(data)"
         end
 
-        # rubocop:disable Metrics/MethodLength
         def payload_header(data)
-          identity_type =
-            'System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib'
-
           {
             '$type' => 'Asi.Soa.Core.DataContracts.GenericEntityData, Asi.Contracts',
             'EntityTypeName' => business_object,
             'PrimaryParentEntityTypeName' => 'Party',
-            'Identity' => {
-              '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
-              'EntityTypeName' => business_object,
-              '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]
-              }
+            '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, ordinal&.to_s].compact
             }
           }
         end
-        # rubocop:enable Metrics/MethodLength
 
-        def property(name, value)
+        def primary_parent_identity
           {
+            '$type' => 'Asi.Soa.Core.DataContracts.IdentityData, Asi.Contracts',
+            'EntityTypeName' => 'Party',
+            'IdentityElements' => {
+              '$type' => identity_type,
+              '$values' => [api.imis_id]
+            }
+          }
+        end
+
+        def identity_type
+          'System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib'
+        end
+
+        def properties(data, &)
+          @properties = []
+
+          instance_eval(&)
+
+          payload_header(data).merge(
+            'Properties' => {
+              '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyDataCollection, Asi.Contracts',
+              '$values' => @properties
+            }
+          )
+        ensure
+          remove_instance_variable(:@properties)
+        end
+
+        def property(name, value)
+          raise Error::ApiError, 'Must be called within a `properties` block' unless defined?(@properties)
+
+          @properties << {
             '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
             'Name' => name,
-            'Value' => value
+            'Value' => property_value(value)
           }
         end
+
+        def property_value(value)
+          case value
+          when String then value
+          when Time, DateTime then value.strftime('%Y-%m-%dT%H:%I:%S')
+          when Integer then { '$type' => 'System.Int32', '$value' => value }
+          when true, false then { '$type' => 'System.Boolean', '$value' => value }
+          else
+            raise Error::ApiError, "Unexpected property type: #{value.inspect}"
+          end
+        end
       end
     end
   end

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

@@ -12,28 +12,21 @@ module Usps
           'ABC_ASC_Educ'
         end
 
-        # rubocop:disable Metrics/MethodLength
         def payload(data)
-          payload_header(data).merge(
-            'Properties' => {
-              '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyDataCollection, Asi.Contracts',
-              '$values' => [
-                property('ID', api.imis_id),
-                (property('Ordinal', { '$type' => 'System.Int32', '$value' => data[:ordinal] }) if data[:ordinal]),
-                property('ABC_EDUC_THRU_DATE', data[:thru_date] || '0001-01-01T00:00:00'),
-                property('ABC_ECertificate', data[:certificate]),
-                property('ABC_Educ_Description', data[:description]),
-                property('ABC_Educ_Effective_Date', data[:effective_date]),
-                property('ABC_Educ_Source_System', data[:source]),
-                property('ABC_Educ_Transaction_Date', Time.now.strftime('%Y-%m-%dT%H:%I:%S')),
-                property('ABC_Other_Code', data[:code]),
-                property('ABC_Product_Code', data[:type_code]),
-                property('ABC_TYPE', data[:abc_type_code] || 'EDUC')
-              ].compact
-            }
-          )
+          properties(data) do
+            property 'ID', api.imis_id
+            property 'Ordinal', data[:ordinal] if data[:ordinal]
+            property 'ABC_EDUC_THRU_DATE', data[:thru_date] || '0001-01-01T00:00:00'
+            property 'ABC_ECertificate', data[:certificate]
+            property 'ABC_Educ_Description', data[:description]
+            property 'ABC_Educ_Effective_Date', data[:effective_date]
+            property 'ABC_Educ_Source_System', data[:source]
+            property 'ABC_Educ_Transaction_Date', Time.now
+            property 'ABC_Other_Code', data[:code]
+            property 'ABC_Product_Code', data[:type_code]
+            property 'ABC_TYPE', data[:abc_type_code] || 'EDUC'
+          end
         end
-        # rubocop:enable Metrics/MethodLength
       end
     end
   end

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

@@ -12,27 +12,20 @@ module Usps
           'ABC_ASC_Vessel_Safety_Checks'
         end
 
-        # rubocop:disable Metrics/MethodLength
         def payload(data)
-          payload_header(data).merge(
-            'Properties' => {
-              '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyDataCollection, Asi.Contracts',
-              '$values' => [
-                property('ID', api.imis_id),
-                (property('Ordinal', { '$type' => 'System.Int32', '$value' => data[:ordinal] }) if data[:ordinal]),
-                property('Source_System', 'Manual ITCom Entry'),
-                property('ABC_ECertificate', data[:certificate]),
-                property('Activity_Type', 'VSC'),
-                property('Description', 'Vessel Safety Checks'),
-                property('Effective_Date', "#{data[:year]}-12-01T00:00:00"),
-                property('Quantity', { '$type' => 'System.Int32', '$value' => data[:count] }),
-                property('Thru_Date', "#{data[:year]}-12-31T00:00:00"),
-                property('Transaction_Date', Time.now.strftime('%Y-%m-%dT%H:%M:%S'))
-              ].compact
-            }
-          )
+          properties(data) do
+            property 'ID', api.imis_id
+            property 'Ordinal', data[:ordinal] if data[:ordinal]
+            property 'Source_System', 'Manual ITCom Entry'
+            property 'ABC_ECertificate', data[:certificate]
+            property 'Activity_Type', 'VSC'
+            property 'Description', 'Vessel Safety Checks'
+            property 'Effective_Date', "#{data[:year]}-12-01T00:00:00"
+            property 'Quantity', data[:count]
+            property 'Thru_Date', "#{data[:year]}-12-31T00:00:00"
+            property 'Transaction_Date', Time.now
+          end
         end
-        # rubocop:enable Metrics/MethodLength
       end
     end
   end

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.6.4'
+    VERSION = '0.6.6'
   end
 end

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

@@ -29,4 +29,22 @@ describe Usps::Imis::Panel::BasePanel do
       'Usps::Imis::Panel::InvalidPanelWithBusinessObject must implement #payload(data)'
     )
   end
+
+  it 'does not allow calling property outside of a properties block' do
+    expect { described_class.new.send(:property, 'name', 'value') }.to raise_error(
+      Usps::Imis::Error::ApiError, 'Must be called within a `properties` block'
+    )
+  end
+
+  it 'handles boolean property values' do
+    expect(described_class.new.send(:property_value, true)).to eq(
+      '$type' => 'System.Boolean', '$value' => true
+    )
+  end
+
+  it 'raises an error for unexpected property types' do
+    expect { described_class.new.send(:property_value, {}) }.to raise_error(
+      Usps::Imis::Error::ApiError, 'Unexpected property type: {}'
+    )
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.6
 platform: ruby
 authors:
 - Julian Fiander