huginn_bigcommerce_product_agent 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6b3753b33f18dcebc855995dd0a0933264939bfbcdb43e3a85782e6c9fe6491
-  data.tar.gz: 61f18e0d600dca9c000757263ce85402fc8f873c4b0ece8b4eccf32a369a8863
+  metadata.gz: fc1f86e4140f0ea64f918029089504724d3fe118af99ff9058520b5443635080
+  data.tar.gz: 5e276b0de209730cb1435efd7afe43429bb616b5db1632da8ac6f579fe7f4d34
 SHA512:
-  metadata.gz: da2ca4d9e10b4c0fcb386e356559308531dcaafc158ac9c0d2e7839dce7d49f40124f8c7818c70199b22bd7726dffaaaaf8a7597ed588e4108e83be4bf55b7a6
-  data.tar.gz: e8da778b8ef5a95862ceb721a1e10f27abd11926eb242b1eb2f46266c05698bdbd2d6dfd94439140ebd2892c9da2c4dacca3fb725fe972640e1da43bf9e840dd
+  metadata.gz: 3abfde4474f27ea44e964897fb98b689cd15d2b3f502a0a41442ed767a6c93756ce45ad4f888452edf406a0f670dd6e5138cf49d88736610deb4bb7dec867f95
+  data.tar.gz: fe9a2d303d6259f58f4d9536cbbf6ff53f7141ecb31a9841b78191acfc0cae9b35eaccfb61aa1adb60005618f87e95e4ebd1a507135fe84e4a82c9305cc3901a

data/lib/client/meta_field.rb

@@ -0,0 +1,49 @@
+module BigcommerceProductAgent
+    module Client
+        class MetaField < AbstractClient
+            @uri_base = 'catalog/products/:product_id/metafields/:meta_field_id'
+
+            def get_for_product(product_id)
+              return [] if product_id.blank?
+
+              response = client.get(uri(product_id: product_id))
+              return response.body['data']
+            end
+
+            def create(meta_field)
+              response = client.post(
+                uri(product_id: meta_field[:resource_id]),
+                meta_field.to_json
+              )
+
+              return response.body['data']
+            end
+
+            def update(meta_field)
+              response = client.put(
+                uri(product_id: meta_field[:resource_id], meta_field_id: meta_field[:id]),
+                meta_field.to_json
+              )
+
+              return response.body['data']
+            end
+
+            def upsert(meta_field)
+              begin
+                if meta_field[:id]
+                  return update(meta_field)
+                else
+                  return create(meta_field)
+                end
+              rescue Faraday::Error::ClientError => e
+                puts e.inspect
+                raise e
+              end
+            end
+
+            def delete(product_id, meta_field_id)
+                client.delete(uri(product_id: product_id, meta_field_id: meta_field_id))
+            end
+        end
+    end
+end

data/lib/huginn_bigcommerce_product_agent/bigcommerce_product_agent.rb

@@ -20,6 +20,8 @@ module Agents
                 'client_id' => '',
                 'access_token' => '',
                 'custom_fields_map' => {},
+                'meta_fields_map' => {},
+                'meta_fields_namespace' => '',
             }
         end
 
@@ -39,6 +41,14 @@ module Agents
             unless options['custom_fields_map'].is_a?(Hash)
                 errors.add(:base, "if provided, custom_fields_map must be a hash")
             end
+
+            unless options['meta_fields_map'].is_a?(Hash)
+                errors.add(:base, "if provided, meta_fields_map must be a hash")
+            end
+
+            if options['meta_fields_map']
+                errors.add(:base, "if meta_fields_map is provided, meta_fields_namespace is required") if options['meta_fields_namespace'].blank?
+            end
         end
 
         def working?
@@ -68,10 +78,15 @@ module Agents
             # upsert child products
             bc_children = []
             custom_fields_delete = []
+            meta_fields_upsert = []
+            meta_fields_delete = []
+
             skus.each do |sku|
                 bc_product = bc_products[sku]
                 result = upsert(sku, product, bc_product)
                 custom_fields_delete += result[:custom_fields_delete]
+                meta_fields_upsert += result[:meta_fields_upsert]
+                meta_fields_delete += result[:meta_fields_delete]
                 bc_children.push(result[:product])
             end
 
@@ -79,6 +94,8 @@ module Agents
             bc_wrapper_product = bc_products[wrapper_sku]
             result = upsert(wrapper_sku, product, bc_wrapper_product)
             custom_fields_delete += result[:custom_fields_delete]
+            meta_fields_upsert += result[:meta_fields_upsert]
+            meta_fields_delete += result[:meta_fields_delete]
 
             # update modifier
             sku_option_map = ::BigcommerceProductAgent::Mapper::ProductMapper.get_sku_option_label_map(product)
@@ -91,7 +108,9 @@ module Agents
 
             clean_up_custom_fields(custom_fields_delete)
             clean_up_modifier_values(modifier_updates[:delete])
+            meta_fields = update_meta_fields(meta_fields_upsert, meta_fields_delete)
 
+            product['meta_fields'] = meta_fields
             product['modifiers'] = modifier_updates[:upsert]
             create_event payload: {
                 product: product,
@@ -115,6 +134,12 @@ module Agents
                 interpolated['access_token']
             )
 
+            @meta_field = ::BigcommerceProductAgent::Client::MetaField.new(
+                interpolated['store_hash'],
+                interpolated['client_id'],
+                interpolated['access_token']
+            )
+
             @modifier = ::BigcommerceProductAgent::Client::Modifier.new(
                 interpolated['store_hash'],
                 interpolated['client_id'],
@@ -136,6 +161,7 @@ module Agents
             )
 
             product_id = bc_product['id'] unless bc_product.nil?
+
             payload = ::BigcommerceProductAgent::Mapper::ProductMapper.payload(
                 sku,
                 product,
@@ -145,9 +171,21 @@ module Agents
 
             bc_product = @product.upsert(payload)
 
+            # Metafields need to be managed separately. Intentionally get them _AFTER_
+            # the upsert so that we have the necessary resource_id (bc_product.id)
+            meta_fields_updates = ::BigcommerceProductAgent::Mapper::MetaFieldMapper.map(
+                interpolated['meta_fields_map'],
+                product,
+                bc_product,
+                @meta_field.get_for_product(bc_product['id']),
+                interpolated['meta_fields_namespace']
+            )
+
             return {
                 product: bc_product,
                 custom_fields_delete: custom_fields_updates[:delete],
+                meta_fields_upsert: meta_fields_updates[:upsert],
+                meta_fields_delete: meta_fields_updates[:delete],
             }
         end
 
@@ -162,5 +200,19 @@ module Agents
                 @modifier_value.delete(field[:product_id], field[:modifier_id], field[:value_id])
             end
         end
+
+        def update_meta_fields(upsert_fields, delete_fields)
+            meta_fields = []
+
+            upsert_fields.each do |field|
+                meta_fields << @meta_field.upsert(field)
+            end
+
+            delete_fields.each do |field|
+                @meta_field.delete(field[:resource_id], field[:id])
+            end
+
+            return meta_fields
+        end
     end
 end

data/lib/mapper/meta_field_mapper.rb

@@ -0,0 +1,100 @@
+module BigcommerceProductAgent
+    module Mapper
+        class MetaFieldMapper
+
+            def self.map(field_map, product, bc_product, meta_fields, namespace)
+                fields = {
+                    upsert: [],
+                    delete: [],
+                }
+
+                existing_fields = {}
+
+                if bc_product
+                    meta_fields.each do |mf|
+
+                        unless mf['namespace'] != namespace
+                          # Only delete meta fields managed by this sync
+                          existing_fields[mf['key'].to_s] = mf
+                        end
+                    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, namespace, bc_product)
+                        fields[:upsert].push(field) unless field.nil?
+                    end
+                end
+
+                if field_map
+                    field_map.each do |key, val|
+                        if key == 'additionalProperty'
+                            next
+                        end
+
+                        field = self.from_property(product, existing_fields, key, val, namespace, bc_product)
+                        fields[:upsert].push(field) unless field.nil?
+                    end
+                end
+
+                # return values that need deleted
+                fields[:delete] = existing_fields.values
+                return fields
+            end
+
+            private
+
+            def self.from_property(product, existing_fields, from_key, to_key, namespace, bc_product)
+
+                if !product[from_key].nil?
+                    field = {
+                        namespace: namespace,
+                        permission_set: 'write',
+                        resource_type: 'product',
+                        key: to_key,
+                        value: product[from_key]
+                    }
+
+                    if bc_product
+                      field[:resource_id] = bc_product['id']
+                    end
+
+                    if existing_fields[to_key]
+                        field[:id] = existing_fields[to_key]['id']
+                        existing_fields.delete(to_key)
+                    end
+
+                    return field
+                end
+            end
+
+            def self.from_additional_property(product, existing_fields, from_key, to_key, namespace, bc_product)
+
+                item = product['additionalProperty'].select {|p| p['propertyID'] == from_key}.first
+                if !item.nil?
+
+                    field = {
+                        namespace: namespace,
+                        permission_set: 'write',
+                        resource_type: 'product',
+                        key: to_key,
+                        value: item['value']
+                    }
+
+                    if bc_product
+                      field[:resource_id] = bc_product['id']
+                    end
+
+                    if existing_fields[to_key]
+                        field[:id] = existing_fields[to_key]['id']
+                        existing_fields.delete(to_key)
+                    end
+
+                    return field
+                end
+            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.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Jacob Spizziri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-06 00:00:00.000000000 Z
+date: 2020-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,12 +62,14 @@ extra_rdoc_files: []
 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/huginn_bigcommerce_product_agent.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/product_mapper.rb
 - spec/bigcommerce_product_agent_spec.rb