usps-imis-api 0.6.13 → 0.6.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce718cab17b65f021cb739faa943d2437f2f4e83f051ad50c37a9ae0cfe48131
-  data.tar.gz: 34cece880ed383d43536f915b1c9480fe557587a61d69c9ed32c061932bbfd3a
+  metadata.gz: 05b1b663fab7b4f81c95f105c0c7f667bc2f5b9855b5fd48e5f384ce0adba8dc
+  data.tar.gz: '02529c44a577d5e239b3bd306cec0f9f91e53413ef3d921c5564352e8dca3d5f'
 SHA512:
-  metadata.gz: a05b5e0bc67ac874b306e688decd19d61c28d4a734165817395f2194a5ac2e166c5e75bcfc900488036f83941c81b4fd0c840810a261813d8b2ae343d5597608
-  data.tar.gz: aa402f52a26d2eb0d44928d9461707bc671d6ebf4f3e85325407762d2529b09668b02c2970f58528ad125d1e36c87718439817307f676b0858d764ac358cc7df
+  metadata.gz: e81f01c677aa5a22b1c7c5cfeb6e3119cc1f4387dc2076fec0001032879378f5be3cd562c3ccdd689a5e26e7becb4381a891249c175b025014d78638a36dd03e
+  data.tar.gz: 3e3f53303d8316f814cefffb3473ccb8e91c5fbd5146bc94b1701532c006fbf8b0ab905a156bd880e3fe6a2f1c2c4f79528c591df8b6ad6e26cb8cee7ab88346

data/Gemfile.lock

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

data/Readme.md

@@ -216,9 +216,9 @@ previous value.
 api.with(31092) do
   # These requests are identical:
 
-  on('ABC_ASC_Individual_Demog') { put('TotMMS' => 15) }
+  on('ABC_ASC_Individual_Demog') { put_fields('TotMMS' => 15) }
 
-  on('ABC_ASC_Individual_Demog').put('TotMMS' => 15)
+  on('ABC_ASC_Individual_Demog').put_fields('TotMMS' => 15)
 
   mapper.update(mm: 15)
 

data/lib/usps/imis/business_object.rb

@@ -39,6 +39,7 @@ module Usps
         result = submit(uri, authorize(request))
         JSON.parse(result.body)
       end
+      alias read get
 
       # Get a single named field from a business object for the current member
       #
@@ -52,6 +53,7 @@ module Usps
 
         value.is_a?(String) ? value : value['$value']
       end
+      alias fetch get_field
 
       # Update only specific fields on a business object for the current member
       #
@@ -63,6 +65,7 @@ module Usps
         updated = filter_fields(fields)
         put(updated)
       end
+      alias patch put_fields
 
       # Update a business object for the current member
       #
@@ -76,6 +79,7 @@ module Usps
         result = submit(uri, authorize(request))
         JSON.parse(result.body)
       end
+      alias update put
 
       # Create a business object for the current member
       #
@@ -89,6 +93,7 @@ module Usps
         result = submit(uri, authorize(request))
         JSON.parse(result.body)
       end
+      alias create post
 
       # Remove a business object for the current member
       #
@@ -99,6 +104,7 @@ module Usps
         result = submit(uri, authorize(request))
         result.body
       end
+      alias destroy delete
 
     private
 
@@ -127,19 +133,22 @@ 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'] = [existing['Properties']['$values'][0]]
+          #
+          updated['Properties']['$values'] = []
 
           # Iterate through all existing fields
           existing['Properties']['$values'].each do |value|
-            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
+            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
             end
 
             # Add the completed field with the updated value

data/lib/usps/imis/panel/base_panel.rb

@@ -22,31 +22,59 @@ module Usps
         def get(ordinal)
           api.on(business_object, ordinal:).get
         end
+        alias read get
 
-        # Create a new object in the Panel
+        # Get a single named field from a Panel for the current member
         #
-        # @param data [Hash] The record data for the desired object
+        # @param ordinal [Integer] The ordinal identifier for the desired object
+        # @param name [String] Field name to return
         #
-        def create(data)
-          api.on(business_object).post(payload(data))
+        # @return [Hash] Response data from the API
+        #
+        def get_field(ordinal, name)
+          api.on(business_object, ordinal:).get_field(name)
+        end
+        alias fetch get_field
+
+        # Update only specific fields on a Panel for the current member
+        #
+        # @param ordinal [Integer] The ordinal identifier for the desired object
+        # @param fields [Hash] Conforms to pattern +{ field_key => value }+
+        #
+        # @return [Hash] Response data from the API
+        #
+        def put_fields(ordinal, fields)
+          api.on(business_object, ordinal:).put_fields(fields)
         end
+        alias patch put_fields
 
         # Update an existing object in the Panel
         #
         # @param data [Hash] The record data for the desired object -- including the required
         #                    +ordinal+ identifier
         #
-        def update(data)
+        def put(data)
           api.on(business_object, ordinal: data[:ordinal]).put(payload(data))
         end
+        alias update put
+
+        # Create a new object in the Panel
+        #
+        # @param data [Hash] The record data for the desired object
+        #
+        def post(data)
+          api.on(business_object).post(payload(data))
+        end
+        alias create post
 
         # Remove a specific object from the Panel
         #
         # @param ordinal [Integer] The ordinal identifier for the desired object
         #
-        def destroy(ordinal)
+        def delete(ordinal)
           api.on(business_object, ordinal:).delete
         end
+        alias destroy delete
 
       private
 

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.6.13'
+    VERSION = '0.6.14'
   end
 end

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

@@ -26,8 +26,14 @@ describe Usps::Imis::Panel::Education do
       end
     end
 
+    describe '#get_field' do
+      it 'returns a specific field' do
+        expect(education.get_field(90737, 'ABC_Product_Code')).to eq('CRS')
+      end
+    end
+
     # rubocop:disable RSpec/ExampleLength
-    it 'handles new records correctly', :aggregate_failures do
+    it 'interacts with records correctly', :aggregate_failures do
       new_record = education.create(details)
       expect(new_record).to be_a(Hash)
 
@@ -40,6 +46,12 @@ describe Usps::Imis::Panel::Education do
       end
       expect(updated['Value']).to eq('Online Exams System - Modified')
 
+      put_fields_result = education.put_fields(ordinal, 'ABC_Educ_Source_System' => 'Online Exams System - Mod2')
+      patched = put_fields_result['Properties']['$values'].find do |v|
+        v['Name'] == 'ABC_Educ_Source_System'
+      end
+      expect(patched['Value']).to eq('Online Exams System - Mod2')
+
       expect(education.destroy(ordinal)).to eq('')
     end
     # rubocop:enable RSpec/ExampleLength

metadata

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