usps-imis-api 1.0.0.pre.rc.3 → 1.0.0.pre.rc.5

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

@@ -20,7 +20,7 @@ module Usps
         # @param ordinal [Integer] The ordinal identifier for the desired object
         #
         def get(ordinal)
-          api.get(business_object, url_id: "~#{api.imis_id}|#{ordinal}")
+          api.business_object(business_object, url_id: "~#{api.imis_id}|#{ordinal}").get
         end
 
         # Create a new object in the Panel
@@ -28,7 +28,7 @@ module Usps
         # @param data [Hash] The record data for the desired object
         #
         def create(data)
-          api.post(business_object, payload(data), url_id: '')
+          api.business_object(business_object, url_id: '').post(payload(data))
         end
 
         # Update an existing object in the Panel
@@ -37,7 +37,9 @@ module Usps
         #                    +ordinal+ identifier
         #
         def update(data)
-          api.put(business_object, payload(data), url_id: "~#{api.imis_id}|#{data[:ordinal]}")
+          api
+            .business_object(business_object, url_id: "~#{api.imis_id}|#{data[:ordinal]}")
+            .put(payload(data))
         end
 
         # Remove a specific object from the Panel
@@ -45,7 +47,7 @@ module Usps
         # @param ordinal [Integer] The ordinal identifier for the desired object
         #
         def destroy(ordinal)
-          api.delete(business_object, url_id: "~#{api.imis_id}|#{ordinal}")
+          api.business_object(business_object, url_id: "~#{api.imis_id}|#{ordinal}").delete
         end
 
       private
@@ -57,6 +59,42 @@ module Usps
         def payload(_data)
           raise Error::ApiError, "#{self.class.name} must implement #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, 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]
+            }
+          }
+        end
+
+        def identity_type = 'System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib'
+
+        def build_payload(data, &) = payload_header(data).merge(PanelProperties.build(&))
       end
     end
   end

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

@@ -12,101 +12,21 @@ module Usps
           '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
-            }
-          }
+          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
-        # rubocop:enable Metrics/MethodLength
       end
     end
   end

data/lib/usps/imis/panel/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 PanelProperties
+        # Build a new Properties field
+        #
+        def self.build(&) = new.build(&)
+
+        # Build 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' => property_value(value)
+          }
+        end
+
+      private
+
+        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
+end

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

@@ -12,99 +12,20 @@ module Usps
           '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
-            }
-          }
+          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
-        # rubocop:enable Metrics/MethodLength
       end
     end
   end

data/lib/usps/imis/requests.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    # @private
+    #
+    module Requests
+    private
+
+      def client(uri)
+        Net::HTTP.new(uri.host, uri.port).tap do |http|
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        end
+      end
+
+      # Authorize a request prior to submitting
+      #
+      # If the current token is missing/expired, request a new one
+      #
+      def authorize(request)
+        authenticate if token_expiration < Time.now
+        request.tap { |r| r.add_field('Authorization', "Bearer #{token}") }
+      end
+
+      def submit(uri, request)
+        client(uri).request(request).tap do |result|
+          raise Error::ResponseError.from(result) unless result.is_a?(Net::HTTPSuccess)
+        end
+      end
+    end
+  end
+end

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '1.0.0-rc.3'
+    VERSION = '1.0.0-rc.5'
   end
 end

data/lib/usps/imis.rb

@@ -6,6 +6,8 @@ require 'json'
 require 'time'
 require 'cgi'
 
+require 'active_support/string_inquirer'
+
 # Extensions
 # :nocov:
 require 'ext/hash' unless defined?(Rails)
@@ -16,9 +18,12 @@ require_relative 'imis/config'
 require_relative 'imis/error/api_error'
 require_relative 'imis/error/mapper_error'
 require_relative 'imis/error/response_error'
+require_relative 'imis/requests'
+require_relative 'imis/business_object'
 require_relative 'imis/api'
 require_relative 'imis/mapper'
 require_relative 'imis/panel/base_panel'
+require_relative 'imis/panel/panel_properties'
 require_relative 'imis/panel/vsc'
 require_relative 'imis/panel/education'
 

data/spec/lib/usps/imis/api_spec.rb

@@ -41,7 +41,9 @@ describe Usps::Imis::Api do
     before { api.imis_id = 31092 }
 
     it 'sends an update' do
-      expect(api.put_fields('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 })).to be_a(Hash)
+      expect(api.business_object('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15)).to(
+        be_a(Hash)
+      )
     end
 
     context 'when receiving a response error' do
@@ -61,8 +63,8 @@ describe Usps::Imis::Api do
       end
 
       it 'wraps the error' do
-        expect { api.put_fields('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 }) }.to raise_error(
-          Usps::Imis::Error::ApiError, warning_text
+        expect { api.business_object('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15) }.to(
+          raise_error(Usps::Imis::Error::ApiError, warning_text)
         )
       end
     end
@@ -71,7 +73,7 @@ describe Usps::Imis::Api do
   describe '#with' do
     it 'sends an update from put' do
       expect(
-        api.with(31092) { put_fields('ABC_ASC_Individual_Demog', { 'TotMMS' => 15 }) }
+        api.with(31092) { business_object('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15) }
       ).to be_a(Hash)
     end
 
@@ -96,6 +98,39 @@ describe Usps::Imis::Api do
     end
   end
 
+  describe '#on' do
+    it 'returns a BusinessObject without a block' do
+      expect(api.on('ABC_ASC_Individual_Demog')).to be_a(Usps::Imis::BusinessObject)
+    end
+
+    it 'sends an update from put', :aggregate_failures do
+      result = api.with(31092) do
+        on('ABC_ASC_Individual_Demog') { put_fields({ 'TotMMS' => 15 }) }
+      end
+
+      expect(result).to be_a(Hash)
+      expect(api.imis_id).to be_nil
+    end
+
+    it 'chains .with().on() to a single block', :aggregate_failures do
+      result = api.with(31092).on('ABC_ASC_Individual_Demog') do
+        put_fields({ 'TotMMS' => 15 })
+      end
+
+      expect(result).to be_a(Hash)
+      expect(api.imis_id).to eq('31092')
+    end
+
+    it 'nests on and with', :aggregate_failures do
+      result = api.on('ABC_ASC_Individual_Demog') do |object|
+        api.with(31092) { object.put_fields({ 'TotMMS' => 15 }) }
+      end
+
+      expect(result).to be_a(Hash)
+      expect(api.imis_id).to be_nil
+    end
+  end
+
   describe '#inspect' do
     it 'is configured to exclude the token instance variable' do
       expect(api.instance_variables_to_inspect).not_to include(:@token)
@@ -120,36 +155,4 @@ describe Usps::Imis::Api do
       expect(api).to have_received(:authenticate)
     end
   end
-
-  describe '#filter_fields' do
-    let(:expected) do
-      {
-        'Properties' => {
-          '$values' => [
-            { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
-            { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
-            { 'Name' => 'Stub String', 'Value' => 'other' }
-          ]
-        }
-      }
-    end
-
-    before do
-      allow(api).to receive(:get).and_return({
-        'Properties' => {
-          '$values' => [
-            { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
-            { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
-            { 'Name' => 'Stub String', 'Value' => 'something' }
-          ]
-        }
-      })
-    end
-
-    it 'formats fields correctly' do
-      updated = api.send(:filter_fields, 'Stub', { 'Stub Integer' => 43, 'Stub String' => 'other' })
-
-      expect(updated).to eq(expected)
-    end
-  end
 end

data/spec/lib/usps/imis/business_object_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis::BusinessObject do
+  let(:business_object) { described_class.new(api, 'Stub') }
+  let(:api) { Usps::Imis::Api.new }
+
+  let(:expected) do
+    {
+      'Properties' => {
+        '$values' => [
+          { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
+          { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
+          { 'Name' => 'Stub String', 'Value' => 'other' }
+        ]
+      }
+    }
+  end
+
+  before do
+    allow(business_object).to receive(:get).and_return({
+      'Properties' => {
+        '$values' => [
+          { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
+          { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
+          { 'Name' => 'Stub String', 'Value' => 'something' }
+        ]
+      }
+    })
+  end
+
+  describe '#get_field' do
+    it 'returns a string value' do
+      expect(business_object.get_field('Stub String')).to eq('something')
+    end
+
+    it 'returns an integer value' do
+      expect(business_object.get_field('Stub Integer')).to eq(42)
+    end
+  end
+
+  describe '#filter_fields' do
+    it 'formats fields correctly' do
+      updated = business_object.send(:filter_fields, 'Stub Integer' => 43, 'Stub String' => 'other')
+
+      expect(updated).to eq(expected)
+    end
+  end
+end

data/spec/lib/usps/imis/config_spec.rb

@@ -5,10 +5,36 @@ require 'spec_helper'
 describe Usps::Imis::Config do
   let(:config) { described_class.new }
 
-  it 'sets values on initialize' do
-    config = described_class.new { |c| c.environment = 'test' }
+  describe 'environment' do
+    subject { config.environment }
 
-    expect(config.environment).to eq('test')
+    let(:config) { described_class.new }
+
+    context 'when not specified' do
+      it { is_expected.to be_development }
+    end
+
+    context 'when specified' do
+      before { config.environment = 'something' }
+
+      it { is_expected.to be_something }
+    end
+
+    context 'when specified on initialize' do
+      subject { config.environment }
+
+      let(:config) do
+        described_class.new { |c| c.environment = 'test' }
+      end
+
+      it { is_expected.to be_test }
+    end
+
+    context 'when in Rails' do
+      before { stub_const('Rails', Struct.new(:env).new(ActiveSupport::StringInquirer.new('qa'))) }
+
+      it { is_expected.to be_qa }
+    end
   end
 
   describe '#hostname' do

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Usps::Imis::Panel::PanelProperties do
+  let(:builder) { described_class.new }
+
+  it 'handles boolean property values' do
+    expect(builder.send(:property_value, true)).to eq(
+      '$type' => 'System.Boolean', '$value' => true
+    )
+  end
+
+  it 'raises an error for unexpected property types' do
+    expect { builder.send(:property_value, {}) }.to raise_error(
+      Usps::Imis::Error::ApiError, 'Unexpected property type: {}'
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ SimpleCov.minimum_coverage(line: 100, branch: 100)
 
 require 'dotenv/load'
 require 'usps/imis'
+require 'active_support/string_inquirer'
 
 ENV['TESTING'] = 'true'
 

data/usps-imis-api.gemspec

@@ -15,4 +15,6 @@ Gem::Specification.new do |s|
   s.metadata['rubygems_mfa_required'] = 'true'
 
   s.required_ruby_version = '>= 3.4'
+
+  s.add_dependency 'activesupport', '~> 8.0'
 end