usps-imis-api 0.11.23.pre.5 → 0.11.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ff5cc6b3fffdbe890fd9798970406cb25f24c86701bea9e9c0f5db0c52f2589
-  data.tar.gz: 5101c13613feaf5ba7c4636154e9e8bee097e22f485c5e00c4205f69cee48d7e
+  metadata.gz: 547836afa31a2c997a8494b75185b98d6102750d83c210c81bb1026dfec76074
+  data.tar.gz: 37ee57c08ff274b829d5cfb17c19ecb1f7110f854900706f2740734925d97405
 SHA512:
-  metadata.gz: aa67cb37519dc9048c6307d816ba97b7e9818a31a963e6a41781b00484b70c7dab36f9166cbf0023555d4ef14940224e7768aaa93fa71687e917d6557f15f873
-  data.tar.gz: 5e705606bcd8721197fcb69705692f4f2dc50e08f58ca0e45a95b2102cf410e256ccd191daf1e37f1a5ecd4e7d73969c553bf7035d6f6fd7e1483249664b89a0
+  metadata.gz: e043dae5556f22f9d903d6a96b0101b3a0516bc424792720b1f394315f88e1c45f4092f63a7010e4027c32e289ab1228d702a5e775e13e4dc4473723a118de22
+  data.tar.gz: 2cf61c236f9d3f6415e09607925ce196876fda35073927c20c890f06769fe4c17e0149a4ae265256666a463827bdf7f363895e2dd532030619e4b970ff45068b

data/lib/usps/imis/api.rb

@@ -135,7 +135,7 @@ module Usps
       #
       # @return [Usps::Imis::Query] Query wrapper
       #
-      def query(query_name, query_params = {}) = Query.new(self, query_name, **query_params)
+      def query(query_name, query_params = nil) = Query.new(self, query_name, **query_params)
 
       # Run requests as DSL, with specific +BusinessObject+ only maintained for this scope
       #
@@ -202,7 +202,7 @@ module Usps
         @panels ||= Panels.all(self)
       end
 
-      # Used by the PHP Wrapper to reduce authentication requests
+      # Used by the CLI wrappers to reduce authentication requests
       #
       def auth_token
         authenticate

data/lib/usps/imis/base_data.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'pp'
+require 'stringio'
+
+module Usps
+  module Imis
+    # Base class for API data response wrappers
+    #
+    class BaseData < Hash
+      # Load raw API response JSON to access properties
+      #
+      # @param json [String] Raw API response JSON
+      #
+      def self.from_json(json) = self[JSON.parse(json)]
+
+      alias raw to_h
+
+      # Access the iMIS ID property
+      #
+      def imis_id
+        raise Errors::ApiError, "#{self.class} must implement #imis_id"
+      end
+      alias id imis_id
+
+      # Access an individual property value by name
+      #
+      def [](_property_name)
+        raise Errors::ApiError, "#{self.class} must implement #[](property_name)"
+      end
+
+      # Hash of all property names to values
+      #
+      def properties(...)
+        raise Errors::ApiError, "#{self.class} must implement #properties"
+      end
+
+      def []=(...)
+        raise(
+          Errors::ApiError,
+          "#{self.class} does not support setting values. If you need to modify it, call `.raw` on it."
+        )
+      end
+
+      def inspect
+        stringio = StringIO.new
+        PP.pp(self, stringio)
+        stringio.string.delete("\n")
+      end
+
+      def pretty_print(pp)
+        pp.group(1, "#<#{self.class}", '>') do
+          pretty_print_data.each do |key, value|
+            pp.breakable
+            pp.text "#{key}="
+            pp.pp value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/usps/imis/business_object.rb

@@ -2,6 +2,7 @@
 
 require_relative 'requests'
 require_relative 'data'
+require_relative 'party_data'
 
 module Usps
   module Imis
@@ -160,6 +161,8 @@ module Usps
       # Manually assemble the matching data structure, with fields in the correct order
       #
       def filter_fields(fields)
+        block_not_supported!
+
         existing = get
 
         JSON.parse(JSON.dump(existing)).tap do |updated|
@@ -188,7 +191,8 @@ module Usps
         raise Errors::MissingIdError if api.imis_id.nil?
 
         response = submit(uri, authorize(http_get))
-        result = Data.from_json(response.body)
+        klass = business_object_name == 'Party' ? PartyData : Data
+        result = klass.from_json(response.body)
         logger.json result
         result
       end
@@ -200,10 +204,17 @@ module Usps
 
         request.body = JSON.dump(body)
         response = submit(uri, authorize(request))
-        result = Data.from_json(response.body)
+        klass = business_object_name == 'Party' ? PartyData : Data
+        result = klass.from_json(response.body)
         logger.json result
         result
       end
+
+      def block_not_supported!
+        return unless business_object_name == 'Party'
+
+        raise Errors::ApiError, 'The Party business object does not support updating specific fields'
+      end
     end
   end
 end

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

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+require_relative 'performers'
+
 module Usps
   module Imis
     module CommandLine
       # Command line interface for the Api
       #
       class Interface
+        include Performers
+
         NAME = 'USPS iMIS API - Ruby'
 
         # CLI options that indicate the response is a raw Hash rather than a Data object,
@@ -21,16 +25,27 @@ module Usps
         #
         attr_reader :logger
 
+        # Initialize an +Interface+ and run it with the provided options
+        #
+        # @param [**Hash] Options from the CLI options parser
+        #
         def self.run(...) = new(...).run
 
+        # A new instance of +Interface+
+        #
+        # @param [**Hash] Options from the CLI options parser
+        #
         def initialize(**)
           @options = input_options.merge(**)
-          validate_options!
+          options[:version] = true if default_options?
+
           configure! if options[:config]
           logging!
           @logger ||= Imis.logger('CommandLine')
         end
 
+        # Run the configured action on the API
+        #
         def run
           logger.info 'Running'
           logger.debug 'CLI Options:'
@@ -49,19 +64,15 @@ module Usps
 
         # :nocov:
         def input_options
-          if ENV.fetch('CI', false) || ENV.fetch('TESTING', false)
-            defaults = {
-              raw: false,
-              quiet: false,
-              log: false,
-              log_level: 'info',
-              version: false,
-              help: false
-            }
-            return defaults
-          end
-
-          OptionsParser.new.options
+          return OptionsParser.new.options unless ENV.fetch('CI', false) || ENV.fetch('TESTING', false)
+
+          {
+            raw: false,
+            quiet: false,
+            log: false,
+            log_level: 'info',
+            version: false
+          }
         end
         # :nocov:
 
@@ -85,62 +96,6 @@ module Usps
           logger.debug "iMIS ID: #{api.imis_id}" if api.imis_id
         end
 
-        # rubocop:disable Metrics
-        def perform!
-          case convert(options)
-          in mapper:, field:, data: then mapper.put_field(field.to_sym, data)
-          in mapper:, fields: then mapper.get_fields(*fields)
-          in mapper:, field: then mapper.get_field(field.to_sym)
-          in mapper:, data: then mapper.update(data)
-
-          in on:, delete: true then on.delete
-          in on:, create: true, data: then on.post(data)
-          in on:, data:, field: then on.put_field(field, data)
-          in on:, data: then on.put_fields(data)
-          in on:, fields: then on.get_fields(*fields)
-          in on:, field: then on.get_field(field)
-          in on: then on.get
-
-          in panel:, delete: true, ordinal: then panel.delete(ordinal)
-          in panel:, create: true, data: then panel.post(data)
-          in panel:, ordinal:, data:, field: then panel.put_field(ordinal, field, data)
-          in panel:, ordinal:, data: then panel.put_fields(ordinal, data)
-          in panel:, ordinal:, fields: then panel.get_fields(ordinal, *fields)
-          in panel:, ordinal:, field: then panel.get_field(ordinal, field)
-          in panel:, ordinal: then panel.get(ordinal)
-
-          in query:, data: then api.query(query, data)
-          in query: then api.query(query)
-
-          in business_objects: true then api.business_objects
-
-          in auth_token: true then api.auth_token
-
-          in certificate: then api.imis_id
-
-          in version: true then Imis::VERSION
-          end
-        rescue NoMatchingPatternError => e
-          raise Errors::CommandLineError, "Unable to match pattern from options: #{e.message}"
-        end
-        # rubocop:enable Metrics
-
-        def convert(options)
-          options.dup.tap do |converted|
-            case converted
-            in map: then converted.merge!(mapper: api.mapper, field: map)
-            in mapper: true then converted[:mapper] = api.mapper
-            in on: then converted[:on] = api.on(on)
-            in panel: then converted[:panel] = api.panels.public_send(panel)
-            else
-              # Nothing to convert
-            end
-
-            # Remove mapper flag when false
-            converted.delete(:mapper) unless converted[:mapper]
-          end
-        end
-
         def simplify(data)
           return data.to_a if data.is_a?(Query)
           return data if options[:raw] || RAW_HASH_RESPONSE_OPTIONS.any? { options[it] }
@@ -158,13 +113,13 @@ module Usps
         end
 
         # :nocov:
-        def output(&block)
+        def output(&)
           if ENV.fetch('SUPPRESS_OUTPUT', false)
             logger.debug 'Output suppressed'
             return
           end
 
-          puts JSON.dump(block.call) if block_given?
+          puts JSON.dump(yield) if block_given?
         end
         # :nocov:
 
@@ -196,11 +151,7 @@ module Usps
           end
         end
 
-        def validate_options!
-          return unless options[:log_level] == 'info' && options.except(:log_level, :quiet).values.none?
-
-          options[:version] = true
-        end
+        def default_options? = options[:log_level] == 'info' && options.except(:log_level).values.none?
       end
     end
   end

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

@@ -99,7 +99,7 @@ module Usps
           @options = parse_options.compact
           @arguments = ARGV # Not currently used
 
-          Optimist.educate if ARGV.empty? && defaults?
+          Optimist.educate if ARGV.empty? && defaults? # DEV: This shadows setting the --version flag by default
 
           # :nocov:
           @options[:data] = read_stdin if stdin?

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    module CommandLine
+      # Command line interface perform matchers
+      #
+      # @private
+      #
+      module Performers
+      private
+
+        def perform!
+          case convert(options)
+          in mapper:, **extra then perform_mapper(mapper, **extra)
+          in on:, **extra then perform_on(on, **extra)
+          in panel:, **extra then perform_panel(panel, **extra)
+          in query:, **extra then api.query(query, extra[:data])
+          in business_objects: true then api.business_objects
+          in auth_token: true then api.auth_token
+          in certificate: then api.imis_id
+          in version: true then "#{Interface::NAME} (v#{Imis::VERSION})"
+          end
+        rescue NoMatchingPatternError => e
+          raise Errors::CommandLineError, "Unable to match pattern from options: #{e.message}"
+        end
+
+        def convert(options)
+          options.dup.tap do |converted|
+            case converted
+            in map: then converted.merge!(mapper: api.mapper, field: map)
+            in mapper: true then converted[:mapper] = api.mapper
+            in on: then converted[:on] = api.on(on)
+            in panel: then converted[:panel] = api.panels.public_send(panel)
+            else
+              # Nothing to convert
+            end
+          end
+        end
+
+        def perform_mapper(mapper, **options)
+          case options
+          in field:, data: then mapper.put_field(field.to_sym, data)
+          in fields: then mapper.get_fields(*fields)
+          in field: then mapper.get_field(field.to_sym)
+          in data: then mapper.update(data)
+          end
+        end
+
+        def perform_on(on, **options)
+          case options
+          in delete: true then on.delete
+          in create: true, data: then on.post(data)
+          in data:, field: then on.put_field(field, data)
+          in data: then on.put_fields(data)
+          in fields: then on.get_fields(*fields)
+          in field: then on.get_field(field)
+          else
+            on.get
+          end
+        end
+
+        def perform_panel(panel, **options)
+          case options
+          in delete: true, ordinal: then panel.delete(ordinal)
+          in create: true, data: then panel.post(data)
+          in ordinal:, data:, field: then panel.put_field(ordinal, field, data)
+          in ordinal:, data: then panel.put_fields(ordinal, data)
+          in ordinal:, fields: then panel.get_fields(ordinal, *fields)
+          in ordinal:, field: then panel.get_field(ordinal, field)
+          in ordinal: then panel.get(ordinal)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/usps/imis/data.rb

@@ -3,19 +3,13 @@
 require 'pp'
 require 'stringio'
 
+require_relative 'base_data'
+
 module Usps
   module Imis
     # Convenience wrapper for accessing specific properties within an API data response
     #
-    class Data < Hash
-      # Load raw API response JSON to access properties
-      #
-      # @param json [String] Raw API response JSON
-      #
-      def self.from_json(json) = self[JSON.parse(json)]
-
-      alias raw to_h
-
+    class Data < BaseData
       # The Business Object or Panel name
       #
       def entity = raw['EntityTypeName']
@@ -32,7 +26,7 @@ module Usps
       # Access an individual property value by name
       #
       def [](property_name)
-        property = raw['Properties']['$values'].find { it['Name'] == property_name }
+        property = property_values.find { it['Name'] == property_name }
         return if property.nil?
 
         value = property['Value']
@@ -44,33 +38,19 @@ module Usps
       # @param include_ids [Boolean] Whether to include the iMIS ID and Ordinal
       #
       def properties(include_ids: false)
-        raw['Properties']['$values']
+        property_values
           .map { it['Name'] }
           .select { include_ids || !%w[ID Ordinal].include?(it) }
           .index_with { self[it] }
       end
 
-      def []=(...)
-        raise Errors::ApiError, '`Data` does not support setting values. If you need to modify it, call `.raw` on it.'
-      end
+    private
 
-      def inspect
-        stringio = StringIO.new
-        PP.pp(self, stringio)
-        stringio.string.delete("\n")
+      def pretty_print_data
+        { entity:, imis_id:, ordinal: }.compact
       end
 
-      def pretty_print(pp)
-        data = { entity:, imis_id:, ordinal: }.compact
-
-        pp.group(1, "#<#{self.class}", '>') do
-          data.each do |key, value|
-            pp.breakable
-            pp.text "#{key}="
-            pp.pp value
-          end
-        end
-      end
+      def property_values = raw['Properties']['$values']
     end
   end
 end

data/lib/usps/imis/party_data.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'pp'
+require 'stringio'
+
+require_relative 'base_data'
+
+module Usps
+  module Imis
+    # Convenience wrapper for accessing specific properties within an API data response for the
+    # Party Business Object, which has a different internal structure than others
+    #
+    class PartyData < BaseData
+      # The Business Object name
+      #
+      def entity = 'Party'
+
+      # Access the iMIS ID property
+      #
+      def imis_id = self['Id'].to_i
+      alias id imis_id
+
+      # Access the certificate number
+      #
+      def certificate = self['AlternateIds'].find { it['IdType'] == 'MajorKey' }['Id']
+
+      # Access an individual property value by name
+      #
+      def [](property_name) = properties[property_name]
+
+      # Hash of all property names to values
+      #
+      def properties
+        @properties ||= format_extracted(extract_hash(raw))
+      end
+
+    private
+
+      def pretty_print_data
+        { 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_value(value)
+        case value
+        when String, Integer, true, false, nil then value
+        when Array then value.map { extract_value(it) }
+        when Hash then extract_hash_value(value)
+        else
+          raise Errors::ApiError, "Unrecognized value type: #{value.inspect}"
+        end
+      end
+
+      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')
+
+        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 Salutations].include?(key)
+            hash[key] = value.map { format_extracted(it.to_h) }
+          elsif value.all? { it.is_a?(String) }
+            # Do nothing
+          else
+            hash[key] = format_extracted(value.to_h)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.11.23-5'
+    VERSION = '0.11.24'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.11.23.pre.5
+  version: 0.11.24
 platform: ruby
 authors:
 - Julian Fiander
@@ -76,10 +76,12 @@ files:
 - bin/imis
 - lib/usps/imis.rb
 - lib/usps/imis/api.rb
+- lib/usps/imis/base_data.rb
 - lib/usps/imis/business_object.rb
 - lib/usps/imis/command_line.rb
 - lib/usps/imis/command_line/interface.rb
 - lib/usps/imis/command_line/options_parser.rb
+- lib/usps/imis/command_line/performers.rb
 - lib/usps/imis/config.rb
 - lib/usps/imis/data.rb
 - lib/usps/imis/error.rb
@@ -103,6 +105,7 @@ files:
 - lib/usps/imis/panels/base_panel.rb
 - lib/usps/imis/panels/education.rb
 - lib/usps/imis/panels/vsc.rb
+- lib/usps/imis/party_data.rb
 - lib/usps/imis/properties.rb
 - lib/usps/imis/query.rb
 - lib/usps/imis/requests.rb