usps-imis-api 0.9.3 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e19af888058a7e7b952269cf44ca87dcd50c733e5ad4c97760c80fee73e713b6
-  data.tar.gz: 85c743311d63b29d85ebab874e174446d452a4e0679bdc7c8191d5cdb1557a22
+  metadata.gz: 0e2478447353e616e857b13ac4b3c87d62c8f8d9a499a1ef8610355d91181539
+  data.tar.gz: f00d8b31112b0295834eca9a74176318d5e51f7596d9fa2082267671763255e6
 SHA512:
-  metadata.gz: eebcd44785ae1a0d021ff01a7205b2fe9db7546c73dd3f47e3e4c34db90c1344bc2dee97283f67a484764b87b1b8ade9e04811a848caece4bd7287df3297e55c
-  data.tar.gz: 52dc9356735c0d972096fefe3de91c5acb2f3cf4698f5fe2a4ac711e655b15f384c7a815a9c4eff7ac12db09f9e425f03de2f318df2d45b99bc14b84e49ce7e7
+  metadata.gz: 8dda7fe4ff5daab7fc34df6ca508005f38295987f626cc73762fbb6f641404e5f9ad9f4108815362f98333e806c2366b7143c94cf3a861d6729cdc77034b2a09
+  data.tar.gz: d9b0f87d187cdb1e10d66ee439a750d659e87ae033fe3c7848d87dc96f211895041ff7196fa88d1f60b27fdfb8a7e39ce03b34a5e74e4be8c88445cb16b01540

data/Gemfile.lock

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

data/Readme.md

@@ -34,7 +34,7 @@ Usps::Imis.configure do |config|
   config.password = ENV['IMIS_PASSWORD']
 
   # These options will use these defaults
-  config.logger = Logger.new($stdout)
+  config.logger = ActiveSupport::TaggedLogging.new(Logger.new($stdout))
   config.logger.level = :info
 end
 ```
@@ -213,13 +213,24 @@ end
 ### Field Mapper
 
 For fields that have already been mapped between the ITCom database and iMIS, you can use the
-Mapper class to further simplify the update interface:
+Mapper class to further simplify the fetch / update interfaces:
+
+```ruby
+mm = api.mapper.fetch(:mm)
+mm = api.mapper[:mm]
+```
 
 ```ruby
 api.mapper.update(mm: 15)
 ```
 
-For simplicity, you can also call `update` on the `Api` class directly:
+For simplicity, you can also call `fetch` (or simply use Hash access syntax) and `update` on the
+`Api` class directly:
+
+```ruby
+api.fetch(:mm)
+api[:mm]
+```
 
 ```ruby
 api.update(mm: 15)

data/lib/usps/imis/api.rb

@@ -128,11 +128,14 @@ module Usps
         @mapper ||= Mapper.new(self)
       end
 
+      # Convenience alias for reading mapped fields
+      #
+      def fetch(field_key) = mapper.fetch(field_key)
+      alias [] fetch
+
       # Convenience alias for updating mapped fields
       #
-      def update(data)
-        mapper.update(data)
-      end
+      def update(data) = mapper.update(data)
 
       # Convenience accessor for available Panel objects, each using this instance as its parent
       # +Api+
@@ -147,10 +150,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

@@ -111,6 +111,8 @@ module Usps
       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)
@@ -164,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
 
@@ -174,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/errors/mapper_error.rb

@@ -19,7 +19,7 @@ module Usps
         #
         def message
           <<~MESSAGE.chomp
-            Mapper does not recognize field: "#{metadata[:field_name]}".
+            Mapper does not recognize field: "#{metadata[:field_key]}".
             Please report what data you are attempting to work with to ITCom leadership.
           MESSAGE
         end

data/lib/usps/imis/mapper.rb

@@ -28,6 +28,14 @@ module Usps
         @api.imis_id = imis_id if imis_id
       end
 
+      def fetch(field_key)
+        missing_mapping!(field_key) unless FIELD_MAPPING.key?(field_key.to_sym)
+
+        business_object_name, field = FIELD_MAPPING[field_key]
+        api.on(business_object_name)[field]
+      end
+      alias [] fetch
+
       # Update a member's data on multiple affected business objects by arbitrary field names
       #
       # Does not require knowing which business object / iMIS-specific field name to use
@@ -57,25 +65,27 @@ module Usps
 
     private
 
-      def map_update(field_name)
-        missing_mapping!(field_name) unless FIELD_MAPPING.key?(field_name.to_sym)
+      def logger = Imis.logger('Mapper')
+
+      def map_update(field_key)
+        missing_mapping!(field_key) unless FIELD_MAPPING.key?(field_key.to_sym)
 
-        business_object_name, field = FIELD_MAPPING[field_name.to_sym]
+        business_object_name, field = FIELD_MAPPING[field_key.to_sym]
         yield(business_object_name, field)
       end
 
-      def missing_mapping!(field_name)
+      def missing_mapping!(field_key)
         unless ENV['TESTING']
           # :nocov:
-          warn(
-            "Mapper does not know how to handle field \"#{field_name}\".\n\n" \
-            'You can use api.put_fields(business_object_name, { field_name => value })  ' \
-            "if you know the business object and iMIS-specific field name.\n\n"
-          )
+          "Mapper does not know how to handle field \"#{field_key}\".\n\n" \
+          'You can use api.put_fields(business_object_name, { field_name => value })  ' \
+          "if you know the business object and iMIS-specific field name.\n\n"
+            .split("\n")
+            .each { logger.warn(it) }
           # :nocov:
         end
 
-        raise Errors::MapperError.new({ field_name: })
+        raise Errors::MapperError.new({ field_key: })
       end
     end
   end

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

@@ -93,6 +93,8 @@ module Usps
 
       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']
@@ -87,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.3'
+    VERSION = '0.9.5'
   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

data/spec/lib/usps/imis/mapper_spec.rb

@@ -13,6 +13,30 @@ describe Usps::Imis::Mapper do
     end
   end
 
+  describe '#fetch' do
+    before { api.imis_id = 31092 }
+
+    it 'fetches a mapped field' do
+      expect(api.mapper.fetch(:mm)).to be_a(Integer)
+    end
+
+    it 'supports Hash access syntax' do
+      expect(api.mapper[:mm]).to be_a(Integer)
+    end
+
+    it 'supports Hash access syntax on the Api directly' do
+      expect(api[:mm]).to be_a(Integer)
+    end
+
+    it 'raises for unmapped updates' do
+      expect { api.mapper.fetch(:another) }.to raise_error(
+        Usps::Imis::Errors::MapperError,
+        %(Mapper does not recognize field: "another".\n) \
+        'Please report what data you are attempting to work with to ITCom leadership.'
+      )
+    end
+  end
+
   describe '#update' do
     before { api.imis_id = 31092 }
 

metadata

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