usps-imis-api 0.6.13 → 0.6.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce718cab17b65f021cb739faa943d2437f2f4e83f051ad50c37a9ae0cfe48131
-  data.tar.gz: 34cece880ed383d43536f915b1c9480fe557587a61d69c9ed32c061932bbfd3a
+  metadata.gz: 1ece5a19e925e1ef85b9e54b1d8fe7139c4015b0a1fe7ddcb602e172fbb50cab
+  data.tar.gz: 723eb4ccbf3b0c86c3f309c83d32d2b892420c688fd1f8aa2bfedcc47d61d2a9
 SHA512:
-  metadata.gz: a05b5e0bc67ac874b306e688decd19d61c28d4a734165817395f2194a5ac2e166c5e75bcfc900488036f83941c81b4fd0c840810a261813d8b2ae343d5597608
-  data.tar.gz: aa402f52a26d2eb0d44928d9461707bc671d6ebf4f3e85325407762d2529b09668b02c2970f58528ad125d1e36c87718439817307f676b0858d764ac358cc7df
+  metadata.gz: fbca9aeda6a7a4e7fc6701c2767da349ab49e6b9126b36ea0a6225b4c18b2c7970dc22390ddabfbf571411d76b86ab2b37bbde79f471f4b5a3ceba9d271fdd5c
+  data.tar.gz: 3b09c75a050ad32e8077d9bc07772d91bb37a7e4628734c0159cb05a206f7f9128059532e22e90f014f07041f2ac87d0d37c2d7878845069c1220ec221cb4e69

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.13)
+    usps-imis-api (0.6.15)
       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)
 
@@ -237,7 +237,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/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
       #
@@ -48,10 +49,11 @@ 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
+      alias fetch get_field
 
       # Update only specific fields on a business object for the current member
       #
@@ -63,9 +65,12 @@ module Usps
         updated = filter_fields(fields)
         put(updated)
       end
+      alias patch put_fields
 
       # 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
@@ -76,6 +81,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 +95,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 +106,7 @@ module Usps
         result = submit(uri, authorize(request))
         result.body
       end
+      alias destroy delete
 
     private
 
@@ -127,11 +135,13 @@ module Usps
         existing = get
 
         JSON.parse(JSON.dump(existing)).tap do |updated|
-          # The first property is always the iMIS ID again
-          updated['Properties']['$values'] = [existing['Properties']['$values'][0]]
+          # 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|
+          properties.each do |value|
+            # Skip unmodified fields
             next unless fields.keys.include?(value['Name'])
 
             # Strings are not wrapped in the type definition structure

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/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/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.13'
+    VERSION = '0.6.15'
   end
 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
 
@@ -26,8 +25,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 +45,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

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.13
+  version: 0.6.15
 platform: ruby
 authors:
 - Julian Fiander