e_plat 0.3.0 → 0.4.0

data/lib/e_plat/mapping/bigcommerce/v_3/order/shipping_address.rb

@@ -0,0 +1,73 @@
+
+module EPlat
+    class Mapping
+        module Bigcommerce
+            module V3
+                class Order::ShippingAddress < EPlat::Mapping::Base
+                    
+                    def native_top_key
+                        "data"
+                    end
+                    
+                    def native_attributes
+                        super.concat([
+                            "first_name",
+                            "last_name",
+                            "company",
+                            "street_1",
+                            "street_2",
+                            "city",
+                            "state",
+                            "zip",
+                            "country",
+                            "country_iso2",
+                            "phone",
+                            "email",
+                            "form_fields"
+                        ])
+                    end
+                    
+                    def native_attribute_aliases
+                        super.concat([
+                            {
+                                alias_attribute: {native_key: "street_1", e_plat_key: "address1"}
+                            },
+                            {
+                                alias_attribute: {native_key: "street_2", e_plat_key: "address2"}
+                            },
+                            {
+                                existing_entry: {native_key: "city", e_plat_key: "city"}
+                            },
+                            {
+                                existing_entry: {native_key: "company", e_plat_key: "company"}
+                            },
+                            {
+                                existing_entry: {native_key: "country", e_plat_key: "country"}
+                            },
+                            {
+                                existing_entry: {native_key: "first_name", e_plat_key: "first_name"}
+                            },
+                            {
+                                existing_entry: {native_key: "last_name", e_plat_key: "last_name"}
+                            },
+                            {
+                                existing_entry: {native_key: "phone", e_plat_key: "phone"}
+                            },
+                            {
+                                alias_attribute: {native_key: "state", e_plat_key: "province"}
+                            },
+                            {
+                                existing_entry: {native_key: "zip", e_plat_key: "zip"}
+                            },
+                            {
+                                alias_attribute: {native_key: "country_iso2", e_plat_key: "country_code"}
+                            }
+                            # NOTE: BigCommerce doesn't provide fields for province_code, latitude, longitude, or a direct mapping for name
+                        ])
+                    end
+                    
+                end
+            end
+        end
+    end
+end

data/lib/e_plat/mapping/bigcommerce/v_3/order.rb

@@ -0,0 +1,160 @@
+module EPlat
+	class Mapping
+	  module Bigcommerce
+		module V3 #v2 used, as v3 order not yet available
+		  class Order < EPlat::Mapping::Base
+			virtual_collection :line_items, class: EPlat::Mapping::VirtualCollection::Bigcommerce::OrderLineItems, map_from: "consignments"
+
+			def native_top_key
+				"data"
+			end
+			
+			def native_attributes
+			  super.concat([
+				"id",
+				"customer_id",
+				"date_created",
+				"date_modified",
+				"date_shipped",
+				"status_id",
+				"status",
+				"subtotal_ex_tax",
+				"subtotal_inc_tax",
+				"subtotal_tax",
+				"base_shipping_cost",
+				"shipping_cost_ex_tax",
+				"shipping_cost_inc_tax",
+				"shipping_cost_tax",
+				"shipping_cost_tax_class_id",
+				"base_handling_cost",
+				"handling_cost_ex_tax",
+				"handling_cost_inc_tax",
+				"handling_cost_tax",
+				"handling_cost_tax_class_id",
+				"base_wrapping_cost",
+				"wrapping_cost_ex_tax",
+				"wrapping_cost_inc_tax",
+				"wrapping_cost_tax",
+				"wrapping_cost_tax_class_id",
+				"total_ex_tax",
+				"total_inc_tax",
+				"total_tax",
+				"items_total",
+				"items_shipped",
+				"payment_method",
+				"payment_provider_id",
+				"payment_status",
+				"refunded_amount",
+				"order_is_digital",
+				"store_credit_amount",
+				"gift_certificate_amount",
+				"ip_address",
+				"ip_address_v6",
+				"geoip_country",
+				"geoip_country_iso2",
+				"currency_id",
+				"currency_code",
+				"currency_exchange_rate",
+				"default_currency_id",
+				"default_currency_code",
+				"staff_notes",
+				"customer_message",
+				"discount_amount",
+				"coupon_discount",
+				"shipping_address_count",
+				"is_deleted",
+				"ebay_order_id",
+				"cart_id",
+				"billing_address",
+				"is_email_opt_in",
+				"credit_card_type",
+				"order_source",
+				"channel_id",
+				"external_source",
+				"products",
+				"shipping_addresses",
+				"coupons",
+				"external_id",
+				"external_merchant_id",
+				"tax_provider_id",
+				"store_default_currency_code",
+				"store_default_to_transactional_exchange_rate",
+				"custom_status",
+				"customer_locale",
+				"external_order_id"
+			  ])
+			end
+			
+			def native_attribute_aliases
+			  super.concat([
+				{
+					alias_attribute: {native_key: "date_created", e_plat_key: "created_at"}
+				  },
+				  {
+					alias_attribute: {native_key: "date_modified", e_plat_key: "updated_at"}
+				  },
+				  {
+					alias_attribute: {native_key: "status_id", e_plat_key: "financial_status",
+						custom_e_plat_getter: "-> (status_id) { 
+							case status_id.to_i
+							when 1 then 'pending'
+							when 4 then 'refunded'
+							when 5 then 'cancelled' # not a valid status for Shopify. just used in this BG specific mapping
+							when 7 then 'unpaid'
+							when 11 then 'paid'
+							else nil
+							end
+						}",
+						custom_native_setter: "-> (financial_status) { 
+							case financial_status
+							when 'pending' then 1
+							when 'refunded' then 4
+							when 'cancelled' then 5
+							when 'unpaid' then 7
+							when 'paid' then 11
+							else nil
+							end
+						}"
+					}
+				  },
+				  {
+					existing_entry: {native_key: "billing_address", e_plat_key: "billing_address"}
+				  },
+				  {
+					alias_attribute: {native_key: "currency_code", e_plat_key: "currency"}
+				  },
+				  {
+					alias_attribute: {native_key: 'subtotal_ex_tax', e_plat_key: 'subtotal_price'} #poundage string. eg "5.31"
+				  },
+				  {
+					existing_entry: {native_key: 'total_tax', e_plat_key: 'total_tax'} #poundage string. eg "5.31"
+				  },
+				  {
+					alias_attribute: {native_key: 'total_inc_tax', e_plat_key: 'total_price'} #poundage string. eg "5.31"
+				  },
+				  {
+					existing_entry: {native_key: 'id', e_plat_key: 'id'}
+				  },
+				  {
+					existing_entry: {native_key: 'customer_locale', e_plat_key: 'customer_locale'} #e.g. "en-{optional_country_code}"
+				  },
+				  {
+					alias_attribute: {native_key: "total_inc_tax", e_plat_key: "current_total_price"}
+				  },
+				  {
+					alias_attribute: {native_key: "discount_amount", e_plat_key: "current_total_discounts"} #poundage string. eg "9.99"
+				  },
+				  {
+					alias_attribute: {native_key: "staff_notes", e_plat_key: "note"}
+				  },
+				  {
+					alias_attribute: {native_key: "billing_address[email]", e_plat_key: "email"}
+				  }
+			  ])
+			end
+  
+		  end
+		end
+	  end
+	end
+  end

data/lib/e_plat/mapping/bigcommerce/v_3/product/image.rb

@@ -15,28 +15,28 @@ module EPlat
 								super.concat([
 									"id", 
 									"product_id",
-										"is_thumbnail",
-										"sort_order",
-										"description",
-										"image_file",
-										"url_zoom",
-										"url_standard",
-										"url_thumbnail",
-										"url_tiny",
-										"date_modified"										
+									"is_thumbnail",
+									"sort_order",
+									"description",
+									"image_file",
+									"url_zoom",
+									"url_standard",
+									"url_thumbnail",
+									"url_tiny",
+									"date_modified"										
 								])
 							end
 							
 							def native_attribute_aliases
 								super.concat([
 									{
-										existing_entry: {native_key:   "id", 		 	e_plat_key: "id"},
+										existing_entry:  {native_key:   "id", 		    e_plat_key: "id"},
 									},
 									{
-										existing_entry: {native_key:   "product_id", 	e_plat_key: "product_id"},
+										existing_entry:  {native_key:   "product_id",   e_plat_key: "product_id"},
 									},
 									{
-										existing_entry: {native_key:   "url_standard", 	e_plat_key: "src"},
+										alias_attribute: {native_key:   "url_standard", e_plat_key: "src"},
 									},
 									{
 										alias_attribute: {native_key: 	"date_created", e_plat_key: "created_at"},	

data/lib/e_plat/mapping/bigcommerce/v_3/product/variant.rb

@@ -82,7 +82,7 @@ module EPlat
 									existing_entry: {native_key:   "weight",		 e_plat_key: "weight"}
 								},
 								{
-									existing_entry: {native_key:   "inventory_level", e_plat_key: "inventory_quantity"}
+									alias_attribute: {native_key:   "inventory_level", e_plat_key: "inventory_quantity"}
 								}
 							])
 						end

data/lib/e_plat/mapping/bigcommerce/v_3/script_tag.rb

@@ -0,0 +1,78 @@
+module EPlat
+    class Mapping
+        module Bigcommerce
+            module V3
+                class ScriptTag < EPlat::Mapping::Base
+                    DEFAULT_VALUES = {
+                        location: "head",
+                        auto_uninstall: true,
+                        kind: "src",
+                        load_method: "async",
+                        name: "app-script",
+                        enabled: true
+                    }
+
+                    def native_top_key
+                        "data"
+                    end
+
+                    def native_attributes
+                        super.concat([
+                            "name",
+                            "description",
+                            "html",
+                            "src",
+                            "auto_uninstall",
+                            "load_method",  # default | async | defer
+                            "location",     # head | footer
+                            "visibility",   # storefront | all_pages | checkout | order_confirmation
+                            "kind",         # src | script_tag
+                            "api_client_id",
+                            "consent_category",
+                            "enabled",
+                            "channel_id",
+                            "date_created",
+                            "date_modified",
+                            "uuid"
+                        ])
+                    end
+
+                    def native_attribute_aliases
+                        super.concat([
+                            {
+                                existing_entry: {native_key: "src", e_plat_key: "src"}
+                            },
+                            {
+                                alias_attribute: {native_key: "date_created", e_plat_key: "created_at"}
+                            },
+                            {
+                                alias_attribute: {native_key: "date_modified", e_plat_key: "updated_at"}
+                            },
+                            {
+                                alias_attribute: {native_key: "visibility", e_plat_key: "display_scope",
+                                    custom_e_plat_getter: "-> (value) {
+                                        case value
+                                        when 'storefront'; then 'online_store'
+                                        when 'all_pages'; then 'all'
+                                        when 'order_confirmation'; then 'order_status'
+                                        else value
+                                        end
+                                    }",
+                                    custom_native_setter: "-> (value) {
+                                        case value
+                                        when 'online_store'; then 'storefront'
+                                        when 'all'; then 'all_pages'
+                                        when 'order_status'; then 'order_confirmation'
+                                        else value
+                                        end
+                                    }"
+                                }
+                            }
+                        ])
+                    end
+
+                end
+            end
+        end
+    end
+end

data/lib/e_plat/mapping/bigcommerce/v_3/shop.rb

@@ -59,9 +59,12 @@ module EPlat
 					end
 					
 					def native_attribute_aliases
-						super.concat([							
+						super.concat([
 							{
-								existing_entry: {native_key:	"id",  			e_plat_key: "id"}
+								existing_entry: {native_key:	"id",  e_plat_key: "id", 
+									custom_e_plat_getter: "-> (value) { nil }",
+									custom_native_setter: "-> (value) { nil }" # not compatible. one is string, one is integer
+								}
 							},
 							{
 								existing_entry: {native_key:	"name",	 		e_plat_key: "name"}
@@ -70,7 +73,12 @@ module EPlat
 								alias_attribute: {native_key:	"admin_email",  e_plat_key: "email"}
 							},
 							{
-								existing_entry: {native_key:	"domain",		 e_plat_key: "domain"}
+								alias_attribute: {native_key:	"control_panel_base_url", e_plat_key: "myshopify_domain", 
+									custom_e_plat_getter: "-> (value) { value.split('://').last }",
+								}
+							},
+							{
+								existing_entry: {native_key:	"domain",	 	 e_plat_key: "domain"}
 							},
 							{
 								existing_entry: {native_key:	"country",	 	 e_plat_key: "country"}
@@ -84,9 +92,6 @@ module EPlat
 							{
 								existing_entry: {native_key:	"currency_symbol", e_plat_key: "currency"}
 							},
-							{
-								alias_attribute: {native_key:	"currency_symbol", e_plat_key: "currency"}
-							},
 							{
 								existing_entry: {native_key:	"plan_name",	   e_plat_key: "plan_name"}
 							},

data/lib/e_plat/mapping/bigcommerce/v_3/webhook.rb

@@ -0,0 +1,54 @@
+module EPlat
+    class Mapping
+      module Bigcommerce
+        module V3
+          class Webhook < EPlat::Mapping::Base
+            DEFAULT_VALUES = {
+                is_active: true
+            }
+            
+            def native_top_key
+              "data"
+            end
+            
+            def native_attributes
+              super.concat([
+                "id",
+                "client_id",
+                "store_hash",
+                "created_at",
+                "updated_at",
+                "scope",
+                "destination",
+                "is_active",
+                "headers"
+              ])
+            end
+            
+            def native_attribute_aliases
+              super.concat([
+                {
+                  existing_entry: {native_key: "id",               e_plat_key: "id"}
+                },
+                {
+                  existing_entry: {native_key: "created_at",       e_plat_key: "created_at"}
+                },
+                {
+                  existing_entry: {native_key: "updated_at",       e_plat_key: "updated_at"}
+                },
+                {
+                  alias_attribute: {native_key: "destination",     e_plat_key: "address"}
+                },
+                {
+                  alias_attribute: {native_key: "scope",           e_plat_key: "topic"}
+                }
+              ])
+            end
+            
+          end
+        end
+      end
+    end
+  end
+
+

data/lib/e_plat/mapping/request_body_root.rb

@@ -0,0 +1,38 @@
+module EPlat
+	class Mapping
+		module RequestBodyRoot
+			extend ActiveSupport::Concern
+
+			included do
+				class << self
+					attr_accessor :root_in_request_body
+					
+					def include_root_in_request_body(include) #<Boolean>
+						self.root_in_request_body = include
+					end
+				end
+			end
+			
+			def include_root_in_request_body?(resource) #<EPlat::Resource>
+				return default_include_root_in_request_body(resource) if self.class.root_in_request_body.nil?
+
+				self.class.root_in_request_body
+			end
+
+			private
+
+			def default_include_root_in_request_body(resource)
+				resource.client.shopify?
+			end
+
+		end
+	end
+end
+
+
+# class LovelyMapping < EPlat::Mapping::Base
+# 	include_root_in_request_body true
+# 
+# then from the resource 
+# variant.mapping.include_root_in_request_body?(variant)
+# 

data/lib/e_plat/mapping/shopify/v_2024_01/metafield.rb

@@ -0,0 +1,26 @@
+module EPlat
+	class Mapping
+		module Shopify
+			module V202401 #< :module
+				class Metafield < EPlat::Mapping::Base
+					
+					def native_top_key
+						"metafield"
+					end
+					
+					def native_attributes
+						super.concat([
+						])
+					end
+					
+					def native_attribute_aliases
+						super.concat([
+						])
+					end
+						
+				end
+			end
+		end
+	end
+end
+	

data/lib/e_plat/mapping/shopify/v_2024_01/order/billing_address.rb

@@ -0,0 +1,14 @@
+
+
+module EPlat
+	class Mapping
+		module Shopify
+			module V202401
+				class Order
+					class BillingAddress < ShippingAddress; end
+				end
+			end
+		end
+	end
+end
+

data/lib/e_plat/mapping/shopify/v_2024_01/order/shipping_address.rb

@@ -0,0 +1,30 @@
+
+
+module EPlat
+	class Mapping
+		module Shopify
+			module V202401
+				class Order
+					class ShippingAddress < EPlat::Mapping::Base
+												
+						def native_top_key
+							:itself
+						end
+						
+						def native_attributes
+							super.concat([
+							])
+						end
+						
+						def native_attribute_aliases
+							super.concat([
+							])
+						end
+						
+					end
+				end
+			end
+		end
+	end
+end
+

data/lib/e_plat/mapping/shopify/{v_2022_07/product.rb → v_2024_01/order.rb}

@@ -1,11 +1,11 @@
 module EPlat
 		class Mapping
 			module Shopify
-				module V202207 #< :module
-					class Product < EPlat::Mapping::Base
+				module V202401 #< :module
+					class Order < EPlat::Mapping::Base
 						
 						def native_top_key
-							"product"
+							"order"
 						end
 						
 						def native_attributes

data/lib/e_plat/mapping/shopify/{v_2022_07 → v_2024_01}/product/image.rb

@@ -3,7 +3,7 @@
 module EPlat
 	class Mapping
 		module Shopify
-			module V202207
+			module V202401
 				class Product
 					class Image < EPlat::Mapping::Base
 												

data/lib/e_plat/mapping/shopify/{v_2022_07 → v_2024_01}/product/variant.rb

@@ -3,9 +3,10 @@
 module EPlat
 	class Mapping
 		module Shopify
-			module V202207
+			module V202401
 				class Product
 					class Variant < EPlat::Mapping::Base
+						include_root_in_request_body true
 												
 						def native_top_key
 							:itself

data/lib/e_plat/mapping/shopify/v_2024_01/product.rb

@@ -0,0 +1,26 @@
+module EPlat
+	class Mapping
+		module Shopify
+			module V202401 #< :module
+				class Product < EPlat::Mapping::Base
+					
+					def native_top_key
+						"product"
+					end
+					
+					def native_attributes
+						super.concat([
+						])
+					end
+					
+					def native_attribute_aliases
+						super.concat([
+						])
+					end
+						
+				end
+			end
+		end
+	end
+end
+	

data/lib/e_plat/mapping/shopify/v_2024_01/script_tag.rb

@@ -0,0 +1,26 @@
+module EPlat
+		class Mapping
+			module Shopify
+				module V202401 #< :module
+					class ScriptTag < EPlat::Mapping::Base
+						
+						def native_top_key
+							"script_tag"
+						end
+						
+						def native_attributes
+							super.concat([
+							])
+						end
+						
+						def native_attribute_aliases
+							super.concat([
+							])
+						end
+							
+					end
+				end
+			end
+		end
+end
+	

data/lib/e_plat/mapping/shopify/{v_2022_07 → v_2024_01}/shop.rb

@@ -1,7 +1,7 @@
 module EPlat
 		class Mapping
 			module Shopify
-				module V202207 #< :module
+				module V202401 #< :module
 					class Shop < EPlat::Mapping::Base
 						
 						def native_top_key