huginn_bigcommerce_product_agent 1.9.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bbd3a133d224fea3726d9b0f8b86803957e919e225e983be8ac3a1c7c027312
-  data.tar.gz: 202e2165d11044d4f44e722aa39e61224b819b344304e73e3c9e888c0a20153a
+  metadata.gz: 75db6b836de4031aa33df47c393b0db0b59f99813fa96e98ee15ec10b39b8f91
+  data.tar.gz: d5c2bcc87f0fd3f95e489aa651f06297b07225398edfb6dfc8869c976f63caf7
 SHA512:
-  metadata.gz: 87204345ec8502a89ac61b5de9bf21f8daf8ab34b3b22cb2563e6a55b90da6239e2dc92d096caf4e9b8e08b2591286ac3f4b8b36a6ba07efecafdbafdf3d93bb
-  data.tar.gz: abe689235f182acf5c2eb977d9179af9b7431a1537435093a140e54e16b1981bb901fa02ec2bdc8e3469c96fab3d314474f63714caa835d878edcb375223f781
+  metadata.gz: 96cc182ce0413cbb9843e4ab435d47ca85540e0025a9cb60579a200f37a3c9c299df0583b20454a83adf23f516e917f75e75942b555245761e21918af79d76b4
+  data.tar.gz: 463354a063899f6cb03c253cf65b692ecb2258525e04ce107320f41e03ea6ee4251eda5c8bd4147596a9d6a2fdb90e1e85837b13aa7a05936e7f026d763e22fd

data/lib/client/meta_field.rb

@@ -42,7 +42,11 @@ module BigcommerceProductAgent
             end
 
             def delete(product_id, meta_field_id)
-                client.delete(uri(product_id: product_id, meta_field_id: meta_field_id))
+                begin
+                    client.delete(uri(product_id: product_id, meta_field_id: meta_field_id))
+                rescue Faraday::Error::ClientError => e
+                    raise e, "\n#{e.message}\nFailed to delete meta_field with id = #{meta_field_id}\nfor product with id = #{product_id}\n", e.backtrace
+                end
             end
         end
     end

data/lib/client/product.rb

@@ -55,6 +55,13 @@ module BigcommerceProductAgent
                 map
             end
 
+            def disable(productId)
+              upsert({ id: productId, is_visible: false })
+            end
+
+            def enable(productId)
+              upsert({ id: productId, is_visible: true })
+            end
         end
     end
 end

data/lib/client/product_option.rb

@@ -33,8 +33,12 @@ module BigcommerceProductAgent
             end
 
             def create(product_id, option)
-                response = client.post(uri(product_id: product_id), option.to_json)
-                return response.body['data']
+                begin
+                    response = client.post(uri(product_id: product_id), option.to_json)
+                    return response.body['data']
+                rescue Faraday::Error::ClientError => e
+                    raise e, "\n#{e.message}\nFailed to upsert product_option = #{option.to_json}\nfor product with id = #{product_id}\n", e.backtrace
+                end
             end
         end
     end

data/lib/huginn_bigcommerce_product_agent/bigcommerce_product_agent.rb

@@ -100,36 +100,48 @@ module Agents
             end
         end
 
-        # 1. upsert product
-        # 2. upsert option & option_values
-        # 3. delete old option_values
+        # 1. Upsert the core product (Wrapper Product)
+        #     - NOTE: This initial  upsert intentionally disables the product.
+        #       Doing so prevents content hiccups with variants particularly
+        #       for products going off sale.
+        # 2. Upsert option & option_values (BigCommerce Variants)
+        # 3. Delete old option_values
         #     - NOTE: deleting an option_value also deletes the variant
         #       associated with the option_value
-        # 4. upsert variants
+        # 4. Upsert variants
         #     - NOTE: because deleting option values deletes variants
         #       we need to fetch the variants AFTER deletion has occurred.
         #     - NOTE: by deleting variants in #3 if option_values on an
         #       existing variant changes over time, we're effectively deleting
         #       and then re-adding the variant. Could get weird.
+        # 5. Re-enable the updated product
+        #    - NOTE: If the product no longer has any variants, it will remain
+        #      disabled as it can no longer be purchased.
         def handle_variants(event)
             product = event.payload
 
             split = get_mapper(:ProductMapper).split_digital_and_physical(
-              product,
-              interpolated['custom_fields_map']
+                product,
+                interpolated['custom_fields_map']
             )
             physical = split[:physical]
             digital = split[:digital]
 
+            base_sku = product['additionalProperty'].find { |p|
+                p['propertyID'] == 'baseSku'
+            }['value']
+
             wrapper_skus = {
-                physical: get_mapper(:ProductMapper).get_wrapper_sku(physical),
-                digital: get_mapper(:ProductMapper).get_wrapper_sku(digital),
+                # Use the provided base_sku if it exists -- otherwise, infer the SKU from the variant list
+                physical: base_sku ? "#{base_sku}-P" : get_mapper(:ProductMapper).get_wrapper_sku(physical),
+                digital: base_sku ? "#{base_sku}-D" : get_mapper(:ProductMapper).get_wrapper_sku(digital),
             }
 
             bc_products = @product.get_by_skus(
                 wrapper_skus.map {|k,v| v},
                 %w[custom_fields options]
             )
+
             #save skus
             digital_skus = []
             physical_skus = []
@@ -149,15 +161,13 @@ module Agents
                     product['name'] = "#{product['name']} (Digital)"
                 end
 
-                # Ignatius Press -- some products have the same name and must be disambiguated.
-                # ...by adding a list of the product types (hardback, paperback, etc.) to their names
+                # BigCommerce requires that product names be unique. In some cases, (like book titles from multiple sources),
+                # this may be hard to enforce. In those cases, the product SKUs should still be unique, so we append the SKU
+                # to the product title with a `|~` separator. We then set the `page_title` to the original product name so
+                # users don't see system values.
                 if boolify(options['should_disambiguate'])
                     product['page_title'] = product['name']
-                    product['name'] += " |~ " + product['model'].map { |m|
-                       m['additionalProperty'].find { |p|
-                           p['propertyID'] == 'option'
-                       }['value']
-                    }.join(", ")
+                    product['name'] += " |~ " + (is_digital ? wrapper_skus[:digital] : wrapper_skus[:physical])
                 end
 
                 wrapper_sku = wrapper_skus[type]
@@ -166,6 +176,8 @@ module Agents
                 bc_option = !bc_product.nil? ? bc_product['options'].select {|opt| opt['display_name'] === variant_option_name}.first : nil
 
                 search_skus = is_digital ? physical_skus : digital_skus
+
+
                 # ##############################
                 # 1. update wrapper product
                 # ##############################
@@ -204,7 +216,7 @@ module Agents
                 # ##############################
                 variant_skus = get_mapper(:ProductMapper).get_product_skus(product)
                 bc_variants = @product_variant.index(product_id)
-                mapped_variants = product['model'].map do |variant|
+                mapped_variants = product['model'].select { |m| m['isAvailableForPurchase'] }.map do |variant|
                     bc_variant = bc_variants.select {|v| v['sku'] === variant['sku']}.first
                     opt = get_mapper(:ProductMapper).get_option(variant)
                     bc_option_value = bc_option['option_values'].select {|ov| ov['label'] == opt}.first
@@ -221,7 +233,15 @@ module Agents
                     )
                 end
 
-                bc_product['variants'] = @variant.upsert(mapped_variants)
+
+                unless (mapped_variants.blank?)
+                  bc_product['variants'] = @variant.upsert(mapped_variants)
+
+                  # ##############################
+                  # 5. Re-enable the updated product
+                  # ##############################
+                  @product.enable(product_id)
+                end
             end
 
             bc_physical = bc_products[wrapper_skus[:physical]]
@@ -329,6 +349,11 @@ module Agents
             clean_up_modifier_values(modifier_updates[:delete])
             meta_fields = update_meta_fields(meta_fields_upsert, meta_fields_delete)
 
+            if product['is_visible']
+              # If the product should be enabled, re-enable it
+              @product.enable(result[:product]['id'])
+            end
+
             product['meta_fields'] = meta_fields
             product['modifiers'] = modifier_updates[:upsert]
             create_event payload: {
@@ -385,6 +410,12 @@ module Agents
                 is_digital,
             )
 
+            payload[:is_visible] = false
+            # NOTE:  Products are intentionally upserted as disabled so that users
+            # don't see an incomplete listing (particularly when leveraging variants)
+            # The variant and option_list methods will re-enable products after the
+            # upsert is complete.
+
             bc_product = @product.upsert(payload, {
                 include: %w[custom_fields variants options].join(',')
             })
@@ -427,7 +458,9 @@ module Agents
             end
 
             delete_fields.each do |field|
-                @meta_field.delete(field[:resource_id], field[:id])
+                if field[:resource_id] && field[:id]
+                    @meta_field.delete(field[:resource_id], field[:id])
+                end
             end
 
             meta_fields

data/lib/mapper/product_mapper.rb

@@ -63,7 +63,7 @@ module BigcommerceProductAgent
                 variant = self.get_variant_by_sku(sku, product)
                 payload = self.map(product, variant, additional_data, is_digital, sku)
                 payload[:id] = product_id unless product_id.nil?
-                payload[:sku] = self.get_wrapper_sku(product)
+                payload[:sku] = sku
 
                 return payload
             end
@@ -76,7 +76,9 @@ module BigcommerceProductAgent
                 map = {}
 
                 product['model'].each do |model|
-                    map[model['sku']] = self.get_option(model)
+                    if model['isAvailableForPurchase']
+                      map[model['sku']] = self.get_option(model)
+                    end
                 end
 
                 return map
@@ -109,6 +111,7 @@ module BigcommerceProductAgent
                     clone = Marshal.load(Marshal.dump(product))
                     clone['model'] = digitals
                     clone['sku'] = clone['model'].select {|m| m['isDefault'] = true}.first['sku']
+                    clone['categories'] = self.get_categories_after_split(clone, clone['categories'])
                     self.merge_additional_properties(clone, field_map)
                     result[:digital] = clone
                 end
@@ -119,6 +122,7 @@ module BigcommerceProductAgent
                     clone = Marshal.load(Marshal.dump(product))
                     clone['model'] = physicals
                     clone['sku'] = clone['model'].select {|m| m['isDefault'] = true}.first['sku']
+                    clone['categories'] = self.get_categories_after_split(clone, clone['categories'])
                     self.merge_additional_properties(clone, field_map)
                     result[:physical] = clone
                 end
@@ -140,6 +144,20 @@ module BigcommerceProductAgent
                 return categories
             end
 
+            def self.get_categories_after_split(product, categories)
+                # categories equal shared categories between digital and physical products
+
+                if product['model'].select { |c| c['categories']}
+                    product['model'].each do |variant|
+                        variant['categories'].map do |category|
+                            categories.push(category)
+                        end
+                    end
+                end
+
+                return categories
+            end
+
             def self.get_option(variant)
                 if variant['encodingFormat']
                     return variant['encodingFormat']

data/lib/mapper/variant_mapper.rb

@@ -9,7 +9,7 @@ module BigcommerceProductAgent
                     price: variant['offers'] && variant['offers'][0] ? variant['offers'][0]['price'] : '0',
                     cost_price: nil,
                     sale_price: nil,
-                    retail_price: nil,
+                    retail_price: variant['offers'] && variant['offers'][0] ? variant['offers'][0]['price'] : nil,
                     weight: variant['weight'] ? variant['weight']['value'] : '0',
                     width: variant['width'] ? variant['width']['value'] : '0',
                     depth: variant['depth'] ? variant['depth']['value'] : '0',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huginn_bigcommerce_product_agent
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Jacob Spizziri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler