usps-imis-api 0.11.7 → 0.11.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae10bc832e8ffa7cb4bc3bb14f5ea0b2d2daef3866cde32cdaea89bfcfe60376
-  data.tar.gz: 137943c3dce52c4c56bc32e2b2dcb6329e1bd568bb95c653084b299d701ed39e
+  metadata.gz: 626c55f443b00f5c4bcf5fe4e266041157fc0bf961825f42a551e6473f8decc0
+  data.tar.gz: b7e430d604ff0f1ae3db77e8cad1a2cb41851fe0ed3e0d8c90c19782b0e5708d
 SHA512:
-  metadata.gz: 9bfc02dddae6d07ee6fedfcc0a89101415d4af68cab2b90380f199957976dd4d128c2913373b38066a4da76d41fbc0a21bca6dab672032e3e6cd03ade2114547
-  data.tar.gz: f31225ef3c5f2b24a69220d165c42697f052427b27967525678846c8ddd0280a4177ef4f4b388e70a45c033a7e1dda7f6d16ead1d6c9ce786b552c96c6aefdbd
+  metadata.gz: e8c1ec5ef4528680e87878225df3abda47e9892913d250eba1a8495ccde36a9801a78170a3bc211fad0714ac61d6696ba8d4cbe025888fa3a25a307d45a6e595
+  data.tar.gz: 98a8d1c2d38de72f9604b28070ca65144979d271ddacd077a2ce548ca7d8eef0a4fb15ad9d81acde7a63a0e1918ce7f8c354f4dbc6bb83d078a01a290aef9f48

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

@@ -66,7 +66,8 @@ module Usps
         def perform!
           case convert(options)
           in mapper:, field:, data: then mapper.put_field(field.to_sym, data)
-          in mapper:, field: then mapper.fetch(field.to_sym)
+          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
@@ -131,11 +132,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

@@ -20,7 +20,7 @@ module Usps
           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 }],
-          config: ['Path to the JSON config file to use', { type: :string, short: :C }],
+          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"],
           quiet: ["Suppress logging to #{'STDERR'.red}"],
@@ -73,25 +73,9 @@ module Usps
 
             #{'Configuration'.underline}
 
-              API configuration can be specified in two ways:
+              For an explanation of how to provide API configuration, please refer to the wiki:
 
-
-              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:
-
-              #{'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}

data/lib/usps/imis/mapper.rb

@@ -38,13 +38,36 @@ module Usps
       #
       # @return Value of the field
       #
-      def fetch(field_key)
+      def get_field(field_key)
         missing_mapping!(field_key) unless FIELD_MAPPING.key?(field_key.to_sym)
 
         business_object_name, field = FIELD_MAPPING[field_key]
         api.on(business_object_name)[field]
       end
-      alias [] fetch
+      alias fetch get_field
+      alias [] get_field
+
+      # Get specific fields by arbitrary field names
+      #
+      # @param names [Array<String>] Internal name of the fields
+      #
+      # @return [Array] Values of the field
+      #
+      def get_fields(*fields)
+        business_objects = {}
+
+        fields.map do |field_key|
+          business_object_name, field = FIELD_MAPPING[field_key.to_sym]
+
+          business_objects[business_object_name] ||= []
+          business_objects[business_object_name] << field
+        end
+
+        business_objects.flat_map do |business_object_name, fields|
+          api.on(business_object_name).get_fields(*fields)
+        end
+      end
+      alias fetch_all get_fields
 
       # Update a member's data for a specific field by arbitrary field name
       #

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.7'
+    VERSION = '0.11.9'
   end
 end

data/lib/usps/imis.rb

@@ -4,6 +4,7 @@
 # Core dependencies
 require 'net/https'
 require 'json'
+require 'yaml'
 require 'time'
 require 'cgi'
 
@@ -15,6 +16,8 @@ require 'logger'
 require 'active_support/isolated_execution_state' # Fix costant loading issue with TaggedLogging
 require 'active_support/tagged_logging'
 
+require 'dotenv/load'
+
 # Internal requires
 require_relative 'imis/config'
 require_relative 'imis/error'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.11.7
+  version: 0.11.9
 platform: ruby
 authors:
 - Julian Fiander
@@ -23,6 +23,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.4
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement