huginn_bigcommerce_product_agent 1.10.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c6e30baa91c2309f76692a19fcba067b76749dbf0a43a608c01c8b67e77e2151
+  data.tar.gz: c234d8636bf50a12cf170494d7a479cc171482b54c724307c317e059233e723f
+SHA512:
+  metadata.gz: 8d787746d57c3eb0a1643da3b586c4e2ad31860912409b0b17e7e44cf5f23d986f5c834231bd54eb2c18249639e02fa0860858e6c609820d1c6e84172c95e078
+  data.tar.gz: 2b045dcce2130e261a4fbf3912efe019d87cfb169788d922315a4f8fd016f4addc82eb238be1964cdb7c8bb5ae80342aae82f46d75b7c3263b047eef713065c0

data/lib/abstract_client.rb

@@ -0,0 +1,89 @@
+
+module BigcommerceProductAgent
+    module Client
+        class AbstractClient
+            @client = nil
+            @uri_base = ''
+
+            def initialize(
+                store_hash,
+                client_id,
+                access_token,
+                params = {
+                    endpoint: 'https://api.bigcommerce.com',
+                    api_version: 'v3',
+                }
+            )
+                @headers = {
+                    'X-Auth-Client' => client_id,
+                    'X-Auth-Token' => access_token,
+                    'Content-Type' => 'application/json',
+                    'Accept' => 'application/json'
+                }
+                @store_hash = store_hash
+                @endpoint = params[:endpoint]
+                @api_version = params[:api_version]
+            end
+
+            def self.uri_base
+                @uri_base
+            end
+
+            def uri_base
+                self.class.uri_base
+            end
+
+            def client
+                if !@client
+                    @client = Faraday.new({ url: @endpoint, headers: @headers }) do |conn|
+                        conn.use Faraday::Response::RaiseError
+                        conn.response :logger, nil, { headers: true, bodies: true }
+                        conn.response :json, :content_type => 'application/json'
+                        conn.adapter Faraday.default_adapter
+                    end
+                end
+
+                return @client
+            end
+
+            def uri(params = {})
+                u = "/stores/#{@store_hash}/#{@api_version}/#{uri_base}"
+
+                params.each do |key,val|
+                  u = u.gsub(":#{key.to_s}", val.to_s)
+                end
+
+                # remove params that weren't provided
+                u = u.gsub(/(\/\:[^\/]+)/, '')
+
+                return u
+            end
+
+            def index(params = {})
+                response = client.get(uri, params)
+                return response.body['data']
+            end
+
+            def create(payload)
+                raise "not implemented yet."
+            end
+
+            def update(payload)
+                raise "not implemented yet."
+            end
+
+            def delete(payload)
+                raise "not implemented yet."
+            end
+
+            def upsert(payload)
+                raise "not implemented yet."
+            end
+
+            def get(url_params = {}, params = {})
+                response = client.get(uri(url_params), params)
+                return response.body['data']
+            end
+        end
+    end
+end

data/lib/client/custom_field.rb

@@ -0,0 +1,36 @@
+module BigcommerceProductAgent
+    module Client
+        class CustomField < AbstractClient
+            @uri_base = 'catalog/products/:product_id/custom-fields/:custom_field_id'
+
+            def create(product_id, payload)
+                response = client.post(uri(product_id: product_id), payload.to_json)
+                return response.body['data']
+            end
+
+            def update(product_id, payload)
+                id = payload.delete('id')
+                response = client.put(uri(product_id: product_id, custom_field_id: id), payload.to_json)
+                return response.body['data']
+            end
+
+            def delete(product_id, custom_field_id)
+                client.delete(uri(product_id: product_id, custom_field_id: custom_field_id))
+            end
+
+            def upsert(product_id, payload)
+                begin
+                    payload['id'] = payload.delete(:id) unless payload[:id].nil?
+                    if payload['id']
+                        return update(product_id, payload)
+                    else
+                        return create(product_id, payload)
+                    end
+                rescue Faraday::Error::ClientError => e
+                    puts e.inspect
+                    raise e
+                end
+            end
+        end
+    end
+end

data/lib/client/meta_field.rb

@@ -0,0 +1,53 @@
+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)
+                begin
+                    client.delete(uri(product_id: product_id, meta_field_id: meta_field_id))
+                rescue Faraday::Error::ClientError => e
+                    raise e, "\n#{e.message}\nFailed to delete meta_field with id = #{meta_field_id}\nfor product with id = #{product_id}\n", e.backtrace
+                end
+            end
+        end
+    end
+end

data/lib/client/modifier.rb

@@ -0,0 +1,35 @@
+module BigcommerceProductAgent
+    module Client
+        class Modifier < AbstractClient
+            @uri_base = 'catalog/products/:product_id/modifiers/:modifier_id'
+
+            def delete(product_id, modifier_id)
+                client.delete(uri(product_id: product_id, modifier_id: modifier_id))
+            end
+
+            def upsert(product_id, modifier)
+                begin
+                    if modifier[:id] || modifier['id']
+                        modifier['id'] = modifier[:id] unless modifier[:id].nil?
+                        return update(product_id, modifier)
+                    else
+                        return create(product_id, modifier)
+                    end
+                rescue Faraday::Error::ClientError => e
+                    puts e.inspect
+                    raise e
+                end
+            end
+
+            def update(product_id, modifier)
+                response = client.put(uri(product_id: product_id, modifier_id: modifier['id']), modifier.to_json)
+                return response.body['data']
+            end
+
+            def create(product_id, modifier)
+                response = client.post(uri(product_id: product_id), modifier.to_json)
+                return response.body['data']
+            end
+        end
+    end
+end

data/lib/client/modifier_value.rb

@@ -0,0 +1,11 @@
+module BigcommerceProductAgent
+    module Client
+        class ModifierValue < AbstractClient
+            @uri_base = 'catalog/products/:product_id/modifiers/:modifier_id/values/:value_id'
+
+            def delete(product_id, modifier_id, value_id)
+                client.delete(uri(product_id: product_id, modifier_id: modifier_id, value_id: value_id))
+            end
+        end
+    end
+end

data/lib/client/product.rb

@@ -0,0 +1,60 @@
+module BigcommerceProductAgent
+    module Client
+        class Product < AbstractClient
+            @uri_base = 'catalog/products/:product_id'
+
+            def update(id, payload, 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']
+            end
+
+            def delete(id)
+                response = client.delete(uri(product_id: id))
+                return true
+            end
+
+            def create(payload, 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={})
+                if payload[:id]
+                    return update(payload[:id], payload, params)
+                else
+                    return create(payload, params)
+                end
+            end
+
+            def get_by_skus(skus, include = %w[custom_fields modifiers])
+                products = index({
+                    'sku:in': skus.join(','),
+                    include: include.join(','),
+                })
+
+                map = {}
+
+                products.each do |product|
+                    map[product['sku']] = product
+                end
+
+                map
+            end
+
+        end
+    end
+end

data/lib/client/product_option.rb

@@ -0,0 +1,45 @@
+module BigcommerceProductAgent
+    module Client
+        class ProductOption < AbstractClient
+            @uri_base = 'catalog/products/:product_id/options/:option_id'
+
+            def delete(product_id, option_id)
+                client.delete(uri(product_id: product_id, option_id: option_id))
+            end
+
+            def delete_all(options)
+                options.each do |option|
+                    delete(option['product_id'], option['id'])
+                end
+            end
+
+            def upsert(product_id, option)
+                begin
+                    if option[:id] || option['id']
+                        option['id'] = option[:id] unless option[:id].nil?
+                        return update(product_id, option)
+                    else
+                        return create(product_id, option)
+                    end
+                rescue Faraday::Error::ClientError => e
+                    puts e.inspect
+                    raise e
+                end
+            end
+
+            def update(product_id, option)
+                response = client.put(uri(product_id: product_id, option_id: option['id']), option.to_json)
+                return response.body['data']
+            end
+
+            def create(product_id, option)
+                begin
+                    response = client.post(uri(product_id: product_id), option.to_json)
+                    return response.body['data']
+                rescue Faraday::Error::ClientError => e
+                    raise e, "\n#{e.message}\nFailed to upsert product_option = #{option.to_json}\nfor product with id = #{product_id}\n", e.backtrace
+                end
+            end
+        end
+    end
+end

data/lib/client/product_option_value.rb

@@ -0,0 +1,72 @@
+module BigcommerceProductAgent
+    module Client
+        class ProductOptionValue < AbstractClient
+            @uri_base = 'catalog/products/:product_id/options/:option_id/values/:value_id'
+
+            def delete(product_id, option_id, value_id)
+                client.delete(uri(product_id: product_id, option_id: option_id, value_id: value_id))
+            end
+
+            def delete_all(option, option_values)
+                option_values.each do |option_value|
+                    delete(option['product_id'], option['id'], option_value['id'])
+                end
+            end
+
+            def upsert(option, option_value)
+                begin
+                    if option[:product_id] || option['product_id']
+                        option['product_id'] = option[:product_id] unless option[:product_id].nil?
+                    end
+
+                    if option[:id] || option['id']
+                        option['id'] = option[:id] unless option[:id].nil?
+                    end
+
+                    if option_value[:id] || option_value['id']
+                        option_value['id'] = option_value[:id] unless option_value[:id].nil?
+                        return update(option, option_value)
+                    else
+                        return create(option, option_value)
+                    end
+                rescue Faraday::Error::ClientError => e
+                    puts e.inspect
+                    raise e
+                end
+            end
+
+            def upsert_all(option, option_values)
+                results = []
+                option_values.each do |option_value|
+                    result = upsert(option, option_value)
+                    results.push(result)
+                end
+
+                return results
+            end
+
+            def update(option, option_value)
+                response = client.put(
+                    uri(
+                        product_id: option['product_id'],
+                        option_id: option['id'],
+                        value_id: option_value['id'],
+                    ),
+                    option_value.to_json,
+                )
+                return response.body['data']
+            end
+
+            def create(option, option_value)
+                response = client.post(
+                    uri(
+                        product_id: option['product_id'],
+                        option_id: option['id'],
+                    ),
+                    option_value.to_json,
+                )
+                return response.body['data']
+            end
+        end
+    end
+end

data/lib/client/product_variant.rb

@@ -0,0 +1,40 @@
+module BigcommerceProductAgent
+    module Client
+        class ProductVariant < AbstractClient
+            @uri_base = 'catalog/products/:product_id/variants/:variant_id'
+
+            def index(product_id, params = {})
+                response = client.get(uri(product_id: product_id), params)
+                return response.body['data']
+            end
+
+            def delete(product_id, variant_id)
+                client.delete(uri(product_id: product_id, variant_id: variant_id))
+            end
+
+            def upsert(product_id, variant)
+                begin
+                    if variant[:id] || variant['id']
+                        variant['id'] = variant[:id] unless variant[:id].nil?
+                        return update(product_id, variant)
+                    else
+                        return create(product_id, variant)
+                    end
+                rescue Faraday::Error::ClientError => e
+                    puts e.inspect
+                    raise e
+                end
+            end
+
+            def update(product_id, variant)
+                response = client.put(uri(product_id: product_id, variant_id: variant['id']), variant.to_json)
+                return response.body['data']
+            end
+
+            def create(product_id, variant)
+                response = client.post(uri(product_id: product_id), variant.to_json)
+                return response.body['data']
+            end
+        end
+    end
+end