huginn_bigcommerce_product_agent 1.4.3 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d9046f3fa0d6c9e3f0c58720148502c622ec9662cecc03488d381f5c7730440
-  data.tar.gz: 15652aee1e058bffc5a15920574bd93c7eb89ba0391c267cb6912c270a1f0810
+  metadata.gz: 8bbd3a133d224fea3726d9b0f8b86803957e919e225e983be8ac3a1c7c027312
+  data.tar.gz: 202e2165d11044d4f44e722aa39e61224b819b344304e73e3c9e888c0a20153a
 SHA512:
-  metadata.gz: b75f6cc9fbfabb4c0143b33146d1c736fd4680657642c29e755621e12a5d1d5efb6aa1aadc4d3ee6494dea17d1f6dab20d34a15aacf8ec992be8c79430d89fc3
-  data.tar.gz: 3fe2de4e3330ae759ef8e43b402a6a5ca7ac9e1ce21dac24c8ff2bbdb0e8680ca2fcde53f129d6ae5358a07d3f9e237eae08ae8b1c0fc1f378b3c880082d5239
+  metadata.gz: 87204345ec8502a89ac61b5de9bf21f8daf8ab34b3b22cb2563e6a55b90da6239e2dc92d096caf4e9b8e08b2591286ac3f4b8b36a6ba07efecafdbafdf3d93bb
+  data.tar.gz: abe689235f182acf5c2eb977d9179af9b7431a1537435093a140e54e16b1981bb901fa02ec2bdc8e3469c96fab3d314474f63714caa835d878edcb375223f781

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/client/variant.rb

@@ -15,10 +15,9 @@ module BigcommerceProductAgent
                 begin
                     response = client.put(uri, payload.to_json)
                     return response.body['data']
-                rescue Faraday::Error::ClientError => e
-                    puts e.inspect
-                    raise e
-                end
+                  rescue Faraday::Error::ClientError => e
+                      raise e, "\n#{e.message}\nFailed to upsert variant with payload = #{payload.to_json}\n", e.backtrace
+                  end
             end
 
             def get_by_skus(skus, include = %w[custom_fields modifiers])

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
 
@@ -67,6 +68,11 @@ module Agents
             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,27 @@ 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['page_title'] = product['name']
+                    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 +365,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 +378,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,19 @@ 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,
+                    page_title: product['page_title'] || '',
                 }
                 result[:upc] = product['gtin12'] if product['gtin12']
 
@@ -182,6 +189,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.3
+  version: 1.9.0
 platform: ruby
 authors:
 - Jacob Spizziri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler