huginn_bigcommerce_product_agent 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af097d968dbd6e4c5b16bd27be4b48a685625056f23e4863e749b8e2382ee06f
-  data.tar.gz: e441b45253fde8999a4480bf2f9dbd419cd228d21c3e05dad47d45d8f4dbbe08
+  metadata.gz: e7d61b54d98e2797d36d581599d2501e70f96a8adb325a6539a14770f16683b3
+  data.tar.gz: f43185ad5ca114d12255997f727fe5a952fd62cbcd3ea412244daa83ddcbc129
 SHA512:
-  metadata.gz: c8fc484fc9c277ce1deb6b1ec3baed84f74a607e12b2667eb4fcfc5c160511623364d9c8d962f3367f713fd1da6b430da128160a45a5f575badfd5efb01f6af6
-  data.tar.gz: 8546a2251a5a077eb00ad8cbbf9aa605b121ce251565121f5a36bdffa65099f1e67e26f217a7f64b0ada326410cfa271b459945fdadc02ac5f0e68cc8b46a1c5
+  metadata.gz: 1e90eb544f99296af2f228db2c8653c64ce6eb196e7c51f523cd426df02315e446df70caf8c28abd5e6f23326069a1fe79debcf2b59d6fed1dbff737ce17e45d
+  data.tar.gz: 0f8ab865f88e45f01eff587b5d92ecaece1dfa8c210d6692e73b47eed5633c717e9c6388c1eeebeb24b5f81450e042eaed90dfe518ecc6c11d17c40ffc573074

data/lib/client/product.rb

@@ -37,10 +37,10 @@ module BigcommerceProductAgent
                   e.response[:status],
                   'update product',
                   'Failed to update product batch',
+                  payload.map { |p|
+                    { id: p["id"], sku: p[:sku] }
+                  },
                   {
-                    product_identifiers: payload.map { |p|
-                      { id: p[:id], sku: p[:sku] }
-                    },
                     errors: JSON.parse(e.response[:body])['errors'],
                   },
                   e
@@ -94,7 +94,7 @@ 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])
+            def get_by_skus(skus, include = %w[custom_fields modifiers], include_fields = %w[sku categories inventory_tracking])
                 products = []
                 skus.each do |sku|
                     begin
@@ -115,7 +115,8 @@ module BigcommerceProductAgent
                         {
                           related_skus: skus,
                           errors: JSON.parse(e.response[:body])['errors'],
-                        }
+                        },
+                        e
                       )
                     end
                 end

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
 
@@ -330,7 +329,7 @@ module Agents
           'upsert_products',
           e.message,
           nil,
-          { sku: product_data.map { |p| p['sku'] } },
+          { sku: product_data.map { |p| p[:sku] } },
           e
         ))
       end
@@ -342,11 +341,20 @@ module Agents
       bc_payload = nil
 
       begin
+        # if track inventory on the agent is true set track inventory to product level track inventory
         track_inventory = boolify(options['track_inventory']).nil? ? true : boolify(options['track_inventory'])
-        bc_payload = get_mapper(:ProductMapper).map_payload(raw_product, additional_data, track_inventory)
+        if (track_inventory)
+          track_inventory = boolify(raw_product['trackInventory'])
+        end
+        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
 
+        if bc_payload[:categories].empty?
+          # If categories is empty keep existing categories because categories should never be empty
+          bc_payload[:categories] = bc_product['categories'] unless bc_product.nil? || bc_product['categories'].nil?
+        end
+
         if bc_payload[:type] == 'digital'
           bc_payload[:name].concat(' (Digital)')
         end

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.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Jacob Spizziri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-25 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