huginn_acumen_product_agent 2.0.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30c918a4763fbc8b84145f83215cf46d9b162adeb32d025d206d7f7fa51ded41
-  data.tar.gz: 77b5d58d8de8f15e3908b920b04882fb0706974009c9fa1ea1fe93bb66b7f1d6
+  metadata.gz: 8324cf31340926d8867293c1431e596dc0da9f328f317e31924a27a9cbac3f6f
+  data.tar.gz: 2c486a789956c1b6e67a70162c63c6b68c55a4a4fed8f3c2831f5d78c8084c42
 SHA512:
-  metadata.gz: e2fe59ce492e910b0ca2c063938141a9f0ef6b64639fff28f34c3e01d577e5388d6007e1a135a51f01579677e60f2ee0e79e3aa2a449bfffba0e44242258953a
-  data.tar.gz: 92563dd015ec11f237a6a91d740d3ff682ddcb73e6598f1768c3dfa51c2c4e75cb8355c3ee7228a5f63a0f1470a483d21adb5bd324283f4efa45b7c77ccada50
+  metadata.gz: 8906fd96d8b41256e97b3810ebeb57c7d8e692a051f71f11ed8b9d6219371a83071b5fe72d57c2b8008910e1d89ac65ae2ef65b8ff366e444dbafc27407461e8
+  data.tar.gz: 89fa26696143748c0496c7d31a3c4f4d2466ecf0ebe873b57f838a0f8f92c20a6dbaf70a2e70f391b4c467581693b728ebb49a4d6694404793147c4141f17c45

data/lib/huginn_acumen_product_agent/acumen_agent_error.rb

@@ -1,5 +1,6 @@
 class AcumenAgentError < StandardError
-  attr_reader :thing
+  attr_reader :scope, :data, :original_error
+
   def initialize(scope, message, data, original_error)
     @scope = scope
     @data = data

data/lib/huginn_acumen_product_agent/acumen_client.rb

@@ -19,6 +19,12 @@ class AcumenClient
       get_results(response, 'ProdMkt')
   end
 
+  def get_inv_status(skus)
+      body = build_inv_status_query(skus)
+      response = execute_in_list_query(body, {})
+      get_results(response, 'Inv_Status')
+  end
+
   def get_linked_products(ids)
       body = build_linked_product_query(ids)
       response = execute_in_list_query(body, {})
@@ -97,6 +103,10 @@ class AcumenClient
                   <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>
+                  <column_name>Inv_Product.Disable_Web_Purchase</column_name>
+                  <column_name>Inv_Product.No_Backorder_Fill</column_name>
+                  <column_name>Inv_Product.Non_Inventory</column_name>
+                  <column_name>Inv_Product.Assembly</column_name>
               </requested_output>
           </acusoapRequest>
       XML
@@ -151,6 +161,28 @@ class AcumenClient
       XML
   end
 
+  def build_inv_status_query(skus)
+      <<~XML
+          <acusoapRequest>
+              #{build_acumen_query_auth()}
+              <query>
+                <statement>
+                  <column_name>Inv_Status.ProdCode</column_name>
+                  <comparator>in</comparator>
+                  <value>#{skus.join(',')}</value>
+                </statement>
+              </query>
+              <requested_output>
+                <view_owner_table_name>Inv_Status</view_owner_table_name>
+                <view_name>Inv_StatusAllRead</view_name>
+                  <column_name>Inv_Status.Warehouse</column_name>
+                  <column_name>Inv_Status.ProdCode</column_name>
+                  <column_name>Inv_Status.Available</column_name>
+              </requested_output>
+          </acusoapRequest>
+      XML
+  end
+
   def build_product_ids_since_request(since)
       <<~XML
           <acusoapRequest>
@@ -207,6 +239,7 @@ class AcumenClient
               <column_name>Product_Link.Link_From_ID</column_name>
               <column_name>Product_Link.Link_To_ID</column_name>
               <column_name>Product_Link.Alt_Format</column_name>
+              <column_name>Product_Link.Inactive</column_name>
             </requested_output>
           </acusoapRequest>
       XML

data/lib/huginn_acumen_product_agent/acumen_product_agent.rb

@@ -184,34 +184,46 @@ module Agents
         def fetch_products(acumen_client, product_ids, digital_format_list)
             products = fetch_inv_product_data(acumen_client, product_ids, digital_format_list)
             products = fetch_product_marketing(acumen_client, products)
+            products = fetch_inv_status(acumen_client, products)
             products = fetch_product_contributors(acumen_client, products)
             products = fetch_product_categories(acumen_client, products)
 
             products.each do |product|
                 map_attributes(product)
+                update_availability(product)
             end
 
             return products
         end
 
-        # Returns an array of product bundles for the provided `products` array.
-        # Each bundle will contain an array of all the product definitions for each
-        # format of a given title.
+        # Loads product bundles for the provided `product_ids` array and emits
+        # a unique event payload for each bundle. Emitted events will contain an
+        # array of all the product definitions for each format of a given title.
         #
         # NOTE: The generated bundles will contain both active and inactive products
         # to facilitate product deletion in external systems.
         def fetch_product_bundles(acumen_client, product_ids, digital_format_list, ignored_skus)
 
           begin
-            alternate_ids_map = fetch_alternate_format_ids(acumen_client, product_ids)
+            data = fetch_alternate_format_ids(acumen_client, product_ids)
+            full_id_set = data[:id_set]
+            alternate_ids_map = data[:alternate_ids_map]
+            product_data = fetch_products(acumen_client, full_id_set, digital_format_list)
 
             bundles = product_ids.map do |id|
               bundle_ids = alternate_ids_map[id]
               bundle_ids.append(id) unless bundle_ids.include?(id)
-              bundle = fetch_products(acumen_client, bundle_ids.sort, digital_format_list)
-
-              # Filter out any products that are explicitly ignored by SKU
-              bundle.select { |p| !ignored_skus.include?(p['sku']) }
+              bundle_ids.sort()
+
+              bundle = []
+              bundle_ids.each() do |b_id|
+                # Filter out any products that are explicitly ignored by SKU
+                product = product_data.find { |p| p['identifier'] == b_id.to_s }
+                bundle << product unless product.nil? || ignored_skus.include?(product['sku'])
+                # NOTE: The product.nil? check is designed to handle cases where a product link
+                # points to a non existent product. Conventionally this shouldn't happen, but
+                # we've seen it, and need to account for it.
+              end
 
               create_event payload: { products: bundle, status: 200 }
             end
@@ -242,5 +254,23 @@ module Agents
                 end
             end
         end
+
+        def update_availability(product)
+            stock_quantity = product['acumenAttributes']['stock_quantity']
+            publication_date = product['datePublished']
+            no_backorder_fill = product['noBackorderFill']
+            stock_quantity = stock_quantity.present? ? stock_quantity.to_i : 0
+
+            if (!product['isDigital'] && product['productAvailability'] == 'available' && product['trackInventory'])
+                if ((publication_date && publication_date.to_datetime > DateTime.current().end_of_day) || (!no_backorder_fill && stock_quantity < 1))
+                    product['productAvailability'] = 'preorder'
+                end
+                
+                if (no_backorder_fill && stock_quantity < 1)
+                    product['productAvailability'] = 'not available'
+                end
+            end
+        end
+
     end
 end

data/lib/huginn_acumen_product_agent/concerns/acumen_query_concern.rb

@@ -50,9 +50,7 @@ module AcumenQueryConcern
       status: status,
       scope: error.scope,
       message: error.message,
-      original_error: error.original_error,
       data: error.data,
-      trace: error.original_error.backtrace,
     }
   end
 end

data/lib/huginn_acumen_product_agent/concerns/alternate_products_query_concern.rb

@@ -12,14 +12,25 @@
 module AlternateProductsQueryConcern
   extend AcumenQueryConcern
 
-  # Fetches the Inv_Product.ID for alternate formats of the provided product_ids
+  # This function returns two data elements in a hash object.
+  # The `id_set` is the full collection of IDs to be fetched including the input
+  # product_ids and all of their alternate format ids. The goal of this value
+  # is to reduce the resource requirements of running each "bundle" individually
+  #
+  # The alternate_ids_map contains arrays of product IDs mapped to their master
+  # product id. This map will be used to assemble fetched product data into bundles
   def fetch_alternate_format_ids(acumen_client, product_ids)
     begin
       link_data = acumen_client.get_linked_products(product_ids)
 
       links = process_alternate_format_response(link_data)
 
-      return map_alternate_format_links(links, product_ids)
+      mapped_ids = map_alternate_format_links(links, product_ids)
+
+      id_set = [] + product_ids
+      mapped_ids.each_value { |bundle| id_set += bundle }
+
+      return {id_set: id_set, alternate_ids_map: mapped_ids }
     rescue => error
       issue_error(AcumenAgentError.new(
         'fetch_alternate_format_ids',
@@ -42,9 +53,10 @@ module AlternateProductsQueryConcern
           'Product_Link.Link_From_ID' => 'from_id',
           'Product_Link.Link_To_ID' => 'to_id',
           'Product_Link.Alt_Format' => 'alt_format',
+          'Product_Link.Inactive' => 'inactive',
         })
 
-        if mapped['alt_format'].to_s != '0' && !mapped.in?(results)
+        if mapped['inactive'] == '0' && mapped['alt_format'].to_s != '0' && !mapped.in?(results)
           results.push(mapped)
         end
 
@@ -52,7 +64,7 @@ module AlternateProductsQueryConcern
         issue_error(AcumenAgentError.new(
           'process_alternate_format_response',
           'Failed while processing alternate format links',
-          raw_data,
+          { product_id: get_field_value(link, 'Product_Link.Link_From_ID') },
           error
         ))
       end

data/lib/huginn_acumen_product_agent/concerns/inv_product_query_concern.rb

@@ -33,9 +33,20 @@ module InvProductQueryConcern
             'Inv_Product.Next_Release' => 'releaseDate',
         })
 
+        # Nullify blank dates
+        if product['datePublished'] == '0000-00-00T00:00:00'
+          product['datePublished'] = nil
+        end
+
+        if product['releaseDate'] == '0000-00-00T00:00:00'
+          product['releaseDate'] = nil
+        end
+
         product['@type'] = 'Product'
         product['isTaxable'] = get_field_value(p, 'Inv_Product.Taxable') == '1'
-        product['isAvailableForPurchase'] = get_field_value(p, 'Inv_Product.Not_On_Website') == '0'
+        product['productAvailability'] = get_field_value(p, 'Inv_Product.Not_On_Website') == '0'
+        product['noBackorderFill'] = get_field_value(p, 'Inv_Product.No_Backorder_Fill') == '1'
+        product['trackInventory'] = !(get_field_value(p, 'Inv_Product.Non_Inventory') == '1' || get_field_value(p, 'Inv_Product.Assembly') == '1')
         product['acumenAttributes'] = {
           'info_alpha_1' => get_field_value(p, 'Inv_Product.Info_Alpha_1'),
           'info_boolean_1' => get_field_value(p, 'Inv_Product.Info_Boolean_1'), # is_available_on_formed
@@ -45,6 +56,12 @@ module InvProductQueryConcern
               '@type' => 'PropertyValue',
               'propertyID' => 'is_master',
               'value' => get_field_value(p, 'Inv_Product.OnWeb_LinkOnly') == '0',
+          },
+          {
+              # NOTE: This is different than isAvailableForPurchase. This
+              '@type' => 'PropertyValue',
+              'propertyID' => 'disable_web_purchase',
+              'value' => get_field_value(p, 'Inv_Product.Disable_Web_Purchase'),
           }
         ]
 
@@ -62,6 +79,22 @@ module InvProductQueryConcern
           })
         end
 
+        not_on_website = get_field_value(p, 'Inv_Product.Not_On_Website')
+        disable_web_purchase = get_field_value(p, 'Inv_Product.Disable_Web_Purchase')
+
+        product_availability = 'available'
+
+
+        if (disable_web_purchase == '1')
+          product_availability = 'disabled'
+        end
+
+        if (not_on_website == '1')
+          product_availability = 'not available'
+        end
+
+        product['productAvailability'] = product_availability
+
         weight = get_field_value(p, 'Inv_Product.Weight')
         product['weight'] = get_quantitative_value(weight, 'oz.')
 
@@ -97,7 +130,10 @@ module InvProductQueryConcern
         issue_error(AcumenAgentError.new(
           'process_inv_product_response',
           'Failed to load Inventory Product Records',
-          { product_ids: product_ids },
+          {
+            product_id: get_field_value(p, 'Inv_Product.ID'),
+            sku: get_field_value(p, 'Inv_Product.ProdCode')
+          },
           error,
         ))
 

data/lib/huginn_acumen_product_agent/concerns/inv_status_query_concern.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# This module is responsible for reading/processing the Inv_Status table. This table
+# contains stock information for the product and is tied to product availability.
+module ProdMktQueryConcern
+  extend AcumenQueryConcern
+
+  # Update the provided products with their associated marketing data
+  # NOTE: The `products` here are Shema.org/Product records mapped from Inv_Product
+  # data
+  def fetch_inv_status(acumen_client, products)
+
+    product_skus = products.map { |p| p['sku'] }
+    inventory_data = acumen_client.get_inv_status(product_skus)
+    inventory_data = process_inv_status_response(inventory_data)
+
+    return map_inv_status_data(products, inventory_data)
+  end
+
+  # This function parses the raw data returned from the Prod_Mkt table
+  def process_inv_status_response(raw_data)
+    results = []
+    raw_data.map do |inv_status|
+
+      begin
+        mapped = response_mapper(inv_status, {
+          'Inv_Status.Warehouse' => 'warehouse',
+          'Inv_Status.ProdCode' => 'sku',
+          'Inv_Status.Available' => 'quantity',
+        })
+
+        if (mapped['warehouse'] === 'Main Warehouse')
+          results << mapped
+        end
+      rescue => error
+        issue_error(AcumenAgentError.new(
+          'process_inv_status_response',
+          'Failed while processing Prod_Mkt record',
+          { sku: get_field_value(inv_status, 'Inv_Status.ProdCode') },
+          error,
+        ))
+      end
+    end
+
+    results
+  end
+
+  # This function maps parsed Prod_Mkt records to their matching product record
+  # and updates the product object with the additional data
+  def map_inv_status_data(products, inventory)
+    products.map do |product|
+      inventory_data = inventory.select { |i| i['sku'] == product['sku'] }
+      begin
+
+        if inventory_data
+          quantity = 0
+          inventory_data.each do |i|
+            quantity = quantity + i['quantity'].to_i if quantity.present?
+          end
+
+          product['acumenAttributes']['stock_quantity'] = quantity
+        end
+
+      rescue => error
+        issue_error(AcumenAgentError.new(
+          'map_inv_status_data',
+          'Failed to map inventory data for product',
+          { sku: product['sku'] },
+          error,
+        ))
+      end
+
+      product
+    end
+
+    return products
+  end
+end

data/lib/huginn_acumen_product_agent/concerns/prod_mkt_query_concern.rb

@@ -34,7 +34,7 @@ module ProdMktQueryConcern
           'ProdMkt.Description_Long' => 'description_long',
           'ProdMkt.Height' => 'height',
           'ProdMkt.Width' => 'width',
-          'ProdMkt.Thickness' => 'depth',
+          'ProdMkt.Thickness' => 'thickness',
           'ProdMkt.Meta_Keywords' => 'meta_keywords',
           'ProdMkt.Meta_Description' => 'meta_description',
           'ProdMkt.Extent_Unit' => 'extent_unit',
@@ -62,7 +62,7 @@ module ProdMktQueryConcern
         issue_error(AcumenAgentError.new(
           'process_prod_mkt_response',
           'Failed while processing Prod_Mkt record',
-          product_marketing,
+          { sku: get_field_value(product_marketing, 'ProdMkt.Product_Code') },
           error,
         ))
       end
@@ -150,7 +150,7 @@ module ProdMktQueryConcern
         issue_error(AcumenAgentError.new(
           'map_marketing_data',
           'Failed to map marketing data for product',
-          { product: product, marketing: marketing },
+          { id: product['identifier'], sku: marketing['sku'] },
           error,
         ))
       end

data/lib/huginn_acumen_product_agent/concerns/product_categories_query_concern.rb

@@ -41,7 +41,7 @@ module ProductCategoriesQueryConcern
           results[product_sku] = [mapped] if mapped['inactive'] == '0'
         end
       rescue => error
-        issue_errpr(AcumenAgentError.new(
+        issue_error(AcumenAgentError.new(
           'process_product_category_response',
           'Failed while processing category data',
           product_category,

data/lib/huginn_acumen_product_agent/concerns/product_contributors_query_concern.rb

@@ -104,7 +104,7 @@ module ProductContributorsQueryConcern
         issue_error(AcumenAgentError.new(
           'map_contributor_data',
           'Failed while mapping contributor data to products',
-          { product: product, contributors: contributor_data, contributor_types: contributor_type_data },
+          { id: product['identifier'], sku: product['sku'] },
           error
         ))
       end

data/lib/huginn_acumen_product_agent.rb

@@ -3,6 +3,7 @@ require 'huginn_agent'
 HuginnAgent.load 'huginn_acumen_product_agent/concerns/acumen_query_concern'
 HuginnAgent.load 'huginn_acumen_product_agent/concerns/alternate_products_query_concern'
 HuginnAgent.load 'huginn_acumen_product_agent/concerns/inv_product_query_concern'
+HuginnAgent.load 'huginn_acumen_product_agent/concerns/inv_status_query_concern'
 HuginnAgent.load 'huginn_acumen_product_agent/concerns/prod_mkt_query_concern'
 HuginnAgent.load 'huginn_acumen_product_agent/concerns/product_categories_query_concern'
 HuginnAgent.load 'huginn_acumen_product_agent/concerns/product_contributors_query_concern'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huginn_acumen_product_agent
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Jacob Spizziri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,9 +67,9 @@ files:
 - lib/huginn_acumen_product_agent/acumen_client.rb
 - lib/huginn_acumen_product_agent/acumen_product_agent.rb
 - lib/huginn_acumen_product_agent/concerns/acumen_query_concern.rb
-- lib/huginn_acumen_product_agent/concerns/agent_error_concern.rb
 - lib/huginn_acumen_product_agent/concerns/alternate_products_query_concern.rb
 - lib/huginn_acumen_product_agent/concerns/inv_product_query_concern.rb
+- lib/huginn_acumen_product_agent/concerns/inv_status_query_concern.rb
 - lib/huginn_acumen_product_agent/concerns/prod_mkt_query_concern.rb
 - lib/huginn_acumen_product_agent/concerns/product_categories_query_concern.rb
 - lib/huginn_acumen_product_agent/concerns/product_contributors_query_concern.rb

data/lib/huginn_acumen_product_agent/concerns/agent_error_concern.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module AgentErrorConcern
-  extend ActiveSupport::Concern
-
-  def issue_error(error, status = 500)
-    # NOTE: Status is intentionally included on the top-level payload so that other
-    # agents can look for a `payload[:status]` of either 200 or 500 to distinguish
-    # between success and failure states
-    create_event payload: {
-      status: status,
-      scope: error.scope,
-      message: error.message,
-      original_error: error.original_error,
-      data: error.data,
-      trace: error.original_error.backtrace,
-    }
-  end
-end