usps-imis-api 0.11.18 → 0.11.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76cd84893c77f63cfa3e49c3442a646898ffa3f900a4013c017598099fd9aec5
-  data.tar.gz: 86d849a56392e78764036c132b10ebf68515b6647fbf6a9c4cdc394e01cfbe5d
+  metadata.gz: 1b704d2eaa3bdb496f4e575b19fff48a0a8d61bb14033ac92ee56910772e72fc
+  data.tar.gz: f2772a7590150c7f342530e2d008d773680abac4372625f226b512bd3357c8c1
 SHA512:
-  metadata.gz: 005bccd46409ddfa00899ab7709c1a60ce3576ea856f601f588dcfb9baa0163ca256ae193c51a103cff15db696a2c98b9b048359708ce5e168f98aeb8d6f5acc
-  data.tar.gz: 758d22069c2d8a72cb540ed3aea7db0be5bb6d472f9100db26d19116f65ddd7bb1c60ba927cfc78f72469af65f68e2f7a2e4fd053f1d381517493b59e9feffcb
+  metadata.gz: ea13f8318a6f0424158973f42eff29903b556764f4fb94e85d415f68109a09593f19acd6e9f9db9350b6a6c25f2f6bfb7ae12848501b32048a8063ce47fc0678
+  data.tar.gz: 20f05f14c38428f0c33d055df86bbb47263e7aebef7478b13eee5e6ad5f93c949b46921bf5f34792e9dd4add55f5ec43783ad4b941f83d73015bbc9989453cf0

data/lib/usps/imis/api.rb

@@ -38,6 +38,17 @@ module Usps
       #
       attr_reader :logger
 
+      # Create a new instance of +Api+ and provide an existing auth token
+      #
+      # @param token [String] Auth token
+      #
+      def self.with_token(token)
+        new.tap do |api|
+          api.instance_variable_set(:@token, token)
+          api.instance_variable_set(:@token_expiration, Time.now + 3600) # Greater than the actual lifetime of the token
+        end
+      end
+
       # A new instance of +Api+
       #
       # @param imis_id [Integer, String] iMIS ID to select immediately on initialization
@@ -45,6 +56,7 @@ module Usps
       def initialize(imis_id: nil)
         self.imis_id = imis_id if imis_id
         @logger ||= Imis.logger('Api')
+        Imis.config.validate!
       end
 
       # Manually set the current ID, if you already have it for a given member
@@ -190,6 +202,14 @@ module Usps
         @panels ||= Panels.all(self)
       end
 
+      # Used by the PHP Wrapper to reduce authentication requests
+      #
+      def auth_token
+        authenticate
+
+        { token: @token, token_expiration: @token_expiration }
+      end
+
       # Ruby 3.5 instance variable filter
       #
       def instance_variables_to_inspect = %i[@token_expiration @imis_id]

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

@@ -8,6 +8,11 @@ module Usps
       class Interface
         NAME = 'USPS iMIS API - Ruby'
 
+        # CLI options that indicate the response is a raw Hash rather than a Data object,
+        # and should not be simplified
+        #
+        RAW_HASH_RESPONSE_OPTIONS = %i[business_objects auth_token].freeze
+
         # Options passed in from the command line
         #
         attr_reader :options
@@ -29,7 +34,7 @@ module Usps
         def run
           logger.info 'Running'
           logger.debug 'CLI Options:'
-          logger.json options
+          logger.json(options.dup.tap { it[:token] = '[FILTERED]' if it[:token] })
 
           set_member
 
@@ -61,7 +66,12 @@ module Usps
         # :nocov:
 
         def api
-          @api ||= Usps::Imis::Api.new
+          @api ||=
+            if options[:token]
+              Usps::Imis::Api.with_token(options[:token])
+            else
+              Usps::Imis::Api.new
+            end
         end
 
         def set_member
@@ -72,7 +82,7 @@ module Usps
             # Query
           end
 
-          logger.debug "iMIS ID: #{api.imis_id}"
+          logger.debug "iMIS ID: #{api.imis_id}" if api.imis_id
         end
 
         # rubocop:disable Metrics
@@ -103,6 +113,10 @@ module Usps
           in query: then api.query(query)
 
           in business_objects: true then api.business_objects
+
+          in auth_token: true then api.auth_token
+
+          in certificate: then api.imis_id
           end
         rescue NoMatchingPatternError => e
           raise Errors::CommandLineError, "Unable to match pattern from options: #{e.message}"
@@ -127,10 +141,10 @@ module Usps
 
         def simplify(data)
           return data.to_a if data.is_a?(Query)
-          return data if options[:raw]
+          return data if options[:raw] || RAW_HASH_RESPONSE_OPTIONS.any? { options[it] }
 
           # Hash includes Usps::Imis::Data
-          if data.is_a?(Hash) && !options[:business_objects]
+          if data.is_a?(Hash)
             logger.debug 'Returning simplified Data#properties'
             data.properties(include_ids: options[:include_ids])
           elsif data.is_a?(Array) && data.all? { it.is_a?(Hash) }

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

@@ -29,6 +29,10 @@ module Usps
           fields: ['Specific field(s) to return', { type: :strings, short: :F }],
           data: ['JSON string input', { type: :string }],
 
+          # Iteractions 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 }],
+
           # 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 }],
@@ -40,7 +44,7 @@ module Usps
 
         CONFLICTING_OPTION_GROUPS = [
           %i[certificate id],
-          %i[on panel query mapper map business_objects],
+          %i[on panel query mapper map business_objects auth_token],
           %i[field fields map query],
           %i[raw include_ids],
           %i[quiet log_level],
@@ -63,11 +67,6 @@ module Usps
           %i[delete raw]
         ].freeze
 
-        DEPENDENT_OPTION_PAIRS = [
-          %i[ordinal panel],
-          %i[create data]
-        ].freeze
-
         attr_reader :arguments, :options
 
         def self.banner_header(version)
@@ -118,7 +117,6 @@ 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/config.rb

@@ -11,6 +11,7 @@ module Usps
     class Config
       IMIS_ROOT_URL_PROD = 'https://portal.americasboatingclub.org'
       IMIS_ROOT_URL_DEV = 'https://abcdev.imiscloud.com'
+      REQUIRED_CONFIGS = %w[imis_id_query_name username password].freeze
 
       attr_accessor :imis_id_query_name, :username, :password
       attr_reader :environment, :logger, :logger_level
@@ -61,6 +62,13 @@ module Usps
       #
       def filtered_parameters = %i[password]
 
+      def validate!
+        missing_config = REQUIRED_CONFIGS.filter_map { it if public_send(it).nil? }
+        return if missing_config.empty?
+
+        raise Errors::ConfigError, "Missing required configuration: #{missing_config.join(', ')}"
+      end
+
     private
 
       def default_environment

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.11.18'
+    VERSION = '0.11.20'
   end
 end

metadata

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