usps-imis-api 0.11.15 → 0.11.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a832672e225e3d314dd72d58089ddb95650e261a6498281a31db365cbadf2c47
-  data.tar.gz: edb5fd91281205f91e1b5891e7d6fff16cba99b6851cf53ec89e6c925e502612
+  metadata.gz: ab24b35210bcf8507b8a9222f77acb9333bc0386305c9cd8c606eab4aee6f11a
+  data.tar.gz: b84b925473193fe7493966070dc3b38d29d2495d8ed67cdddec80f4dbcf3c8e1
 SHA512:
-  metadata.gz: fb3943d61228582bdef6e516060e816682f48ee6552188d1306f003cee9eb973e1c2c26db1f7a8025e45d60d885512878e4bb5bfbe99a93f59ede12ad0fa4611
-  data.tar.gz: ec25020f0a3c138c0f250b5aadfb3e4cdf254172ab430ac587196fe5764a2f8c12a20339dddac2856ad80dade2671aca2eb5f95761461b6fd4b421ca89df8914
+  metadata.gz: '09a0c8b2c2c15741a4d4602d54ddb0e28839ff7ada31c37deb975a5214dd9e9d294751f8765e258f02b289a0af2bf1bc6c086fe39d5d9ff3c64d9ff6dc47c95e'
+  data.tar.gz: ee7cb6cc8de2752f2ed5812bdf5a279bee89babc2b9ca15253faf1010b054c6f3bdeb3b351987428e8e214a66205d560242f3db80edac401de34fb0406b50a83

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'
@@ -76,11 +81,14 @@ module Usps
 
       # Run requests as DSL, with specific iMIS ID only maintained for this scope
       #
+      # Either +id+ or +certificate+ is required.
+      #
       # While in this block, changes to the value of +imis_id+ are not allowed
       #
       # If no block is given, this sets the iMIS ID and returns self.
       #
       # @param id [Integer, String] iMIS ID to select for requests within the block
+      # @param certificate [String] Certificate number to convert to iMIS ID and select for requests within the block
       #
       # @example
       #   with(12345) do
@@ -89,9 +97,12 @@ module Usps
       #
       # @return [Usps::Imis::Api]
       #
-      def with(id, &)
+      def with(id = nil, certificate: nil, &)
+        raise ArgumentError, 'Must provide id or certificate' unless id || certificate
+
         old_id = imis_id
-        self.imis_id = id
+
+        id.nil? ? imis_id_for(certificate) : self.imis_id = id
         return self unless block_given?
 
         @lock_imis_id = true
@@ -185,24 +196,26 @@ 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
+        @token_expiration = Time.now + json['expires_in'] - 60
       end
 
       # URI for the authentication endpoint

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,8 @@
 # frozen_string_literal: true
 
+require_relative 'logger'
+require_relative 'logger_formatter'
+
 module Usps
   module Imis
     # API Configuration
@@ -16,7 +19,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 +32,8 @@ module Usps
       end
 
       def logger=(logger)
-        @logger = ActiveSupport::TaggedLogging.new(logger)
+        @base_logger = logger.tap { it.formatter = LoggerFormatter.new }
+        @logger = ActiveSupport::TaggedLogging.new(@base_logger)
       end
 
       def silence!
@@ -48,7 +53,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,24 @@
+# frozen_string_literal: true
+
+require_relative 'logger_formatter'
+
+module Usps
+  module Imis
+    # Formatted logger with additional helpers
+    #
+    class Logger < ::Logger
+      def initialize(...)
+        super
+        self.formatter = LoggerFormatter.new
+      end
+
+      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/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/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,7 +59,9 @@ module Usps
         @page_size = page_size
         @offset = offset
         @count = 0
+        @logger ||= Imis.logger('Query', query_type)
 
+        logger.debug inspect
         logger.debug "URI: #{uri}"
       end
 
@@ -92,9 +98,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 +126,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 +145,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.15'
+    VERSION = '0.11.17'
   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.15
+  version: 0.11.17
 platform: ruby
 authors:
 - Julian Fiander
@@ -93,6 +93,8 @@ 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/mapper.rb
 - lib/usps/imis/mocks.rb
 - lib/usps/imis/mocks/business_object.rb