usps-imis-api 0.6.6 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac6724a275018ca6e957f9342236882dde2232e1c6e9cf8f0f11e962e2ae5bb7
-  data.tar.gz: 196dc78c0f36f2921e79aba9cfd6157818932f62751475817f0b054cd2decc8d
+  metadata.gz: 81e2ba39cba54049cb049ddaa01817fe51e0e1212768359b0a0d5151b7de23f6
+  data.tar.gz: fcd351bc3eb4ed7325ebb35a74e9609e1437c5c63219ae679a5da036a71c496d
 SHA512:
-  metadata.gz: 6ef1c062d0d887efcb0d9c0884e43df859d992f65546b16de6d359545c6f0fa92bc0d6d533c6dbca212e5fbdd47b1e3d1cd23e7a91b4af304ed4e95199e8cdb1
-  data.tar.gz: 1fe0de2b0c8f722afa9159779973ef9491f007dad2667cd18f2e863128d69c487f7a09801fba1c9bb0c0710c002e84396064d0a3a98c725f43b4d75f006ca907
+  metadata.gz: 1678dd35cf80cf95741ced1140eb208358f1ccf4ae2ec2da8af5e518feacba53acbf27c3e3afa61d26265bc1f459eb77c7c55b67ad0afefa1f19b35f0f1a314f
+  data.tar.gz: 4498ecff60bc76446b2e053e9908cadbe2f9a1f095eda8d4d1bcdfca916d9bc2a113d2ee4740faff730547426527ad965ef8e1a44e21fcfe1d0fb1dd975f7798

data/Gemfile.lock

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

data/Readme.md

@@ -13,7 +13,7 @@ gem install usps-imis-api
 or add this line to your Gemfile:
 
 ```ruby
-gem 'usps-imis-api', '~> 0.6.3'
+gem 'usps-imis-api'
 ```
 
 ## Setup

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

@@ -92,45 +92,9 @@ module Usps
           }
         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 identity_type = 'System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib'
 
-        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' => 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
+        def build_payload(data, &) = payload_header(data).merge(Properties.build(&))
       end
     end
   end

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

@@ -13,18 +13,18 @@ module Usps
         end
 
         def payload(data)
-          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'
+          build_payload(data) do |props|
+            props.add 'ID', api.imis_id
+            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]
+            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

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    module Panel
+      # Constructor for the Properties field for Panel requests
+      #
+      class Properties
+        # Build the data for a new Properties field
+        #
+        def self.build(&) = new.build(&)
+
+        # Build the data for the Properties field
+        #
+        def build
+          yield(self)
+
+          {
+            'Properties' => {
+              '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyDataCollection, Asi.Contracts',
+              '$values' => @properties
+            }
+          }
+        end
+
+        # Add an individual property to the field
+        #
+        def add(name, value)
+          @properties ||= []
+          @properties << {
+            '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
+            'Name' => name,
+            'Value' => wrap(value)
+          }
+        end
+
+      private
+
+        def wrap(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
+end

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

@@ -13,17 +13,17 @@ module Usps
         end
 
         def payload(data)
-          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
+          build_payload(data) do |props|
+            props.add 'ID', api.imis_id
+            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'
+            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

data/lib/usps/imis/version.rb

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

data/lib/usps/imis.rb

@@ -23,6 +23,7 @@ require_relative 'imis/business_object'
 require_relative 'imis/api'
 require_relative 'imis/mapper'
 require_relative 'imis/panel/base_panel'
+require_relative 'imis/panel/properties'
 require_relative 'imis/panel/vsc'
 require_relative 'imis/panel/education'
 

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

@@ -29,22 +29,4 @@ 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

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis::Panel::Properties do
+  let(:builder) { described_class.new }
+
+  it 'wraps boolean property values' do
+    expect(builder.send(:wrap, true)).to eq(
+      '$type' => 'System.Boolean', '$value' => true
+    )
+  end
+
+  it 'raises an error for unexpected property types' do
+    expect { builder.send(:wrap, {}) }.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.6
+  version: 0.6.8
 platform: ruby
 authors:
 - Julian Fiander
@@ -52,6 +52,7 @@ files:
 - lib/usps/imis/mapper.rb
 - lib/usps/imis/panel/base_panel.rb
 - lib/usps/imis/panel/education.rb
+- lib/usps/imis/panel/properties.rb
 - lib/usps/imis/panel/vsc.rb
 - lib/usps/imis/requests.rb
 - lib/usps/imis/version.rb
@@ -63,6 +64,7 @@ files:
 - spec/lib/usps/imis/mapper_spec.rb
 - spec/lib/usps/imis/panel/base_panel_spec.rb
 - spec/lib/usps/imis/panel/education_spec.rb
+- spec/lib/usps/imis/panel/properties_spec.rb
 - spec/lib/usps/imis/panel/vsc_spec.rb
 - spec/lib/usps/imis_spec.rb
 - spec/spec_helper.rb