usps-imis-api 0.9.7 → 0.9.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a78cd8daed5969574e8ec5fc3120a8a5a6c362e519918620ce41c2ed0fc0f26c
-  data.tar.gz: 0f20aa470ec2f2b8501f670046ee1071fea8552c22dd9f70165fb2ea986a46aa
+  metadata.gz: 80cb6198e125d3dc201641a6a70c639c8890094582fe6c293c807fb212a59738
+  data.tar.gz: e5382f2b08c9bffd26204cd06c3d55bc8604e7fa62ebc612a5b88a42a4029ab1
 SHA512:
-  metadata.gz: 41f2a2c9082ce49399a1a9b3e44ddd2cb86a8624d112ea6c36875e05da74db61cd6272f96819d0d889c5ac83e857f900ecaad357da9dd25a3b3094b7354dbce4
-  data.tar.gz: 131e53225ae3d111b49c64302a99d5b32227e45b2734c42ea2131d5de986c60c2d359c43aef10a5191ce03d6406c5f6bbe0fcfadd11843347533cef0dcd555f3
+  metadata.gz: ba2f8613ca13a61eda5d8a0c5a229e09d8226e74ca8611f83e80d6d3259e2f120f6fddab9ee2eb7740c0de150de8462537219147fe7d3c2aceafc5e0c8652dfc
+  data.tar.gz: 472196fce4e1a5e05287889b6d70e56bc72f5326944dafd114527865688d82f3208d7e4ae38b4161a176ea43663a7981eee196e145bbeac3d62f9c2f9b941713

data/.rubocop.yml

@@ -84,3 +84,6 @@ Security/JSONLoad:
   Enabled: true
 Security/YAMLLoad:
   Enabled: true
+
+RSpec/NestedGroups:
+  Max: 4

data/Gemfile.lock

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

data/Readme.md

@@ -213,7 +213,7 @@ end
 ### Field Mapper
 
 For fields that have already been mapped between the ITCom database and iMIS, you can use the
-Mapper class to further simplify the fetch / update interfaces:
+Mapper class to further simplify the `fetch` / `update` interfaces:
 
 ```ruby
 mm = api.mapper.fetch(:mm)
@@ -234,6 +234,7 @@ api[:mm]
 
 ```ruby
 api.update(mm: 15)
+api[:mm] = 15
 ```
 
 If there is no known mapping for the requested field, the Mapper will give up, but will provide
@@ -272,6 +273,7 @@ ordinal = created.raw['Identity']['IdentityElements']['$values'][1].to_i # Value
 vsc.update(certificate: 'E136924', year: 2024, count: 43, ordinal: ordinal)
 
 vsc.put_fields(ordinal, 'Quantity' => 44)
+vsc['Quantity'] = 44
 
 vsc.destroy(ordinal)
 ```
@@ -305,7 +307,12 @@ api.with(31092) do
   mapper.update(mm: 15)
 
   update(mm: 15)
+
+  mapper[:mm] = 15
 end
+
+# This request fetches the same data, but leaves the iMIS ID selected
+api.with(31092)[:mm] = 15
 ```
 
 ```ruby
@@ -333,8 +340,9 @@ api.with(31092) do
   on('ABC_ASC_Individual_Demog')['TotMMS']
 end
 
-# This request fetches the same data, but leaves the iMIS ID selected
+# These requests fetch the same data, but leave the iMIS ID selected
 api.with(31092).on('ABC_ASC_Individual_Demog').get_field('TotMMS')
+api.with(31092).on('ABC_ASC_Individual_Demog')['TotMMS']
 ```
 
 ### Data Methods

data/lib/usps/imis/api.rb

@@ -133,6 +133,11 @@ module Usps
       def fetch(field_key) = mapper.fetch(field_key)
       alias [] fetch
 
+      # Convenience alias for updating mapped fields
+      #
+      def put_field(field_key, value) = update(field_key => value)
+      alias []= put_field
+
       # Convenience alias for updating mapped fields
       #
       def update(data) = mapper.update(data)

data/lib/usps/imis/business_object.rb

@@ -66,6 +66,16 @@ module Usps
       end
       alias fetch_all get_fields
 
+      # Update a single named field on a business object for the current member
+      #
+      # @param field [String] Name of the field
+      # @param value Value of the field
+      #
+      # @return [Usps::Imis::Data] Response data from the API
+      #
+      def put_field(field, value) = put(filter_fields(field => value))
+      alias []= put_field
+
       # Update only specific fields on a business object for the current member
       #
       # @param fields [Hash] Conforms to pattern +{ field_key => value }+

data/lib/usps/imis/error.rb

@@ -17,6 +17,8 @@ module Usps
       def initialize(message, metadata = {})
         super(message)
         @metadata = metadata
+
+        Imis.logger.debug self
       end
 
       # Additional metadata to include in Bugsnag reports

data/lib/usps/imis/mapper.rb

@@ -28,6 +28,16 @@ module Usps
         @api.imis_id = imis_id if imis_id
       end
 
+      # Get a member's data for a specific field by arbitrary field name
+      #
+      # Does not require knowing which business object / iMIS-specific field name to use
+      #
+      # Only available for fields defined in +FIELD_MAPPING+
+      #
+      # @param field_key [Symbol] Internal name of the field
+      #
+      # @return Value of the field
+      #
       def fetch(field_key)
         missing_mapping!(field_key) unless FIELD_MAPPING.key?(field_key.to_sym)
 
@@ -36,6 +46,19 @@ module Usps
       end
       alias [] fetch
 
+      # Update a member's data for a specific field by arbitrary field name
+      #
+      # Does not require knowing which business object / iMIS-specific field name to use
+      #
+      # Only available for fields defined in +FIELD_MAPPING+
+      #
+      # @param field_key [Symbol] Internal name of the field
+      #
+      # @return Value of the field
+      #
+      def put_field(field_key, value) = update(field_key => value)
+      alias []= put_field
+
       # Update a member's data on multiple affected business objects by arbitrary field names
       #
       # Does not require knowing which business object / iMIS-specific field name to use

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

@@ -49,6 +49,16 @@ module Usps
         def get_fields(ordinal, *fields) = api.on(business_object, ordinal:).get_fields(*fields)
         alias fetch_all get_fields
 
+        # Update a single named field on a business object for the current member
+        #
+        # @param field [String] Name of the field
+        # @param value Value of the field
+        #
+        # @return [Usps::Imis::Data] Response data from the API
+        #
+        def put_field(field, value) = api.on(business_object, ordinal:).put_field(field, value)
+        alias []= put_field
+
         # Update only specific fields on a Panel for the current member
         #
         # @param ordinal [Integer] The ordinal identifier for the desired object

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.9.7'
+    VERSION = '0.9.8'
   end
 end

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

@@ -3,72 +3,85 @@
 require 'spec_helper'
 
 describe Usps::Imis::BusinessObject do
-  let(:business_object) { described_class.new(api, 'Stub') }
-  let(:api) { Usps::Imis::Api.new }
-
-  before do
-    allow(business_object).to receive(:raw_object).and_return(
-      Usps::Imis::Data[
-        'Properties' => {
-          '$values' => [
-            { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
-            { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
-            { 'Name' => 'Stub String', 'Value' => 'something' }
-          ]
-        }
-      ]
-    )
+  describe '#put_field' do
+    let(:business_object) { api.on('ABC_ASC_Individual_Demog') }
+    let(:api) { Usps::Imis::Api.new.with(31092) }
+
+    before { business_object.put_field('TotMMS', 15) }
+
+    it 'submits the correct update request' do
+      expect { business_object['TotMMS'] = 16 }.to change { business_object['TotMMS'] }.from(15).to(16)
+    end
   end
 
-  describe '#get' do
-    it 'returns multiple values' do
-      expect(business_object.get('Stub String', 'Stub Integer')).to eq(['something', 42])
+  context 'with stubbed data' do
+    let(:business_object) { described_class.new(api, 'Stub') }
+    let(:api) { Usps::Imis::Api.new }
+
+    before do
+      allow(business_object).to receive(:raw_object).and_return(
+        Usps::Imis::Data[
+          'Properties' => {
+            '$values' => [
+              { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
+              { 'Name' => 'Stub Integer', 'Value' => { '$value' => 42 } },
+              { 'Name' => 'Stub String', 'Value' => 'something' }
+            ]
+          }
+        ]
+      )
     end
 
-    describe 'delegation to get_fields' do
-      before { allow(business_object).to receive(:get_fields).with('Stub String', 'Stub Integer') }
+    describe '#get' do
+      it 'returns multiple values' do
+        expect(business_object.get('Stub String', 'Stub Integer')).to eq(['something', 42])
+      end
+
+      describe 'delegation to get_fields' do
+        before { allow(business_object).to receive(:get_fields).with('Stub String', 'Stub Integer') }
 
-      it 'delegates to get_fields' do
-        business_object.get('Stub String', 'Stub Integer')
+        it 'delegates to get_fields' do
+          business_object.get('Stub String', 'Stub Integer')
 
-        expect(business_object).to have_received(:get_fields).with('Stub String', 'Stub Integer')
+          expect(business_object).to have_received(:get_fields).with('Stub String', 'Stub Integer')
+        end
       end
     end
-  end
 
-  describe '#get_field' do
-    it 'returns a string value' do
-      expect(business_object.get_field('Stub String')).to eq('something')
-    end
+    describe '#get_field' do
+      it 'returns a string value' do
+        expect(business_object.get_field('Stub String')).to eq('something')
+      end
 
-    it 'returns an integer value' do
-      expect(business_object.get_field('Stub Integer')).to eq(42)
+      it 'returns an integer value' do
+        expect(business_object.get_field('Stub Integer')).to eq(42)
+      end
     end
-  end
 
-  describe '#get_fields' do
-    it 'returns multiple values' do
-      expect(business_object.get_fields('Stub String', 'Stub Integer')).to eq(['something', 42])
+    describe '#get_fields' do
+      it 'returns multiple values' do
+        expect(business_object.get_fields('Stub String', 'Stub Integer')).to eq(['something', 42])
+      end
     end
-  end
 
-  describe '#filter_fields' do
-    let(:expected) do
-      {
-        'Properties' => {
-          '$values' => [
-            { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
-            { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
-            { 'Name' => 'Stub String', 'Value' => 'other' }
-          ]
+    describe '#filter_fields' do
+      let(:expected) do
+        {
+          'Properties' => {
+            '$values' => [
+              { 'Name' => 'ID', 'Value' => { '$value' => '31092' } },
+              { 'Name' => 'Stub Integer', 'Value' => { '$value' => 43 } },
+              { 'Name' => 'Stub String', 'Value' => 'other' }
+            ]
+          }
         }
-      }
-    end
+      end
 
-    it 'formats fields correctly' do
-      updated = business_object.send(:filter_fields, 'Stub Integer' => 43, 'Stub String' => 'other')
+      it 'formats fields correctly' do
+        updated = business_object.send(:filter_fields, 'Stub Integer' => 43, 'Stub String' => 'other')
 
-      expect(updated).to eq(expected)
+        expect(updated).to eq(expected)
+      end
     end
   end
 end

metadata

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