huginn_acumen_product_agent 1.6.0 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '039c056f31f39d29c6dd956c1eea702c9719ee62c1549d1ee5eba1f7154aabcc'
-  data.tar.gz: 11cde731d4163bc95d8ea9b154171d8c1be4998812fdfa1c7bf9d3e78a77fd07
+  metadata.gz: 1025b857902f5c14f649104a892ec5d882201920933ca4f010b45cab3a25f480
+  data.tar.gz: 999d68b437f373c47b70f69f5d884c52a30c6788f46262beb226b24c2200bba0
 SHA512:
-  metadata.gz: ffe42c8cb2135556c76c64ee241b59256632196ef38ce920c365f6e501eab321d300142d41ed04eff1da9a6a98af8498cf683488408db113f1322916774b9b1f
-  data.tar.gz: 1ef83798e88e33c4a275dd298a0d6abb5cf48a920903ea7086838634d04226023e6be25f7c54b769d31b158c71326cf8d3ddc1aee5af8ba1b292dd1b7ffeb63a
+  metadata.gz: 46ea5a9bd225a32c1af84c9a14becb87b71a4c01038a85199e6dfc9bdea0f1073fef090738839f4d2cbc2a5d3b3b81e2d13da67cc9f6952dbd9542b7647a3014
+  data.tar.gz: c08f0f45ed92defb6704b6b821053859c959c0a4061c5f58b094bac7c5bb5ca3c7e1bf0bda93ff2117d11134533945d00a6b65df1a6ed1214c2ac242a88c2782

data/lib/huginn_acumen_product_agent/acumen_client.rb

@@ -95,6 +95,8 @@ class AcumenClient
                   <column_name>Inv_Product.Category</column_name>
                   <column_name>Inv_Product.Next_Release</column_name>
                   <column_name>Inv_Product.BO_Reason</column_name>
+                  <column_name>Inv_Product.Not_On_Website</column_name>
+                  <column_name>Inv_Product.Not_Active</column_name>
               </requested_output>
           </acusoapRequest>
       XML

data/lib/huginn_acumen_product_agent/acumen_product_agent.rb

@@ -11,7 +11,28 @@ module Agents
         default_schedule 'never'
 
         description <<-MD
-      Huginn agent for sane ACUMEN product data.
+      Huginn agent for retrieving sane ACUMEN product data.
+
+      ## Agent Options
+      The following outlines the available options in this agent
+
+      ### Acumen Connection
+      * endpoint: The root URL for the Acumen API
+      * site_code: The site code from Acumen
+      * password: The Acumen API password
+
+      ### Variant Settings
+      * physical_formats: A list of the formats associated with a physical product
+      * digital_formats: A list of the formats associated with a digital product
+
+      ### Product Attributes
+      * attribute_to_property: An optional map linking Acumen attributes to Schema.org
+        product properties.
+
+      ### Other Options
+      * ignore_skus: An optional array of Acumen product skus that will be intentionally
+        excluded from any output.
+
         MD
 
         def default_options
@@ -22,7 +43,6 @@ module Agents
                 'physical_formats' => [],
                 'digital_formats' => [],
                 'attribute_to_property' => {},
-                'contributor_types_map' => {},
             }
         end
 
@@ -51,10 +71,6 @@ module Agents
                 errors.add(:base, "if provided, attribute_to_property must be a hash")
             end
 
-            unless options['contributor_types_map'].is_a?(Hash)
-                errors.add(:base, "if provided, contributor_types_map must be a hash")
-            end
-
             if options['ignore_skus']
               unless options['ignore_skus'].is_a?(Array)
                   errors.add(:base, "if provided, ignore_skus must be an array")
@@ -96,6 +112,7 @@ module Agents
             ids = event.payload['ids']
             products = get_products_by_ids(client, ids)
             products = get_product_variants(client, products, physical_formats, digital_formats)
+            products = get_master_products_by_id(client, products)
             products = get_product_categories(client, products)
             products = get_product_contributors(client, products)
 

data/lib/huginn_acumen_product_agent/concerns/acumen_product_query_concern.rb

@@ -10,6 +10,8 @@ module AcumenProductQueryConcern
 
     def get_products_by_ids(acumen_client, ids)
         response = acumen_client.get_products(ids)
+        products = []
+
         products = parse_product_request(response)
 
         response = acumen_client.get_products_marketing(ids)
@@ -69,6 +71,35 @@ module AcumenProductQueryConcern
         products
     end
 
+    def get_master_products_by_id(client, products)
+        master_products = []
+
+        products.each do |product|
+            wrapper_id = product['identifier']
+            master_id = 0
+            product['model'].each do |variant|
+                if variant['acumenAttributes']['is_master'] && variant['isAvailableForPurchase']
+                    master_id = variant['identifier']
+                end
+            end
+            if wrapper_id == master_id || master_id == 0
+                master_products.push(product)
+            else
+                if (master_products.find { |p| p['identifier'] == master_id }).nil?
+                    reloaded_product = get_products_by_ids(client, [master_id.to_s])[0]
+
+                    unless reloaded_product.nil?
+                        reloaded_product['model'] = product['model']
+                        reloaded_product['additionalProperty'].push(product['additionalProperty'].select { |m| m['propertyID'] == 'baseSku'}[0])
+                        master_products.push(reloaded_product)
+                    end
+                end
+            end
+        end
+
+        master_products
+    end
+
     def get_product_variants(acumen_client, products, physical_formats, digital_formats)
         ids = products.map { |product| product['identifier'] }
         # fetch product/variant relationships
@@ -86,20 +117,27 @@ module AcumenProductQueryConcern
 
     def get_product_categories(acumen_client, products)
         # fetch categories
-        skus = products.map { |product| product['sku'] }
-        response = acumen_client.get_product_categories(skus)
-        categories = process_product_categories_query(response)
+        categories_map = {}
+
+        skus = products.map { |product| product['model'].map { |m| m['sku'] } }
+        skus.each do |sku_set|
+            sku_set.each do |sku|
+              response = acumen_client.get_product_categories([sku])
+              categories = process_product_categories_query(response)
+              categories_map[sku] = categories != {} ? categories[sku] : []
+            end
+        end
 
         # map categories to products
         products.each do |product|
-            sku = product['sku']
-            if categories[sku]
-                active = categories[sku].select { |c| c['inactive'] == '0' }
-                product['categories'] = active.map do |category|
-                  {
-                    '@type' => 'Thing',
-                    'identifier' => category['category_id']
-                  }
+            product['model'].each do |variant|
+                variant['categories'] = []
+                categories = categories_map[variant['sku']].select { |c| c['inactive'] == '0' }
+                categories.map do |c|
+                    variant['categories'].push({
+                      '@type' => 'Thing',
+                      'identifier' => c['category_id']
+                    })
                 end
             end
         end
@@ -120,6 +158,7 @@ module AcumenProductQueryConcern
             variant['@type'] = 'ProductModel'
             variant['isDefault'] = false
             variant['isTaxable'] = field_value(p, 'Inv_Product.Taxable') == '1'
+            variant['isAvailableForPurchase'] = field_value(p, 'Inv_Product.Not_On_Website') == '0'
             variant['acumenAttributes'] = {
               'is_master' => field_value(p, 'Inv_Product.OnWeb_LinkOnly') == '0'
             }
@@ -154,6 +193,7 @@ module AcumenProductQueryConcern
                     'info_alpha_1' => field_value(p, 'Inv_Product.Info_Alpha_1'),
                     'info_boolean_1' => field_value(p, 'Inv_Product.Info_Boolean_1'),
                 },
+                'isAvailableForPurchase' => field_value(p, variant['isAvailableForPurchase']),
             }
 
             category = field_value(p, 'Inv_Product.Category')
@@ -397,6 +437,7 @@ module AcumenProductQueryConcern
         result.each do |product|
           if product['model'].length == 1
             product['model'][0]['isDefault'] = true
+            set_base_sku(product, product['model'][0]['sku'])
             next
           else
             physical_formats.each do |val|
@@ -417,6 +458,17 @@ module AcumenProductQueryConcern
               end
             end
           end
+
+          model_ids = product['model'].map { |m| m['identifier'] }
+          primary_variant = product['model'].select { |m| m['identifier'] == model_ids.min }.first
+
+          # Set the base SKU to the SKU of the oldest record.
+          # The base_sku property is designed to be a system value specific to the inegration using this agent.
+          # As a result, we don't particularly care what that value is so long as we can retrieve it consistently
+          # across executions. If a paperback product is created first, this will always return that product's SKU
+          # as the base. This gives us a consistent way to link Acumen products to an external system where database
+          # IDs may not match.
+          set_base_sku(product, primary_variant ? primary_variant['sku'] : product['model'][0]['sku'])
         end
         result
     end
@@ -436,6 +488,18 @@ module AcumenProductQueryConcern
         field[key]['__content__'] if field[key]
     end
 
+    def set_base_sku(product, sku)
+
+      product['additionalProperty'].push({
+          '@type' => 'PropertyValue',
+          'propertyID' => 'baseSku',
+          'name' => 'Base SKU',
+          'value' => sku,
+      })
+
+      product
+    end
+
     def quantitative_value(value, unit)
       {
         '@type' => 'QuantitativeValue',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huginn_acumen_product_agent
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.3
 platform: ruby
 authors:
 - Jacob Spizziri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-12 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler