usps-imis-api 0.11.16 → 0.11.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6437192db35a0e8a3e80d44d338366c9460060dc7b13d8f53a17c0d0c7ed8b8
-  data.tar.gz: 4c4ad6121f1f282e3788e311e78be6d753b56c04f8112a3ac6a23c808e198ca2
+  metadata.gz: 76cd84893c77f63cfa3e49c3442a646898ffa3f900a4013c017598099fd9aec5
+  data.tar.gz: 86d849a56392e78764036c132b10ebf68515b6647fbf6a9c4cdc394e01cfbe5d
 SHA512:
-  metadata.gz: 5aa9c0cac48c98eb3826c107e9db3a471689c6e30cc3d7fbce138db24f0c01128440b4e1fcc8b46bd3e96bd002ce0f4ce2136e9d678b60023af5b66330e55ceb
-  data.tar.gz: 8fa27434be1d69626b27653189636c4daeb1739407752d24a977314c70ac09029ab624f618c007a78669f8f8d8875b8a63646cb22e894ad87cd62a5c3fbeae20
+  metadata.gz: 005bccd46409ddfa00899ab7709c1a60ce3576ea856f601f588dcfb9baa0163ca256ae193c51a103cff15db696a2c98b9b048359708ce5e168f98aeb8d6f5acc
+  data.tar.gz: 758d22069c2d8a72cb540ed3aea7db0be5bb6d472f9100db26d19116f65ddd7bb1c60ba927cfc78f72469af65f68e2f7a2e4fd053f1d381517493b59e9feffcb

data/lib/usps/imis/api.rb

@@ -34,12 +34,17 @@ module Usps
       #
       attr_reader :lock_imis_id
 
+      # Tagged logger
+      #
+      attr_reader :logger
+
       # A new instance of +Api+
       #
       # @param imis_id [Integer, String] iMIS ID to select immediately on initialization
       #
       def initialize(imis_id: nil)
         self.imis_id = imis_id if imis_id
+        @logger ||= Imis.logger('Api')
       end
 
       # Manually set the current ID, if you already have it for a given member
@@ -66,8 +71,8 @@ module Usps
         logger.debug "Fetching iMIS ID for #{certificate}"
 
         begin
-          result = query(Imis.configuration.imis_id_query_name, { certificate: }).tap { logger.debug it }
-          page = result.page.tap { logger.debug it }
+          result = query(Imis.configuration.imis_id_query_name, { certificate: })
+          page = result.page.tap { logger.tagged('Response').debug it }
           self.imis_id = page.first['ID'].to_i
         rescue StandardError
           raise Errors::NotFoundError, 'Member not found'
@@ -191,21 +196,23 @@ module Usps
 
     private
 
-      def logger = Imis.logger('Api')
-
       # Authenticate to the iMIS API, and store the access token and expiration time
       #
       def authenticate
-        logger.debug 'Authenticating with iMIS'
-
-        request = http_post
-        request.body = URI.encode_www_form(
-          grant_type: 'password',
-          username: Imis.configuration.username,
-          password: Imis.configuration.password
-        )
-        result = submit(uri, request)
-        json = JSON.parse(result.body)
+        json = nil # Scope
+
+        logger.tagged('Auth') do
+          logger.info 'Authenticating with iMIS'
+
+          request = http_post
+          request.body = URI.encode_www_form(
+            grant_type: 'password',
+            username: Imis.configuration.username,
+            password: Imis.configuration.password
+          )
+          result = submit(uri, request)
+          json = JSON.parse(result.body)
+        end
 
         @token = json['access_token']
         @token_expiration = Time.now + json['expires_in'] - 60

data/lib/usps/imis/business_object.rb

@@ -25,12 +25,17 @@ module Usps
       #
       attr_reader :ordinal
 
+      # Tagged logger
+      #
+      attr_reader :logger
+
       # A new instance of +BusinessObject+
       #
       def initialize(api, business_object_name, ordinal: nil)
         @api = api
         @business_object_name = business_object_name
         @ordinal = ordinal
+        @logger ||= Imis.logger('BusinessObject')
       end
 
       # Run a query on the entire business object
@@ -132,12 +137,10 @@ module Usps
 
       # Ruby 3.5 instance variable filter
       #
-      def instance_variables_to_inspect = instance_variables - %i[@api]
+      def instance_variables_to_inspect = instance_variables - %i[@api @logger]
 
     private
 
-      def logger = Imis.logger('BusinessObject')
-
       # Construct a business object API endpoint address
       #
       def uri(id: nil)
@@ -186,7 +189,7 @@ module Usps
 
         response = submit(uri, authorize(http_get))
         result = Data.from_json(response.body)
-        JSON.pretty_generate(result).split("\n").each { logger.debug "    -> #{it}" }
+        logger.json result
         result
       end
 
@@ -198,7 +201,7 @@ module Usps
         request.body = JSON.dump(body)
         response = submit(uri, authorize(request))
         result = Data.from_json(response.body)
-        JSON.pretty_generate(result).split("\n").each { logger.debug "    -> #{it}" }
+        logger.json result
         result
       end
     end

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

@@ -8,8 +8,14 @@ module Usps
       class Interface
         NAME = 'USPS iMIS API - Ruby'
 
+        # Options passed in from the command line
+        #
         attr_reader :options
 
+        # Tagged logger
+        #
+        attr_reader :logger
+
         def self.run(...) = new(...).run
 
         def initialize(**)
@@ -17,9 +23,14 @@ module Usps
           validate_options!
           configure! if options[:config]
           logging!
+          @logger ||= Imis.logger('CommandLine')
         end
 
         def run
+          logger.info 'Running'
+          logger.debug 'CLI Options:'
+          logger.json options
+
           set_member
 
           result = simplify(perform!)
@@ -60,6 +71,8 @@ module Usps
           else
             # Query
           end
+
+          logger.debug "iMIS ID: #{api.imis_id}"
         end
 
         # rubocop:disable Metrics
@@ -118,8 +131,10 @@ module Usps
 
           # Hash includes Usps::Imis::Data
           if data.is_a?(Hash) && !options[:business_objects]
+            logger.debug 'Returning simplified Data#properties'
             data.properties(include_ids: options[:include_ids])
           elsif data.is_a?(Array) && data.all? { it.is_a?(Hash) }
+            logger.debug 'Returning simplified Array<Data#properties>'
             data.map { it.properties(include_ids: options[:include_ids]) }
           else
             data
@@ -128,7 +143,10 @@ module Usps
 
         # :nocov:
         def output(&block)
-          return if ENV.fetch('SUPPRESS_OUTPUT', false)
+          if ENV.fetch('SUPPRESS_OUTPUT', false)
+            logger.debug 'Output suppressed'
+            return
+          end
 
           puts JSON.dump(block.call) if block_given?
         end

data/lib/usps/imis/config.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require_relative 'logger'
+require_relative 'logger_formatter'
+require_relative 'logger_helpers'
+
 module Usps
   module Imis
     # API Configuration
@@ -16,7 +20,8 @@ module Usps
         @imis_id_query_name = ENV.fetch('IMIS_ID_QUERY_NAME', nil)
         @username = ENV.fetch('IMIS_USERNAME', nil)
         @password = ENV.fetch('IMIS_PASSWORD', nil)
-        @logger = ActiveSupport::TaggedLogging.new(Logger.new($stdout, level: :info))
+        @base_logger = Logger.new($stdout, level: :info)
+        @logger = ActiveSupport::TaggedLogging.new(@base_logger)
 
         yield self if block_given?
 
@@ -28,7 +33,9 @@ module Usps
       end
 
       def logger=(logger)
-        @logger = ActiveSupport::TaggedLogging.new(logger)
+        @base_logger = logger.tap { it.formatter = LoggerFormatter.new }
+        @base_logger.singleton_class.include(LoggerHelpers)
+        @logger = ActiveSupport::TaggedLogging.new(@base_logger)
       end
 
       def silence!
@@ -48,7 +55,7 @@ module Usps
 
       # Ruby 3.5 instance variable filter
       #
-      def instance_variables_to_inspect = instance_variables - %i[@password @logger]
+      def instance_variables_to_inspect = instance_variables - %i[@password @base_logger @logger]
 
       # Parameters to filter out of logging
       #

data/lib/usps/imis/logger.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'logger_formatter'
+require_relative 'logger_helpers'
+
+module Usps
+  module Imis
+    # Formatted logger with additional helpers
+    #
+    class Logger < ::Logger
+      include LoggerHelpers
+
+      def initialize(...)
+        super
+        self.formatter = LoggerFormatter.new
+      end
+    end
+  end
+end

data/lib/usps/imis/logger_formatter.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    # Formats log statements
+    #
+    class LoggerFormatter < ::Logger::Formatter
+      def call(severity, time, _progname, message)
+        log_chunks = [
+          format('%-5s', severity.to_s),
+          "[#{$PROCESS_ID}]",
+          "[#{time.strftime('%Y-%m-%d %H:%M:%S %Z')}]",
+          'iMIS Ruby API',
+          '|',
+          formatted_tags,
+          '|',
+          message.sub(/^#{Regexp.escape(tags_text)}/, '')
+        ]
+        "#{log_chunks.join(' ')}\n"
+      end
+
+    private
+
+      def formatted_tags
+        tags = current_tags || []
+        tags&.any? ? tags.join(' | ') : ''
+      end
+    end
+  end
+end

data/lib/usps/imis/logger_helpers.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    # Formatted logger helpers
+    #
+    module LoggerHelpers
+      def multiline(string)
+        string.split("\n").each { |line| debug(line) }
+      end
+
+      def json(data)
+        tagged('JSON') { multiline(JSON.pretty_generate(data)) }
+      end
+    end
+  end
+end

data/lib/usps/imis/mapper.rb

@@ -21,11 +21,16 @@ module Usps
       #
       attr_reader :api
 
+      # Tagged logger
+      #
+      attr_reader :logger
+
       # A new instance of +Mapper+
       #
       def initialize(api = nil, imis_id: nil)
         @api = api || Api.new
         @api.imis_id = imis_id if imis_id
+        @logger ||= Imis.logger('Mapper')
       end
 
       # Get a member's data for a specific field by arbitrary field name
@@ -107,12 +112,10 @@ module Usps
 
       # Ruby 3.5 instance variable filter
       #
-      def instance_variables_to_inspect = instance_variables - %i[@api]
+      def instance_variables_to_inspect = instance_variables - %i[@api @logger]
 
     private
 
-      def logger = Imis.logger('Mapper')
-
       def map_update(field_key)
         missing_mapping!(field_key) unless FIELD_MAPPING.key?(field_key.to_sym)
 

data/lib/usps/imis/panels/base_panel.rb

@@ -10,9 +10,14 @@ module Usps
         #
         attr_reader :api
 
+        # Tagged logger
+        #
+        attr_reader :logger
+
         def initialize(api = nil, imis_id: nil)
           @api = api || Api.new
           @api.imis_id = imis_id if imis_id
+          @logger ||= Imis.logger('Panel')
         end
 
         # Get a specific object from the Panel
@@ -100,12 +105,10 @@ module Usps
 
         # Ruby 3.5 instance variable filter
         #
-        def instance_variables_to_inspect = instance_variables - %i[@api]
+        def instance_variables_to_inspect = instance_variables - %i[@api @logger]
 
       private
 
-        def logger = Imis.logger('Panel')
-
         def business_object
           raise Errors::PanelUnimplementedError.from(self.class.name, 'business_object')
         end

data/lib/usps/imis/query.rb

@@ -40,6 +40,10 @@ module Usps
       #
       attr_reader :next_page
 
+      # Tagged logger
+      #
+      attr_reader :logger
+
       # A new instance of +Query+
       #
       # @param api [Api] Parent to use for making requests
@@ -55,8 +59,13 @@ module Usps
         @page_size = page_size
         @offset = offset
         @count = 0
+        @logger ||= Imis.logger('Query', query_type)
 
-        logger.debug "URI: #{uri}"
+        logger.tagged('Name').debug query_name
+        logger.tagged('Params').json query_params
+        logger.tagged('URI').debug uri
+        logger.tagged('Page Size').debug page_size
+        logger.tagged('Offset').debug offset.to_i
       end
 
       # Iterate through all results from the query
@@ -92,9 +101,9 @@ module Usps
 
         @count += result['Count'] || 0
         total = result['TotalCount']
-        logger.info "  -> #{@count} / #{total} #{'item'.pluralize(total)}"
-        logger.debug '  -> Query page data:'
-        JSON.pretty_generate(result).split("\n").each { logger.debug "    -> #{it}" }
+        logger.info "#{@count} / #{total} #{'item'.pluralize(total)}"
+        logger.debug 'Query page data:'
+        logger.json result
 
         @offset = result['NextOffset']
         @next_page = result['HasNext']
@@ -120,7 +129,7 @@ module Usps
 
       # Ruby 3.5 instance variable filter
       #
-      def instance_variables_to_inspect = instance_variables - %i[@api]
+      def instance_variables_to_inspect = instance_variables - %i[@api @logger]
 
     private
 
@@ -139,8 +148,6 @@ module Usps
           "#{Imis::BusinessObject::API_PATH}/#{query_name}?#{path_params.to_query}"
         end
       end
-
-      def logger = Imis.logger("#{query_type} Query")
     end
   end
 end

data/lib/usps/imis/requests.rb

@@ -7,7 +7,7 @@ module Usps
     module Requests
     private
 
-      def logger = Imis.logger
+      def logger = raise("#{self.class.name} must implement #logger")
 
       def token = api.token
       def token_expiration = api.token_expiration
@@ -39,12 +39,15 @@ module Usps
 
       def submit(uri, request)
         logger.info 'Submitting request to iMIS'
-        logger.debug "  -> #{request.class.name.demodulize.upcase} #{uri}"
-        sanitized_request_body(request).split("\n").each { logger.debug "  -> #{it}" }
-        client(uri).request(request).tap do |result|
-          raise Errors::ResponseError.from(result) unless result.is_a?(Net::HTTPSuccess)
+        logger.tagged('Request') do
+          logger.debug "#{request.class.name.demodulize.upcase} #{uri}"
+          logger.multiline sanitized_request_body(request)
 
-          logger.info 'Request succeeded'
+          client(uri).request(request).tap do |result|
+            raise Errors::ResponseError.from(result) unless result.is_a?(Net::HTTPSuccess)
+
+            logger.info 'Request succeeded'
+          end
         end
       end
 

data/lib/usps/imis/version.rb

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

data/lib/usps/imis.rb

@@ -51,7 +51,7 @@ module Usps
 
       # Logger (with optional nested tags) to write to
       #
-      def logger(*tags) = configuration.logger.tagged('iMIS', *tags)
+      def logger(*) = configuration.logger.tagged(*)
 
       # Gem version
       #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.11.16
+  version: 0.11.18
 platform: ruby
 authors:
 - Julian Fiander
@@ -93,6 +93,9 @@ files:
 - lib/usps/imis/errors/panel_unimplemented_error.rb
 - lib/usps/imis/errors/response_error.rb
 - lib/usps/imis/errors/unexpected_property_type_error.rb
+- lib/usps/imis/logger.rb
+- lib/usps/imis/logger_formatter.rb
+- lib/usps/imis/logger_helpers.rb
 - lib/usps/imis/mapper.rb
 - lib/usps/imis/mocks.rb
 - lib/usps/imis/mocks/business_object.rb