huginn_bigcommerce_product_agent 2.2.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89cfc257bee7acf8c2a48655ce32e2e4bd9aa91f09a0e17fb19a54224fc764f4
-  data.tar.gz: ea56efe75b854b60a42bcb6f26b7a105f0910ec7e629dc08e7d2c927d7a91900
+  metadata.gz: 27cf670464183919a89406859de8c626afc22dde8215131409a8c6a7216c905e
+  data.tar.gz: ab101f6ffbd97154e08f251aefcd1e5160976d8155c84796a9c6969e2c004eaa
 SHA512:
-  metadata.gz: 266955d42682aaf2e8f92f5685ac915767a75070b7cdb6957d7e6b0a23e11ed7854070b04a7218bea809b7269702a2f51fb33d4813e355debcc435684adcb5b6
-  data.tar.gz: 19fef7e12d26c6ac94945204e375d3c86bc016eae304f435851e222ef026e4eb1066159b4601b9d92ee546cb9f21803ee41cb809c0d958207408e5fbe5af7e8e
+  metadata.gz: 05416caf4092031603db2a0fadf8153f4774fa2d39532a2df58af356f4da12e18f37b96df24eeacaed4a1607796e1395433b92c30b35d4600897db189ce8254f
+  data.tar.gz: 42fd87774053b50615271eb2b3f8955c4ae032999c9483a041deb510d87d08c1396353b00f0968d6e658fd8c8f5e5a0122dae8686df53fa63f8fbf22891c112f

data/lib/client/product.rb

@@ -94,7 +94,11 @@ module BigcommerceProductAgent
             end
 
             # When using sku:in you must specify the fields you want returned.
-            def get_by_skus(skus, include = %w[custom_fields modifiers], include_fields = %w[sku categories])
+            def get_by_skus(
+              skus,
+              include = %w[custom_fields modifiers],
+              include_fields = %w[sku categories inventory_tracking is_visible]
+            )
                 products = []
                 skus.each do |sku|
                     begin

data/lib/huginn_bigcommerce_product_agent/bigcommerce_product_agent.rb

@@ -25,7 +25,6 @@ module Agents
         'meta_fields_namespace' => '',
         'not_purchasable_format_list' => [],
         'should_disambiguate' => false,
-
       }
     end
 
@@ -347,7 +346,7 @@ module Agents
         if (track_inventory)
           track_inventory = boolify(raw_product['trackInventory'])
         end
-        bc_payload = get_mapper(:ProductMapper).map_payload(raw_product, additional_data, track_inventory)
+        bc_payload = get_mapper(:ProductMapper).map_payload(raw_product, bc_product, additional_data, track_inventory)
         bc_payload['id'] = bc_product['id'] unless bc_product.nil? || bc_product['id'].nil?
         # NOTE: bc_product will be nil when this is called with `to_create` products
 

data/lib/mapper/product_mapper.rb

@@ -2,12 +2,19 @@ module BigcommerceProductAgent
     module Mapper
         class ProductMapper
 
-            def self.map_payload(product, additional_data = {}, track_inventory = true, default_sku = '')
+            def self.map_payload(product, bc_product, additional_data = {}, track_inventory = true, default_sku = '')
                 name = product['name']
                 isDigital = product['isDigital'].to_s == 'true'
 
                 track_inventory = self.get_availability(product) == 'preorder' ? false : track_inventory
 
+                # respect the visibility setting of existing products, otherwise
+                # default visibility to true.
+                is_visible = true
+                if !bc_product.nil? && !bc_product['is_visible'].nil?
+                  is_visible = bc_product['is_visible']
+                end
+
                 result = {
                   availability: self.get_availability(product),
                   categories: self.get_categories(product),
@@ -15,8 +22,8 @@ module BigcommerceProductAgent
                   description: product['description'] || '',
                   height: product['height'] ? product['height']['value'] : '0',
                   is_default: product['isDefault'],
-                  is_preorder_only: self.get_availability(product) == 'preorder' ? true : false,
-                  is_visible: true,
+                  is_preorder_only: false,
+                  is_visible: is_visible,
                   meta_description: self.meta_description(product) || '',
                   meta_keywords: self.meta_keywords(product),
                   name: name,
@@ -30,8 +37,37 @@ module BigcommerceProductAgent
                   type: isDigital ? 'digital' : 'physical',
                   weight: product['weight'] ? product['weight']['value'] : '0',
                   width: product['width'] ? product['width']['value'] : '0',
-                  inventory_tracking: isDigital || !track_inventory ? 'none' : 'product',
                 }
+
+                #  BEGIN:  The following block is a workaround for a BigCommerce bug.
+                #
+                #  It seems that when the `inventory_tracking` attribute is included in the payload,
+                #  BigCommerce is now triggering a low stock warning for products with inventory
+                #  tracking disabled.
+                #
+                #  We are currently seeing notifications for _every digital product_ each time
+                #  the sync process runs.
+                #
+                #  Pending a fix from BigCommerce the following logic is designed to mitigate
+                #  the false alarms. Essentially, we will only be including the `inventory_tracking`
+                #  attribute if the value is _changing_ from whatever is currently set.
+                #  While this may not stop _all_ of the false alarms, it should reduce them
+                #  significantly.
+                current_tracking_value = bc_product['inventory_tracking'] unless bc_product.nil?
+                new_tracking_value = isDigital || !track_inventory ? 'none' : 'product'
+
+                if (current_tracking_value != new_tracking_value)
+                  result[:inventory_tracking] = new_tracking_value
+                end
+                #  END:   Stock warning workaround
+
+
+                stock = get_additional_property_value(product, 'product_inventory', 0)
+
+                if (stock)
+                  result[:inventory_level] = stock
+                end
+
                 result[:upc] = product['isbn'] ? product['isbn'] : product['gtin12']
                 result[:gtin] = product['gtin12'] if product['gtin12']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huginn_bigcommerce_product_agent
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Jacob Spizziri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-17 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Agent that takes a generic product interface and upserts that product in