usps-imis-api 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46a4e7cdf12bf5d20a7fca22f0efbdaa2b8d6d9b4f4419b8b787828de969f0b5
-  data.tar.gz: a3bd80bfb5bb48f495c60e07b7c93a91d834e40fc50ce9157c65bccbdd4be234
+  metadata.gz: 53b4870b15d7758a4de24b84f2ef96afbdf5fb657e8969ea6ceb29ef940a4f8c
+  data.tar.gz: '009005a1b43078f129671df80aa4271202073c549aafc1558ca3d4b23ed79a79'
 SHA512:
-  metadata.gz: 13a72cdd52375dd37a1856e3add682d4162e0a8cd6ae3fb72b78bb5bc9d834deff583662cff3a1d1fe73f7c69a664a53f1f6e8bf88b8eb10bc8fcaa77fe163d2
-  data.tar.gz: 6289ddfecf558b29c44cede8fdb44cd8fe694554351057c753b232951c5fcd1c945419afc20894b88d15426ba55881e7538ffeb11a8f7629e25dbd48cd219968
+  metadata.gz: 7ad3868896d1e9c80d39d7edf8a27f7e647838f069fb9b2cb58776c2e2befb87990b20e8cf080690a859c2b3b4fc87928a0f648c2217efaab095c69251de0138
+  data.tar.gz: b5004fabdeaa0a62ad9cdd43252ee3d09320eace98161283185afa7873a582e63a736537b052c90968335275c1b0878702218c291886a3a06fb370b644d0f246

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

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.10.0'
+    VERSION = '0.10.1'
   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.1
 platform: ruby
 authors:
 - Julian Fiander