huginn_bigcommerce_product_agent 1.10.1 → 2.1.0

data/lib/mapper/custom_field_mapper.rb

@@ -2,41 +2,49 @@ module BigcommerceProductAgent
     module Mapper
         class CustomFieldMapper
 
-            def self.map(field_map, product, bc_product)
+            def self.map(field_map, raw_product, bc_product, current_custom_fields, namespace)
                 fields = {
                     upsert: [],
                     delete: [],
                 }
 
-                existing_fields = {}
+                to_delete = {}
 
-                if bc_product
-                    bc_product['custom_fields'].each do |cf|
+                if bc_product && current_custom_fields
+                    current_custom_fields.each do |cf|
                         cf['product_id'] = bc_product['id']
-                        existing_fields[cf['name'].to_s] = cf
+
+                        # Initially assume that a field should be deleted.
+                        to_delete[cf['name'].to_s] = cf
                     end
                 end
 
                 if field_map && field_map['additionalProperty']
-                    field_map['additionalProperty'].each do |key, val|
-                        field = self.from_additional_property(product, existing_fields, key, val)
-                        fields[:upsert].push(field) unless field.nil?
+                    field_map['additionalProperty'].each do |from_key, to_key|
+                        field = self.from_additional_property(raw_product, to_delete, from_key, to_key)
+                        if field
+                          field['product_id'] = bc_product['id'] unless bc_product.nil?
+                          fields[:upsert].push(field)
+                        end
                     end
                 end
 
                 if field_map
-                    field_map.each do |key, val|
-                        if key == 'additionalProperty'
+                    field_map.each do |from_key, to_key|
+                        if from_key == 'additionalProperty'
                             next
                         end
 
-                        field = self.from_property(product, existing_fields, key, val)
-                        fields[:upsert].push(field) unless field.nil?
+                        field = self.from_property(raw_product, to_delete, from_key, to_key)
+                        if field
+                          field['product_id'] = bc_product['id'] unless bc_product.nil?
+                          fields[:upsert].push(field)
+                        end
                     end
                 end
 
                 # return values that need deleted
-                fields[:delete] = existing_fields.values
+                fields[:delete] = to_delete.values
                 return fields
             end
 
@@ -57,34 +65,34 @@ module BigcommerceProductAgent
 
             private
 
-            def self.from_property(product, existing_fields, from_key, to_key)
-                if !product[from_key].nil?
+            def self.from_property(raw_product, fields_to_delete, from_key, to_key)
+                if !raw_product[from_key].nil?
                     field = {
                         name: to_key,
-                        value: product[from_key].to_s
+                        value: raw_product[from_key].to_s
                     }
 
-                    if existing_fields[to_key]
-                        field[:id] = existing_fields[to_key]['id']
-                        existing_fields.delete(to_key)
+                    if fields_to_delete[to_key]
+                        field[:id] = fields_to_delete[to_key]['id']
+                        fields_to_delete.delete(to_key)
                     end
 
                     return field
                 end
             end
 
-            def self.from_additional_property(product, existing_fields, from_key, to_key)
+            def self.from_additional_property(raw_product, fields_to_delete, from_key, to_key)
                 # date published
-                item = product['additionalProperty'].select {|p| p['propertyID'] == from_key}.first
+                item = raw_product['additionalProperty'].select {|p| p['propertyID'] == from_key}.first
                 if !item.nil?
                     field = {
                         name: to_key,
                         value: item['value'].to_s
                     }
 
-                    if existing_fields[to_key]
-                        field[:id] = existing_fields[to_key]['id']
-                        existing_fields.delete(to_key)
+                    if fields_to_delete[to_key]
+                        field[:id] = fields_to_delete[to_key]['id']
+                        fields_to_delete.delete(to_key)
                     end
 
                     return field

data/lib/mapper/meta_field_mapper.rb

@@ -2,7 +2,7 @@ module BigcommerceProductAgent
     module Mapper
         class MetaFieldMapper
 
-            def self.map(field_map, product, bc_product, meta_fields, namespace)
+            def self.map(field_map, raw_product, bc_product, current_meta_fields, namespace)
                 fields = {
                     upsert: [],
                     delete: [],
@@ -11,8 +11,8 @@ module BigcommerceProductAgent
                 existing_fields = {}
 
                 if bc_product
-                    meta_fields.each do |mf|
-
+                    current_meta_fields.each do |mf|
+                        mf['resource_id'] = bc_product['id']
                         unless mf['namespace'] != namespace
                           # Only delete meta fields managed by this sync
                           existing_fields[mf['key'].to_s] = mf
@@ -22,7 +22,7 @@ module BigcommerceProductAgent
 
                 if field_map && field_map['additionalProperty']
                     field_map['additionalProperty'].each do |key, val|
-                        field = self.from_additional_property(product, existing_fields, key, val, namespace, bc_product)
+                        field = self.from_additional_property(raw_product, existing_fields, key, val, namespace, bc_product)
                         fields[:upsert].push(field) unless field.nil?
                     end
                 end
@@ -33,7 +33,7 @@ module BigcommerceProductAgent
                             next
                         end
 
-                        field = self.from_property(product, existing_fields, key, val, namespace, bc_product)
+                        field = self.from_property(raw_product, existing_fields, key, val, namespace, bc_product)
                         fields[:upsert].push(field) unless field.nil?
                     end
                 end
@@ -45,15 +45,15 @@ module BigcommerceProductAgent
 
             private
 
-            def self.from_property(product, existing_fields, from_key, to_key, namespace, bc_product)
+            def self.from_property(raw_product, existing_fields, from_key, to_key, namespace, bc_product)
 
-                if !product[from_key].nil?
+                if !raw_product[from_key].nil?
                     field = {
                         namespace: namespace,
                         permission_set: 'write',
                         resource_type: 'product',
                         key: to_key,
-                        value: product[from_key]
+                        value: raw_product[from_key]
                     }
 
                     if bc_product
@@ -69,9 +69,9 @@ module BigcommerceProductAgent
                 end
             end
 
-            def self.from_additional_property(product, existing_fields, from_key, to_key, namespace, bc_product)
+            def self.from_additional_property(raw_product, existing_fields, from_key, to_key, namespace, bc_product)
 
-                item = product['additionalProperty'].select {|p| p['propertyID'] == from_key}.first
+                item = raw_product['additionalProperty'].select {|p| p['propertyID'] == from_key}.first
                 if !item.nil?
 
                     field = {

data/lib/mapper/product_mapper.rb

@@ -2,130 +2,42 @@ module BigcommerceProductAgent
     module Mapper
         class ProductMapper
 
-            def self.map(product, variant, additional_data = {}, is_digital = false, default_sku='')
+            def self.map_payload(product, additional_data = {}, track_inventory = true, default_sku = '')
                 name = product['name']
+                isDigital = product['isDigital'].to_s == 'true'
 
-                if variant
-                    # variants inherit from and override parent product info
-                    name = "#{name} (#{self.get_option(variant)})"
-                    product = product.merge(variant)
-                else
-                    # wrapper product
-                    default_variant = self.get_variant_by_sku(product['sku'], product)
-                    if default_variant
-                        # pull up some properties from default variant (since bc doesn't display them otherwise)
-                        product = {
-                            "weight" => default_variant['weight'],
-                            "width" => default_variant['width'],
-                            "depth" => default_variant['depth'],
-                            "height" => default_variant['height'],
-                            "releaseDate" => default_variant['releaseDate'],
-                            "datePublished" => default_variant['datePublished'],
-                            "availability" => self.get_availability_offer(product, default_variant),
-                        }.merge(product)
-                    end
-                end
+                track_inventory = self.get_availability(product) == 'preorder' ? false : track_inventory
 
                 result = {
-                    name: name,
-                    sku: product ? product['sku'] : default_sku,
-                    is_default: product['isDefault'],
-                    type: product['isDigital'] == true || is_digital ? 'digital' : 'physical',
-                    description: product['description'] || '',
-                    price: product['offers'] && product['offers'][0] ? product['offers'][0]['price'] : '0',
-                    categories: self.get_categories(product),
-                    availability: self.get_availability(product),
-                    weight: product['weight'] ? product['weight']['value'] : '0',
-                    width: product['width'] ? product['width']['value'] : '0',
-                    depth: product['depth'] ? product['depth']['value'] : '0',
-                    height: product['height'] ? product['height']['value'] : '0',
-                    meta_keywords: self.meta_keywords(product),
-                    meta_description: self.meta_description(product) || '',
-                    search_keywords: self.get_search_keywords(additional_data.delete(:additional_search_terms), product),
-                    is_visible: variant ? false : true,
-                    preorder_release_date: product['releaseDate'] && product['releaseDate'].to_datetime ? product['releaseDate'].to_datetime.strftime("%FT%T%:z") : nil,
-                    preorder_message: self.get_availability(product) == 'preorder' ? product['availability'] : '',
-                    is_preorder_only: self.get_availability(product) == 'preorder' ? true : false,
-                    page_title: product['page_title'] || '',
+                  availability: self.get_availability(product),
+                  categories: self.get_categories(product),
+                  depth: product['depth'] ? product['depth']['value'] : '0',
+                  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,
+                  meta_description: self.meta_description(product) || '',
+                  meta_keywords: self.meta_keywords(product),
+                  name: name,
+                  page_title: product['page_title'] || '',
+                  preorder_message: self.get_availability(product) == 'preorder' ? product['offers'][0]['availability'] : '',
+                  preorder_release_date: product['releaseDate'] && product['releaseDate'].to_datetime ? product['releaseDate'].to_datetime.strftime("%FT%T%:z") : nil,
+                  price: product['offers'] && product['offers'][0] ? product['offers'][0]['price'] : '0',
+                  retail_price: product['offers'] && product['offers'][0] ? product['offers'][0]['price'] : '0',
+                  search_keywords: self.get_search_keywords(additional_data.delete(:additional_search_terms), product),
+                  sku: product ? product['sku'] : default_sku,
+                  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',
                 }
-                result[:upc] = product['gtin12'] if product['gtin12']
+                result[:upc] = product['isbn'] ? product['isbn'] : product['gtin12']
+                result[:gtin] = product['gtin12'] if product['gtin12']
 
                 result.merge(additional_data)
             end
 
-            def self.get_wrapper_sku(product)
-                if product
-                    "#{product['sku']}-W"
-                end
-            end
-
-            def self.payload(sku, product, product_id = nil, additional_data = {}, is_digital = false)
-                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)
-
-                return payload
-            end
-
-            def self.get_product_skus(product)
-                product['model'].map { |model| model['sku'] }
-            end
-
-            def self.get_sku_option_label_map(product)
-                map = {}
-
-                product['model'].each do |model|
-                    map[model['sku']] = self.get_option(model)
-                end
-
-                return map
-            end
-
-            def self.get_is_default(product)
-              map = {}
-
-              product['model'].each do |model|
-                  map[model['sku']] = model["isDefault"]
-              end
-
-              return map
-            end
-
-            def self.has_digital_variants?(product)
-                product['model'].any? {|m| m['isDigital'] == true}
-            end
-
-            def self.has_physical_variants?(product)
-                product['model'].any? {|m| m['isDigital'] != true}
-            end
-
-            def self.split_digital_and_physical(product, field_map)
-                result = {}
-
-                digitals = product['model'].select {|m| m['isDigital'] == true}
-
-                if digitals.length > 0
-                    clone = Marshal.load(Marshal.dump(product))
-                    clone['model'] = digitals
-                    clone['sku'] = clone['model'].select {|m| m['isDefault'] = true}.first['sku']
-                    self.merge_additional_properties(clone, field_map)
-                    result[:digital] = clone
-                end
-
-                physicals = product['model'].select {|m| m['isDigital'] != true}
-
-                if physicals.length > 0
-                    clone = Marshal.load(Marshal.dump(product))
-                    clone['model'] = physicals
-                    clone['sku'] = clone['model'].select {|m| m['isDefault'] = true}.first['sku']
-                    self.merge_additional_properties(clone, field_map)
-                    result[:physical] = clone
-                end
-
-                return result
-            end
-
             private
 
             def self.get_categories(product)
@@ -140,17 +52,6 @@ module BigcommerceProductAgent
                 return categories
             end
 
-            def self.get_option(variant)
-                if variant['encodingFormat']
-                    return variant['encodingFormat']
-                elsif variant['bookFormat']
-                    parts = variant['bookFormat'].split('/')
-                    return parts[parts.length - 1]
-                else
-                    return self.get_additional_property_value(variant, 'option')
-                end
-            end
-
             def self.meta_description(product)
                 return self.get_additional_property_value(product, 'meta_description', '')
             end
@@ -158,7 +59,7 @@ module BigcommerceProductAgent
             def self.meta_keywords(product)
                 meta_keywords = []
 
-                product['keywords'].split(',') unless product['keywords'].nil?
+                meta_keywords = product['keywords'].split(',') unless product['keywords'].nil?
 
                 return meta_keywords
             end
@@ -174,52 +75,23 @@ module BigcommerceProductAgent
                 return value
             end
 
-            def self.get_variant_by_sku(sku, product)
-                product['model'].select {|m| m['sku'] == sku}.first
-            end
-
-            def self.merge_additional_properties(clone, field_map)
-                defaultVariant = clone['model'].select { |v| v['isDefault'] }.first
-                if defaultVariant['isDefault'] && defaultVariant['additionalProperty']
-                    unless  field_map.nil? || field_map['additionalProperty'].nil?
-                        field_map['additionalProperty'].each do |field, key|
-                            prop = defaultVariant['additionalProperty'].select { |prop| prop['propertyID'] == field[key] }.first
-                            clone['additionalProperty'].push(prop) unless prop.nil?
-                        end
-                    end
-                end
-            end
-
             # get a list of search keywords for the products
             def self.get_search_keywords(additional_search_terms, product)
-                return (self.meta_keywords(product) + additional_search_terms.split(",")).join(",")
-            end
+              search_keywords = self.meta_keywords(product)
+              search_keywords << product['isbn'] if product['isbn'].present?
+              if (additional_search_terms && !additional_search_terms.empty?)
+                search_keywords.concat(additional_search_terms)
+              end
 
-            def self.get_availability(product)
-                if product['datePublished'] && product['datePublished'].to_datetime && product['datePublished'].to_datetime < DateTime.now
-                    return 'available'
-                else
-                    if product['releaseDate'] && product['releaseDate'].to_datetime
-                        if product['releaseDate'].to_datetime > DateTime.now
-                            return 'preorder'
-                        else
-                            return 'available'
-                        end
-                    else
-                        return 'disabled'
-                    end
-                end
+              return search_keywords.uniq.join(",")
             end
 
-            def self.get_availability_offer(product, variant)
-                if product['offers'] && product['offers'][0]
-                    return product['offers'][0]['availability']
+            def self.get_availability(product)
+                if product['productAvailability'] == 'not available'
+                  return 'disabled'
                 else
-                    if variant['offers'] && variant['offers'][0]
-                        return variant['offers'][0]['availability']
-                    end
+                  return product['productAvailability']
                 end
-                return ''
             end
         end
     end

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.10.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Jacob Spizziri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -63,18 +63,12 @@ files:
 - lib/abstract_client.rb
 - lib/client/custom_field.rb
 - lib/client/meta_field.rb
-- lib/client/modifier.rb
-- lib/client/modifier_value.rb
 - lib/client/product.rb
-- lib/client/product_option.rb
-- lib/client/product_option_value.rb
-- lib/client/product_variant.rb
-- lib/client/variant.rb
 - lib/huginn_bigcommerce_product_agent.rb
+- lib/huginn_bigcommerce_product_agent/big_commerce_product_error.rb
 - lib/huginn_bigcommerce_product_agent/bigcommerce_product_agent.rb
 - lib/mapper/custom_field_mapper.rb
 - lib/mapper/meta_field_mapper.rb
-- lib/mapper/modifier_mapper.rb
 - lib/mapper/option_mapper.rb
 - lib/mapper/option_value_mapper.rb
 - lib/mapper/product_mapper.rb