usps-imis-api 0.15.2 → 0.15.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71bf86bea5de43c3a42aee00194fc56a1e0b42269e960e49508f8f2b1cc3e22f
-  data.tar.gz: d5721fd614d0da0f92d24e495d9cc4de8631af9d1609c9a5cca9eee6fc24a31b
+  metadata.gz: 6192c91d6014b89e3cb78b0afc8b05cb0cd8f44352bdbeb6fe55ac99d02bf9d4
+  data.tar.gz: f37891d8dabf058351c6dae8bc12f54b5c8752acdac352b52a1fc27add15b749
 SHA512:
-  metadata.gz: b414c11006fca75e300b1847474aab6319aaac3807eab7a025bb13d45c44d248a2b894b651affda14e7924341f6dea722bd2613d275cfeea908f9589cfa05535
-  data.tar.gz: b302e648c10ab09c427acfdc90fe9622b1fda6e03e6587ce8be1e7dc96c33b2c98cd293ea9191f6c78428193e55f395252cba5ee337e046a9716783264cfd24c
+  metadata.gz: 25d2d665ce5a3e323977de8c2308fad23284ef1fa3fb93b56b68f0e649978214d3cd296e4a4792f23eb09a9992fee3412344097055088191cecc64f8ffc13c58
+  data.tar.gz: e79ca2364a98b9394a21c2c213e35cfb956c75990a790baa99ae49f4441e652aa573bee3b4247aaa224f2b8684cec64a5f12b935ee72d41538cbfcef7430f9bd

data/lib/usps/imis/api.rb

@@ -112,15 +112,19 @@ module Usps
       #
       # @return [Integer] Corresponding iMIS ID
       #
+      # @raise [Errors::AmbiguousCertificateError] If the certificate matches more than one person
+      #
       def imis_id_for(certificate)
         raise Errors::LockedIdError if lock_imis_id
 
         logger.debug "Fetching iMIS ID for #{certificate}"
 
-        net_contact_data = query('NetContactData', MajorKey: certificate).one
-        raise Errors::NotFoundError, 'Member not found' if net_contact_data.nil?
+        # Family records can share their member's MajorKey, so only people are candidates
+        people = query('NetContactData', MajorKey: certificate).page.reject { it['IsCompany'] }
+        raise Errors::NotFoundError, 'Member not found' if people.empty?
+        raise Errors::AmbiguousCertificateError, certificate if people.many?
 
-        party = query('Party', UniformId: net_contact_data.id).one
+        party = query('Party', UniformId: people.first.id).one
         raise Errors::NotFoundError, 'Member not found' if party.nil?
 
         self.imis_id = party.imis_id

data/lib/usps/imis/errors/ambiguous_certificate_error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    module Errors
+      # Raised when a certificate number matches more than one person, so there is no single
+      # iMIS ID to select for it
+      #
+      class AmbiguousCertificateError < Error
+        attr_reader :certificate
+
+        def initialize(certificate)
+          @certificate = certificate
+          super(message)
+        end
+
+        def message = "Multiple members found for certificate #{certificate}"
+      end
+    end
+  end
+end

data/lib/usps/imis/party_data.rb

@@ -31,7 +31,7 @@ module Usps
       # Hash of all property names to values
       #
       def properties
-        @properties ||= format_extracted(extract_hash(raw))
+        @properties ||= extract_hash(raw)
       end
 
     private
@@ -40,18 +40,12 @@ module Usps
         { entity:, imis_id: }.compact
       end
 
-      def extract_hash(hash)
-        hash.filter_map do |key, value|
-          next if key == '$type'
-
-          [key, extract_value(value)]
-        end
-      end
+      def extract_hash(hash) = hash.except('$type').transform_values { extract_value(it) }
 
       def extract_value(value)
         case value
         when String, Integer, true, false, nil then value
-        when Array then value.map { extract_value(it) }
+        when Array then extract_array(value)
         when Hash then extract_hash_value(value)
         else
           raise Errors::ApiError, "Unrecognized value type: #{value.inspect}"
@@ -60,29 +54,23 @@ module Usps
 
       def extract_hash_value(value)
         return value['$value'] if value.key?('$value')
-        return extract_value(value['$values']) if value.key?('$values')
-        return [value['Name'], extract_value(value['Value'])] if value.key?('Name') && value.key?('Value')
+        return extract_array(value['$values']) if value.key?('$values')
 
         extract_hash(value)
       end
 
-      def format_extracted(data)
-        hash = data.to_h
-
-        hash.each do |key, value|
-          case value
-          when String, Integer, true, false then next
-          end
-
-          if %w[Addresses AlternateIds CommunicationPreferences Emails Phones Salutations].include?(key)
-            hash[key] = value.map { format_extracted(it.to_h) }
-          elsif value.all?(String)
-            # Do nothing
-          else
-            hash[key] = format_extracted(value.to_h)
-          end
+      # A list of +Name+ / +Value+ objects (e.g. +AdditionalAttributes+) is a property bag, so
+      # collapse it into a hash; any other list stays a list
+      #
+      def extract_array(values)
+        if values.any? && values.all? { named_value?(it) }
+          values.to_h { [it['Name'], extract_value(it['Value'])] }
+        else
+          values.map { extract_value(it) }
         end
       end
+
+      def named_value?(value) = value.is_a?(Hash) && value.key?('Name') && value.key?('Value')
     end
   end
 end

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.15.2'
+    VERSION = '0.15.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.15.2
+  version: 0.15.3
 platform: ruby
 authors:
 - Julian Fiander
@@ -119,6 +119,7 @@ files:
 - lib/usps/imis/data.rb
 - lib/usps/imis/dependencies.rb
 - lib/usps/imis/error.rb
+- lib/usps/imis/errors/ambiguous_certificate_error.rb
 - lib/usps/imis/errors/api_error.rb
 - lib/usps/imis/errors/command_line_error.rb
 - lib/usps/imis/errors/config_error.rb