usps-imis-api 0.11.19 → 0.11.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aea0bbaf9d56d6b87c79ea640e60c796bed4349b9aff10523882fa69b5f8fc5
-  data.tar.gz: a30ff5cd43dc7b0d60b79e7184f9707124e37f315eb8f64588801cf09664f655
+  metadata.gz: 35b16ade1f6397b66b62731eb83a514ef1fa4a1e4ef656f639a153ecb1bbc8a5
+  data.tar.gz: b0b191774bd37dcea2342ff8fa5349a06bfb62de69cb1835316bc522367bbda9
 SHA512:
-  metadata.gz: 93736a5bd1693f879294910ef3908e03fbb002dc271152a636aa76743b9f390ff31f9d8fba054ed4244a27212640dba4e373252aefe80618d41fb897ef456ced
-  data.tar.gz: 8041ac9e86d6e62da036110ca27ecb3f57709039d9770d2317d710817b40f2a5ff80568bc0611846c675b292e423827031cd4f4c14b9cb00a5b7553bced490d0
+  metadata.gz: 7604ac9a7672a37fa47cd6d5585d54e54f2a5bcf8853fb4200ceb54c20db0c24e16b5036f94ced091fa9523cf2157934bb840c6f171ec4b567113f50f1423ea3
+  data.tar.gz: cc021585df733a3dc596cbd54486655b297290665128b1f4fa362976e9274d2b4b572ae88417f3fd17f9cd33a3352e62a64726e9c9357e1801629be93c150b94

data/Readme.md

@@ -82,5 +82,7 @@ file to [rubygems.org](https://rubygems.org).
 
 ## PHP
 
-This same API is
-[available for PHP](https://github.com/unitedstatespowersquadrons/imis-api).
+A wrapper for the CLI from this API is
+[available for PHP](https://github.com/unitedstatespowersquadrons/imis-api-php).
+
+You can also view the [original PHP API](https://github.com/unitedstatespowersquadrons/imis-api).

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
@@ -191,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/logger_formatter.rb

@@ -5,6 +5,8 @@ module Usps
     # Formats log statements
     #
     class LoggerFormatter < ::Logger::Formatter
+      include ::ActiveSupport::TaggedLogging::Formatter
+
       def call(severity, time, _progname, message)
         log_chunks = [
           format('%-5s', severity.to_s),
@@ -14,7 +16,7 @@ module Usps
           '|',
           formatted_tags,
           '|',
-          message.sub(/^#{Regexp.escape(tags_text)}/, '')
+          message.to_s.sub(/^#{Regexp.escape(tags_text)}/, '')
         ]
         "#{log_chunks.join(' ')}\n"
       end

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.11.19'
+    VERSION = '0.11.21'
   end
 end

metadata

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