usps-imis-api 0.9.2 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e410751cbd3ff6de46be231c0003cd5b23ffdfa891233f70025e493fa8e8057
-  data.tar.gz: 993830af54fb76c8361b589b797b6c8fe600d485704087bf8020a17c20c5ca8e
+  metadata.gz: f53d9f4d8fc199b09d71f6b5e566c91d7e1052005e511d3921412d569900f584
+  data.tar.gz: 1843a632acc1c9c3e5db431c443e8b8d150ab8efa4834f0c80ee76e842161a86
 SHA512:
-  metadata.gz: 481e7d0d83547f00cb77dbdec9ecb7b1d678d467fb8aacf0e35883bcdfa6700a9e926e6f1f73fb783bcdaed96fbda3a765ce854cf5d12f64e1c9aa3162ae3bed
-  data.tar.gz: 1712c9f3e1ad4cf2ab7b6567861c6c1537b69fae0601829eafabacc80a22ae300681edb67d3ef6ab02e5c07e2ac0a999eab1e51142a21a101f262511a9115cf2
+  metadata.gz: 19d6a858ab56b41eff03cc80f499779fe28500b6c5664916f3c08dc8506f170d3b0aa6ffdcc7cf79801a912a020239685b7142029109a4118e896bead1953c62
+  data.tar.gz: aac564fc27bbfd9afd0b6e0db552e808b14e8be9fdd6e7e29c4fb5f5c95c6fa4c7225e16821dc43dd97c2c0d412ab6a9401169149093a7846d2662e9da937455

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (0.9.2)
+    usps-imis-api (0.9.4)
       activesupport (~> 8.0)
 
 GEM

data/lib/usps/imis/api.rb

@@ -147,10 +147,12 @@ module Usps
 
     private
 
+      def logger = Imis.logger('Api')
+
       # Authenticate to the iMIS API, and store the access token and expiration time
       #
       def authenticate
-        Imis.logger.debug 'Authenticating with iMIS'
+        logger.debug 'Authenticating with iMIS'
 
         uri = URI(File.join(Imis.configuration.hostname, AUTHENTICATION_PATH))
         req = Net::HTTP::Post.new(uri)

data/lib/usps/imis/business_object.rb

@@ -102,11 +102,17 @@ module Usps
       def delete = submit(uri, authorize(Net::HTTP::Delete.new(uri))).body == '' # rubocop:disable Naming/PredicateMethod
       alias destroy delete
 
+      # Ruby 3.5 instance variable filter
+      #
+      def instance_variables_to_inspect = instance_variables - %i[@api]
+
     private
 
       def token = api.token
       def token_expiration = api.token_expiration
 
+      def logger = Imis.logger('BusinessObject')
+
       # Construct a business object API endpoint address
       #
       def uri(id: nil)
@@ -160,7 +166,7 @@ module Usps
         request = Net::HTTP::Get.new(uri)
         result = submit(uri, authorize(request))
         result = Data.from_json(result.body)
-        JSON.pretty_generate(result).split("\n").each { Imis.logger.debug "    -> #{it}" }
+        JSON.pretty_generate(result).split("\n").each { logger.debug "    -> #{it}" }
         result
       end
 
@@ -170,7 +176,7 @@ module Usps
         request.body = JSON.dump(body)
         result = submit(uri, authorize(request))
         result = Data.from_json(result.body)
-        JSON.pretty_generate(result).split("\n").each { Imis.logger.debug "    -> #{it}" }
+        JSON.pretty_generate(result).split("\n").each { logger.debug "    -> #{it}" }
         result
       end
     end

data/lib/usps/imis/config.rb

@@ -8,15 +8,15 @@ module Usps
       IMIS_ROOT_URL_PROD = 'https://portal.americasboatingclub.org'
       IMIS_ROOT_URL_DEV = 'https://abcdev.imiscloud.com'
 
-      attr_accessor :imis_id_query_name, :username, :password, :logger
-      attr_reader :environment, :logger_level
+      attr_accessor :imis_id_query_name, :username, :password
+      attr_reader :environment, :logger, :logger_level
 
       def initialize
         @environment = defined?(Rails) ? Rails.env : ActiveSupport::StringInquirer.new('development')
         @imis_id_query_name = ENV.fetch('IMIS_ID_QUERY_NAME', nil)
         @username = ENV.fetch('IMIS_USERNAME', nil)
         @password = ENV.fetch('IMIS_PASSWORD', nil)
-        @logger = Logger.new($stdout, level: :info)
+        @logger = ActiveSupport::TaggedLogging.new(Logger.new($stdout, level: :info))
 
         yield self if block_given?
 
@@ -27,6 +27,10 @@ module Usps
         @environment = ActiveSupport::StringInquirer.new(env.to_s)
       end
 
+      def logger=(logger)
+        @logger = ActiveSupport::TaggedLogging.new(logger)
+      end
+
       # Environment-specific API endpoint hostname
       #
       # @return The API hostname for the current environment

data/lib/usps/imis/mapper.rb

@@ -51,8 +51,14 @@ module Usps
         end
       end
 
+      # Ruby 3.5 instance variable filter
+      #
+      def instance_variables_to_inspect = instance_variables - %i[@api]
+
     private
 
+      def logger = Imis.logger('Mapper')
+
       def map_update(field_name)
         missing_mapping!(field_name) unless FIELD_MAPPING.key?(field_name.to_sym)
 

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

@@ -87,8 +87,14 @@ module Usps
         def delete(ordinal) = api.on(business_object, ordinal:).delete
         alias destroy delete
 
+        # Ruby 3.5 instance variable filter
+        #
+        def instance_variables_to_inspect = instance_variables - %i[@api]
+
       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

@@ -43,7 +43,7 @@ module Usps
       # Iterate through all results from the query
       #
       def each(&)
-        Imis.logger.info 'Running IQA Query on iMIS'
+        logger.info 'Running IQA Query on iMIS'
 
         items = []
         find_each { items << it }
@@ -57,14 +57,14 @@ module Usps
         count = 0
 
         while result['HasNext']
-          Imis.logger.info 'Fetching IQA Query page'
+          logger.info 'Fetching IQA Query page'
 
           result = fetch
 
           count += result['Count'] || 0
-          Imis.logger.info "  -> #{count} / #{result['TotalCount']} #{'item'.pluralize(count)}"
-          Imis.logger.debug '  -> Query page data:'
-          JSON.pretty_generate(result).split("\n").each { Imis.logger.debug "    -> #{it}" }
+          logger.info "  -> #{count} / #{result['TotalCount']} #{'item'.pluralize(count)}"
+          logger.debug '  -> Query page data:'
+          JSON.pretty_generate(result).split("\n").each { logger.debug "    -> #{it}" }
 
           items = result['Items']['$values'].map { it.except('$type') }
           @offset = result['NextOffset']
@@ -75,6 +75,10 @@ module Usps
         nil
       end
 
+      # Ruby 3.5 instance variable filter
+      #
+      def instance_variables_to_inspect = instance_variables - %i[@api]
+
     private
 
       def token = api.token
@@ -83,6 +87,8 @@ module Usps
       def path = "#{QUERY_PATH}?#{query_params.merge(QueryName: query_name, Offset: offset).to_query}"
       def uri = URI(File.join(Imis.configuration.hostname, path))
       def fetch = JSON.parse(submit(uri, authorize(Net::HTTP::Get.new(uri))).body)
+
+      def logger = Imis.logger('Query')
     end
   end
 end

data/lib/usps/imis/requests.rb

@@ -7,6 +7,8 @@ module Usps
     module Requests
     private
 
+      def logger = Imis.logger
+
       def client(uri)
         Net::HTTP.new(uri.host, uri.port).tap do |http|
           http.use_ssl = true
@@ -20,20 +22,20 @@ module Usps
       #
       def authorize(request)
         if token_expiration < Time.now
-          Imis.logger.debug 'Token expired: re-authenticating with iMIS'
+          logger.debug 'Token expired: re-authenticating with iMIS'
           authenticate
         end
         request.tap { it.add_field('Authorization', "Bearer #{token}") }
       end
 
       def submit(uri, request)
-        Imis.logger.info 'Submitting request to iMIS'
-        Imis.logger.debug "  -> #{request.class.name.demodulize.upcase} #{uri}"
-        sanitized_request_body(request).split("\n").each { Imis.logger.debug "  -> #{it}" }
+        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)
 
-          Imis.logger.info 'Request succeeded'
+          logger.info 'Request succeeded'
         end
       end
 

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.9.2'
+    VERSION = '0.9.4'
   end
 end

data/lib/usps/imis.rb

@@ -11,6 +11,8 @@ require 'active_support/core_ext/object/to_query'
 require 'active_support/core_ext/enumerable'
 require 'active_support/string_inquirer'
 require 'logger'
+require 'active_support/isolated_execution_state' # Fix costant loading issue with TaggedLogging
+require 'active_support/tagged_logging'
 
 # Internal requires
 require_relative 'imis/config'
@@ -43,9 +45,9 @@ module Usps
         configuration
       end
 
-      # Logger instance to write to
+      # Logger (with optional nested tags) to write to
       #
-      def logger = configuration.logger
+      def logger(*tags) = configuration.logger.tagged('iMIS', *tags)
     end
   end
 end

metadata

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