usps-imis-api 0.11.27 → 0.11.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c955b3a9fbb3332402a055df4c362098cdfb48ccdab24b68d12a11b5400e04d
-  data.tar.gz: f5bf791f4fcc5c69f65bdef290f2342537d2b4d0afec5ba9a5a02366dde68d4e
+  metadata.gz: ff08376f763d16ba1615aea1d4d072f25c31faf5586a255cbf500d920d5d0de0
+  data.tar.gz: fdb80613eaf2d4448e9e7731001b276f3513a86de9c9e2b85718cd99df4aa738
 SHA512:
-  metadata.gz: 58459a3b0ecfd22e76e14499767e6fa056eed31a1bbc95c2c84dc97936feb62791df4e4f43b5ac395ec0bfb1f639d51db69e1d3fe439a58c819d661704ac4588
-  data.tar.gz: ea91b6a28f59ca29b28a4676367b0b65288e2f4903ab2833a24aa0135f1e90fe305ffab8fe3ba6cd918d1338235ced2d49da4f3a478e9f2cd5511bec9484e676
+  metadata.gz: 9ea444e537b5f978c3017045faf126474f8f53d885c6a8c802d5f81051b738f5474a43fe4de2baad28a68b5365b5e929e73717ba08cb2183cbe8e020c88873aa
+  data.tar.gz: ac58fcaef0547ae18db0170ca5ffb1370df2965b6f8563104d9d20ff986c892ad41fffd0bcf6764a80d8ebbf96ec8bbd33bb8354acadf6227384a8e4fcbe08bd

data/lib/usps/imis/api.rb

@@ -53,8 +53,9 @@ module Usps
       #
       # @param imis_id [Integer, String] iMIS ID to select immediately on initialization
       #
-      def initialize(imis_id: nil)
+      def initialize(imis_id: nil, record_id: nil)
         self.imis_id = imis_id if imis_id
+        self.record_id = record_id if record_id
         @logger ||= Imis.logger('Api')
         Imis.config.validate!
       end
@@ -71,6 +72,26 @@ module Usps
         @imis_id = id&.to_i
       end
 
+      # Manually set the current record ID
+      #
+      # @param id [Integer, String] Record ID to select for future requests
+      #
+      # @return [Integer] Record ID
+      #
+      def record_id=(id)
+        return if id.nil?
+
+        raise Errors::LockedIdError if lock_imis_id
+
+        @record_id = id.to_i
+      end
+
+      # Currently selected Record ID for API requests
+      #
+      # Defaults to the iMIS ID
+      #
+      def record_id = @record_id || imis_id
+
       # Convert a member's certificate number into an iMIS ID number
       #
       # @param certificate [String] Certificate number to lookup the corresponding iMIS ID for
@@ -101,6 +122,7 @@ module Usps
       #
       # @param id [Integer, String] iMIS ID to select for requests within the block
       # @param certificate [String] Certificate number to convert to iMIS ID and select for requests within the block
+      # @param record_id [Integer] Record ID to select for requests within the block
       #
       # @example
       #   with(12345) do
@@ -109,12 +131,14 @@ module Usps
       #
       # @return [Usps::Imis::Api]
       #
-      def with(id = nil, certificate: nil, &)
+      def with(id = nil, certificate: nil, record_id: nil, &)
         raise ArgumentError, 'Must provide id or certificate' unless id || certificate
 
         old_id = imis_id
+        old_record_id = @record_id
 
         id.nil? ? imis_id_for(certificate) : self.imis_id = id
+        self.record_id = record_id
         return self unless block_given?
 
         @lock_imis_id = true
@@ -123,6 +147,7 @@ module Usps
         if block_given?
           @lock_imis_id = false
           self.imis_id = old_id
+          self.record_id = old_record_id
         end
       end
 

data/lib/usps/imis/base_data.rb

@@ -23,6 +23,12 @@ module Usps
       end
       alias id imis_id
 
+      # Access the Record ID property
+      #
+      def record_id
+        raise Errors::ApiError, "#{self.class} must implement #record_id"
+      end
+
       # Access an individual property value by name
       #
       def [](_property_name)

data/lib/usps/imis/blank_object.rb

@@ -20,7 +20,7 @@ module Usps
 
       # Build a blank object for the current iMIS ID
       #
-      def build(&) = payload_header.merge(Properties.build(parent.api.imis_id.to_s, @ordinal.to_s, &))
+      def build(&) = payload_header.merge(Properties.build(parent.api.record_id.to_s, @ordinal&.to_s, &))
 
     private
 
@@ -42,7 +42,7 @@ module Usps
           'EntityTypeName' => parent.business_object_name,
           'IdentityElements' => {
             '$type' => identity_type,
-            '$values' => [parent.api.imis_id.to_s, @ordinal&.to_s].compact
+            '$values' => [parent.api.record_id.to_s, @ordinal&.to_s].compact
           }
         }
       end

data/lib/usps/imis/business_object.rb

@@ -48,12 +48,12 @@ module Usps
 
       # Support passthrough for Api#with
       #
-      def with(imis_id, &)
+      def with(*, **, &)
         # Bring into local scope
         wrapper_business_object_name = business_object_name
         wrapper_ordinal = ordinal
 
-        api.with(imis_id) do
+        api.with(*, **) do
           on(wrapper_business_object_name, ordinal: wrapper_ordinal, &)
         end
       end
@@ -163,9 +163,9 @@ module Usps
       #
       def id_for_uri(id = nil)
         return CGI.escape(id) unless id.nil?
-        return CGI.escape("~#{api.imis_id}|#{ordinal}") if ordinal
+        return CGI.escape("~#{api.record_id}|#{ordinal}") if ordinal
 
-        api.imis_id.to_s
+        api.record_id.to_s
       end
 
       # Manually assemble the matching data structure, with fields in the correct order

data/lib/usps/imis/command_line/interface.rb

@@ -93,7 +93,10 @@ module Usps
             # Query
           end
 
+          api.record_id = options[:record_id] if options[:record_id]
+
           logger.debug "iMIS ID: #{api.imis_id}" if api.imis_id
+          logger.debug "Record ID: #{api.record_id}" if api.record_id
         end
 
         def simplify(data)

data/lib/usps/imis/command_line/options_parser.rb

@@ -10,6 +10,7 @@ module Usps
           # IDs
           certificate: ['Member certificate number', { type: :string }],
           id: ['Member iMIS ID', { type: :integer }],
+          record_id: ['Specific Record ID', { type: :integer, short: :I }],
 
           # Primary interactions
           on: ['Business Object name', { type: :string }],

data/lib/usps/imis/data.rb

@@ -14,11 +14,15 @@ module Usps
       #
       def entity = raw['EntityTypeName']
 
-      # Access the iMIS ID property
+      # Access the iMIS ID (i.e. Party ID) property
       #
-      def imis_id = self['ID'].to_i
+      def imis_id = raw['PrimaryParentIdentity']['IdentityElements']['$values'].first.to_i
       alias id imis_id
 
+      # Access the Record ID property
+      #
+      def record_id = raw['Identity']['IdentityElements']['$values'].first.to_i
+
       # Access the Ordinal identifier property (if present)
       #
       def ordinal = self['Ordinal']&.to_i
@@ -47,7 +51,7 @@ module Usps
     private
 
       def pretty_print_data
-        { entity:, imis_id:, ordinal: }.compact
+        { entity:, imis_id:, record_id: (record_id unless record_id == imis_id), ordinal: }.compact
       end
 
       def property_values = raw['Properties']['$values']

data/lib/usps/imis/error.rb

@@ -18,7 +18,7 @@ module Usps
         super(message)
         @metadata = metadata
 
-        Imis.logger(self.class.name).error self
+        Imis.logger(self.class.name).multiline(self.message, level: :error)
       end
 
       # Additional metadata to include in Bugsnag reports

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

@@ -3,12 +3,12 @@
 module Usps
   module Imis
     module Errors
-      # Exception raised when attempting to change the iMIS ID while it is locked
+      # Exception raised when attempting to change the iMIS ID or Record ID while it is locked
       #
       class LockedIdError < Error
         def initialize = super(message)
 
-        def message = 'Cannot change iMIS ID while locked'
+        def message = 'Cannot change iMIS or Record ID while locked'
       end
     end
   end

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

@@ -49,8 +49,8 @@ module Usps
         #
         def message
           [
-            "#{self.class.name}: [#{status.to_s.upcase}] The iMIS API returned an error.",
-            (metadata.inspect if metadata != {}),
+            "[#{status.to_s.upcase}] The iMIS API returned an error.",
+            (metadata.inspect if metadata?),
             body
           ].compact.join("\n")
         end
@@ -61,6 +61,8 @@ module Usps
           { api: { status:, body: } }
         end
 
+        def metadata? = metadata != {} && !metadata.nil?
+
         def status
           @status ||=
             case response.code
@@ -93,7 +95,7 @@ module Usps
             response_body['error_description']
           else
             # Unknown error type: just use the raw response
-            response.body
+            JSON.pretty_generate(response.body)
           end
         end
       end

data/lib/usps/imis/logger_helpers.rb

@@ -5,12 +5,15 @@ module Usps
     # Formatted logger helpers
     #
     module LoggerHelpers
-      def multiline(string)
-        string.split("\n").each { |line| debug(line) }
+      def multiline(string, level: :debug)
+        string.split("\n").each { public_send(level, it) }
       end
 
       def json(data)
-        tagged('JSON') { multiline(JSON.pretty_generate(data)) }
+        hash = data.is_a?(String) ? JSON.parse(data) : data
+        tagged('JSON') { multiline(JSON.pretty_generate(hash)) }
+      rescue StandardError
+        multiline(data)
       end
     end
   end

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

@@ -14,9 +14,10 @@ module Usps
         #
         attr_reader :logger
 
-        def initialize(api = nil, imis_id: nil)
+        def initialize(api = nil, imis_id: nil, record_id: nil)
           @api = api || Api.new
           @api.imis_id = imis_id if imis_id
+          @api.record_id = record_id if record_id
           @logger ||= Imis.logger('Panel')
         end
 

data/lib/usps/imis/requests.rb

@@ -41,7 +41,7 @@ module Usps
         logger.info 'Submitting request to iMIS'
         logger.tagged('Request') do
           logger.debug "#{request.class.name.demodulize.upcase} #{uri}"
-          logger.multiline sanitized_request_body(request)
+          logger.json sanitized_request_body(request)
 
           client(uri).request(request).tap do |result|
             raise Errors::ResponseError.from(result) unless result.is_a?(Net::HTTPSuccess)

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.11.27'
+    VERSION = '0.11.29'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.11.27
+  version: 0.11.29
 platform: ruby
 authors:
 - Julian Fiander