usps-imis-api 0.6.15 → 0.6.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ece5a19e925e1ef85b9e54b1d8fe7139c4015b0a1fe7ddcb602e172fbb50cab
-  data.tar.gz: 723eb4ccbf3b0c86c3f309c83d32d2b892420c688fd1f8aa2bfedcc47d61d2a9
+  metadata.gz: 9d68eb23f00014bc9cb6173f716084f8eff9cedfc48e70507c07a35fe8e7b207
+  data.tar.gz: fda5c7882bc758d9cfdd2889e734ff8c0d319f456e39bf1965f030765ec82a0e
 SHA512:
-  metadata.gz: fbca9aeda6a7a4e7fc6701c2767da349ab49e6b9126b36ea0a6225b4c18b2c7970dc22390ddabfbf571411d76b86ab2b37bbde79f471f4b5a3ceba9d271fdd5c
-  data.tar.gz: 3b09c75a050ad32e8077d9bc07772d91bb37a7e4628734c0159cb05a206f7f9128059532e22e90f014f07041f2ac87d0d37c2d7878845069c1220ec221cb4e69
+  metadata.gz: bb42f257b1e4e6c6383dd9b1f37d68e9c89f358f98bfccb09c53190573da28b0259fabe27e12f50c5420daa8f009661e928463c19a48e854abd86b8dd34021f1
+  data.tar.gz: a4fb539ef056e6936e1546b303ef8b20bf52a822185063d8b6eabc042eb5b3f2b2fceb5d0cff5959c40ce524175a137dd1821783af7eea495803342c1d065cff

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (0.6.15)
+    usps-imis-api (0.6.16)
       activesupport (~> 8.0)
 
 GEM

data/Readme.md

@@ -77,7 +77,13 @@ You can also manually set the current ID, if you already have it for a given mem
 api.imis_id = imis_id
 ```
 
-### GET
+### Business Object and Panel Actions
+
+Business Objects and Panels support the following actions.
+
+Panels require passing in the ordinal identifier as an argument, except for `POST`.
+
+#### GET
 
 To fetch member data, run e.g.:
 
@@ -87,7 +93,9 @@ api.imis_id = 31092
 data = api.on('ABC_ASC_Individual_Demog').get
 ```
 
-### GET Field
+Alias: `read`
+
+#### GET Field
 
 To fetch a specific field from member data, run e.g.:
 
@@ -97,7 +105,9 @@ api.imis_id = 31092
 tot_mms = api.on('ABC_ASC_Individual_Demog').get_field('TotMMS')
 ```
 
-### PUT Fields
+Alias: `fetch`
+
+#### PUT Fields
 
 To update member data, run e.g.:
 
@@ -111,7 +121,9 @@ update = api.on('ABC_ASC_Individual_Demog').put_fields(data)
 This method fetches the current data structure, and filters it down to just what you want to
 update, to reduce the likelihood of update collisions or type validation failures.
 
-### PUT
+Alias: `patch`
+
+#### PUT
 
 To update member data, run e.g.:
 
@@ -121,9 +133,13 @@ api.imis_id = 31092
 update = api.on('ABC_ASC_Individual_Demog').put(complete_imis_object)
 ```
 
-This method requires a complete iMIS data structure.
+This method requires a complete iMIS data structure. However, any properties not included will be
+left unmodified (meaning this also effectively handles `PATCH`, though iMIS does not accept that
+HTTP verb).
+
+Alias: `update`
 
-### POST
+#### POST
 
 To create new member data, run e.g.:
 
@@ -133,7 +149,9 @@ created = api.on('ABC_ASC_Individual_Demog').post(complete_imis_object)
 
 This method requires a complete iMIS data structure.
 
-### DELETE
+Alias: `create`
+
+#### DELETE
 
 To remove member data, run e.g.:
 
@@ -145,6 +163,8 @@ api.on('ABC_ASC_Individual_Demog').delete
 
 This returns a blank string on success.
 
+Alias: `destroy`
+
 ### QUERY
 
 Run an IQA Query
@@ -187,7 +207,8 @@ vsc.api.imis_id = 6374
 vsc.get(1417)
 
 created = vsc.create(certificate: 'E136924', year: 2024, count: 42)
-ordinal = created['Properties']['$values'][1]['Value']['$value']
+ordinal = created['Properties']['$values'].find { it['Name'] == 'Ordinal' }['Value']['$value']
+# ordinal = created['Identity']['IdentityElements']['$values'][1] # Alternative
 
 vsc.update(certificate: 'E136924', year: 2024, count: 43, ordinal: ordinal)
 

data/lib/usps/imis/api.rb

@@ -132,15 +132,6 @@ module Usps
         results
       end
 
-      # An instance of +BusinessObject+, using this instance as its parent +Api+
-      #
-      # @param business_object_name [String] Name of the business object
-      # @param ordinal [Integer] Ordinal to build override ID param of the URL (e.g. used for Panels)
-      #
-      def business_object(business_object_name, ordinal: nil)
-        BusinessObject.new(self, business_object_name, ordinal:)
-      end
-
       # Run requests as DSL, with specific +BusinessObject+ only maintained for this scope
       #
       # If no block is given, this returns the specified +BusinessObject+.
@@ -149,7 +140,7 @@ module Usps
       # @param ordinal [Integer] Ordinal to build override ID param of the URL (e.g. used for Panels)
       #
       def on(business_object_name, ordinal: nil, &)
-        object = business_object(business_object_name, ordinal:)
+        object = BusinessObject.new(self, business_object_name, ordinal:)
         return object unless block_given?
 
         object.instance_eval(&)

data/lib/usps/imis/mapper.rb

@@ -47,7 +47,7 @@ module Usps
         end
 
         updates.map do |business_object_name, field_updates|
-          api.business_object(business_object_name).put_fields(field_updates)
+          api.on(business_object_name).put_fields(field_updates)
         end
       end
 

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.6.15'
+    VERSION = '0.6.16'
   end
 end

data/spec/lib/usps/imis/api_spec.rb

@@ -56,7 +56,7 @@ describe Usps::Imis::Api do
     before { api.imis_id = 31092 }
 
     it 'sends an update' do
-      expect(api.business_object('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15)).to(
+      expect(api.on('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15)).to(
         be_a(Hash)
       )
     end
@@ -78,7 +78,7 @@ describe Usps::Imis::Api do
       end
 
       it 'wraps the error' do
-        expect { api.business_object('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15) }.to(
+        expect { api.on('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15) }.to(
           raise_error(Usps::Imis::Error::ApiError, warning_text)
         )
       end
@@ -88,7 +88,7 @@ describe Usps::Imis::Api do
   describe '#with' do
     it 'sends an update from put' do
       expect(
-        api.with(31092) { business_object('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15) }
+        api.with(31092) { on('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15) }
       ).to be_a(Hash)
     end
 

metadata

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