usps-imis-api 0.13.5 → 0.13.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f533f6f1c46a836c57ed615db3e4ed3a960e1cf6e280d258cc59ee72bbe735d
-  data.tar.gz: b2877c785c60738326dc96e7aa50da21eff214e21b961a30773dc2f0f843e195
+  metadata.gz: 0c08ef9fb00018afc5a5ff89f2504c1c3eb50966834323549a0d5b889bf62fc8
+  data.tar.gz: cb0eb88ff00dcff37318ae4db9d5eba37c82a1138aab77c257dd9c81455adb70
 SHA512:
-  metadata.gz: 1c032d83d0b9c87de3d0e705e330e840cf159dc252837b54b138b5ee7a791d587b21630050b05427a59d81a5c2c605331b514dbed339634a199c2fc67f61b35c
-  data.tar.gz: 6f6a335d752b0aacef359d5fb79a499e7f6224a9c884acc42730beb44ab595d4a88659545fb7ec8ae612d84c3ba16159cc568a8993a1101bbf7bca74bd399e48
+  metadata.gz: e828834ae003610f3c3e217763bc26602626cb840b69cd4590b1ebe07659cd960cc1988da5ac0551fcac9fcfc71e89ab1ffaf004831d69344b9ad8503b787e83
+  data.tar.gz: fc6eccef25f63c11fd8e997d99c6527da8a56a0cfdcd16034744d457c214a86a973262de5215d1979f8cee5581c7f130992c3b9e7abeea85687d2ad8ab200177

data/Readme.md

@@ -1,6 +1,7 @@
 # USPS iMIS API for Ruby
 
-[![Gem Version](https://img.shields.io/gem/v/usps-imis-api)](https://rubygems.org/gems/usps-imis-api)
+[![Gem Version][gem-badge]](https://rubygems.org/gems/usps-imis-api)
+[![iMIS API PHP Wrapper Version][php-badge]](https://github.com/unitedstatespowersquadrons/imis-api-php)
 
 ## Installation
 
@@ -29,7 +30,6 @@ Usps::Imis.configure do |config|
   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']
 
@@ -83,7 +83,10 @@ file to [rubygems.org](https://rubygems.org).
 
 ## PHP
 
-A wrapper for the CLI from this API is
-[available for PHP](https://github.com/unitedstatespowersquadrons/imis-api-php).
+A wrapper for the CLI from this API is [available for PHP][php-repo].
 
 You can also view the (***deprecated***) [original PHP API](https://github.com/unitedstatespowersquadrons/imis-api).
+
+[gem-badge]: https://img.shields.io/gem/v/usps-imis-api?logo=rubygems&logoColor=white
+[php-badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fadmin.aws.usps.org%2Flibrary_badge%2Fimis-api-php&label=wrapper&logo=php&logoColor=white
+[php-repo]: https://github.com/unitedstatespowersquadrons/imis-api-php

data/lib/usps/imis/api.rb

@@ -11,6 +11,7 @@ module Usps
     #
     class Api
       include Requests
+      include Imis::Helpers
 
       NAME = 'USPS iMIS API - Ruby'
 
@@ -59,9 +60,13 @@ module Usps
       #
       # @param imis_id [Integer, String] iMIS ID to select immediately on initialization
       #
-      def initialize(imis_id: nil, record_id: nil)
+      def initialize(imis_id: nil, record_id: nil, certificate: nil)
+        raise ArgumentError, 'Cannot provide both imis_id and certificate' if imis_id && certificate
+
         self.imis_id = imis_id if imis_id
         self.record_id = record_id if record_id
+        imis_id_for(certificate) if certificate
+
         @logger = Imis.logger('Api')
         Imis.config.validate!
       end
@@ -77,15 +82,7 @@ module Usps
       def imis_id=(id)
         raise Errors::LockedIdError if lock_imis_id
 
-        hex = '[0-9a-fA-F]'
-        uuid_pattern = /^#{hex}{8}-#{hex}{4}-#{hex}{4}-#{hex}{4}-#{hex}{12}$/
-        @imis_id =
-          if id.to_s.match?(uuid_pattern) then id
-          elsif id.to_i.to_s == id.to_s.gsub(' ', '') then id.to_i
-          elsif id.nil? then nil
-          else
-            raise ArgumentError, "Invalid id: #{id.inspect}"
-          end
+        @imis_id = format_id(id)
       end
 
       # Manually set the current record ID
@@ -119,11 +116,13 @@ module Usps
 
         logger.debug "Fetching iMIS ID for #{certificate}"
 
-        result = query(Imis.configuration.imis_id_query_name, { certificate: })
-        page = result.page.tap { logger.tagged('Response').debug it }
-        raise Errors::NotFoundError, 'Member not found' if page.empty?
+        net_contact_data = query('NetContactData', MajorKey: certificate).one
+        raise Errors::NotFoundError, 'Member not found' if net_contact_data.nil?
+
+        party = query('Party', UniformId: net_contact_data.id).one
+        raise Errors::NotFoundError, 'Member not found' if party.nil?
 
-        self.imis_id = page.first['ID'].to_i
+        self.imis_id = party.id
       rescue Errors::ResponseError
         raise Errors::NotFoundError, 'Member not found'
       end

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

@@ -26,6 +26,10 @@ module Usps
         #
         ESCAPE_PADDING = 14
 
+        # Pattern for removing escape codes from strings
+        #
+        ESCAPE_PATTERN = /\e\[[0-9;]*m/
+
         def banner_header(version)
           <<~BANNER
             #{version.bold.blue}
@@ -50,7 +54,7 @@ module Usps
 
               #{wiki}
 
-              https://github.com/unitedstatespowersquadrons/imis-api-ruby/wiki/Command-Line
+              #{'https://github.com/unitedstatespowersquadrons/imis-api-ruby/wiki/Command-Line'.light_blue}
 
           BANNER
         end
@@ -71,12 +75,13 @@ module Usps
           raw_description, details = options[key]
           details ||= {}
 
-          flag = option_flag_string(key, details).ljust(option_column_width)
+          flag_string = option_flag_string(key, details)
+          flag = flag_string.ljust(option_column_width + invisible_length(flag_string))
           left_width = option_column_width + indent(3).length # Indent additional lines one step further
           tags = [
             (" (default: #{details[:default]})" if details[:default]),
             (" (max: #{details[:max]})" if details[:max])
-          ].compact.join
+          ].compact.join.gray
 
           "#{flag}#{wrap_description(raw_description, left_width, suffix: tags)}"
         end
@@ -118,8 +123,8 @@ module Usps
 
           legacy_flags.each do |flags, replacement|
             left_width = indent(2).length + option_column_width
-            description = wrap_description("use:  #{replacement}", left_width)
-            lines << "#{indent(2)}#{flags.ljust(option_column_width)}#{description}"
+            description = wrap_description("#{'use:'.light_magenta}  #{replacement}", left_width)
+            lines << "#{indent(2)}#{flags.ljust(option_column_width + invisible_length(flags))}#{description}"
           end
           lines << "\n"
         end
@@ -147,7 +152,7 @@ module Usps
           when :io then '=<io>'
           when :ios then '=<io+>'
           else ''
-          end
+          end.gray
         end
 
         def wrap_description(text, left_width, suffix: '')
@@ -181,17 +186,16 @@ module Usps
           lines
         end
 
-        def visible_length(text)
-          text.gsub(/\e\[[0-9;]*m/, '').length
-        end
+        def visible_length(text) = text.gsub(ESCAPE_PATTERN, '').length
+        def invisible_length(text) = text.length - visible_length(text)
 
         def option_column_width
           option_widths = option_groups.values.flatten.map do |key|
             _, details = options[key]
-            option_flag_string(key, details || {}).length
+            visible_length(option_flag_string(key, details || {}))
           end
 
-          all_widths = option_widths + legacy_flags.keys.map(&:length)
+          all_widths = option_widths + legacy_flags.keys.map { visible_length(it) }
           all_widths.max + GAP
         end
       end

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

@@ -168,9 +168,11 @@ module Usps
 
         def default_options? = options[:log_level] == 'info' && options.except(:log_level).values.none?
 
-        # :nocov:
-        def handle_exception!(exception) = options[:trace] ? raise(exception) : exit(2)
-        # :nocov:
+        def handle_exception!(exception)
+          raise(exception) if options[:trace] || ENV.fetch('TESTING', false) || ENV.fetch('CI', false)
+
+          exit(2)
+        end
       end
     end
   end

data/lib/usps/imis/command_line/options.yml

@@ -2,47 +2,40 @@ Subcommands:
   object:
     description: Interact with a Business Object
     value: name
-    legacy_name: 'on'
+    legacy: 'on'
     option:
-      - Business Object name
-      - type: string
-        short: O
+      type: string
+      short: O
   panel:
     description: Interact with a Panel
     value: name
     option:
-      - Panel name
-      - type: string
-        short: P
+      type: string
+      short: P
   query:
     description: Run an IQA or Business Object Query
     value: name
     option:
-      - IQA Query or Business Object name to query
-      - type: string
-        short: Q
+      type: string
+      short: Q
   mapper:
     description: Interact with mapped fields
     option:
-      - Interact with mapped fields
-      - short: M
+      short: M
   map:
     description: Shorthand for `%{green:mapper -f}` to access a single mapped field
     value: field
     option:
-      - Shorthand for %{green:-Mf} to access a single mapped field
-      - type: string
-        short: m
+      type: string
+      short: m
   business-objects:
     description: List available Business Objects
     option:
-      - List available Business Objects
-      - short: B
+      short: B
   auth-token:
     description: Return an auth token for other language wrappers
     option:
-      - Return an auth token for other language wrappers
-      - short: T
+      short: T
 
 Options:
   Identity:
@@ -164,10 +157,10 @@ Options:
 
   Misc:
     version:
-      - Print version and exit
+      - Return API version
       - short: v
     environment:
-      - Print configured environment and exit
+      - Return configured environment
       - short: E
     help:
       - Show this message

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

@@ -36,15 +36,15 @@ module Usps
 
         def legacy_aliases
           @legacy_aliases ||= subcommands.each_with_object({}) do |(name, details), aliases|
-            next unless details[:legacy_name]
+            next unless details[:legacy]
 
-            aliases["--#{details[:legacy_name]}"] = "--#{name}"
+            aliases["--#{details[:legacy]}"] = "--#{name}"
           end
         end
 
         def legacy_flags
           @legacy_flags ||= subcommands.to_h do |name, details|
-            flag_name = details[:legacy_name] || name.tr('-', '_')
+            flag_name = details[:legacy] || name.tr('-', '_')
             option_key = name.tr('-', '_').to_sym
             _, option_details = options[option_key]
 
@@ -62,18 +62,18 @@ module Usps
         end
 
         def colorize_text(text)
-          text.gsub(STYLE_PATTERN) { Regexp.last_match(2).colorize(style_args(Regexp.last_match(1))) }
-        end
-
-        def style_args(styles)
-          styles.split('.').each_with_object({}) do |name, args|
-            key = String.colors.include?(name.to_sym) ? :color : :mode
-            args[key] = name.to_sym
+          text.gsub(STYLE_PATTERN) do
+            Regexp.last_match(2).colorize(
+              Regexp.last_match(1).split('.').each_with_object({}) do |name, args|
+                key = String.colors.include?(name.to_sym) ? :color : :mode
+                args[key] = name.to_sym
+              end
+            )
           end
         end
 
         def merged_options
-          subcommand_options = subcommands.transform_values { it[:option] }.transform_keys { it.gsub('-', '_') }
+          subcommand_options = subcommands.transform_values { ['', it[:option]] }.transform_keys { it.gsub('-', '_') }
           yaml['Options'].values.inject(:merge).merge(subcommand_options)
         end
       end

data/lib/usps/imis/config.rb

@@ -14,16 +14,15 @@ module Usps
       IMIS_ROOT_URL_PROD = 'https://portal.americasboatingclub.org'
       IMIS_ROOT_URL_DEV = 'https://abcdev.imiscloud.com'
       DEFAULT_GLOBAL_LOG_PATH = '/var/log/imis/imis.log'
-      REQUIRED = %w[imis_id_query_name username password].freeze
+      REQUIRED = %w[username password].freeze
       OPTIONAL = %w[environment logger_file global_log_path].freeze
       SETTABLE = (REQUIRED + OPTIONAL).freeze
 
-      attr_accessor :imis_id_query_name, :username, :password
+      attr_accessor :username, :password
       attr_reader :environment, :logger, :logger_level, :logger_file
 
       def initialize
         @environment = default_environment
-        @imis_id_query_name = ENV.fetch('IMIS_ID_QUERY_NAME', nil)
         @username = ENV.fetch('IMIS_USERNAME', nil)
         @password = ENV.fetch('IMIS_PASSWORD', nil)
         @base_logger = Logger.new($stdout, level: :info)

data/lib/usps/imis/data.rb

@@ -10,18 +10,23 @@ module Usps
     # Convenience wrapper for accessing specific properties within an API data response
     #
     class Data < BaseData
+      include Imis::Helpers
+
       # The Business Object or Panel name
       #
       def entity = raw['EntityTypeName']
 
       # Access the iMIS ID (i.e. Party ID) property
       #
-      def imis_id = raw['PrimaryParentIdentity']['IdentityElements']['$values'].first.to_i
+      def imis_id = format_id(raw['PrimaryParentIdentity']['IdentityElements']['$values'].first)
       alias id imis_id
 
       # Access the Record ID property
       #
-      def record_id = raw['Identity']['IdentityElements']['$values'].first.to_i
+      def record_id
+        identity = format_id(raw['Identity']['IdentityElements']['$values'].first)
+        identity unless identity == imis_id
+      end
 
       # Access the Ordinal identifier property (if present)
       #
@@ -51,7 +56,7 @@ module Usps
     private
 
       def pretty_print_data
-        { entity:, imis_id:, record_id: (record_id unless record_id == imis_id), ordinal: }.compact
+        { entity:, imis_id:, record_id:, ordinal: }.compact
       end
 
       def property_values = raw['Properties']['$values']

data/lib/usps/imis/helpers.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    # General helper methods
+    #
+    module Helpers
+      # Helper for consistently formatting valid IDs
+      #
+      def format_id(raw_id)
+        hex = '[0-9a-fA-F]'
+        uuid_pattern = /^#{hex}{8}-#{hex}{4}-#{hex}{4}-#{hex}{4}-#{hex}{12}$/
+
+        if raw_id.to_s.match?(uuid_pattern) then raw_id
+        elsif raw_id.to_i.to_s == raw_id.to_s.gsub(' ', '') then raw_id.to_i
+        elsif raw_id.nil? then nil
+        else
+          raise ArgumentError, "Invalid id: #{raw_id.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/usps/imis/query.rb

@@ -90,6 +90,10 @@ module Usps
       #
       def page = fetch_next['Items']['$values'].map { iqa? ? it.except('$type') : wrap(it) }
 
+      # Fetch the first result from a single query page
+      #
+      def one = page.first
+
       # Fetch the next raw query page, and update the current offset
       #
       def fetch_next

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.13.5'
+    VERSION = '0.13.7'
   end
 end

data/lib/usps/imis.rb

@@ -20,6 +20,7 @@ require 'active_support/tagged_logging'
 require 'dotenv/load'
 
 # Internal requires
+require_relative 'imis/helpers'
 require_relative 'imis/config'
 require_relative 'imis/error'
 require_relative 'imis/api'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.13.5
+  version: 0.13.7
 platform: ruby
 authors:
 - Julian Fiander
@@ -115,6 +115,7 @@ files:
 - lib/usps/imis/errors/pattern_matching_error.rb
 - lib/usps/imis/errors/response_error.rb
 - lib/usps/imis/errors/unexpected_property_type_error.rb
+- lib/usps/imis/helpers.rb
 - lib/usps/imis/logger.rb
 - lib/usps/imis/logger_formatter.rb
 - lib/usps/imis/logger_helpers.rb