usps-imis-api 0.11.34 → 0.11.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 898b26512f82544ff037e289bfe2466ac375bfa481a0c7ebf77d5d6c2d9ecf96
-  data.tar.gz: 1a01816c119999a2ca2e8b01ae75c83df028a9d2cc1542b174b23a2e49f2877e
+  metadata.gz: 27d14e895f15b3dc94ab5d32f07f52855253b412d0f09e62925ae2833664269e
+  data.tar.gz: 3c2f8d03ae31e1b4372f5ae16047ad09c7401fee5831e62c3f72e2e5517761cd
 SHA512:
-  metadata.gz: 89ff926322610bc6eefaf4aa605d7ecc498d1240f577a39e8a3267ab923d744f6364c73da84afeb65eb8672114d315a043c7a5d3d492b10f788c5734f1be13b4
-  data.tar.gz: 5858b73de1805cc9ee93527964b9220c2bd3c7b91075913103adff9a36994e018f8ac2c40404e80d8afeda314c3e7d4e6ab6e5ea4ba82c12022d67347c3a6bd3
+  metadata.gz: 0f67ef6dd5d2dc56a8fcb982498c7766eb6b6a7ea26e340f7fe358cb88d694e3d1a4c392da59660fd6ddb134bc09c1e9b3394609af7dcf8ba388d203fa33f51a
+  data.tar.gz: a6bf0462662992192b01cac14124b640dd3ccf7ad56637719cf2b71558cdf3198a89df6110b37e16fac56b4aecfd6d0ca4659fef0f598a28774e11bbaf2bd191

data/Readme.md

@@ -6,7 +6,7 @@
 
 Run this command:
 
-```ruby
+```sh
 gem install usps-imis-api
 ```
 
@@ -36,6 +36,7 @@ Usps::Imis.configure do |config|
   # These options will use these defaults
   config.logger = ActiveSupport::TaggedLogging.new(Logger.new($stdout))
   config.logger.level = :info
+  config.global_log_path = '/var/log/imis/imis.log'
 end
 ```
 

data/lib/usps/imis/api.rb

@@ -12,6 +12,8 @@ module Usps
     class Api
       include Requests
 
+      NAME = 'USPS iMIS API - Ruby'
+
       # Endpoint for (re-)authentication requests
       #
       AUTHENTICATION_PATH = 'Token'
@@ -244,6 +246,10 @@ module Usps
         { token: @token, token_expiration: @token_expiration }
       end
 
+      # Name and version of the API
+      #
+      def version = "#{NAME} (v#{Imis::VERSION})"
+
       # Ruby 3.5 instance variable filter
       #
       def instance_variables_to_inspect = %i[@token_expiration @imis_id]

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

@@ -10,7 +10,16 @@ module Usps
       class Interface
         include Performers
 
-        NAME = 'USPS iMIS API - Ruby'
+        # Prioritized list of config file paths to automatically check if not provided
+        #
+        CONFIG_PATHS = {
+          local_dot: File.join(Dir.pwd, '.imis.yml'),
+          local: File.join(Dir.pwd, 'imis.yml'),
+          local_dot_config: File.join(Dir.pwd, '.config', 'imis.yml'),
+          local_config: File.join(Dir.pwd, 'config', 'imis.yml'),
+          user: "#{Dir.home}/.config/imis.yml",
+          system: '/usr/local/imis/config.yml'
+        }.freeze
 
         # CLI options that indicate the response is a raw Hash rather than a Data object,
         # and should not be simplified
@@ -39,7 +48,7 @@ module Usps
           @options = input_options.merge(**)
           options[:version] = true if default_options?
 
-          configure! if options[:config]
+          configure!
           logging!
           @logger ||= Imis.logger('CommandLine')
         end
@@ -111,7 +120,7 @@ module Usps
             # Hash includes Usps::Imis::Data
             logger.debug 'Returning simplified Data#properties'
             data.properties(include_ids: options[:include_ids])
-          elsif data.is_a?(Array) && data.all? { it.is_a?(Hash) }
+          elsif data.is_a?(Array) && data.all?(Hash)
             logger.debug 'Returning simplified Array<Data#properties>'
             data.map { it.properties(include_ids: options[:include_ids]) }
           else
@@ -141,15 +150,26 @@ module Usps
         # Supports YAML or JSON config data
         #
         def configure!
-          config_data = YAML.safe_load_file(options[:config])
+          return if config_path.nil?
+
+          config_data = YAML.safe_load_file(config_path)
 
           Usps::Imis.configure do |config|
-            config_data.each do |key, value|
+            global_log!(config)
+
+            config_data&.each do |key, value|
               config.public_send("#{key}=", value)
             end
           end
         end
 
+        def config_path
+          return @config_path if @config_path
+          return @config_path = CONFIG_PATHS.values.find { File.exist?(it) } if options[:config].nil?
+
+          @config_path = CONFIG_PATHS[options[:config].to_sym] || options[:config]
+        end
+
         def logging!
           Usps::Imis.configure do |config|
             # :nocov:
@@ -166,6 +186,21 @@ module Usps
           end
         end
 
+        def global_log!(config)
+          # :nocov:
+          return if ENV['TESTING']
+
+          time = DateTime.now
+          log_path = [
+            time.year,
+            time.month,
+            time.day,
+            time.strftime('%Y-%m-%dT%H-%M-%S%z')
+          ].join('/')
+          config.global_log_path = "/var/log/imis/cli/#{log_path}.log"
+          # :nocov:
+        end
+
         def default_options? = options[:log_level] == 'info' && options.except(:log_level).values.none?
       end
     end

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

@@ -29,14 +29,24 @@ module Usps
           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', { type: :string }],
+          data: ["JSON string input -- #{'STDIN'.red} takes priority", { 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 }],
+          config: [
+            'Path to the JSON/YAML config file to use, or one of the following preset options: ' \
+            "`#{'local'.yellow}`, " \
+            "`#{'local_dot_config'.yellow}`, " \
+            "`#{'local_config'.yellow}`, " \
+            "`#{'user'.yellow}`, " \
+            "`#{'system'.yellow}`. " \
+            'If no option is provided, the first matching preset option will be automatically used.',
+            { type: :string, short: :C }
+          ],
+          show_config: ['Return the active config file path', { short: :X }],
           raw: ['Return raw JSON output, rather than simplified data', { short: :R }],
           include_ids: ["Include any #{'iMIS ID'.yellow} and #{'Ordinal'.yellow} properties in returned data"],
           jsonl: ['Format array output as JSONL', { short: :j }],
@@ -48,7 +58,7 @@ module Usps
         CONFLICTING_OPTION_GROUPS = [
           %i[certificate id uuid],
           %i[record_id uuid],
-          %i[on panel query mapper map business_objects auth_token],
+          %i[on panel query mapper map business_objects auth_token show_config],
           %i[field fields map query],
           %i[raw include_ids],
           %i[quiet log_level],

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

@@ -19,7 +19,8 @@ module Usps
           in business_objects: true then api.business_objects
           in auth_token: true then api.auth_token
           in certificate: then api.imis_id
-          in version: true then "#{Interface::NAME} (v#{Imis::VERSION})"
+          in show_config: then config_path
+          in version: true then api.version
           end
         rescue NoMatchingPatternError => e
           raise Errors::CommandLineError, "Unable to match pattern from options: #{e.message}"
@@ -36,8 +37,8 @@ module Usps
               # Nothing to convert
             end
 
-            # Remove mapper flag when false
-            converted.delete(:mapper) unless converted[:mapper]
+            # Remove flags when false
+            %i[mapper show_config].each { converted.delete(it) unless converted[it] }
           end
         end
 

data/lib/usps/imis/config.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+
 require_relative 'logger'
 require_relative 'logger_formatter'
 require_relative 'logger_helpers'
@@ -45,6 +47,23 @@ module Usps
         @logger = ActiveSupport::TaggedLogging.new(@base_logger)
       end
 
+      def global_logger
+        return @global_logger if @global_logger
+
+        global_log_path
+        @global_logger
+      end
+
+      def global_log_path
+        @global_log_path || self.global_log_path = '/var/log/imis/imis.log'
+      end
+
+      def global_log_path=(path)
+        @global_log_path = path
+        @global_logger = build_global_logger
+        global_log_path
+      end
+
       def silence!
         self.logger = Logger.new(nil)
       end
@@ -62,7 +81,7 @@ module Usps
 
       # Ruby 3.5 instance variable filter
       #
-      def instance_variables_to_inspect = instance_variables - %i[@password @base_logger @logger]
+      def instance_variables_to_inspect = instance_variables - %i[@password @base_logger @logger @global_logger]
 
       # Parameters to filter out of logging
       #
@@ -82,6 +101,23 @@ module Usps
 
         ActiveSupport::StringInquirer.new(ENV.fetch('IMIS_ENVIRONMENT', 'development'))
       end
+
+      def build_global_logger
+        writable =
+          begin
+            FileUtils.mkdir_p(File.dirname(global_log_path))
+            File.writable?(global_log_path) || File.writable?(File.dirname(global_log_path))
+          rescue StandardError
+            false
+          end
+        return ActiveSupport::TaggedLogging.new(::Logger.new(nil)) unless writable
+
+        ActiveSupport::TaggedLogging.new(
+          ::Logger
+            .new(File.open(global_log_path, 'a'), level: :debug)
+            .tap { it.formatter = LoggerFormatter.new }
+        )
+      end
     end
   end
 end

data/lib/usps/imis/logger.rb

@@ -14,6 +14,15 @@ module Usps
         super
         self.formatter = LoggerFormatter.new
       end
+
+      # Also send logger methods to the global logger
+      #
+      %w[debug info warn error fatal unknown].each do |method|
+        define_method(method) do |message|
+          super(message)
+          Usps::Imis.config.global_logger.tagged(formatter.current_tags).public_send(method, message)
+        end
+      end
     end
   end
 end

data/lib/usps/imis/party_data.rb

@@ -81,7 +81,7 @@ module Usps
 
           if %w[Addresses AlternateIds CommunicationPreferences Emails Salutations].include?(key)
             hash[key] = value.map { format_extracted(it.to_h) }
-          elsif value.all? { it.is_a?(String) }
+          elsif value.all?(String)
             # Do nothing
           else
             hash[key] = format_extracted(value.to_h)

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.11.34'
+    VERSION = '0.11.36'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.11.34
+  version: 0.11.36
 platform: ruby
 authors:
 - Julian Fiander
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.9
 specification_version: 4
 summary: iMIS API Wrapper
 test_files: []