usps-imis-api 0.11.41 → 0.11.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac3e7c47ae3555e7cb4d83bf24585b5b4ffac669c0f60dab014996566a4ad366
-  data.tar.gz: 547b0943b75e78b4ba4b968e3a780194cfe783eaef2301a4f5cacdee6e298c0e
+  metadata.gz: db2bc7a4cecec659c0b9d6c86ec8a5819f066537f35b0db089ca5f7df243c597
+  data.tar.gz: 7945390fbd0d073799a01e25cbfd9ffcd6a590da818055a39a7c6368a881e787
 SHA512:
-  metadata.gz: 5f7009001491dd4177d883335bdd63a2049bf157bbac66295d22c789dd1755b9672d096a760a000883f6397e4ee9c74d48cebae0c1868895e46c7b63577aaae6
-  data.tar.gz: 8509266846dab5d93389ee7486afb8f987202d1cfbda01b2e59894e2e5fe6caddf7e820b2c822335c7123535fac1b0d3ada220d9deaf20bb3ab56a3284fccd37
+  metadata.gz: 20eca697722eb6ef3d502afa3b87f46655feee6739eabec86580a032d28f590f29b619abdca8d25f56edcc77a7584305fe9911c73c596b5b70dd847d00fb1b96
+  data.tar.gz: 92676045e015b98881b8d40e5d99b9720ddae3618d3686837e6ac9ac0a5414308ba146f4a9339e64038f85c696abbc2d07f148c3a62bed14d93c9f9e7096f0b7

data/Readme.md

@@ -86,4 +86,4 @@ file to [rubygems.org](https://rubygems.org).
 A wrapper for the CLI from this API is
 [available for PHP](https://github.com/unitedstatespowersquadrons/imis-api-php).
 
-You can also view the [original PHP API](https://github.com/unitedstatespowersquadrons/imis-api).
+You can also view the (***deprecated***) [original PHP API](https://github.com/unitedstatespowersquadrons/imis-api).

data/lib/usps/imis/api.rb

@@ -139,6 +139,8 @@ module Usps
       # @param id [Integer, String] iMIS ID to select for requests within the block
       # @param certificate [String] Certificate number to convert to iMIS ID and select for requests within the block
       # @param record_id [Integer] Record ID to select for requests within the block
+      # @yield Block context to run requests with a specific iMIS ID
+      # @yieldparam [Api]
       #
       # @example
       #   with(12345) do
@@ -184,6 +186,8 @@ module Usps
       #
       # @param business_object_name [String, Symbol] Name of the business object
       # @param ordinal [Integer] Ordinal to build override ID param of the URL (e.g. used for Panels)
+      # @yield Block context to run requests on a specific +BusinessObject+
+      # @yieldparam [Api]
       #
       # @return [Usps::Imis::BusinessObject]
       #

data/lib/usps/imis/blank_object.rb

@@ -21,6 +21,8 @@ module Usps
       # Build a blank object for the current iMIS ID
       #
       # @param hash [Hash] Hash version of props to set (block takes priority)
+      # @yield Block context to define additional properties with +add+
+      # @yieldparam [Properties]
       #
       def build(hash = {}, &) = header.merge(Properties.build(parent.api.record_id.to_s, @ordinal&.to_s, hash, &))
 

data/lib/usps/imis/business_object.rb

@@ -139,11 +139,17 @@ module Usps
 
       # Build a blank object for the current iMIS ID
       #
+      # @param hash [Hash] Hash version of props to set (block takes priority)
+      # @yield Block context to define additional properties with +add+
+      # @yieldparam [Properties]
+      #
       def blank_object(hash = {}, &) = BlankObject.new(self).build(hash, &)
 
       # Create a business object for the current member, starting with a blank object and building properties
       #
       # @param hash [Hash] Hash version of props to set (block takes priority)
+      # @yield Block context to define additional properties with +add+
+      # @yieldparam [Properties]
       #
       def post_from_blank(hash = {}, &) = post(blank_object(hash, &))
       alias create_from_blank post_from_blank

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

@@ -17,7 +17,7 @@ module Usps
           local: File.join(Dir.pwd, 'imis.yml'),
           local_dot_config: File.join(Dir.pwd, '.config', 'imis.yml'),
           local_config: File.join(Dir.pwd, 'config', 'imis.yml'),
-          user: "#{Dir.home}/.config/imis.yml",
+          user: File.join(Dir.home, '.config', 'imis.yml'),
           system: '/usr/local/imis/config.yml'
         }.freeze
 

data/lib/usps/imis/config.rb

@@ -34,22 +34,36 @@ module Usps
         @logger_level = logger.class::SEV_LABEL[logger.level].downcase.to_sym
       end
 
+      # Define the API environment
+      #
+      # @param env [String] Environment to use
+      #
       def environment=(env)
         @environment = ActiveSupport::StringInquirer.new(env.to_s)
       end
 
+      # Override the main logger
+      #
+      # @param logger [Logger] Configured logging object
+      #
       def logger=(logger)
         @base_logger = logger.tap { it.formatter = LoggerFormatter.new }
         @base_logger.singleton_class.include(LoggerHelpers)
         @logger = ActiveSupport::TaggedLogging.new(@base_logger)
       end
 
+      # Define the main logger
+      #
+      # @param path [path, nil] Path to write log to, or +nil+ to log to +STDOUT+
+      #
       def logger_file=(path)
         @logger_file = path
         @base_logger = Logger.new(@logger_file.nil? ? $stdout : @logger_file, level: logger.level)
         @logger = ActiveSupport::TaggedLogging.new(@base_logger)
       end
 
+      # Current global mirror debug logger
+      #
       def global_logger
         return @global_logger if @global_logger
 
@@ -57,12 +71,18 @@ module Usps
         @global_logger
       end
 
+      # Current path for the global mirror debug logger
+      #
       def global_log_path
         return @global_log_path if defined?(@global_log_path)
 
         self.global_log_path = DEFAULT_GLOBAL_LOG_PATH
       end
 
+      # Define the global mirror debug logger
+      #
+      # @param path [path, nil] Path to write log to, or +nil+ to disable
+      #
       def global_log_path=(path)
         @global_log_path = path
         @global_logger = build_global_logger

data/lib/usps/imis/mapper.rb

@@ -39,14 +39,14 @@ module Usps
       #
       # Only available for fields defined in +FIELD_MAPPING+
       #
-      # @param field_key [Symbol] Internal name of the field
+      # @param field_key [String, Symbol] Internal name of the field
       #
       # @return Value of the field
       #
       def get_field(field_key)
         missing_mapping!(field_key) unless FIELD_MAPPING.key?(field_key.to_sym)
 
-        business_object_name, field = FIELD_MAPPING[field_key]
+        business_object_name, field = FIELD_MAPPING[field_key.to_sym]
         api.on(business_object_name)[field]
       end
       alias fetch get_field

data/lib/usps/imis/properties.rb

@@ -10,6 +10,8 @@ module Usps
       # @param id [String] iMIS ID to include in the properties before running the block
       # @param ordinal [String] Ordinal to include in the properties before running the block
       # @param hash [Hash] Hash version of props to set (block takes priority)
+      # @yield Block context to define additional properties with +add+
+      # @yieldparam [Properties]
       #
       def self.build(id = nil, ordinal = nil, hash = {}, &) = new.build(id, ordinal, hash, &)
 
@@ -33,6 +35,7 @@ module Usps
       # @param ordinal [String] Ordinal to include in the properties before running the block
       # @param hash [Hash] Hash version of props to set (block takes priority)
       # @yield Block context to define additional properties with +add+
+      # @yieldparam [Properties]
       #
       def build(id = nil, ordinal = nil, hash = {})
         @properties ||= []

data/lib/usps/imis/version.rb

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

metadata

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