usps-imis-api 0.11.12 → 0.11.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b7dbdde63c0e5541e240df706bd51d2f4db983473a29e3b5db1d4779015893b
-  data.tar.gz: aa80e0a5094e561d3e8a2b64c56c9e18ea4cf93c24a6e3c8729c108d3a639ccf
+  metadata.gz: 44450f01517549462f9d3aa96be347bd194af2ae1b5783f6b850490e00996c1b
+  data.tar.gz: 4f0e3a76e46b7b18c1f2fb6456d49630df2bf61a123f672ac892926db3504abb
 SHA512:
-  metadata.gz: cda6f17fedd33eaed4f347bf0213b4f87ba1d784cd333208a244c84ac6223610363f402bc40348eb2bc4ea770de83d3f63edfa37bd3bcb5d3c4d7454cc064780
-  data.tar.gz: 2124949a5db9853087e076681f76b3e7df609610573026679f2bc89f9403f88cf762ae9be68f2a7f3852d255a9bfcceb3eed02bf0a5b518d5f6b9daaeeec0a84
+  metadata.gz: 7e3c7adbd2000547146095a15a375e330a9a14ec4fd63fdac085d08b36fc3932bd99f3c3c165de8321ad8b55dc7022496e5ab6c672333296fc88d180997e0acc
+  data.tar.gz: 4157ad2c639306c47026fe1a14846515a07a2933cd6f039e5d44887aef7b3e5167d2c0bd5c6bc7f5510e7d25167bbb04a986b42ea5088aa09fbcc114404c5382

data/lib/usps/imis/api.rb

@@ -46,6 +46,8 @@ module Usps
       #
       # @param id [Integer, String] iMIS ID to select for future requests
       #
+      # @return [Integer] iMIS ID
+      #
       def imis_id=(id)
         raise Errors::LockedIdError if lock_imis_id
 
@@ -56,7 +58,7 @@ module Usps
       #
       # @param certificate [String] Certificate number to lookup the corresponding iMIS ID for
       #
-      # @return [String] Corresponding iMIS ID
+      # @return [Integer] Corresponding iMIS ID
       #
       def imis_id_for(certificate)
         raise Errors::LockedIdError if lock_imis_id
@@ -85,6 +87,8 @@ module Usps
       #     update(mm: 15)
       #   end
       #
+      # @return [Usps::Imis::Api]
+      #
       def with(id, &)
         old_id = imis_id
         self.imis_id = id
@@ -117,6 +121,8 @@ module Usps
       # @param business_object_name [String] Name of the business object
       # @param ordinal [Integer] Ordinal to build override ID param of the URL (e.g. used for Panels)
       #
+      # @return [Usps::Imis::BusinessObject]
+      #
       def on(business_object_name, ordinal: nil, &)
         object = BusinessObject.new(self, business_object_name, ordinal:)
         return object unless block_given?
@@ -132,24 +138,34 @@ module Usps
 
       # Convenience alias for reading mapped fields
       #
+      # @return Value of the specified field
+      #
       def fetch(field_key) = mapper.fetch(field_key)
       alias [] fetch
 
       # Convenience alias for reading multiple mapped fields
       #
+      # @return [Array] Values of the specified fields
+      #
       def fetch_all(*fields) = mapper.fetch_all(*fields)
 
       # Convenience alias for updating mapped fields
       #
+      # @return [Array] Array containing the updated object
+      #
       def put_field(field_key, value) = update(field_key => value)
       alias []= put_field
 
       # Convenience alias for updating mapped fields
       #
+      # @return [Usps::Imis::Data] Updated object
+      #
       def update(data) = mapper.update(data)
 
       # List of available Business Object names
       #
+      # @return [Hash<Symbol, Array<String>>] Grouped available Business Objects
+      #
       def business_objects
         abc, other = query('BOEntityDefinition').map(&:entity).partition { it.include?('ABC') }
 

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

@@ -71,7 +71,7 @@ module Usps
           in mapper:, data: then mapper.update(data)
 
           in on:, delete: true then on.delete
-          in on:, post: true, data: then on.post(data)
+          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)
@@ -79,7 +79,7 @@ module Usps
           in on: then on.get
 
           in panel:, delete: true, ordinal: then panel.delete(ordinal)
-          in panel:, post: true, data: then panel.post(data)
+          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)
@@ -88,6 +88,8 @@ module Usps
 
           in query:, data: then api.query(query, data)
           in query: then api.query(query)
+
+          in business_objects: true then api.business_objects
           end
         rescue NoMatchingPatternError => e
           raise Errors::CommandLineError, "Unable to match pattern from options: #{e.message}"
@@ -115,7 +117,7 @@ module Usps
           return data if options[:raw]
 
           # Hash includes Usps::Imis::Data
-          if data.is_a?(Hash)
+          if data.is_a?(Hash) && !options[:business_objects]
             data.properties(include_ids: options[:include_ids])
           elsif data.is_a?(Array) && data.all? { it.is_a?(Hash) }
             data.map { it.properties(include_ids: options[:include_ids]) }

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

@@ -7,22 +7,32 @@ module Usps
       #
       class OptionsParser
         OPTIONS = {
+          # IDs
           certificate: ['Member certificate number', { type: :string }],
           id: ['Member iMIS ID', { type: :integer }],
+
+          # Primary interactions
           on: ['Business Object name', { type: :string }],
           panel: ['Panel name', { type: :string }],
-          ordinal: ['Ordinal ID within a Panel', { type: :integer }],
           query: ['IQA Query or Business Object name to query', { type: :string, short: :Q }],
           mapper: ['Interact with mapped fields', { short: :M }],
-          map: ["Shorthand for accessing a single mapped field\n  Equivalent to #{'-Mf'.green}", { type: :string }],
-          post: ["Send a #{'POST'.cyan} request", { short: :P }],
+          map: ["Shorthand for #{'-Mf'.green} to access a single mapped field", { type: :string }],
+          business_objects: ['List available Business Objects'],
+
+          # Alternate verbs
+          create: ["Send a #{'POST'.cyan} request", { short: :P }],
           delete: ["Send a #{'DELETE'.cyan} request", { short: :D }],
+
+          # Data
+          ordinal: ['Ordinal ID within a Panel', { type: :integer }],
           field: ['Specific field to return or update', { type: :string }],
           fields: ['Specific field(s) to return', { type: :strings, short: :F }],
-          data: ["JSON string input\n  When present, sets the default HTTP verb to #{'PUT'.cyan}", { type: :string }],
+          data: ['JSON string input', { type: :string }],
+
+          # General config
           config: ['Path to the JSON/YAML config file to use', { type: :string, short: :C }],
           raw: ['Return raw JSON output, rather than simplified data', { short: :R }],
-          include_ids: ["Include #{'iMIS ID'.yellow} and #{'Ordinal'.yellow} properties in returned data, if present"],
+          include_ids: ["Include any #{'iMIS ID'.yellow} and #{'Ordinal'.yellow} properties in returned data"],
           quiet: ["Suppress logging to #{'STDERR'.red}"],
           log: ["Redirect logging to #{'STDOUT'.red}"],
           log_level: ['Set the logging level', { type: :string, default: 'info', short: :L }]
@@ -30,25 +40,32 @@ module Usps
 
         CONFLICTING_OPTION_GROUPS = [
           %i[certificate id],
-          %i[on panel query map],
+          %i[on panel query mapper map business_objects],
           %i[field fields map query],
           %i[raw include_ids],
           %i[quiet log_level],
           %i[quiet log],
 
-          %i[post delete],
+          %i[create delete],
 
-          %i[post mapper],
-          %i[post query],
-          %i[post map],
+          %i[create mapper],
+          %i[create query],
+          %i[create map],
+          %i[create field],
+          %i[create fields],
 
           %i[delete mapper],
           %i[delete query],
-          %i[delete map]
+          %i[delete map],
+          %i[delete field],
+          %i[delete fields],
+          %i[delete data],
+          %i[delete raw]
         ].freeze
 
         DEPENDENT_OPTION_PAIRS = [
-          %i[ordinal panel]
+          %i[ordinal panel],
+          %i[create data]
         ].freeze
 
         attr_reader :arguments, :options
@@ -67,20 +84,10 @@ module Usps
               #{'imis.rb'.bold} #{'[options]'.gray}
 
 
-            #{'HTTP Verbs'.underline}
-
-              The default HTTP verb is #{'GET'.cyan}.
-
-              If #{'--data'.green}/#{'-d'.green} is provided, the default HTTP verb is #{'PUT'.cyan}.
-
-              #{'--data'.green}/#{'-d'.green} is used to provide field(s) data for #{'PUT'.cyan}
-              requests and mapper updates, object data for #{'POST'.cyan},
-              and to provide any query params.
-
-
-            #{'Configuration'.underline}
+            #{'Further Help'.underline}
 
-              For an explanation of how to provide API configuration, please refer to the wiki:
+              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
 

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.11.12'
+    VERSION = '0.11.14'
   end
 end

metadata

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