usps-imis-api 0.12.10 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 885f7ace4c5c5f77d9e986c1b09e12d9e1d811596800b6181220b24fe3fecbe8
-  data.tar.gz: 397ad89928f4efdbfea3299123378685c4fcbe78c87edf852f2fd60873acd4a5
+  metadata.gz: 01ea56e2c86361876d694df871ed74b17ead231c2a04956cbcf4121e9ea81a43
+  data.tar.gz: f1bb3827652a82ef2bbd821267305e200da82adc5305a3e8743634574ac8cba7
 SHA512:
-  metadata.gz: '07083a6c15f1177f94c2039f1a3b80c893bfd671a6d8f9cbcfeabad33d16a8d1da3d162132acf0864ed2d21768ac0ca773e72a65b0e6a02bbb08fe9a262342f5'
-  data.tar.gz: e5933277a7c6923b729c26fa68a65a63cf91eb997b6bc18221c57db027cb4d310f96fe2dc3d554f2d0f1ec79803154eddc4bdcb2ab268a4c52de66f9908ee596
+  metadata.gz: 7d827dc920c5b0db49ec6e965d1a6991e6c2198671db810fc8bd76f8d50e74ae1f3f8bcfe4c98bc1af97a6f54444b41ed94893f240bad5ec0987772bae2fe95b
+  data.tar.gz: c0887342a3a94477e4a2bf9e888443b4a1db68ce343b0555b5dcd9a8dd1706f70c15962a7088c19d2613f3e13f1ef6c669bdcd8f192e5c1708c41f34f77591f6

data/lib/usps/imis/business_object.rb

@@ -44,7 +44,12 @@ module Usps
       #
       # @return [Usps::Imis::Query] Query wrapper
       #
-      def query = api.query(business_object_name)
+      def query(**) = api.query(business_object_name, **)
+
+      # Get all records from the business object for the current member
+      #
+      def get_all(**) = query(**, id: api.imis_id).to_a
+      alias list get_all
 
       # Support passthrough for Api#with
       #

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

@@ -69,6 +69,8 @@ module Usps
           CSV.generate(headers:, write_headers: !headers.nil?) do |csv|
             headers ? value.each { csv << it } : csv << value
           end
+        rescue StandardError
+          raise Errors::CommandLineError, 'Unable to format response as CSV'
         end
       end
     end

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

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    module CommandLine
+      # Custom help page generator for the command line interface
+      #
+      # @private
+      #
+      module Help
+        TERMINAL_WIDTH = 120
+        GAP = 4
+
+        def banner_header(version)
+          <<~BANNER
+            #{version.bold.blue}
+            #{'P/R/C Julian Fiander, SN'.gray}
+          BANNER
+        end
+
+        def banner_contents
+          <<~BANNER
+            #{'Usage'.underline}
+
+              #{'imis'.bold} #{'[command] [options]'.gray}
+
+
+            #{'Further Help'.underline}
+
+              For an explanation of how to provide API configuration, more details on the options,
+              and usage examples, please refer to the wiki:
+
+              https://github.com/unitedstatespowersquadrons/imis-api-ruby/wiki/Command-Line
+
+          BANNER
+        end
+
+        # Build the custom help page
+        #
+        def custom_help
+          [banner_header(Api.version), '', banner_contents].tap do |lines|
+            help_commands(lines)
+            help_options(lines)
+            help_legacy_flags(lines)
+          end.join("\n")
+        end
+
+        # Format a single option line for the help page
+        #
+        def format_option(key)
+          raw_description, details = options[key]
+          details ||= {}
+
+          flag = option_flag_string(key, details).ljust(option_column_width)
+          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
+
+          "#{flag}#{wrap_description(raw_description, left_width, suffix: tags)}"
+        end
+
+      private
+
+        def help_commands(lines)
+          # Adjust the underlying command padding to account for non-printing characters
+          #
+          # Bold and gray each add 14:
+          #   '-'.bold.length == 15
+          #   '-'.gray.length == 15
+          #
+          escape_padding = 14
+
+          command_lengths = subcommands.map { |name, details| name.length + details[:value].to_s.length }
+          command_width = command_lengths.max + GAP + escape_padding
+
+          lines << "#{'Commands'.underline}\n"
+          subcommands.each do |name, details|
+            combined_name = details[:value] ? "#{name.bold} #{"<#{details[:value]}>".gray}" : name.bold
+            lines << [
+              indent(1),
+              combined_name.ljust(command_width + (details[:value] ? escape_padding : 0)),
+              details[:description]
+            ].join
+          end
+          lines << "\n"
+        end
+
+        def help_options(lines)
+          lines << "#{'Options'.underline}\n"
+          option_groups.each do |group_name, option_keys|
+            lines << "#{indent(1)}#{group_name.underline}"
+            option_keys.each { lines << "#{indent(2)}#{format_option(it)}" }
+            lines << ''
+          end
+        end
+
+        def help_legacy_flags(lines)
+          lines << "#{indent(1)}#{'Legacy Flags'.underline}\n"
+          lines << "#{indent(2)}The following options are still supported, but have been replaced by subcommands:\n"
+          legacy_flags.each do |flags, replacement|
+            lines << "#{indent(2)}#{flags.ljust(option_column_width)}use:  #{replacement}"
+          end
+          lines << "\n"
+        end
+
+        def indent(level) = '  ' * level
+
+        def option_flag_string(key, details)
+          [
+            details[:short] ? "-#{details[:short]}, " : indent(2),
+            "--#{key.to_s.tr('_', '-')}",
+            type_suffix(details[:type])
+          ].join
+        end
+
+        def type_suffix(type)
+          case type
+          when :string then '=<s>'
+          when :strings then '=<s+>'
+          when :integer then '=<i>'
+          when :ints then '=<i+>'
+          when :float then '=<f>'
+          when :floats then '=<f+>'
+          when :date then '=<d>'
+          when :dates then '=<d+>'
+          when :io then '=<io>'
+          when :ios then '=<io+>'
+          else ''
+          end
+        end
+
+        def wrap_description(text, left_width, suffix: '')
+          max_width = TERMINAL_WIDTH - left_width
+          padding = "\n#{' ' * left_width}"
+
+          lines = text.split("\n").flat_map { word_wrap(it, max_width) }
+
+          if suffix.empty? || visible_length("#{lines.last}#{suffix}") <= max_width
+            lines[-1] = "#{lines.last}#{suffix}"
+          else
+            lines << suffix.lstrip
+          end
+
+          lines.join(padding)
+        end
+
+        def word_wrap(text, max_width)
+          return [text] if max_width <= 0 || visible_length(text) <= max_width
+
+          words = text.split
+          lines = [words.shift]
+          words.each do |word|
+            candidate = "#{lines.last} #{word}"
+            if visible_length(candidate) <= max_width
+              lines[-1] = candidate
+            else
+              lines << word
+            end
+          end
+          lines
+        end
+
+        def visible_length(text)
+          text.gsub(/\e\[[0-9;]*m/, '').length
+        end
+
+        def option_column_width
+          option_widths = option_groups.values.flatten.map do |key|
+            _, details = options[key]
+            option_flag_string(key, details || {}).length
+          end
+
+          all_widths = option_widths + legacy_flags.keys.map(&:length)
+          all_widths.max + GAP
+        end
+      end
+    end
+  end
+end

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

@@ -1,134 +1,166 @@
-# IDs
-certificate:
-  - Member certificate number
-  - type: string
-    short: c
-id:
-  - Member iMIS ID
-  - type: integer
-    short: i
-record_id:
-  - Specific Record ID
-  - type: integer
-    short: I
-uuid:
-  - Record UUID
-  - type: string
-    short: u
+Subcommands:
+  object:
+    description: Interact with a Business Object
+    value: name
+    legacy_name: 'on'
+    option:
+      - Business Object name
+      - type: string
+        short: O
+  panel:
+    description: Interact with a Panel
+    value: name
+    option:
+      - Panel name
+      - 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
+  mapper:
+    description: Interact with mapped fields
+    option:
+      - Interact with mapped fields
+      - short: M
+  map:
+    description: "Shorthand for `<%= 'mapper -f'.green %>` to access a single mapped field"
+    value: field
+    option:
+      - "Shorthand for <%= '-Mf'.green %> to access a single mapped field"
+      - type: string
+        short: m
+  business-objects:
+    description: List available Business Objects
+    option:
+      - List available Business Objects
+      - short: B
+  auth-token:
+    description: Return an auth token for other language wrappers
+    option:
+      - Return an auth token for other language wrappers
+      - short: T
 
-# Primary interactions
-'on':
-  - Business Object name
-  - type: string
-    short: O
-panel:
-  - Panel name
-  - type: string
-    short: P
-query:
-  - IQA Query or Business Object name to query
-  - type: string
-    short: Q
-mapper:
-  - Interact with mapped fields
-  - short: M
-map:
-  - "Shorthand for <%= '-Mf'.green %> to access a single mapped field"
-  - type: string
-    short: m
-business_objects:
-  - List available Business Objects
-  - short: B
+Options:
+  Identity:
+    certificate:
+      - Member certificate number
+      - type: string
+        short: c
+    id:
+      - Member iMIS ID
+      - type: integer
+        short: i
+    record_id:
+      - Specific Record ID
+      - type: integer
+        short: I
+    uuid:
+      - Record UUID
+      - type: string
+        short: u
 
-# Alternate verbs
-create:
-  - "Send a <%= 'POST'.cyan %> request"
-  - short: C
-delete:
-  - "Send a <%= 'DELETE'.cyan %> request"
-  - short: D
+  Business Object or Panel:
+    create:
+      - "Send a <%= 'POST'.cyan %> request"
+      - short: C
+    delete:
+      - "Send a <%= 'DELETE'.cyan %> request"
+      - short: D
+    all:
+      - "Send a <%= 'GET'.cyan %> request for all records for a member"
+      - short: A
 
-# Data
-ordinal:
-  - Ordinal ID within a Panel
-  - type: integer
-    short: r
-field:
-  - Specific field to return or update
-  - type: string
-    short: f
-fields:
-  - Specific field(s) to return
-  - type: strings
-    short: F
-data:
-  - "JSON string input -- <%= 'STDIN'.red %> takes priority"
-  - type: string
-    short: d
+  Panel:
+    ordinal:
+      - Ordinal ID within a Panel
+      - type: integer
+        short: r
 
-# Query params
-page:
-  - Specific page number from a query to return
-  - type: integer
-    short: p
-page_size:
-  - Maximum number of records to include on a single page (max 500)
-  - type: integer
-    default: 100
-    short: -s
-offset:
-  - Number of records to skip from the beginning of a query
-  - type: integer
-    short: -o
+  Query:
+    page:
+      - Specific page number from a query to return
+      - type: integer
+        short: p
+    page_size:
+      - Maximum number of records to include on a single page
+      - type: integer
+        default: 100
+        max: 500
+        short: s
+    offset:
+      - Number of records to skip from the beginning of a query
+      - type: integer
+        short: o
 
-# Output formats
-raw:
-  - Return raw JSON output, rather than simplified data
-  - short: R
-jsonl:
-  - Format array output as JSONL
-  - short: j
-csv:
-  - Format output as CSV (if possible)
-  - short: S
+  Data Input:
+    field:
+      - Specific field to return or update
+      - type: string
+        short: f
+    fields:
+      - Specific field(s) to return
+      - type: strings
+        short: F
+    data:
+      - "JSON string input -- <%= 'STDIN'.red %> takes priority"
+      - type: string
+        short: d
 
-# General config
-config:
-  - "Path to the JSON/YAML config file to use, or one of the following preset options: \
-    `<%= 'local_dot'.yellow %>`, \
-    `<%= 'local'.yellow %>`, \
-    `<%= 'local_dot_config'.yellow %>`, \
-    `<%= 'local_config'.yellow %>`, \
-    `<%= 'user'.yellow %>`, \
-    `<%= 'system'.yellow %>`. \
-    If no option is provided, the first matching preset option will be automatically used."
-  - type: string
-    short: Y
-show_config:
-  - Return the active config file path
-  - short: X
-include_ids:
-  - "Include any <%= 'iMIS ID'.yellow %> and <%= 'Ordinal'.yellow %> properties in returned data"
-  - short: N
+  Output Format:
+    raw:
+      - Return raw JSON output, rather than simplified data
+      - short: R
+    jsonl:
+      - Format array output as JSONL
+      - short: j
+    csv:
+      - Format output as CSV (if possible)
+      - short: S
 
-# Interactions for supporting other language wrappers
-auth_token:
-  - Return an auth token for other language wrappers
-  - short: T
-token:
-  - Provide an existing auth token
-  - type: string
-    short: t
+  Configuration:
+    config:
+      - "Path to the JSON/YAML config file to use, or one of the following preset options:\
+        \n`<%= 'local_dot'.yellow %>`, \
+        `<%= 'local'.yellow %>`, \
+        `<%= 'local_dot_config'.yellow %>`, \
+        `<%= 'local_config'.yellow %>`, \
+        `<%= 'user'.yellow %>`, \
+        `<%= 'system'.yellow %>`\
+        \nIf no option is provided, the first matching preset option will be automatically used."
+      - type: string
+        short: Y
+    show_config:
+      - Return the active config file path
+      - short: X
+    include_ids:
+      - "Include any <%= 'iMIS ID'.yellow %> and <%= 'Ordinal'.yellow %> properties in returned data"
+      - short: N
+    token:
+      - Provide an existing auth token
+      - type: string
+        short: t
 
-# Logging
-quiet:
-  - "Suppress logging to <%= 'STDERR'.red %>"
-  - short: q
-log:
-  - "Redirect logging to <%= 'STDOUT'.red %>"
-  - short: l
-log_level:
-  - Set the logging level
-  - type: string
-    default: info
-    short: L
+  Logging:
+    quiet:
+      - "Suppress logging to <%= 'STDERR'.red %>"
+      - short: q
+    log:
+      - "Redirect logging to <%= 'STDOUT'.red %>"
+      - short: l
+    log_level:
+      - Set the logging level
+      - type: string
+        default: info
+        short: L
+
+  Misc:
+    version:
+      - Print version and exit
+      - short: v
+    help:
+      - Show this message
+      - short: h

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

@@ -6,12 +6,15 @@ module Usps
       # Command line options parser
       #
       class OptionsParser
+        extend OptionsParserConfig
+        extend Help
+
         SOLO_FLAGS = %i[show_config auth_token business_objects].freeze
         QUERY_FLAGS = %i[query page page_size offset].freeze
         CONFLICTING_OPTION_GROUPS = [
           %i[certificate id uuid],
-          %i[record_id uuid],
-          %i[on panel query mapper map] + SOLO_FLAGS,
+          %i[certificate record_id uuid],
+          %i[object panel query mapper map] + SOLO_FLAGS,
           %i[field fields map query],
           %i[raw include_ids],
           %i[raw jsonl csv],
@@ -25,71 +28,56 @@ module Usps
 
           *(SOLO_FLAGS + QUERY_FLAGS + %i[mapper map field fields certificate]).map { [:create, it] },
           *(SOLO_FLAGS + QUERY_FLAGS + %i[mapper map field fields certificate data raw]).map { [:delete, it] },
-          *(SOLO_FLAGS + QUERY_FLAGS + %i[mapper map on]).map { [:ordinal, it] },
+          *(SOLO_FLAGS + QUERY_FLAGS + %i[mapper map object]).map { [:ordinal, it] },
           *(SOLO_FLAGS + %i[certificate]).map { [:data, it] }
         ].freeze
 
-        attr_reader :arguments, :options
-
-        def self.options
-          return @options if @options
-
-          raw_yaml_erb = File.read("#{File.dirname(__FILE__)}/options.yml.erb")
-          rendered_yaml = ERB.new(raw_yaml_erb).result.gsub("\x1b", '\u001b')
-          options = YAML.safe_load(rendered_yaml)
-
-          @options = options.transform_keys(&:to_sym).transform_values do |description, details|
-            next [description] if details.nil?
-
-            details = details.transform_keys(&:to_sym).each_with_object({}) do |(key, value), hash|
-              hash[key] = key == :default ? value : value.to_sym
-            end
-
-            [description, details]
-          end
-        end
+        attr_reader :options
 
-        def self.banner_header(version)
-          <<~BANNER
-            #{version.bold.blue}
-            #{'P/R/C Julian Fiander, SN'.gray}\n \n
-          BANNER
+        # Render the custom help page and exit
+        #
+        # :nocov:
+        def self.help
+          IO.popen('less -R', 'w') { it.puts custom_help }
+          exit 0
         end
+        # :nocov:
 
-        def self.banner_contents
-          <<~BANNER
-            #{'Usage'.underline}
-
-              #{'imis'.bold} #{'[options]'.gray}
-
-
-            #{'Further Help'.underline}
+        # Pre-process ARGV to convert subcommands and legacy aliases to current flags
+        #
+        def self.preprocess_argv!
+          return if ARGV.empty?
 
-              For an explanation of how to provide API configuration, more details on the options,
-              and usage examples, please refer to the wiki:
+          ARGV.map! do |arg|
+            flag, value = arg.split('=', 2)
+            next arg unless legacy_aliases.key?(flag)
 
-              https://github.com/unitedstatespowersquadrons/imis-api-ruby/wiki/Command-Line
+            [legacy_aliases[flag], value].compact.join('=')
+          end
 
+          return unless (subcommand = subcommands[ARGV[0]])
 
-            #{'Options'.underline}
-          BANNER
+          name = ARGV.shift
+          value = ARGV.shift if subcommand[:value]
+          ARGV.unshift("--#{name}", *[value].compact)
         end
 
         def initialize
+          self.class.preprocess_argv!
+
+          # Manually render help page before parsing options, to override the default behavior
+          #
+          # :nocov:
+          self.class.help if ARGV.delete('-h') || ARGV.delete('--help')
+          # :nocov:
+
           @options = parse_options.compact
-          @arguments = ARGV # Not currently used
 
           # Set the default behavior to --help instead of --version
           #
-          # Passing any subcommands as arguments will cause this conditional to fail
-          #
-          # If this is disabled:
-          #
-          #   - The default behavior is to print just the version label to the terminal
-          #   - CommandLine::Performers#perform! *must* expect a `version:` pattern,
-          #     and will return a quoted string of the version label
-          #
-          Optimist.educate if ARGV.empty? && defaults?
+          # :nocov:
+          self.class.help if ARGV.empty? && defaults?
+          # :nocov:
 
           pre_process_options!
         end
@@ -130,15 +118,24 @@ module Usps
           @options[:data] = JSON.parse(@options[:data]) if @options[:data]
 
           validate_query_options!
-
-          raise Errors::CommandLineError, 'Maximum page size is 500' if @options[:page_size] > 500
+          validate_max_values!
 
           @options[:offset] = (@options[:page] - 1) * @options[:page_size] if @options[:page]
 
-          # Support shorthand for setting `certificate` param on queries
-          return unless @options[:query] && @options[:certificate]
+          set_shorthand_query_data if @options[:query]
+        end
 
-          @options[:data] = { 'certificate' => @options.delete(:certificate) }
+        # Support shorthand for setting identity param on queries
+        #
+        # Doesn't currently support record_id
+        #
+        def set_shorthand_query_data
+          case @options
+          in id: _ then @options[:data] = { 'id' => @options.delete(:id) }
+          in certificate: _ then @options[:data] = { 'certificate' => @options.delete(:certificate) }
+          in uuid: _ then @options[:data] = { 'id' => @options.delete(:uuid) }
+          else # Do nothing
+          end
         end
 
         def validate_query_options!
@@ -147,6 +144,14 @@ module Usps
 
           Optimist.die(:query, "must be provided if any of --#{query_options.join(', --').gsub('_', '-')} are provided")
         end
+
+        def validate_max_values!
+          self.class.options.each do |option, (_, details)|
+            next unless details&.key?(:max) && @options[option] > details[:max]
+
+            Optimist.die(option, "must be at most #{details[:max]}")
+          end
+        end
       end
     end
   end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    module CommandLine
+      # Command line options parser config loading and processing
+      #
+      # @private
+      #
+      module OptionsParserConfig
+        def subcommands
+          @subcommands ||= yaml['Subcommands'].transform_values { it.transform_keys(&:to_sym) }
+        end
+
+        def option_groups
+          @option_groups ||= yaml['Options'].transform_values { it.keys.map(&:to_sym) }
+        end
+
+        def options
+          @options ||= merged_options.transform_keys(&:to_sym).transform_values do |description, details|
+            [
+              description,
+              details.transform_keys(&:to_sym).each_with_object({}) do |(key, value), hash|
+                hash[key] = %i[type short].include?(key) ? value.to_sym : value
+              end
+            ]
+          end
+        end
+
+        def legacy_aliases
+          @legacy_aliases ||= subcommands.each_with_object({}) do |(name, details), aliases|
+            next unless details[:legacy_name]
+
+            aliases["--#{details[:legacy_name]}"] = "--#{name}"
+          end
+        end
+
+        def legacy_flags
+          @legacy_flags ||= subcommands.to_h do |name, details|
+            flag_name = details[:legacy_name] || name.tr('-', '_')
+            option_key = name.tr('-', '_').to_sym
+            _, option_details = options[option_key]
+
+            display = option_flag_string(flag_name.to_sym, option_details || {})
+            replacement = ["imis #{name}".bold, details[:value] && "<#{details[:value]}>".gray].compact.join(' ')
+
+            [display, replacement]
+          end
+        end
+
+      private
+
+        def yaml
+          return @yaml if @yaml
+
+          raw_yaml_erb = File.read("#{File.dirname(__FILE__)}/options.yml.erb")
+          rendered_yaml = ERB.new(raw_yaml_erb).result.gsub("\x1b", '\u001b')
+          @yaml = YAML.safe_load(rendered_yaml)
+        end
+
+        def merged_options
+          subcommand_options = subcommands.transform_values { it[:option] }.transform_keys { it.gsub('-', '_') }
+          yaml['Options'].values.inject(:merge).merge(subcommand_options)
+        end
+      end
+    end
+  end
+end

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

@@ -13,7 +13,7 @@ module Usps
         def perform!
           case convert(options)
           in mapper:, **extra then perform_mapper(mapper, **extra)
-          in on:, **extra then perform_on(on, **extra)
+          in object:, **extra then perform_object(object, **extra)
           in panel:, **extra then perform_panel(panel, **extra)
           in query:, **extra then perform_query(query, **extra)
           in business_objects: true then api.business_objects
@@ -31,7 +31,7 @@ module Usps
             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 object: then converted[:object] = api.on(object)
             in panel: then converted[:panel] = api.panels.public_send(panel)
             else # Nothing to convert
             end
@@ -50,15 +50,16 @@ module Usps
           end
         end
 
-        def perform_on(on, **options)
+        def perform_object(object, **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
+          in delete: true then object.delete
+          in create: true, data: then object.post(data)
+          in all: true then object.list
+          in data:, field: then object.put_field(field, data)
+          in data: then object.put_fields(data)
+          in fields: then object.get_fields(*fields)
+          in field: then object.get_field(field)
+          else object.get
           end
         end
 
@@ -66,6 +67,7 @@ module Usps
           case options
           in delete: true, ordinal: then panel.delete(ordinal)
           in create: true, data: then panel.post(data)
+          in all: true then panel.list
           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)

data/lib/usps/imis/command_line.rb

@@ -13,5 +13,7 @@ module Usps
   end
 end
 
+require_relative 'command_line/options_parser_config'
+require_relative 'command_line/help'
 require_relative 'command_line/options_parser'
 require_relative 'command_line/interface'

data/lib/usps/imis/logger_formatter.rb

@@ -11,7 +11,7 @@ module Usps
         log_chunks = [
           format('%-5s', severity.to_s),
           "[#{$PROCESS_ID}]",
-          "[#{time.strftime('%Y-%m-%d %H:%M:%S %Z')}]",
+          "[#{time.iso8601(6)}]",
           'iMIS Ruby API',
           '|',
           formatted_tags,

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

@@ -21,6 +21,17 @@ module Usps
           @logger = Imis.logger('Panel')
         end
 
+        # Run a query on the entire business object
+        #
+        # @return [Usps::Imis::Query] Query wrapper
+        #
+        def query(**) = api.query(business_object_name, **)
+
+        # Get all records from the Panel for the current member
+        #
+        def get_all(**) = query(**, id: api.imis_id).to_a
+        alias list get_all
+
         # Get a specific object from the Panel
         #
         # If +fields+ is provided, will return only those field values

data/lib/usps/imis/query.rb

@@ -88,7 +88,7 @@ module Usps
 
       # Fetch a filtered query page, and update the current offset
       #
-      def page = fetch_next['Items']['$values'].map { iqa? ? it.except('$type') : Imis::Data[it] }
+      def page = fetch_next['Items']['$values'].map { iqa? ? it.except('$type') : wrap(it) }
 
       # Fetch the next raw query page, and update the current offset
       #
@@ -148,6 +148,8 @@ module Usps
           "#{Imis::BusinessObject::API_PATH}/#{query_name}?#{path_params.to_query}"
         end
       end
+
+      def wrap(data) = query_name == 'Party' ? Imis::PartyData[data] : Imis::Data[data]
     end
   end
 end

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.12.10'
+    VERSION = '0.13.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.12.10
+  version: 0.13.0
 platform: ruby
 authors:
 - Julian Fiander
@@ -95,9 +95,11 @@ files:
 - lib/usps/imis/business_object.rb
 - lib/usps/imis/command_line.rb
 - lib/usps/imis/command_line/formatters.rb
+- lib/usps/imis/command_line/help.rb
 - lib/usps/imis/command_line/interface.rb
 - lib/usps/imis/command_line/options.yml.erb
 - lib/usps/imis/command_line/options_parser.rb
+- lib/usps/imis/command_line/options_parser_config.rb
 - lib/usps/imis/command_line/performers.rb
 - lib/usps/imis/config.rb
 - lib/usps/imis/data.rb