usps-imis-api 0.11.38 → 0.11.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8696718e5b2fdfe5d0f31f13c4b1183e078a2a96d707c89bf1ac57f1de7b2519
-  data.tar.gz: 1b06739853b3ed21b2d308219ee9f212aac43d530674ae13fdf1297411d7832a
+  metadata.gz: '09b163c4f02496fa2205d3ed3056f2e0e7bf7306b63f2176390a498503ca32d3'
+  data.tar.gz: c5e9dd8def7221e9f63f71e277ebbdbd3d6b8f080d93af5a5494b50149b649cd
 SHA512:
-  metadata.gz: 2c0b9a60ba2076b79bd123ba7219988f04bb25a687d6fc5c3d6ce11cc6e62c4ba4de0b4fbd983aa906b0f0780c1d2d6f965ec5b7b929e38a72271a3e0cdcbfe4
-  data.tar.gz: 2b19a230584337980aea3effba0a4784a2bfef41df9acf3b3bf867c6612a32d174c729a45835f6cfcd1f8602b59ca6423108b6eb5449f728647abb890ffb4ed7
+  metadata.gz: 2cf04565727807685ef016b823bdd798ac453ed9510d32b430c4b6e286b9f71d01ee6d2d08d15bcdfc3c55dc8168e42f224c9c2fddec2e9933c4e03ee34e03ed
+  data.tar.gz: b0a7eeb21ce375a205b1783f839eba1c02aa2040091319845729d33680e49cb43a373a256e3ac002037222516ef111bf8d08903181458c0e8a5fcc1180b30772

data/lib/usps/imis/api.rb

@@ -72,7 +72,7 @@ module Usps
       #
       # @param id [Integer, String] iMIS ID to select for future requests
       #
-      # @return [Integer] iMIS ID
+      # @return [Integer, String] iMIS ID
       #
       def imis_id=(id)
         raise Errors::LockedIdError if lock_imis_id
@@ -181,7 +181,7 @@ module Usps
       #
       # If no block is given, this returns the specified +BusinessObject+.
       #
-      # @param business_object_name [String] Name of the business object
+      # @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)
       #
       # @return [Usps::Imis::BusinessObject]

data/lib/usps/imis/blank_object.rb

@@ -20,13 +20,15 @@ module Usps
 
       # Build a blank object for the current iMIS ID
       #
-      def build(&) = payload_header.merge(Properties.build(parent.api.record_id.to_s, @ordinal&.to_s, &))
+      # @param hash [Hash] Hash version of props to set (block takes priority)
+      #
+      def build(hash = {}, &) = header.merge(Properties.build(parent.api.record_id.to_s, @ordinal&.to_s, hash, &))
 
     private
 
       def identity_type = 'System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib'
 
-      def payload_header
+      def header
         {
           '$type' => 'Asi.Soa.Core.DataContracts.GenericEntityData, Asi.Contracts',
           'EntityTypeName' => parent.business_object_name,

data/lib/usps/imis/business_object.rb

@@ -35,7 +35,7 @@ module Usps
       #
       def initialize(api, business_object_name, ordinal: nil)
         @api = api
-        @business_object_name = business_object_name
+        @business_object_name = business_object_name.to_s
         @ordinal = ordinal
         @logger ||= Imis.logger('BusinessObject')
       end
@@ -62,7 +62,7 @@ module Usps
       #
       # If +fields+ is provided, will return only those field values
       #
-      # @param fields [String] Field names to return
+      # @param fields [Array<String, Symbol>] Field names to return
       #
       # @return [Usps::Imis::Data, Array<Usps::Imis::Data>] Response data from the API
       #
@@ -71,23 +71,23 @@ module Usps
 
       # Get a single named field from a business object for the current member
       #
-      # @param field [String] Field name to return
+      # @param field [String, Symbol] Field name to return
       #
       # @return Response data field value from the API
       #
-      def get_field(field) = raw_object[field]
+      def get_field(field) = raw_object[field.to_s]
       alias fetch get_field
       alias [] get_field
 
       # Get named fields from a business object for the current member
       #
-      # @param names [Array<String>] Field names to return
+      # @param names [Array<String, Symbol>] Field names to return
       #
       # @return [Array] Response data from the API
       #
       def get_fields(*fields)
         values = raw_object
-        fields.map { values[it] }
+        fields.map { values[it.to_s] }
       end
       alias fetch_all get_fields
 
@@ -139,11 +139,13 @@ module Usps
 
       # Build a blank object for the current iMIS ID
       #
-      def blank_object(&) = BlankObject.new(self).build(&)
+      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
       #
-      def post_from_blank(&) = post(blank_object(&))
+      # @param hash [Hash] Hash version of props to set (block takes priority)
+      #
+      def post_from_blank(hash = {}, &) = post(blank_object(hash, &))
       alias create_from_blank post_from_blank
 
       # Ruby 3.5 instance variable filter
@@ -173,6 +175,8 @@ module Usps
       def filter_fields(fields)
         block_not_supported!
 
+        fields = fields.transform_keys(&:to_s)
+
         existing = get
 
         JSON.parse(JSON.dump(existing)).tap do |updated|

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

@@ -113,13 +113,29 @@ module Usps
           @options = parse_options.compact
           @arguments = ARGV # Not currently used
 
-          Optimist.educate if ARGV.empty? && defaults? # DEV: This shadows setting the --version flag by default
+          # Set the default behavior to --help instead of --version
+          #
+          # Passing any subcommands as arguments will cause this conditional to fail
+          #
+          # If this is disabled:
+          #
+          #   - The default behavior is to print just the version label to the terminal
+          #   - CommandLine::Performers#perform! *must* expect a `version:` pattern,
+          #     and will return a quoted string of the version label
+          #
+          Optimist.educate if ARGV.empty? && defaults?
 
           # :nocov:
           @options[:data] = read_stdin if stdin?
           # :nocov:
 
           @options[:data] = JSON.parse(@options[:data]) if @options[:data]
+
+          # Support shorthand for setting `certificate` param on queries
+          return unless @options[:query] && @options[:certificate]
+
+          @options[:data] ||= {}
+          @options[:data]['certificate'] = @options.delete(:certificate)
         end
 
       private
@@ -143,7 +159,12 @@ module Usps
         def read_stdin = $stdin.read.chomp
         # :nocov:
 
-        def defaults? = options[:log_level] == 'info' && options.except(:log_level).values.none?
+        def defaults?
+          options_with_defaults = 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?
+        end
       end
     end
   end

data/lib/usps/imis/properties.rb

@@ -9,14 +9,16 @@ 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)
       #
-      def self.build(id = nil, ordinal = nil, &) = new.build(id, ordinal, &)
+      def self.build(id = nil, ordinal = nil, hash = {}, &) = new.build(id, ordinal, hash, &)
 
       # Wrap value in the API-internal type structure
       #
       def self.wrap(value)
         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 Integer then { '$type' => 'System.Int32', '$value' => value }
         when true, false then { '$type' => 'System.Boolean', '$value' => value }
@@ -29,14 +31,18 @@ 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+
       #
-      def build(id = nil, ordinal = nil)
+      def build(id = nil, ordinal = nil, hash = {})
         @properties ||= []
 
         add('ID', id) if id
         add('Ordinal', ordinal) if ordinal
 
-        yield(self)
+        hash.each { |key, value| add(key, value) }
+
+        yield(self) if block_given?
 
         {
           'Properties' => {
@@ -48,10 +54,15 @@ module Usps
 
       # Add an individual property to the field
       #
+      # The last definition for a given property name will be used
+      #
       def add(name, value)
+        existing = @properties.find { it['Name'] == name.to_s }
+        @properties.delete(existing) if existing
+
         @properties << {
           '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
-          'Name' => name,
+          'Name' => name.to_s,
           'Value' => self.class.wrap(value)
         }
       end

data/lib/usps/imis/version.rb

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

metadata

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