usps-imis-api 0.11.40 → 0.11.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09b163c4f02496fa2205d3ed3056f2e0e7bf7306b63f2176390a498503ca32d3'
-  data.tar.gz: c5e9dd8def7221e9f63f71e277ebbdbd3d6b8f080d93af5a5494b50149b649cd
+  metadata.gz: ac3e7c47ae3555e7cb4d83bf24585b5b4ffac669c0f60dab014996566a4ad366
+  data.tar.gz: 547b0943b75e78b4ba4b968e3a780194cfe783eaef2301a4f5cacdee6e298c0e
 SHA512:
-  metadata.gz: 2cf04565727807685ef016b823bdd798ac453ed9510d32b430c4b6e286b9f71d01ee6d2d08d15bcdfc3c55dc8168e42f224c9c2fddec2e9933c4e03ee34e03ed
-  data.tar.gz: b0a7eeb21ce375a205b1783f839eba1c02aa2040091319845729d33680e49cb43a373a256e3ac002037222516ef111bf8d08903181458c0e8a5fcc1180b30772
+  metadata.gz: 5f7009001491dd4177d883335bdd63a2049bf157bbac66295d22c789dd1755b9672d096a760a000883f6397e4ee9c74d48cebae0c1868895e46c7b63577aaae6
+  data.tar.gz: 8509266846dab5d93389ee7486afb8f987202d1cfbda01b2e59894e2e5fe6caddf7e820b2c822335c7123535fac1b0d3ada220d9deaf20bb3ab56a3284fccd37

data/lib/usps/imis/api.rb

@@ -62,7 +62,7 @@ module Usps
       def initialize(imis_id: nil, record_id: nil)
         self.imis_id = imis_id if imis_id
         self.record_id = record_id if record_id
-        @logger ||= Imis.logger('Api')
+        @logger = Imis.logger('Api')
         Imis.config.validate!
       end
 
@@ -80,10 +80,11 @@ module Usps
         hex = '[0-9a-fA-F]'
         uuid_pattern = /^#{hex}{8}-#{hex}{4}-#{hex}{4}-#{hex}{4}-#{hex}{12}$/
         @imis_id =
-          if id.to_s.match?(uuid_pattern)
-            id
-          elsif id.to_i.to_s == id.to_s.gsub(' ', '')
-            id.to_i
+          if id.to_s.match?(uuid_pattern) then id
+          elsif id.to_i.to_s == id.to_s.gsub(' ', '') then id.to_i
+          elsif id.nil? then nil
+          else
+            raise ArgumentError, "Invalid id: #{id.inspect}"
           end
       end
 
@@ -118,13 +119,13 @@ module Usps
 
         logger.debug "Fetching iMIS ID for #{certificate}"
 
-        begin
-          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'
-        end
+        result = query(Imis.configuration.imis_id_query_name, { certificate: })
+        page = result.page.tap { logger.tagged('Response').debug it }
+        raise Errors::NotFoundError, 'Member not found' if page.empty?
+
+        self.imis_id = page.first['ID'].to_i
+      rescue Errors::ResponseError
+        raise Errors::NotFoundError, 'Member not found'
       end
 
       # Run requests as DSL, with specific iMIS ID only maintained for this scope
@@ -175,7 +176,7 @@ module Usps
       #
       # @return [Usps::Imis::Query] Query wrapper
       #
-      def query(query_name, query_params = nil) = Query.new(self, query_name, **query_params)
+      def query(query_name, query_params = {}) = Query.new(self, query_name, **query_params)
 
       # Run requests as DSL, with specific +BusinessObject+ only maintained for this scope
       #
@@ -250,12 +251,27 @@ module Usps
         { token: @token, token_expiration: @token_expiration }
       end
 
+      # Persistent HTTP connection for reuse across requests
+      #
+      def http_connection
+        return @http_connection if @http_connection&.started?
+
+        hostname = URI(Imis.configuration.hostname)
+        @http_connection = Net::HTTP.new(hostname.host, hostname.port).tap do |http|
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          http.open_timeout = 10
+          http.read_timeout = 30
+          http.write_timeout = 30
+          http.keep_alive_timeout = 30
+          http.start
+        end
+      end
+
       # Ruby 3.5 instance variable filter
       #
       def instance_variables_to_inspect = %i[@token_expiration @imis_id]
 
-    private
-
       # Authenticate to the iMIS API, and store the access token and expiration time
       #
       def authenticate
@@ -270,7 +286,7 @@ module Usps
             username: Imis.configuration.username,
             password: Imis.configuration.password
           )
-          result = submit(uri, request)
+          result = submit(request)
           json = JSON.parse(result.body)
         end
 
@@ -278,6 +294,8 @@ module Usps
         @token_expiration = Time.now + json['expires_in'] - 60
       end
 
+    private
+
       # URI for the authentication endpoint
       #
       def uri(...) = URI(File.join(Imis.configuration.hostname, AUTHENTICATION_PATH))

data/lib/usps/imis/base_data.rb

@@ -7,14 +7,28 @@ module Usps
   module Imis
     # Base class for API data response wrappers
     #
-    class BaseData < Hash
+    class BaseData
+      # The raw API response hash
+      #
+      attr_reader :raw
+
+      # Create an instance from a hash
+      #
+      def self.[](hash) = new(hash)
+
       # Load raw API response JSON to access properties
       #
       # @param json [String] Raw API response JSON
       #
-      def self.from_json(json) = self[JSON.parse(json)]
+      def self.from_json(json) = new(JSON.parse(json))
+
+      def initialize(raw = {})
+        @raw = raw
+      end
+
+      alias to_h raw
 
-      alias raw to_h
+      def to_json(*) = raw.to_json(*)
 
       # Access the iMIS ID property
       #
@@ -48,6 +62,14 @@ module Usps
         )
       end
 
+      def ==(other)
+        case other
+        when BaseData then raw == other.raw
+        when Hash then raw == other
+        else super
+        end
+      end
+
       def inspect
         stringio = StringIO.new
         PP.pp(self, stringio)

data/lib/usps/imis/business_object.rb

@@ -37,7 +37,7 @@ module Usps
         @api = api
         @business_object_name = business_object_name.to_s
         @ordinal = ordinal
-        @logger ||= Imis.logger('BusinessObject')
+        @logger = Imis.logger('BusinessObject')
       end
 
       # Run a query on the entire business object
@@ -134,7 +134,7 @@ module Usps
       #
       # @return [true] Only on success response (i.e. blank string from the API)
       #
-      def delete = submit(uri, authorize(http_delete)).body == '' # rubocop:disable Naming/PredicateMethod
+      def delete = submit(authorize(http_delete)).body == '' # rubocop:disable Naming/PredicateMethod
       alias destroy delete
 
       # Build a blank object for the current iMIS ID
@@ -179,7 +179,7 @@ module Usps
 
         existing = get
 
-        JSON.parse(JSON.dump(existing)).tap do |updated|
+        JSON.parse(JSON.dump(existing.raw)).tap do |updated|
           # Preserve the iMIS ID, as well as the Ordinal (if present)
           updated['Properties']['$values'], properties =
             existing.raw['Properties']['$values'].partition { %w[ID Ordinal].include?(it['Name']) }
@@ -204,7 +204,7 @@ module Usps
       def raw_object
         raise Errors::MissingIdError if api.imis_id.nil?
 
-        response = submit(uri, authorize(http_get))
+        response = submit(authorize(http_get))
         klass = business_object_name == 'Party' ? PartyData : Data
         result = klass.from_json(response.body)
         logger.json result
@@ -217,7 +217,7 @@ module Usps
         raise Errors::MissingIdError if api.imis_id.nil?
 
         request.body = JSON.dump(body)
-        response = submit(uri, authorize(request))
+        response = submit(authorize(request))
         klass = business_object_name == 'Party' ? PartyData : Data
         result = klass.from_json(response.body)
         logger.json result

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

@@ -50,7 +50,7 @@ module Usps
 
           configure!
           logging!
-          @logger ||= Imis.logger('CommandLine')
+          @logger = Imis.logger('CommandLine')
         end
 
         # Run the configured action on the API
@@ -111,16 +111,15 @@ module Usps
 
         def simplify(data)
           return data.to_a if data.is_a?(Query)
-          return data if options[:raw] || RAW_HASH_RESPONSE_OPTIONS.any? { options[it] }
+          return data.is_a?(BaseData) ? data.raw : data if force_raw_output?
 
           if data.is_a?(PartyData)
             logger.debug 'Returning simplified PartyData#properties'
             data.properties
-          elsif data.is_a?(Hash)
-            # Hash includes Usps::Imis::Data
+          elsif data.is_a?(Data)
             logger.debug 'Returning simplified Data#properties'
             data.properties(include_ids: options[:include_ids])
-          elsif data.is_a?(Array) && data.all?(Hash)
+          elsif data.is_a?(Array) && data.all?(Data)
             logger.debug 'Returning simplified Array<Data#properties>'
             data.map { it.properties(include_ids: options[:include_ids]) }
           else
@@ -128,6 +127,8 @@ module Usps
           end
         end
 
+        def force_raw_output? = options[:raw] || RAW_HASH_RESPONSE_OPTIONS.any? { options[it] }
+
         # :nocov:
         def output(&)
           if ENV.fetch('SUPPRESS_OUTPUT', false)
@@ -158,6 +159,8 @@ module Usps
             global_log!(config)
 
             config_data&.each do |key, value|
+              next unless Config::SETTABLE.include?(key)
+
               config.public_send("#{key}=", value)
             end
           end

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

@@ -6,83 +6,46 @@ module Usps
       # Command line options parser
       #
       class OptionsParser
-        OPTIONS = {
-          # IDs
-          certificate: ['Member certificate number', { type: :string }],
-          id: ['Member iMIS ID', { type: :integer }],
-          record_id: ['Specific Record ID', { type: :integer, short: :I }],
-          uuid: ['Record UUID', { type: :string }],
-
-          # Primary interactions
-          on: ['Business Object name', { type: :string }],
-          panel: ['Panel name', { type: :string }],
-          query: ['IQA Query or Business Object name to query', { type: :string, short: :Q }],
-          mapper: ['Interact with mapped fields', { short: :M }],
-          map: ["Shorthand for #{'-Mf'.green} to access a single mapped field", { type: :string }],
-          business_objects: ['List available Business Objects'],
-
-          # Alternate verbs
-          create: ["Send a #{'POST'.cyan} request", { short: :P }],
-          delete: ["Send a #{'DELETE'.cyan} request", { short: :D }],
-
-          # Data
-          ordinal: ['Ordinal ID within a Panel', { type: :integer }],
-          field: ['Specific field to return or update', { type: :string }],
-          fields: ['Specific field(s) to return', { type: :strings, short: :F }],
-          data: ["JSON string input -- #{'STDIN'.red} takes priority", { type: :string }],
-
-          # Iteractions for supporting other language wrappers
-          auth_token: ['Return an auth token for other language wrappers', { short: :T }],
-          token: ['Provide an existing auth token', { type: :string }],
-
-          # General config
-          config: [
-            'Path to the JSON/YAML config file to use, or one of the following preset options: ' \
-            "`#{'local'.yellow}`, " \
-            "`#{'local_dot_config'.yellow}`, " \
-            "`#{'local_config'.yellow}`, " \
-            "`#{'user'.yellow}`, " \
-            "`#{'system'.yellow}`. " \
-            'If no option is provided, the first matching preset option will be automatically used.',
-            { type: :string, short: :C }
-          ],
-          show_config: ['Return the active config file path', { short: :X }],
-          raw: ['Return raw JSON output, rather than simplified data', { short: :R }],
-          include_ids: ["Include any #{'iMIS ID'.yellow} and #{'Ordinal'.yellow} properties in returned data"],
-          jsonl: ['Format array output as JSONL', { short: :j }],
-          quiet: ["Suppress logging to #{'STDERR'.red}"],
-          log: ["Redirect logging to #{'STDOUT'.red}"],
-          log_level: ['Set the logging level', { type: :string, default: 'info', short: :L }]
-        }.freeze
-
+        SOLO_FLAGS = %i[show_config auth_token business_objects].freeze
         CONFLICTING_OPTION_GROUPS = [
           %i[certificate id uuid],
           %i[record_id uuid],
-          %i[on panel query mapper map business_objects auth_token show_config],
+          %i[on panel query mapper map] + SOLO_FLAGS,
           %i[field fields map query],
           %i[raw include_ids],
           %i[quiet log_level],
           %i[quiet log],
 
           %i[create delete],
+          %i[create ordinal],
+          %i[data fields],
 
-          %i[create mapper],
-          %i[create query],
-          %i[create map],
-          %i[create field],
-          %i[create fields],
-
-          %i[delete mapper],
-          %i[delete query],
-          %i[delete map],
-          %i[delete field],
-          %i[delete fields],
-          %i[delete data],
-          %i[delete raw]
+          *(SOLO_FLAGS + %i[mapper query map field fields certificate]).map { [:create, it] },
+          *(SOLO_FLAGS + %i[mapper query map field fields certificate data raw]).map { [:delete, it] },
+          *(SOLO_FLAGS + %i[mapper query map on]).map { [:ordinal, it] },
+          *(SOLO_FLAGS + %i[certificate]).map { [:data, it] }
         ].freeze
 
         attr_reader :arguments, :options
 
+        def self.options
+          return @options if @options
+
+          raw_yaml_erb = File.read("#{File.dirname(__FILE__)}/options.yml.erb")
+          rendered_yaml = ERB.new(raw_yaml_erb).result.gsub("\x1b", '\u001b')
+          options = YAML.safe_load(rendered_yaml)
+
+          @options = options.transform_keys(&:to_sym).transform_values do |description, details|
+            next [description] if details.nil?
+
+            details = details.transform_keys(&:to_sym).each_with_object({}) do |(key, value), hash|
+              hash[key] = key == :default ? value : value.to_sym
+            end
+
+            [description, details]
+          end
+        end
+
         def self.banner_header(version)
           <<~BANNER
             #{version.bold.blue}
@@ -147,7 +110,7 @@ module Usps
             banner OptionsParser.banner_header(version)
             banner OptionsParser.banner_contents
 
-            OPTIONS.each { |option, data| opt(option, *data) }
+            OptionsParser.options.each { |option, data| opt(option, *data) }
             CONFLICTING_OPTION_GROUPS.each { |group| conflicts(*group) }
 
             educate_on_error
@@ -160,7 +123,7 @@ module Usps
         # :nocov:
 
         def defaults?
-          options_with_defaults = OPTIONS.select { |_, data| data[1]&.key?(:default) }
+          options_with_defaults = OptionsParser.options.select { |_, data| data[1]&.key?(:default) }
 
           options_with_defaults.all? { |option, data| data[1].nil? || options[option] == data[1][:default] } &&
             options.except(*options_with_defaults.keys).values.none?

data/lib/usps/imis/command_line.rb

@@ -2,6 +2,7 @@
 
 require 'optimist'
 require 'colorize'
+require 'erb'
 
 module Usps
   module Imis

data/lib/usps/imis/config.rb

@@ -13,7 +13,10 @@ module Usps
     class Config
       IMIS_ROOT_URL_PROD = 'https://portal.americasboatingclub.org'
       IMIS_ROOT_URL_DEV = 'https://abcdev.imiscloud.com'
-      REQUIRED_CONFIGS = %w[imis_id_query_name username password].freeze
+      DEFAULT_GLOBAL_LOG_PATH = '/var/log/imis/imis.log'
+      REQUIRED = %w[imis_id_query_name username password].freeze
+      OPTIONAL = %w[environment logger_file global_log_path].freeze
+      SETTABLE = (REQUIRED + OPTIONAL).freeze
 
       attr_accessor :imis_id_query_name, :username, :password
       attr_reader :environment, :logger, :logger_level, :logger_file
@@ -55,13 +58,14 @@ module Usps
       end
 
       def global_log_path
-        defined?(@global_log_path) ? @global_log_path : self.global_log_path = '/var/log/imis/imis.log'
+        return @global_log_path if defined?(@global_log_path)
+
+        self.global_log_path = DEFAULT_GLOBAL_LOG_PATH
       end
 
       def global_log_path=(path)
         @global_log_path = path
         @global_logger = build_global_logger
-        global_log_path
       end
 
       def silence!
@@ -88,7 +92,7 @@ module Usps
       def filtered_parameters = %i[password]
 
       def validate!
-        missing_config = REQUIRED_CONFIGS.filter_map { it if public_send(it).nil? }
+        missing_config = REQUIRED.filter_map { it if public_send(it).nil? }
         return if missing_config.empty?
 
         raise Errors::ConfigError, "Missing required configuration: #{missing_config.join(', ')}"

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

@@ -95,7 +95,7 @@ module Usps
             response_body['error_description']
           else
             # Unknown error type: just use the raw response
-            JSON.pretty_generate(response.body)
+            JSON.pretty_generate(response_body)
           end
         end
       end

data/lib/usps/imis/mapper.rb

@@ -30,7 +30,7 @@ module Usps
       def initialize(api = nil, imis_id: nil)
         @api = api || Api.new
         @api.imis_id = imis_id if imis_id
-        @logger ||= Imis.logger('Mapper')
+        @logger = Imis.logger('Mapper')
       end
 
       # Get a member's data for a specific field by arbitrary field name
@@ -68,8 +68,8 @@ module Usps
           business_objects[business_object_name] << field
         end
 
-        business_objects.flat_map do |business_object_name, fields|
-          api.on(business_object_name).get_fields(*fields)
+        business_objects.flat_map do |business_object_name, object_fields|
+          api.on(business_object_name).get_fields(*object_fields)
         end
       end
       alias fetch_all get_fields

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

@@ -18,7 +18,7 @@ module Usps
           @api = api || Api.new
           @api.imis_id = imis_id if imis_id
           @api.record_id = record_id if record_id
-          @logger ||= Imis.logger('Panel')
+          @logger = Imis.logger('Panel')
         end
 
         # Get a specific object from the Panel

data/lib/usps/imis/properties.rb

@@ -19,7 +19,7 @@ module Usps
         case value
         when String then value
         when Symbol then value.to_s
-        when Time, DateTime then value.strftime('%Y-%m-%dT%H:%I:%S')
+        when Time, DateTime then value.strftime('%Y-%m-%dT%H:%M:%S')
         when Integer then { '$type' => 'System.Int32', '$value' => value }
         when true, false then { '$type' => 'System.Boolean', '$value' => value }
         else

data/lib/usps/imis/query.rb

@@ -59,7 +59,7 @@ module Usps
         @page_size = page_size
         @offset = offset
         @count = 0
-        @logger ||= Imis.logger('Query', query_type)
+        @logger = Imis.logger('Query', query_type)
 
         logger.tagged('Name').debug query_name
         logger.tagged('Params').json query_params
@@ -113,7 +113,7 @@ module Usps
 
       # Fetch a raw query page
       #
-      def fetch = JSON.parse(submit(uri, authorize(http_get)).body)
+      def fetch = JSON.parse(submit(authorize(http_get)).body)
 
       # Reset query paging progress
       #

data/lib/usps/imis/requests.rb

@@ -7,23 +7,18 @@ module Usps
     module Requests
     private
 
-      def logger = raise("#{self.class.name} must implement #logger")
+      def logger = raise(Errors::ApiError, "#{self.class.name} must implement #logger")
 
       def token = api.token
       def token_expiration = api.token_expiration
-      def authenticate = api.send(:authenticate)
+      def authenticate = api.authenticate
 
       def http_get = Net::HTTP::Get.new(uri)
       def http_put = Net::HTTP::Put.new(uri)
       def http_post = Net::HTTP::Post.new(uri(id: ''))
       def http_delete = Net::HTTP::Delete.new(uri)
 
-      def client(uri)
-        Net::HTTP.new(uri.host, uri.port).tap do |http|
-          http.use_ssl = true
-          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-        end
-      end
+      def client = respond_to?(:http_connection) ? http_connection : api.http_connection
 
       # Authorize a request prior to submitting
       #
@@ -37,13 +32,13 @@ module Usps
         request.tap { it.add_field('Authorization', "Bearer #{token}") }
       end
 
-      def submit(uri, request)
+      def submit(request)
         logger.info 'Submitting request to iMIS'
         logger.tagged('Request') do
           logger.debug "#{request.class.name.demodulize.upcase} #{uri}"
           logger.json sanitized_request_body(request)
 
-          client(uri).request(request).tap do |result|
+          client.request(request).tap do |result|
             raise Errors::ResponseError.from(result) unless result.is_a?(Net::HTTPSuccess)
 
             logger.info 'Request succeeded'

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.11.40'
+    VERSION = '0.11.41'
   end
 end

data/lib/usps/imis.rb

@@ -12,7 +12,7 @@ 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/isolated_execution_state' # Fix constant loading issue with TaggedLogging
 require 'active_support/tagged_logging'
 
 require 'dotenv/load'

metadata

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