huginn_bigcommerce_product_agent 1.4.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80abf4633b57aeb958ec7f79f516f860fb099c20e6962de6e4cd0d8d0e1f3f5c
-  data.tar.gz: df57c8f677d590947fc4fce038740adc6d2aba7618acf60eca3c4a9bcaa5700a
+  metadata.gz: ce068992ff7f5e99b7f7656d246d104b60bc1a12c836c84d3c0156e0fadc9c67
+  data.tar.gz: eadfb8e593e0e44a806f6cbcffbbe8f0b6d364f73215ffd2565c91be80c6b885
 SHA512:
-  metadata.gz: 817b6c0d76780bfab457aaf7a6b67693caf97d6d7c581361270adb1ff874cef268a63adf74b52846d7278c4ad02c9d095c230e7af7ffc77ac3572b73a121b505
-  data.tar.gz: a87ce903ed0c6c9c9e47fdb68acefcf1de788f8f6f754d02aa149793bed703846087a324b9c4004a99b5d3d9bf4de83de6dc223a5c59cf451093f4961dad5f22
+  metadata.gz: 3b8cbc08bc80f5cf0e811fa61874545ce54cb2ee4af113cc3f43fc102959690b32d8e7ce8ec027e29d836c60db78d4d7c50aca414ca24149f66dae1756879032
+  data.tar.gz: a1ee6941129e2df489daa52077f5bd9daa57943ebc6328880a8cbf7b8747a3c59ebdd16634f9ed8398f48e2490ffee278c0360d472b8989c45c6fa629d27da52

data/lib/huginn_bigcommerce_product_agent/bigcommerce_product_agent.rb

@@ -28,7 +28,9 @@ module Agents
                 'custom_fields_map' => {},
                 'meta_fields_map' => {},
                 'meta_fields_namespace' => '',
-                'mode' => modes[0]
+                'mode' => modes[0],
+                'not_purchasable_format_list' => [],
+                'should_disambiguate' => false
             }
         end
 
@@ -62,6 +64,15 @@ module Agents
             unless options['mode'].present? && modes.include?(options['mode'])
                 errors.add(:base, "mode is a required field and must be one of: #{modes.join(', ')}")
             end
+
+            if options['not_purchasable_format_list'].present? && !options['not_purchasable_format_list'].is_a?(Array)
+                errors.add(:base, 'not_purchasable_format_list must be an Array')
+            end
+
+            if options.has_key?('should_disambiguate') && boolify(options['should_disambiguate']).nil?
+                errors.add(:base, 'when provided, `should_disambiguate` must be either true or false')
+            end
+
         end
 
         def working?
@@ -119,6 +130,16 @@ module Agents
                 wrapper_skus.map {|k,v| v},
                 %w[custom_fields options]
             )
+            #save skus
+            digital_skus = []
+            physical_skus = []
+            if split[:digital] and split[:physical]
+                digital_skus.concat([wrapper_skus[:digital]])
+                digital_skus.concat(get_mapper(:ProductMapper).get_product_skus(split[:digital])).join(",")
+                physical_skus.concat([wrapper_skus[:physical]])
+                physical_skus.concat(get_mapper(:ProductMapper).get_product_skus(split[:physical])).join(",")
+            end
+
             # upsert wrapper products
             split.each do |type, product|
                 is_digital = type == :digital ? true : false
@@ -128,15 +149,26 @@ 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
+                if boolify(options['should_disambiguate'])
+                    product['name'] += " |~ " + product['model'].map { |m|
+                       m['additionalProperty'].find { |p|
+                           p['propertyID'] == 'option'
+                       }['value']
+                    }.join(", ")
+                end
+
                 wrapper_sku = wrapper_skus[type]
                 bc_product = bc_products[wrapper_sku]
                 variant_option_name = get_mapper(:OptionMapper).variant_option_name
                 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
                 # ##############################
-                upsert_result = upsert_product(wrapper_sku, product, bc_product, is_digital)
+                upsert_result = upsert_product(wrapper_sku, product, bc_product, is_digital, search_skus)
                 bc_product = upsert_result[:product]
 
                 # clean up custom/meta fields. there are not batch operations so we might as well do them here.
@@ -183,6 +215,8 @@ module Agents
                         [option_value],
                         product_id,
                         bc_variant.nil? ? nil : bc_variant['id'],
+                        interpolated['not_purchasable_format_list'],
+                        bc_option_value
                     )
                 end
 
@@ -330,7 +364,7 @@ module Agents
             return ::BigcommerceProductAgent::Mapper.const_get(class_name.to_sym)
         end
 
-        def upsert_product(sku, product, bc_product = nil, is_digital=false)
+        def upsert_product(sku, product, bc_product = nil, is_digital=false, search_skus=[])
             custom_fields_updates = get_mapper(:CustomFieldMapper).map(
                 interpolated['custom_fields_map'],
                 product,
@@ -343,7 +377,10 @@ module Agents
                 sku,
                 product,
                 product_id,
-                { custom_fields: custom_fields_updates[:upsert] },
+                {
+                    additional_search_terms: search_skus,
+                    custom_fields: custom_fields_updates[:upsert]
+                },
                 is_digital,
             )
 

data/lib/mapper/product_mapper.rb

@@ -19,6 +19,9 @@ module BigcommerceProductAgent
                             "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
@@ -28,18 +31,21 @@ module BigcommerceProductAgent
                     sku: product ? product['sku'] : default_sku,
                     is_default: product['isDefault'],
                     type: product['isDigital'] == true || is_digital ? 'digital' : 'physical',
-                    description: product['description'],
+                    description: product['description'] || '',
                     price: product['offers'] && product['offers'][0] ? product['offers'][0]['price'] : '0',
                     categories: self.get_categories(product),
-                    available: 'available',
+                    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.meta_keywords(product).join(','),
+                    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,
                 }
                 result[:upc] = product['gtin12'] if product['gtin12']
 
@@ -182,6 +188,38 @@ module BigcommerceProductAgent
                     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
+
+            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
+            end
+
+            def self.get_availability_offer(product, variant)
+                if product['offers'] && product['offers'][0]
+                    return product['offers'][0]['availability']
+                else
+                    if variant['offers'] && variant['offers'][0]
+                        return variant['offers'][0]['availability']
+                    end
+                end
+                return ''
+            end
         end
     end
 end

data/lib/mapper/variant_mapper.rb

@@ -2,7 +2,7 @@ module BigcommerceProductAgent
     module Mapper
         class VariantMapper
 
-            def self.map(variant, option_values, product_id, variant_id=nil)
+            def self.map(variant, option_values, product_id, variant_id=nil, not_purchasable_format_list, bc_option_value)
                 mapped = {
                     product_id: product_id,
                     sku: variant['sku'],
@@ -29,6 +29,14 @@ module BigcommerceProductAgent
                     mapped[:id] = variant_id
                 end
 
+                unless not_purchasable_format_list.nil?
+                  not_purchasable_format_list.each do |format|
+                      if format == bc_option_value['label']
+                          mapped[:purchasing_disabled] = true
+                      end
+                  end
+                end
+
                 return mapped
             end
 

metadata

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