huginn_acumen_product_agent 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ad21ecb6e4948cfc5ce3e2ee77e5538a64ba3dfb7335ff393e676cad02a1ca2
-  data.tar.gz: 19b6969752c7f30a562cb957aaada0e97c19e616d0e5c2e8cc078d2b79a6101c
+  metadata.gz: f611c6b9e7567e84ec03753277031b227c70fee3afe17cfbf35be0c185932b4f
+  data.tar.gz: ecfc5e4acee56876eee9b4c3de78db3f6e40ff1cce60d5a6e834c75dae97523f
 SHA512:
-  metadata.gz: 42e77906d862630e4cd5b8eb08de74fdadd904bb6b7955a910e53f985f19639fc04b3fc5f39e4039a5d7a7b473c1a1158176e2b5d0097849182b3e9fcf5abac8
-  data.tar.gz: 280c0e72c100b17369b2bf18c578b8b4b50844efa72ea328918bbeebbc2fd2db0e60c3181ea6ea6fe2731d938827730a86507113b0d8f5606f0bd261b709e082
+  metadata.gz: 8ccf91cb1986314c492cbe9b0b189503504705bc6521a8f7861bbef9338bdb2e27ebb2036b5b595c55c33c52f1cb81e4534ca9686b3d2a67cd1fa6dfa2389e6b
+  data.tar.gz: 63b33acb6744b016c1f08ddf409d6580c2e78e57b46c93ccfe91326b7233b2dc54db09cd5fb52ee6eb49f6178f0439ee0b9518d87633baefcd0e52a5a7af9e10

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,
@@ -104,7 +127,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)
@@ -20,7 +22,16 @@ module AcumenProductQueryConcern
 
     def get_variants_for_ids(acumen_client, ids)
         result = get_linked_products_by_ids(acumen_client, ids)
-        result.select { |link| link['alt_format'].to_s != 0.to_s }
+
+        # Filtering out duplicate links getting sent from acumen
+        filter = []
+        result.each do |link|
+          if (link['alt_format'].to_s != 0.to_s && !link.in?(filter))
+            filter.push(link)
+          end
+        end
+
+        return filter
     end
 
     def get_linked_products_by_ids(acumen_client, ids)
@@ -77,20 +88,24 @@ module AcumenProductQueryConcern
 
     def get_product_categories(acumen_client, products)
         # fetch categories
-        skus = products.map { |product| product['sku'] }
+
+        skus = products.map { |product| product['model'].map { |m| m['sku'] } }[0]
         response = acumen_client.get_product_categories(skus)
         categories = process_product_categories_query(response)
 
         # 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'] = []
+                sku = variant['sku']
+                if categories[sku]
+                    active = categories[sku].select { |c| c['inactive'] == '0' }
+                    active.map do |category|
+                      variant['categories'].push({
+                        '@type' => 'Thing',
+                        'identifier' => category['category_id']
+                      })
+                    end
                 end
             end
         end
@@ -111,6 +126,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'
             }
@@ -145,6 +161,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')
@@ -375,9 +392,11 @@ module AcumenProductQueryConcern
         links.each do |link|
             from_id = link['from_id']
             to_id = link['to_id']
-            variant = variants_map[to_id]
-            variant['isDefault'] = false
-            products_map[from_id]['model'].push(*variant['model'])
+            if variants_map.key?(to_id)
+              variant = variants_map[to_id]
+              variant['isDefault'] = false
+              products_map[from_id]['model'].push(*variant['model'])
+            end
         end
 
         result = []
@@ -406,6 +425,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
@@ -425,6 +455,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.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Jacob Spizziri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler