usps-imis-api 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8075b08c9527b8309ac2e784db46c2e9dc6d922b5a4ee7392fbb493ece0bdb8
-  data.tar.gz: 1f37a85470c68ee132e42e10f26cf3d6be97700d160fbd7479d14bdcd3f23474
+  metadata.gz: 3b20172987ecd5b1bd13b0f142b616d71704e906aed312d71dca5e9b63c8432c
+  data.tar.gz: aab0fa56ded131c2a116203ea292c15ab024d408309a03144aeb5e795df77820
 SHA512:
-  metadata.gz: 158b6e90ec01dc5b1d8f3f9ddad0d91434ba86facfe05b1547aaa4ba3a16679092f6e4c4a83d6c96d3ff1e02724bd1c8d8e4aa42eb45782019f18989036842ba
-  data.tar.gz: 298cf14dee964a5c6c1029a68a629b3e0cd921ec7f3ff396947919269686c3233a160fe48d36eb7058431f7e8d5be8b9bd174c911c23f4cdf5bed836ea11b8b2
+  metadata.gz: 108e95c1487b42e6cf8508705e286094b1b79f7c2b3a10feb5bbf818d926837c1f5ca0f35e1f1bfc08b3a9a3a00e8e09f1b734dcde32e7995aa012ffceb78841
+  data.tar.gz: b42d7b63f8a0131003d8bb86cd4b2abc25e28842b6d79f9af01d426cd5dedbe64f81afa727b13658349b618a18203c5d60e88989528b3dc2cd1fb761a6ccebae

data/lib/usps/imis/api.rb

@@ -264,13 +264,14 @@ module Usps
       def http_connection
         return @http_connection if @http_connection&.started?
 
-        hostname = URI(Imis.configuration.hostname)
+        config = Imis.configuration
+        hostname = URI(config.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.open_timeout = config.open_timeout
+          http.read_timeout = config.read_timeout
+          http.write_timeout = config.write_timeout
           http.keep_alive_timeout = 30
           http.start
         end

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

@@ -45,6 +45,11 @@ module Usps
           @options = input_options.merge(**)
           options[:version] = true if default_options?
 
+          # Skip model loading, unless we explicitly need it, because the CLI
+          # generally only works with raw response data
+          #
+          Usps::Imis::Models.skip! unless options[:business_objects]
+
           configure!
           logging!
           @logger = Imis.logger('CommandLine')

data/lib/usps/imis/config.rb

@@ -10,8 +10,19 @@ module Usps
       IMIS_ROOT_URL_PROD = 'https://portal.americasboatingclub.org'
       IMIS_ROOT_URL_DEV = 'https://abcdev.imiscloud.com'
       DEFAULT_GLOBAL_LOG_PATH = '/var/log/imis/imis.log'
+
+      # Net::HTTP timeouts for the API connection (seconds). open_timeout governs connection
+      # establishment (TCP connect + TLS handshake) — the phase that stalls when iMIS is unreachable,
+      # so it defaults low to fail fast rather than pin the caller.
+      DEFAULT_OPEN_TIMEOUT = 3
+      DEFAULT_READ_TIMEOUT = 30
+      DEFAULT_WRITE_TIMEOUT = 30
+
       REQUIRED = %w[username password].freeze
-      OPTIONAL = %w[environment logger_file global_log_path pretty_print_api].freeze
+      OPTIONAL = %w[
+        environment logger_file global_log_path pretty_print_api
+        open_timeout read_timeout write_timeout
+      ].freeze
       SETTABLE = (REQUIRED + OPTIONAL).freeze
 
       class << self
@@ -24,13 +35,16 @@ module Usps
         end
       end
 
-      attr_accessor :username, :password, :pretty_print_api
+      attr_accessor :username, :password, :pretty_print_api, :open_timeout, :read_timeout, :write_timeout
       attr_reader :environment, :logger, :logger_level, :logger_file
 
       def initialize
         @environment = default_environment
         @username = ENV.fetch('IMIS_USERNAME', nil)
         @password = ENV.fetch('IMIS_PASSWORD', nil)
+        @open_timeout = Integer(ENV.fetch('IMIS_OPEN_TIMEOUT', DEFAULT_OPEN_TIMEOUT).to_s, 10)
+        @read_timeout = Integer(ENV.fetch('IMIS_READ_TIMEOUT', DEFAULT_READ_TIMEOUT).to_s, 10)
+        @write_timeout = Integer(ENV.fetch('IMIS_WRITE_TIMEOUT', DEFAULT_WRITE_TIMEOUT).to_s, 10)
         @base_logger = Logger.new($stdout, level: :info)
         @logger = ActiveSupport::TaggedLogging.new(@base_logger)
 

data/lib/usps/imis/models.rb

@@ -21,11 +21,17 @@ module Usps
         # Look up the registered Model class for an iMIS Business Object name.
         # Returns +nil+ if none is registered.
         #
-        def for_entity(name) = @registry[name.to_s]
+        def for_entity(name)
+          load!
+          @registry[name.to_s]
+        end
 
         # All registered Business Object names, sorted.
         #
-        def entity_names = @registry.keys.sort
+        def entity_names
+          load!
+          @registry.keys.sort
+        end
 
         # Register a Model subclass under its +business_object_name+. Called
         # from +Base.business_object+; tests can call +deregister+ for cleanup.
@@ -35,23 +41,52 @@ module Usps
         # Remove a Model subclass from the routing registry.
         #
         def deregister(name) = @registry.delete(name.to_s)
+
+        # Require all model files. Hand-written files at the top level go first
+        # (some — e.g. party.rb — require their own subdirectory). Auto-generated
+        # wrappers under generated/ are loaded next. Finally, files in associations/
+        # reopen previously-loaded classes to declare cross-model relationships;
+        # they're separated from generated/ so the generator doesn't clobber them.
+        #
+        # Deferred until first registry lookup so CLI startup (--help, --version)
+        # doesn't pay the cost of requiring several hundred model files.
+        #
+        # Trigger lazy load when callers reference a model constant directly
+        # (e.g. +Usps::Imis::Models::Party+) before any registry lookup has
+        # forced loading.
+        #
+        def const_missing(name)
+          return super if loaded? || skipped? || name == :Base
+
+          load!
+          const_get(name)
+        end
+
+        def load!
+          return if loaded? || skipped?
+
+          dir = File.expand_path('models', __dir__)
+          paths =
+            Dir[File.join(dir, '*.rb')] +
+            Dir[File.join(dir, 'generated', '*.rb')] +
+            Dir[File.join(dir, 'associations', '*.rb')]
+          paths
+            .reject { it.end_with?('models/base.rb') }
+            .map { it.sub(/\.rb$/, '') }
+            .each { require it }
+
+          @loaded = true
+        end
+
+        def skip!
+          @skipped = true
+        end
+
+        def loaded? = @loaded
+        def skipped? = @skipped
       end
     end
   end
 end
 
 require_relative 'models/base'
-
-# Require all other model files. Hand-written files at the top level go first
-# (some — e.g. party.rb — require their own subdirectory). Auto-generated
-# wrappers under generated/ are loaded next. Finally, files in associations/
-# reopen previously-loaded classes to declare cross-model relationships;
-# they're separated from generated/ so the generator doesn't clobber them.
-paths =
-  Dir[File.join(__dir__, 'models', '*.rb')] +
-  Dir[File.join(__dir__, 'models', 'generated', '*.rb')] +
-  Dir[File.join(__dir__, 'models', 'associations', '*.rb')]
-paths
-  .reject { it.end_with?('models/base.rb') }
-  .map { it.sub(/\.rb$/, '') }
-  .each { require it }

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.14.0'
+    VERSION = '0.15.0'
   end
 end

metadata

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