huginn_bigcommerce_product_agent 1.4.2 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4212c209c32fafb12fc7746a038bcb4c20af8cde053cb2adc44cff87e8112433
-  data.tar.gz: 4dd2faafdf9ab8422eacd7c407ccf35549a69ace3df0a9a748c09bc91a038ffc
+  metadata.gz: 401d12c4fd8a1bd918e0e0b4d6a20eca3467e7ce288130025c500e7f3a7e7d9c
+  data.tar.gz: 501ebd2b48cc23f68671c407ddefdf69d12b666eb608f37d4f149e81eeaecf6d
 SHA512:
-  metadata.gz: c871f927452151ecd880b7b68731d8629100262911c9fc7d4566cf7f31a29c626bedba74f5dcb83dbd135413a95a781042d1e6408b060c00e0bf4106c408d2af
-  data.tar.gz: a275f1a162b1a7ed5633b5e0868766eb9e41b9b1ce0e8a024c5bc241183bf286ddc582f53df9b580e2ea3cb52b7ad6de51bdc1274b13857ecb153a206e924ce3
+  metadata.gz: fb699b59217b6c4ee28b5691ffa1f08bd8298e7aa96bdaed61060097e506bb170d189a386b61871bfb761c5eb6c103e9451aa13ced6330843808774e9fd00997
+  data.tar.gz: a368c30a438e9c20659a7b819e4cdf691f2f790436ecd588bb6742b65fefa6453ee42a3f8eb4aab0aaf924d6bfd7f002053b60cd946f27b7da13fc11f1470748

data/lib/client/product.rb

@@ -4,8 +4,12 @@ module BigcommerceProductAgent
             @uri_base = 'catalog/products/:product_id'
 
             def update(id, payload, params={})
-                response = client.put(uri(product_id: id), payload.to_json) do |request|
-                    request.params.update(params) if params
+                begin
+                    response = client.put(uri(product_id: id), payload.to_json) do |request|
+                        request.params.update(params) if params
+                    end
+                rescue Faraday::Error::ClientError => e
+                    raise e, "\n#{e.message}\nFailed to update product with payload = #{payload.to_json}\n", e.backtrace
                 end
 
                 return response.body['data']
@@ -17,23 +21,22 @@ module BigcommerceProductAgent
             end
 
             def create(payload, params={})
-                response = client.post(uri, payload.to_json) do |request|
-                    request.params.update(params) if params
+                begin
+                    response = client.post(uri, payload.to_json) do |request|
+                        request.params.update(params) if params
+                    end
+                rescue Faraday::Error::ClientError => e
+                    raise e, "\n#{e.message}\nFailed to create product with payload = #{payload.to_json}\n", e.backtrace
                 end
 
                 return response.body['data']
             end
 
             def upsert(payload, params={})
-                begin
-                    if payload[:id]
-                        return update(payload[:id], payload, params)
-                    else
-                        return create(payload, params)
-                    end
-                rescue Faraday::Error::ClientError => e
-                    puts e.inspect
-                    raise e
+                if payload[:id]
+                    return update(payload[:id], payload, params)
+                else
+                    return create(payload, params)
                 end
             end
 

data/lib/huginn_bigcommerce_product_agent/bigcommerce_product_agent.rb

@@ -29,7 +29,8 @@ module Agents
                 'meta_fields_map' => {},
                 'meta_fields_namespace' => '',
                 'mode' => modes[0],
-                'not_purchasable_format_list' => []
+                'not_purchasable_format_list' => [],
+                'should_disambiguate' => false
             }
         end
 
@@ -64,9 +65,14 @@ module Agents
                 errors.add(:base, "mode is a required field and must be one of: #{modes.join(', ')}")
             end
 
-            unless options['not_purchasable_format_list'].present? && !options['not_purchasable_format_list'].is_a?(Array)
+            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?
@@ -124,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
@@ -133,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.
@@ -337,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,
@@ -350,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
@@ -31,15 +34,18 @@ module BigcommerceProductAgent
                     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(','),
+                    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

metadata

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