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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb187f7e4a8497da991378eec6a9893c5c2a5e637b808a9225ab72ebd5ee385d
-  data.tar.gz: 0d09118f25fce28b94ddbc1257e9670fe3454e34df094885bc9cf35cbb1a86a0
+  metadata.gz: 1c0abf715f3c6019016bc6b8bdf867ce9d83234ba093c6150a4885997e9156f4
+  data.tar.gz: bcd2727e5f74b7a8681ae8ea1c510539fc24b62085719b439a01a331989a59c9
 SHA512:
-  metadata.gz: f50698bc529a6d66d3c69e201d696cdfde1f24c7bf414ab1f655ebdf3b21e1bd512b8e00476ffa62e3ded1a50d72e82586b8f11c002291c5a8038ad5f4cdd2d6
-  data.tar.gz: '09e2849e666c312d0a974efc14b5133ac6e2f0ef181a6715f83ae420b6ba48f6a1566cc749a1dcbce614989c9e5b9fa343ba4dd6a56f1ecd47a9a14b7572617a'
+  metadata.gz: e0f98c36fd93ae643a949980e590fbb327cc40e1947ef5c8b530156e3961073082702dd38916fa27da4db10c642316c3c3db9f97d82d2f7c616032917cea22f1
+  data.tar.gz: 3195ecb427cff0fea1c6d1cef0d877507c2bb7baaa3a3db6d669f281048a03de7fb06c15e3b5f1cfe36625ece30d2e890f05202accfaf56148de40dda0fdce4d

data/.rubocop.yml

@@ -32,8 +32,6 @@ Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyleForEmptyBraces: no_space
 Layout/SpaceInsideArrayLiteralBrackets:
   EnforcedStyle: no_space
-Layout/LineLength:
-  Max: 100
 
 Lint/UnusedMethodArgument:
   Enabled: true

data/Gemfile.lock

@@ -1,17 +1,39 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (1.0.0.pre.rc.4)
+    usps-imis-api (1.0.0.pre.rc.5)
+      activesupport (~> 8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (8.0.3)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     ast (2.4.2)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.3.1)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.4)
     date (3.4.1)
     diff-lcs (1.5.1)
     docile (1.4.1)
     dotenv (3.1.4)
+    drb (2.2.3)
     erb (5.0.3)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
     io-console (0.8.1)
     irb (1.15.2)
       pp (>= 0.6.0)
@@ -19,6 +41,8 @@ GEM
       reline (>= 0.4.2)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
+    logger (1.7.0)
+    minitest (5.26.0)
     parallel (1.26.3)
     parser (3.3.5.0)
       ast (~> 2.4.1)
@@ -67,6 +91,7 @@ GEM
     rubocop-rspec (3.1.0)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -75,7 +100,10 @@ GEM
     simplecov_json_formatter (0.1.4)
     stringio (3.1.7)
     tsort (0.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.6.0)
+    uri (1.0.4)
 
 PLATFORMS
   arm64-darwin-23

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.0'
+gem 'usps-imis-api', '~> 0.6.3'
 ```
 
 ## Setup
@@ -25,9 +25,11 @@ require 'dotenv/load' # Optionally load environment variables from `.env` file
 require 'usps/imis'
 
 Usps::Imis.configure do |config|
-  config.environment = :development # Rails.env
-  config.imis_id_query_name = ENV['IMIS_ID_QUERY_NAME']
+  # This will default to `Rails.env` if available.
+  config.environment = :development
 
+  # These options will default to the listed `ENV` variable if available.
+  config.imis_id_query_name = ENV['IMIS_ID_QUERY_NAME']
   config.username = ENV['IMIS_USERNAME']
   config.password = ENV['IMIS_PASSWORD']
 end
@@ -85,6 +87,16 @@ api.imis_id = 31092
 data = api.on('ABC_ASC_Individual_Demog').get
 ```
 
+### GET Field
+
+To fetch a specific field from member data, run e.g.:
+
+```ruby
+api.imis_id = 31092
+
+tot_mms = api.on('ABC_ASC_Individual_Demog').get_field('TotMMS')
+```
+
 ### PUT Fields
 
 To update member data, run e.g.:
@@ -202,7 +214,7 @@ previous value.
 
 ```ruby
 api.with(31092) do
-  # These four requests are identical:
+  # These requests are identical:
 
   on('ABC_ASC_Individual_Demog') { put('TotMMS' => 15) }
 
@@ -220,12 +232,26 @@ api.with(6374) do
 end
 ```
 
-## Exception Handling
+```ruby
+api.with(31092) do
+  # These requests are identical:
+
+  on('ABC_ASC_Individual_Demog') do
+    get['Properties']['$values'].find { |hash| hash['Name'] == 'TotMMS' }['Value']['$value']
+  end
+
+  on('ABC_ASC_Individual_Demog') { get_field('TotMMS') }
+
+  on('ABC_ASC_Individual_Demog').get_field('TotMMS')
+end
 
-Exception and error response handling will be added later.
+# This request fetches the same data, but leaves the iMIS ID selected
+api.with(31092).on('ABC_ASC_Individual_Demog').get_field('TotMMS')
+```
 
-To print exception information to STDERR when raising, set the environment
-variable `IMIS_ERROR_LOG_TO_STDERR=true`.
+## Exception Handling
+
+All internal exceptions inherit from `Usps::Imis::ApiError`.
 
 ## Automated Testing and Linting
 
@@ -241,6 +267,8 @@ Linting is available by running:
 bundle exec rubocop
 ```
 
+100% branch coverage is enforced on the test suite.
+
 ### GitHub Actions
 
 Testing and linting are automatically run on every push.

data/lib/usps/imis/business_object.rb

@@ -40,6 +40,19 @@ module Usps
         JSON.parse(result.body)
       end
 
+      # Get a single named field from a business object for the current member
+      #
+      # @param name [String] Field name to return
+      #
+      # @return [Hash] Response data from the API
+      #
+      def get_field(name)
+        values = get['Properties']['$values']
+        value = values.find { |hash| hash['Name'] == name }['Value']
+
+        value.is_a?(String) ? value : value['$value']
+      end
+
       # Update only specific fields on a business object for the current member
       #
       # @param fields [Hash] Conforms to pattern +{ field_key => value }+

data/lib/usps/imis/config.rb

@@ -8,25 +8,31 @@ module Usps
       IMIS_ROOT_URL_PROD = 'https://portal.americasboatingclub.org'
       IMIS_ROOT_URL_DEV = 'https://abcdev.imiscloud.com'
 
-      attr_accessor :environment, :imis_id_query_name, :username, :password
+      attr_accessor :imis_id_query_name, :username, :password
+      attr_reader :environment
 
       def initialize
+        @environment = defined?(Rails) ? Rails.env : ActiveSupport::StringInquirer.new('development')
+        @imis_id_query_name = ENV.fetch('IMIS_ID_QUERY_NAME', nil)
+        @username = ENV.fetch('IMIS_USERNAME', nil)
+        @password = ENV.fetch('IMIS_PASSWORD', nil)
+
         yield self if block_given?
       end
 
+      def environment=(env)
+        @environment = ActiveSupport::StringInquirer.new(env.to_s)
+      end
+
       # Environment-specific API endpoint hostname
       #
       # @return The API hostname for the current environment
       #
       def hostname
-        case environment.to_sym
-        when :production
-          IMIS_ROOT_URL_PROD
-        when :development
-          IMIS_ROOT_URL_DEV
-        else
-          raise Error::ApiError, "Unexpected API environment: #{environment}"
-        end
+        return IMIS_ROOT_URL_PROD if environment.production?
+        return IMIS_ROOT_URL_DEV if environment.development?
+
+        raise Error::ApiError, "Unexpected API environment: #{environment}"
       end
 
       # Ruby 3.5 instance variable filter

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

@@ -59,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

@@ -2,6 +2,8 @@
 
 module Usps
   module Imis
+    # @private
+    #
     module Requests
     private
 

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '1.0.0-rc.4'
+    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)
@@ -21,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/panel_properties'
 require_relative 'imis/panel/vsc'
 require_relative 'imis/panel/education'
 

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

@@ -6,31 +6,41 @@ describe Usps::Imis::BusinessObject do
   let(:business_object) { described_class.new(api, 'Stub') }
   let(:api) { Usps::Imis::Api.new }
 
-  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' }
-          ]
-        }
+  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
 
-    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' }
-          ]
-        }
-      })
+    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')
 

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

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc.4
+  version: 1.0.0.pre.rc.5
 platform: ruby
 authors:
 - Julian Fiander
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 description: A wrapper for the iMIS API.
 email: jsfiander@gmail.com
 executables: []
@@ -38,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/panel_properties.rb
 - lib/usps/imis/panel/vsc.rb
 - lib/usps/imis/requests.rb
 - lib/usps/imis/version.rb
@@ -49,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/panel_properties_spec.rb
 - spec/lib/usps/imis/panel/vsc_spec.rb
 - spec/lib/usps/imis_spec.rb
 - spec/spec_helper.rb