huginn_acumen_product_agent 1.5.2 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dde4939a6f527acdc57c3cca3b489046521b4f9220e369d76424da6a34e18e5
-  data.tar.gz: dce7f773ea6ff04bf58a98816d6d7f1624e56148c722ee694488c06a10cd84a9
+  metadata.gz: 15346dc00cb87c79547be2024b2957762649181385a8863e98159acc7fc7c106
+  data.tar.gz: 18face53f1022e63bb4b554ba60736e00f592775b38909d559f6f5e2c7eea792
 SHA512:
-  metadata.gz: b665673955979aebd6a03fae4f240a40eb4ae4623103ee208bbcaf5ed5b220cc5619584bb0531b5cf8981c5cf2aa304907ab53bbcc402507689d38cb3064137b
-  data.tar.gz: 76435c4a56a302ff36d193ca3e8cb1c42a6ab862e2536b1e31f9b3272826ef25f929450f369f59c5cb66becd189501754b7045e78e32782c8a5bdefe9a4dacba
+  metadata.gz: 3ee1716eb040c991c36911b8d9fc514e6b1084a351ea92f037fb02c46b384b2d9de00c2f51d23b31eff9d98fa597f7e365c13a225f8187da1a8b689dcf385b91
+  data.tar.gz: 6cfc6a2383668400b21de9386207eda46aa01510f17f9471823377bd6763615ecdf7d884f2d3d579c2a5432d6f49d6e931f0e1bcc3c8d93209aac39907e3aeaa

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,8 +71,10 @@ 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")
+            if options['ignore_skus']
+              unless options['ignore_skus'].is_a?(Array)
+                  errors.add(:base, "if provided, ignore_skus must be an array")
+              end
             end
         end
 
@@ -78,6 +100,7 @@ module Agents
             password = interpolated['password']
             physical_formats = interpolated['physical_formats']
             digital_formats = interpolated['digital_formats']
+            ignore_skus = interpolated['ignore_skus'] ? interpolated['ignore_skus'] : []
 
             auth = {
                 'site_code' => site_code,
@@ -89,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)
 
@@ -104,7 +128,9 @@ module Agents
             end
 
             products.each do |product|
-                create_event payload: product
+                unless ignore_skus.include?(product['sku'])
+                  create_event payload: product
+                end
             end
         end
 

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,34 @@ 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']
+                        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 +116,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 +157,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 +192,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 +436,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 +457,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 +487,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.5.2
+  version: 1.7.2
 platform: ruby
 authors:
 - Jacob Spizziri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2020-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler