usps-imis-api 0.9.15 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccbec46e992d8642344cfeb67755b31e98c7e915c8066dc2207b3c31023d7bd1
-  data.tar.gz: 7c1ecddcfe0b322f00ed419e95ab8cd63728191476e650de3364c46b7e4d41fe
+  metadata.gz: 46a4e7cdf12bf5d20a7fca22f0efbdaa2b8d6d9b4f4419b8b787828de969f0b5
+  data.tar.gz: a3bd80bfb5bb48f495c60e07b7c93a91d834e40fc50ce9157c65bccbdd4be234
 SHA512:
-  metadata.gz: 821d850f11301fdb49062366ccba161aa0abe4758e176f0328b2356d53806e1f13d3caa34d4cf7e7a95085f810f6c5ceb716ca25995566458405e5eeb269f3ed
-  data.tar.gz: 02b02bed4a879ec5bc946d4063b25589f2130dac4b6ea30a01d29358f27af9a06722a77dfb9aa7948ff96cd1cde183ded233d1fd9567ab4eab736e36fc4cae26
+  metadata.gz: 13a72cdd52375dd37a1856e3add682d4162e0a8cd6ae3fb72b78bb5bc9d834deff583662cff3a1d1fe73f7c69a664a53f1f6e8bf88b8eb10bc8fcaa77fe163d2
+  data.tar.gz: 6289ddfecf558b29c44cede8fdb44cd8fe694554351057c753b232951c5fcd1c945419afc20894b88d15426ba55881e7538ffeb11a8f7629e25dbd48cd219968

data/lib/usps/imis/api.rb

@@ -61,8 +61,12 @@ module Usps
       def imis_id_for(certificate)
         raise Errors::LockedIdError if lock_imis_id
 
+        logger.debug "Fetching iMIS ID for #{certificate}"
+
         begin
-          self.imis_id = query(Imis.configuration.imis_id_query_name, { certificate: }).first['ID'].to_i
+          result = query(Imis.configuration.imis_id_query_name, { certificate: }).tap { logger.debug it }
+          page = result.page.tap { logger.debug it }
+          self.imis_id = page.first['ID'].to_i
         rescue StandardError
           raise Errors::NotFoundError, 'Member not found'
         end
@@ -95,9 +99,11 @@ module Usps
         end
       end
 
-      # Build an IQA Query interface
+      # Build a Query interface
+      #
+      # Works with IQA queries and Business Objects
       #
-      # @param query_name [String] Full path of the query in IQA, e.g. +$/_ABC/Fiander/iMIS_ID+
+      # @param query_name [String] Full path of the query, e.g. +$/_ABC/Fiander/iMIS_ID+
       # @query_params [Hash] Conforms to pattern +{ param_name => param_value }+
       #
       # @return [Hash] Response data from the API

data/lib/usps/imis/business_object.rb

@@ -33,6 +33,10 @@ module Usps
         @ordinal = ordinal
       end
 
+      # Run a query on the entire business object
+      #
+      def query = api.query(business_object_name)
+
       # Get a business object for the current member
       #
       # If +fields+ is provided, will return only those field values
@@ -170,6 +174,8 @@ module Usps
       # Useful for stubbing data in tests
       #
       def raw_object
+        raise Errors::MissingIdError if api.imis_id.nil?
+
         response = submit(uri, authorize(http_get))
         result = Data.from_json(response.body)
         JSON.pretty_generate(result).split("\n").each { logger.debug "    -> #{it}" }
@@ -179,6 +185,8 @@ module Usps
       # Upload an object to the API
       #
       def put_object(request, body)
+        raise Errors::MissingIdError if api.imis_id.nil?
+
         request.body = JSON.dump(body)
         response = submit(uri, authorize(request))
         result = Data.from_json(response.body)

data/lib/usps/imis/config.rb

@@ -12,7 +12,7 @@ module Usps
       attr_reader :environment, :logger, :logger_level
 
       def initialize
-        @environment = defined?(Rails) ? Rails.env : ActiveSupport::StringInquirer.new('development')
+        @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)
@@ -31,6 +31,10 @@ module Usps
         @logger = ActiveSupport::TaggedLogging.new(logger)
       end
 
+      def silence!
+        self.logger = Logger.new(nil)
+      end
+
       # Environment-specific API endpoint hostname
       #
       # @return The API hostname for the current environment

data/lib/usps/imis/error.rb

@@ -47,6 +47,7 @@ require_relative 'errors/api_error'
 require_relative 'errors/config_error'
 require_relative 'errors/locked_id_error'
 require_relative 'errors/mapper_error'
+require_relative 'errors/missing_id_error'
 require_relative 'errors/not_found_error'
 require_relative 'errors/response_error'
 require_relative 'errors/panel_unimplemented_error'

data/lib/usps/imis/errors/missing_id_error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Usps
+  module Imis
+    module Errors
+      # Exception raised when attempting to access a +BusinessObject+ without an iMIS ID
+      #
+      class MissingIdError < Error
+        def initialize = super(message)
+
+        def message = 'Cannot access an individual Business Object without an iMIS ID'
+      end
+    end
+  end
+end

data/lib/usps/imis/query.rb

@@ -2,7 +2,7 @@
 
 module Usps
   module Imis
-    # API wrapper for IQA Queries
+    # API wrapper for IQA and Business Object Queries
     #
     class Query
       include Enumerable
@@ -10,7 +10,7 @@ module Usps
 
       # Endpoint for IQA query requests
       #
-      QUERY_PATH = 'api/Query'
+      IQA_PATH = 'api/Query'
 
       # The parent +Api+ object
       #
@@ -36,6 +36,10 @@ module Usps
       #
       attr_reader :count
 
+      # Whether the current query has a next page
+      #
+      attr_reader :next_page
+
       # A new instance of +Query+
       #
       # @param api [Api] Parent to use for making requests
@@ -48,14 +52,18 @@ module Usps
         @api = api
         @query_name = query_name
         @query_params = query_params
+        @query_params.merge!(QueryName: query_name) if iqa?
         @page_size = page_size
         @offset = offset
+        @count = 0
+
+        logger.debug "URI: #{uri}"
       end
 
       # Iterate through all results from the query
       #
       def each(&)
-        logger.info 'Running IQA Query on iMIS'
+        logger.info 'Running'
 
         items = []
         find_each { items << it }
@@ -65,10 +73,10 @@ module Usps
       # Iterate through all results from the query, fetching one page at a time
       #
       def find_each(&)
-        result = reset!
+        reset!
 
-        while result['HasNext']
-          result = fetch_next.tap do |result_page|
+        while page?
+          fetch_next.tap do |result_page|
             result_page['Items']['$values'].map { it.except('$type') }.each(&)
           end
         end
@@ -76,14 +84,16 @@ module Usps
         nil
       end
 
-      # Fetch a raw query page
+      # Fetch a filtered query page, and update the current offset
       #
-      def fetch = JSON.parse(submit(uri, authorize(http_get)).body)
+      def page = fetch_next['Items']['$values'].map { iqa? ? it.except('$type') : Imis::Data[it] }
 
       # Fetch the next raw query page, and update the current offset
       #
       def fetch_next
-        logger.info 'Fetching IQA Query page'
+        return unless page?
+
+        logger.info "Fetching #{query_type} Query page"
 
         result = fetch
 
@@ -94,30 +104,44 @@ module Usps
         JSON.pretty_generate(result).split("\n").each { logger.debug "    -> #{it}" }
 
         @offset = result['NextOffset']
+        @next_page = result['HasNext']
 
         result
       end
 
+      # Fetch a raw query page
+      #
+      def fetch = JSON.parse(submit(uri, authorize(http_get)).body)
+
+      # Reset query paging progress
+      #
+      def reset!
+        return if next_page.nil?
+
+        logger.debug 'Resetting progress'
+
+        @count = 0
+        @offset = 0
+        @next_page = nil
+      end
+
       # Ruby 3.5 instance variable filter
       #
       def instance_variables_to_inspect = instance_variables - %i[@api]
 
     private
 
-      def path_params = query_params.merge(QueryName: query_name).merge({ Offset: offset, Limit: page_size }.compact)
-      def path = "#{QUERY_PATH}?#{path_params.to_query}"
-      def uri = URI(File.join(Imis.configuration.hostname, path))
-
-      def logger = Imis.logger('Query')
+      # Only skip if explicitly set
+      def page? = next_page.nil? || next_page
 
-      def reset!
-        logger.debug 'Resetting Query progress'
-
-        @count = 0
-        @offset = 0
+      def iqa? = query_name.match?(/^\$/)
+      def query_type = iqa? ? :IQA : :'Business Object'
+      def path_params = query_params.merge({ Offset: offset, Limit: page_size }.compact)
+      def endpoint = iqa? ? IQA_PATH : "#{Imis::BusinessObject::API_PATH}/#{query_name}"
+      def path = "#{endpoint}?#{path_params.to_query}"
+      def uri = URI(File.join(Imis.configuration.hostname, path))
 
-        { 'HasNext' => true }
-      end
+      def logger = Imis.logger("#{query_type} Query")
     end
   end
 end

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.9.15'
+    VERSION = '0.10.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.9.15
+  version: 0.10.0
 platform: ruby
 authors:
 - Julian Fiander
@@ -40,6 +40,7 @@ files:
 - lib/usps/imis/errors/config_error.rb
 - lib/usps/imis/errors/locked_id_error.rb
 - lib/usps/imis/errors/mapper_error.rb
+- lib/usps/imis/errors/missing_id_error.rb
 - lib/usps/imis/errors/not_found_error.rb
 - lib/usps/imis/errors/panel_unimplemented_error.rb
 - lib/usps/imis/errors/response_error.rb