usps-imis-api 0.6.12 → 0.6.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03dbc937f5336d48ede502436a3ddcee7d77f8f357d18d807ac4119b52acf7e8
-  data.tar.gz: 9052ead6d9fb967e5faadb730d7000f32d0e97e83545e60fdef7e9a0b3deda18
+  metadata.gz: 05b1b663fab7b4f81c95f105c0c7f667bc2f5b9855b5fd48e5f384ce0adba8dc
+  data.tar.gz: '02529c44a577d5e239b3bd306cec0f9f91e53413ef3d921c5564352e8dca3d5f'
 SHA512:
-  metadata.gz: 33d7ced678ecc240e405b73fe5ba6c006fedece86612f76018296166c53e8226996b27617fb1a7212f885c4a5107c9c03186ad922106ccc79714e6a522127fd9
-  data.tar.gz: 78b04d51fde868adf81b86231083bdafdb6f08a7f6e7664ba3406b65557be09bb875cc9f1c37846a353872f784cdc872506b27415150ad1b5f79363b5baf29aa
+  metadata.gz: e81f01c677aa5a22b1c7c5cfeb6e3119cc1f4387dc2076fec0001032879378f5be3cd562c3ccdd689a5e26e7becb4381a891249c175b025014d78638a36dd03e
+  data.tar.gz: 3e3f53303d8316f814cefffb3473ccb8e91c5fbd5146bc94b1701532c006fbf8b0ab905a156bd880e3fe6a2f1c2c4f79528c591df8b6ad6e26cb8cee7ab88346

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    usps-imis-api (0.6.12)
+    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/api.rb

@@ -135,10 +135,10 @@ module Usps
       # An instance of +BusinessObject+, using this instance as its parent +Api+
       #
       # @param business_object_name [String] Name of the business object
-      # @param url_id [String] Override the ID param of the URL (e.g. used for Panels)
+      # @param ordinal [Integer] Ordinal to build override ID param of the URL (e.g. used for Panels)
       #
-      def business_object(business_object_name, url_id: nil)
-        BusinessObject.new(self, business_object_name, url_id:)
+      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
@@ -146,15 +146,13 @@ module Usps
       # If no block is given, this returns the specified +BusinessObject+.
       #
       # @param business_object_name [String] Name of the business object
-      # @param url_id [String] Override the ID param of the URL (e.g. used for Panels)
+      # @param ordinal [Integer] Ordinal to build override ID param of the URL (e.g. used for Panels)
       #
-      def on(business_object_name, url_id: nil, &)
-        object = business_object(business_object_name, url_id:)
+      def on(business_object_name, ordinal: nil, &)
+        object = business_object(business_object_name, ordinal:)
         return object unless block_given?
 
-        result = nil
-        object.tap { |obj| result = obj.instance_eval(&) }
-        result
+        object.instance_eval(&)
       end
 
       # An instance of +Mapper+, using this instance as its parent +Api+

data/lib/usps/imis/business_object.rb

@@ -18,16 +18,16 @@ module Usps
       #
       attr_reader :business_object_name
 
-      # Override ID param of the URL (e.g. used for Panels)
+      # Ordinal to build override ID param of the URL (e.g. used for Panels)
       #
-      attr_reader :url_id
+      attr_reader :ordinal
 
       # A new instance of +BusinessObject+
       #
-      def initialize(api, business_object_name, url_id: nil)
+      def initialize(api, business_object_name, ordinal: nil)
         @api = api
         @business_object_name = business_object_name
-        @url_id = url_id
+        @ordinal = ordinal
       end
 
       # Get a business object for the current member
@@ -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
       #
@@ -84,11 +88,12 @@ module Usps
       # @return [Hash] Response data from the API
       #
       def post(body)
-        request = Net::HTTP::Post.new(uri)
+        request = Net::HTTP::Post.new(uri(id: ''))
         request.body = JSON.dump(body)
         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
 
@@ -107,31 +113,42 @@ module Usps
 
       # Construct a business object API endpoint address
       #
-      def uri
-        id_for_url = url_id ? CGI.escape(url_id) : api.imis_id
-        full_path = "#{API_PATH}/#{business_object_name}/#{id_for_url}"
+      def uri(id: nil)
+        full_path = "#{API_PATH}/#{business_object_name}/#{id_for_uri(id)}"
         URI(File.join(Imis.configuration.hostname, full_path))
       end
 
+      # Select the correct ID to use in the URI
+      #
+      def id_for_uri(id = nil)
+        return CGI.escape(id) unless id.nil?
+        return CGI.escape("~#{api.imis_id}|#{ordinal}") if ordinal
+
+        api.imis_id
+      end
+
       # Manually assemble the matching data structure, with fields in the correct order
       #
       def filter_fields(fields)
         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

@@ -20,35 +20,61 @@ module Usps
         # @param ordinal [Integer] The ordinal identifier for the desired object
         #
         def get(ordinal)
-          api.business_object(business_object, url_id: "~#{api.imis_id}|#{ordinal}").get
+          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
+        #
+        # @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 create(data)
-          api.business_object(business_object, url_id: '').post(payload(data))
+        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)
-          api
-            .business_object(business_object, url_id: "~#{api.imis_id}|#{data[:ordinal]}")
-            .put(payload(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)
-          api.business_object(business_object, url_id: "~#{api.imis_id}|#{ordinal}").delete
+        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.12'
+    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.12
+  version: 0.6.14
 platform: ruby
 authors:
 - Julian Fiander