usps-imis-api 0.15.1 → 0.15.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0281a50954f7068fa9ab74ce19ed5c533d358d101a983cffb7b729bbca8e4139'
-  data.tar.gz: fb411c0c9204eb97b240dc2ca92a2c7348fa1a0ce43ff09011336b3a18716537
+  metadata.gz: 6192c91d6014b89e3cb78b0afc8b05cb0cd8f44352bdbeb6fe55ac99d02bf9d4
+  data.tar.gz: f37891d8dabf058351c6dae8bc12f54b5c8752acdac352b52a1fc27add15b749
 SHA512:
-  metadata.gz: 9e7e886d137639e08132b6cd7f8e7734d375c330d3f6d28712b10ea8ff5b7362fae0d1525b24b0060987833203fdfb96492629f8e62e6487be17fa5bbc0051e4
-  data.tar.gz: 1bd999a801fc341d93243b27eaebbf0fc7701737c227723a91c77d1fd76c48d73320c8949d5da1fb48107481539a429f708475847bc46bb49fdfa5da6f6bcdc6
+  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/config.rb

@@ -107,6 +107,14 @@ module Usps
         @global_logger = build_global_logger
       end
 
+      # Whether the global mirror debug logger writes anywhere. Disabled or unwritable, it is a null
+      # logger, and nothing needs to be mirrored to it.
+      #
+      def global_logging?
+        global_logger
+        @global_logging
+      end
+
       def silence!
         self.logger = Logger.new(nil)
       end
@@ -153,6 +161,7 @@ module Usps
           rescue StandardError
             false
           end
+        @global_logging = writable
         return ActiveSupport::TaggedLogging.new(::Logger.new(nil)) unless writable
 
         ActiveSupport::TaggedLogging.new(

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/logger.rb

@@ -12,14 +12,29 @@ module Usps
         self.formatter = LoggerFormatter.new
       end
 
-      # Also send logger methods to the global logger
+      # Also send logger methods to the global logger, while it is writing anywhere
       #
       %w[debug info warn error fatal unknown].each do |method|
         define_method(method) do |message|
           super(message)
-          Usps::Imis.config.global_logger.tagged(formatter.current_tags).public_send(method, message)
+          mirror(method, message) if Usps::Imis.config.global_logging?
         end
       end
+
+      # Whether a message at this level is recorded anywhere: here, or by the global logger, which
+      # records everything while it is writing
+      #
+      def logs?(level) = super || Usps::Imis.config.global_logging?
+
+    private
+
+      # The block form tags this one message, rather than building a tagged copy of the global logger
+      # for every line logged
+      #
+      def mirror(method, message)
+        global_logger = Usps::Imis.config.global_logger
+        global_logger.tagged(formatter.current_tags) { global_logger.public_send(method, message) }
+      end
     end
   end
 end

data/lib/usps/imis/logger_helpers.rb

@@ -5,11 +5,22 @@ module Usps
     # Formatted logger helpers
     #
     module LoggerHelpers
+      # Whether a message at this level is recorded at all
+      #
+      def logs?(level) = public_send(:"#{level}?")
+
+      # Each line is logged on its own, so nothing is formatted or split for a level that would only
+      # discard them -- a full query page is tens of thousands of lines
+      #
       def multiline(string, level: :debug)
+        return unless logs?(level)
+
         string.split("\n").each { public_send(level, it) }
       end
 
       def json(data, level: :debug)
+        return unless logs?(level)
+
         hash = data.is_a?(String) ? JSON.parse(data) : data
         tagged('JSON') { multiline(JSON.pretty_generate(hash), level:) }
       rescue StandardError

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.1'
+    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.1
+  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