usps-imis-api 0.6.14 → 0.6.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05b1b663fab7b4f81c95f105c0c7f667bc2f5b9855b5fd48e5f384ce0adba8dc
-  data.tar.gz: '02529c44a577d5e239b3bd306cec0f9f91e53413ef3d921c5564352e8dca3d5f'
+  metadata.gz: 9d68eb23f00014bc9cb6173f716084f8eff9cedfc48e70507c07a35fe8e7b207
+  data.tar.gz: fda5c7882bc758d9cfdd2889e734ff8c0d319f456e39bf1965f030765ec82a0e
 SHA512:
-  metadata.gz: e81f01c677aa5a22b1c7c5cfeb6e3119cc1f4387dc2076fec0001032879378f5be3cd562c3ccdd689a5e26e7becb4381a891249c175b025014d78638a36dd03e
-  data.tar.gz: 3e3f53303d8316f814cefffb3473ccb8e91c5fbd5146bc94b1701532c006fbf8b0ab905a156bd880e3fe6a2f1c2c4f79528c591df8b6ad6e26cb8cee7ab88346
+  metadata.gz: bb42f257b1e4e6c6383dd9b1f37d68e9c89f358f98bfccb09c53190573da28b0259fabe27e12f50c5420daa8f009661e928463c19a48e854abd86b8dd34021f1
+  data.tar.gz: a4fb539ef056e6936e1546b303ef8b20bf52a822185063d8b6eabc042eb5b3f2b2fceb5d0cff5959c40ce524175a137dd1821783af7eea495803342c1d065cff

data/.rubocop.yml

@@ -37,6 +37,8 @@ Lint/UnusedMethodArgument:
   Enabled: true
 Lint/UselessAssignment:
   Enabled: true
+Lint/ItWithoutArgumentsInBlock:
+  Enabled: false
 
 Metrics/MethodLength:
   Enabled: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (0.6.14)
+    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)
 
@@ -237,7 +258,7 @@ api.with(31092) do
   # These requests are identical:
 
   on('ABC_ASC_Individual_Demog') do
-    get['Properties']['$values'].find { |hash| hash['Name'] == 'TotMMS' }['Value']['$value']
+    get['Properties']['$values'].find { it['Name'] == 'TotMMS' }['Value']['$value']
   end
 
   on('ABC_ASC_Individual_Demog') { get_field('TotMMS') }

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/business_object.rb

@@ -49,7 +49,7 @@ module Usps
       #
       def get_field(name)
         values = get['Properties']['$values']
-        value = values.find { |hash| hash['Name'] == name }['Value']
+        value = values.find { it['Name'] == name }['Value']
 
         value.is_a?(String) ? value : value['$value']
       end
@@ -69,6 +69,8 @@ module Usps
 
       # Update a business object for the current member
       #
+      # Any properties not included will be left unmodified
+      #
       # @param body [Hash] Full raw API object data
       #
       # @return [Hash] Response data from the API
@@ -133,22 +135,21 @@ module Usps
         existing = get
 
         JSON.parse(JSON.dump(existing)).tap do |updated|
-          # Wipe the array on the duped object
-          #
-          # The first property is always the iMIS ID again
-          #
-          updated['Properties']['$values'] = []
+          # Preserve the iMIS ID, as well as the Ordinal (if present)
+          updated['Properties']['$values'], properties =
+            existing['Properties']['$values'].partition { %w[ID Ordinal].include?(it['Name']) }
 
           # Iterate through all existing fields
-          existing['Properties']['$values'].each do |value|
-            if 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
+          properties.each do |value|
+            # 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
 
             # Add the completed field with the updated value

data/lib/usps/imis/error/response_error.rb

@@ -43,7 +43,7 @@ module Usps
         # @return [Hash]
         #
         def bugsnag_meta_data
-          base_metadata.tap { |m| m[:api].merge!(metadata) }
+          base_metadata.tap { it[:api].merge!(metadata) }
         end
 
         # Auto-formatted exception message, based on the provided API response

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/requests.rb

@@ -20,7 +20,7 @@ module Usps
       #
       def authorize(request)
         authenticate if token_expiration < Time.now
-        request.tap { |r| r.add_field('Authorization', "Bearer #{token}") }
+        request.tap { it.add_field('Authorization', "Bearer #{token}") }
       end
 
       def submit(uri, request)

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.6.14'
+    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
 

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

@@ -10,7 +10,7 @@ describe Usps::Imis::BusinessObject do
     {
       'Properties' => {
         '$values' => [
-          { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
+          { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
           { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
           { 'Name' => 'Stub String', 'Value' => 'other' }
         ]
@@ -22,7 +22,7 @@ describe Usps::Imis::BusinessObject do
     allow(business_object).to receive(:get).and_return({
       'Properties' => {
         '$values' => [
-          { 'Name' => 'Stub iMIS ID', 'Value' => { '$value' => '31092' } },
+          { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
           { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
           { 'Name' => 'Stub String', 'Value' => 'something' }
         ]

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

@@ -24,7 +24,7 @@ describe Usps::Imis::Config do
       subject { config.environment }
 
       let(:config) do
-        described_class.new { |c| c.environment = 'test' }
+        described_class.new { it.environment = 'test' }
       end
 
       it { is_expected.to be_test }

data/spec/lib/usps/imis/panel/education_spec.rb

@@ -14,7 +14,6 @@ describe Usps::Imis::Panel::Education do
         source: 'Online Exams System',
         code: 'MN',
         type_code: 'CRS'
-
       }
     end
 

data/spec/lib/usps/imis/panel/vsc_spec.rb

@@ -29,7 +29,7 @@ describe Usps::Imis::Panel::Vsc do
     ordinal = new_record['Identity']['IdentityElements']['$values'][1]
 
     update_result = vsc.update(details.merge(count: 43, ordinal:))
-    updated = update_result['Properties']['$values'].find { |v| v['Name'] == 'Quantity' }
+    updated = update_result['Properties']['$values'].find { it['Name'] == 'Quantity' }
     expect(updated['Value']['$value']).to eq(43)
 
     expect(vsc.destroy(ordinal)).to eq('')

metadata

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