usps-imis-api 0.10.0 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46a4e7cdf12bf5d20a7fca22f0efbdaa2b8d6d9b4f4419b8b787828de969f0b5
-  data.tar.gz: a3bd80bfb5bb48f495c60e07b7c93a91d834e40fc50ce9157c65bccbdd4be234
+  metadata.gz: 1bacafdd40f6a1fc863575164f8a29ff135e3f16a4c0dfcc0e2aa6983c55208f
+  data.tar.gz: 37854e85dda3f088d48cfa0a9a399f7d1c5e979f74c4d0c57b462090c6bcf8ae
 SHA512:
-  metadata.gz: 13a72cdd52375dd37a1856e3add682d4162e0a8cd6ae3fb72b78bb5bc9d834deff583662cff3a1d1fe73f7c69a664a53f1f6e8bf88b8eb10bc8fcaa77fe163d2
-  data.tar.gz: 6289ddfecf558b29c44cede8fdb44cd8fe694554351057c753b232951c5fcd1c945419afc20894b88d15426ba55881e7538ffeb11a8f7629e25dbd48cd219968
+  metadata.gz: 663df0b691ea1add42032df1cfd693667baafc2d39ddd01813c3ada66bf04c52b4bb1285a3d23f387fae17a8842f6be2f06299c88fbee7aff33f3a8aa39f02a2
+  data.tar.gz: 839207827b65431fdf565b35cb9c6c98bc4b75d0807ee852ea5bcbfe09c99234b784b77caba2af0e141f04b67afdeec6973e58184f6be3a598ddebcb969173a3

data/Readme.md

@@ -83,7 +83,21 @@ api.imis_id = imis_id
 
 #### Without an iMIS ID
 
-Running requests without an iMIS ID set will result in query results returned from the API.
+Running requests without an iMIS ID set will raise an exception.
+
+If you want to query the entire Business Object, use the query interface instead:
+
+```ruby
+api = Usps::Imis::Api.new # No iMIS ID set
+
+# These requests are identical:
+
+Usps::Imis::Query.new(api, 'ABC_ASC_Individual_Demog')
+
+api.on('ABC_ASC_Individual_Demog').query
+
+api.query('ABC_ASC_Individual_Demog')
+```
 
 ### Business Object and Panel Actions
 

data/lib/usps/imis/api.rb

@@ -106,7 +106,7 @@ module Usps
       # @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
+      # @return [Usps::Imis::Query] Query wrapper
       #
       def query(query_name, query_params = {}) = Query.new(self, query_name, **query_params)
 

data/lib/usps/imis/business_object.rb

@@ -35,6 +35,8 @@ module Usps
 
       # Run a query on the entire business object
       #
+      # @return [Usps::Imis::Query] Query wrapper
+      #
       def query = api.query(business_object_name)
 
       # Get a business object for the current member
@@ -155,13 +157,7 @@ module Usps
             # Skip unmodified fields
             next unless fields.keys.include?(value['Name'])
 
-            # Strings are not wrapped in the type definition structure
-            new_value = fields[value['Name']]
-            if new_value.is_a?(String)
-              value['Value'] = new_value
-            else
-              value['Value']['$value'] = new_value
-            end
+            value['Value'] = Properties.wrap(fields[value['Name']])
 
             # Add the completed field with the updated value
             updated['Properties']['$values'] << value

data/lib/usps/imis/properties.rb

@@ -9,6 +9,19 @@ module Usps
       #
       def self.build(&) = new.build(&)
 
+      # Wrap value in the API-internal type structure
+      #
+      def self.wrap(value)
+        case value
+        when String then value
+        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 }
+        else
+          raise Errors::UnexpectedPropertyTypeError.from(value)
+        end
+      end
+
       # Build the data for the Properties field
       #
       def build
@@ -29,22 +42,9 @@ module Usps
         @properties << {
           '$type' => 'Asi.Soa.Core.DataContracts.GenericPropertyData, Asi.Contracts',
           'Name' => name,
-          'Value' => wrap(value)
+          'Value' => self.class.wrap(value)
         }
       end
-
-    private
-
-      def wrap(value)
-        case value
-        when String then value
-        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 }
-        else
-          raise Errors::UnexpectedPropertyTypeError.from(value)
-        end
-      end
     end
   end
 end

data/lib/usps/imis/version.rb

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

metadata

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