usps-imis-api 0.11.6 → 0.11.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67535b48ce969a401d19d573ba5b1557fac0dfa971dddacf9345a0c1c365486f
-  data.tar.gz: 6c39e4c4f3276f8bd26a317c2c96ebf0be2561998d5b3cfecc3ebdefd27d6328
+  metadata.gz: 5cb250d5dd836f5ca8b2382bcc45e788d57307dc47800337d59ff2976b4c52dd
+  data.tar.gz: 65c492cb9bec04a98be6aa8c5821cda5f3bf28304b91fb9202c13c95ab21ae67
 SHA512:
-  metadata.gz: 4c9fa38439583904701cfbd42aaad35e9b1affae85fb15eaf94237641380462df353aaa25b93ec901e633ef37b8ee88af5e55928cb560a2ec273484fcb79b731
-  data.tar.gz: f321eaf91b434b4bfa15279cab97fbf9d2c7f0d9d54094f6987de69742ea1927d0f5f93bd6206a458316cb99dc02222c7e030780b4a09dfede70d174b34b865d
+  metadata.gz: 764a6555ba593dc6e7b6b159aa741d9866f9981278fc1d4b7820d3a83efaa0ff5ddfff8eb93c7f2d09868853251db89163471582ed4a8f0086809c824823703d
+  data.tar.gz: 949e90aa4c506455184fd162cc75fb6b8a45c8c98b4e3561e3656d2445ca32b5174c6bd14164d51108fb5c69d7275a30a8cb06eda04ee480290eacb77524a6bd

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

@@ -65,9 +65,9 @@ module Usps
         # rubocop:disable Metrics
         def perform!
           case convert(options)
-          in mapper: true, field:, data: then api.mapper[field.to_sym] = data
-          in mapper: true, field: then api.mapper[field.to_sym]
-          in mapper: true, data: then api.mapper.update(data)
+          in mapper:, field:, data: then mapper.put_field(field.to_sym, data)
+          in mapper:, field: then mapper.fetch(field.to_sym)
+          in mapper:, data: then mapper.update(data)
 
           in on:, delete: true then on.delete
           in on:, post: true, data: then on.post(data)
@@ -96,21 +96,31 @@ module Usps
         def convert(options)
           options.dup.tap do |converted|
             case converted
-            in map: then converted.merge!(mapper: true, field: map)
+            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]
-          return data unless data.is_a?(Hash) # Includes Usps::Imis::Data
 
-          data.properties(include_ids: options[:include_ids])
+          # Hash includes Usps::Imis::Data
+          if data.is_a?(Hash)
+            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]) }
+          else
+            data
+          end
         end
 
         # :nocov:
@@ -121,11 +131,13 @@ module Usps
         end
         # :nocov:
 
+        # Supports YAML or JSON config data
+        #
         def configure!
-          json_config = JSON.parse(File.read(options[:config]))
+          config_data = YAML.safe_load_file(options[:config])
 
           Usps::Imis.configure do |config|
-            json_config.each do |key, value|
+            config_data.each do |key, value|
               config.public_send("#{key}=", value)
             end
           end

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

@@ -13,25 +13,42 @@ module Usps
           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 }],
           delete: ["Send a #{'DELETE'.cyan} request", { short: :D }],
           field: ['Specific field to return or update', { type: :string }],
           fields: ['Specific field(s) to return', { type: :strings, short: :F }],
-          map: ['Shorthand for accessing a single mapped field', { type: :string }],
-          mapper: ['Interact with mapped fields', { short: :M }],
-          data: ['JSON string input', { type: :string }],
-          config: ['Path to the JSON config file to use', { type: :string, short: :C }],
+          data: ["JSON string input\n  When present, sets the default HTTP verb to #{'PUT'.cyan}", { type: :string }],
+          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 ID properties in returned data'],
-          quiet: ['Suppress logging to STDERR'],
-          log: ['Redirect logging to STDOUT'],
+          include_ids: ["Include #{'iMIS ID'.yellow} and #{'Ordinal'.yellow} properties in returned data, if present"],
+          quiet: ["Suppress logging to #{'STDERR'.red}"],
+          log: ["Redirect logging to #{'STDOUT'.red}"],
           log_level: ['Set the logging level', { type: :string, default: 'info', short: :L }]
         }.freeze
 
         CONFLICTING_OPTION_GROUPS = [
           %i[certificate id],
           %i[on panel query map],
-          %i[field fields map query]
+          %i[field fields map query],
+          %i[raw include_ids],
+          %i[quiet log_level],
+          %i[quiet log],
+
+          %i[post delete],
+
+          %i[post mapper],
+          %i[post query],
+          %i[post map],
+
+          %i[delete mapper],
+          %i[delete query],
+          %i[delete map]
+        ].freeze
+
+        DEPENDENT_OPTION_PAIRS = [
+          %i[ordinal panel]
         ].freeze
 
         attr_reader :arguments, :options
@@ -56,25 +73,9 @@ module Usps
 
             #{'Configuration'.underline}
 
-              API configuration can be specified in two ways:
-
-
-              With #{'--config'.green}/#{'-C'.green} given the path to a JSON file, e.g.:
-
-              {
-                "imis_id_query_name": "#{'$/IQA_QUERY_NAME'.yellow}",
-                "environment": "#{'development'.yellow}",
-                "username": "#{'USERNAME'.yellow}",
-                "password": "#{'PASSWORD'.yellow}"
-              }
-
-
-              By setting the following environment variables:
+              For an explanation of how to provide API configuration, please refer to the wiki:
 
-              #{'IMIS_ID_QUERY_NAME'.yellow}
-              #{'IMIS_ENVIRONMENT'.yellow}
-              #{'IMIS_USERNAME'.yellow}
-              #{'IMIS_PASSWORD'.yellow}
+              https://github.com/unitedstatespowersquadrons/imis-api-ruby/wiki/Usage#command-line-interface
 
 
             #{'Options'.underline}
@@ -103,6 +104,7 @@ module Usps
 
             OPTIONS.each { |option, data| opt(option, *data) }
             CONFLICTING_OPTION_GROUPS.each { |group| conflicts(*group) }
+            DEPENDENT_OPTION_PAIRS.each { |pair| depends(*pair) }
 
             educate_on_error
           end

data/lib/usps/imis/query.rb

@@ -52,7 +52,6 @@ module Usps
         @api = api
         @query_name = query_name
         @query_params = query_params
-        @query_params.merge!(QueryName: query_name) if iqa?
         @page_size = page_size
         @offset = offset
         @count = 0
@@ -137,10 +136,16 @@ module Usps
       def iqa? = query_name.match?(/^\$/)
       def query_type = iqa? ? :IQA : :'Business Object'
       def path_params = query_params.merge({ Offset: offset, Limit: page_size }.compact)
-      def endpoint = iqa? ? IQA_PATH : "#{Imis::BusinessObject::API_PATH}/#{query_name}"
-      def path = "#{endpoint}?#{path_params.to_query}"
       def uri = URI(File.join(Imis.configuration.hostname, path))
 
+      def path
+        if iqa?
+          "#{IQA_PATH}?#{path_params.merge(QueryName: query_name).to_query}"
+        else
+          "#{Imis::BusinessObject::API_PATH}/#{query_name}?#{path_params.to_query}"
+        end
+      end
+
       def logger = Imis.logger("#{query_type} Query")
     end
   end

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.11.6'
+    VERSION = '0.11.8'
   end
 end

data/lib/usps/imis.rb

@@ -4,6 +4,7 @@
 # Core dependencies
 require 'net/https'
 require 'json'
+require 'yaml'
 require 'time'
 require 'cgi'
 

metadata

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