e_plat 1.0.0.pre.rc.3 → 1.0.0.pre.rc.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4536b6c98d19d158d7cd4a7da8bc723b7fefab2213a76dd8bd88217d8ad8f30
-  data.tar.gz: 13391e3f683ac05378723564b58d72dcc5016b61b38cef9ab44d42b44319ab7d
+  metadata.gz: 953c86fe923b6191dfe8d01e89d316601c31d5b55d50e356bb7b898bd0238a8f
+  data.tar.gz: f59b674ab4e8efad4e945d1fd2309b388c441f61202e07405afe26960cba05a4
 SHA512:
-  metadata.gz: d7e5382b733e1ad0561d10c560b9bc49f6ff2de2bf9156d92869d5769288943de63d34a0ce6ee1023c3f4abc9a040bbe11d07cf355431dd444f0208f4fe4edb3
-  data.tar.gz: 7444dd3afecfa2d1012ff29024855715afbb062bf9713d865f98891009b31a90bd8ef4a9156378c9ec2c6f55f1bececb1af2d07d7df0575aa28f602a535763aa
+  metadata.gz: e0965ed485b7a393c6a06981eaf1b943be3847721c0491678435db5aa859d97ef96f736d4d6424104c8b5dd1261acb37aa4815ec87a6c9a5f3b77170423913a8
+  data.tar.gz: 17094ac85530115a4a32ecee582d2a89fca6cb5ce65cae0ad94bb3bbbedab77a41defe45ede364d319f4b68890c78d3bbe5279058989c4481136f926a8d98445

data/README.md

@@ -50,7 +50,7 @@ EPlat.config.bigcommerce_api_version = "v3"
 ```
 <br>
 
-## Testing
+## Testing and development
 
 To run the test for the default versions of all supported platforms:
 ```
@@ -67,6 +67,28 @@ To print out Shopify GraphQL queries/mutations
 EPLAT_PRINT_GRAPHQL_REQUESTS=true rails test
 ```
 
+We have a guide on upgrading the gem to a new Shopify API version here: [UPGRADE_GUIDE.md](UPGRADE_GUIDE.md)
+
+### In the console ###
+You can run `rails c` then `Dotenv.load` to load the environment variables.
+You can then add to your .env file and run the following to setup your session:
+```
+  EPlat::Session.new(
+    platform: :shopify, 
+    store_url: ENV["SHOPIFY_TEST_STORE_URL"], 
+    api_token: ENV["SHOPIFY_TEST_API_KEY"]
+  )
+	
+	# or...
+
+  EPlat::Session.new(
+    platform: :bigcommerce, 
+    store_url: ENV["BIGCOMMERCE_TEST_STORE_URL"], 
+    api_token:  ENV["BIGCOMMERCE_TEST_API_KEY"],
+    store_hash: ENV["BIGCOMMERCE_TEST_STORE_HASH"]
+  )
+```
+
 <br>
 
 ## Releasing a new version

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

@@ -0,0 +1,26 @@
+module EPlat
+	class Mapping
+		module Shopify
+			module V202501 #< :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_2025_01/order/billing_address.rb

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

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

@@ -0,0 +1,30 @@
+
+
+module EPlat
+	class Mapping
+		module Shopify
+			module V202501
+				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_2025_01/order.rb

@@ -0,0 +1,26 @@
+module EPlat
+		class Mapping
+			module Shopify
+				module V202501 #< :module
+					class Order < EPlat::Mapping::Base
+						
+						def native_top_key
+							"order"
+						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_2025_01/product/image.rb

@@ -0,0 +1,52 @@
+
+
+module EPlat
+	class Mapping
+		module Shopify
+			module V202501
+				class Product
+					class Image < EPlat::Mapping::Base
+												
+						def native_top_key
+							:itself
+						end
+						
+						def native_attributes
+							super.concat([
+								"id",
+								"alt_text", #would be altText before and after EPlat processes it
+								"width",
+								"height",
+								"url"
+							])
+						end
+						
+						def native_attribute_aliases
+							super.concat([
+								{
+									existing_entry: {native_key: "id", e_plat_key: "id",
+										custom_e_plat_getter: '-> { _1.try(:split, "/")&.last || _1 }',
+										custom_native_setter: '-> { "gid://shopify/ProductImage/#{_1}" }'
+									}
+								},
+								{
+									alias_attribute: {native_key: "alt_text", e_plat_key: "alt"}
+								},
+								{
+									existing_entry: {native_key: "width", e_plat_key: "width"}
+								},
+								{
+									existing_entry: {native_key: "height", e_plat_key: "height"}
+								},
+								{
+									alias_attribute: {native_key: "url", e_plat_key: "src"}
+								}
+							])
+						end
+						
+					end						
+				end
+			end
+		end
+	end
+end

data/lib/e_plat/mapping/shopify/v_2025_01/product/option.rb

@@ -0,0 +1,45 @@
+
+
+module EPlat
+	class Mapping
+		module Shopify
+			module V202501
+				class Product
+					class Option < EPlat::Mapping::Base
+						include_root_in_request_body true
+												
+						def native_top_key
+							:itself
+						end
+						
+						def native_attributes
+							super
+						end
+
+						def native_attribute_aliases
+							super.concat([
+								
+								{
+									existing_entry: {native_key: "id", e_plat_key: "id",
+										custom_e_plat_getter: '-> { _1&.split("/")&.last }',
+										custom_native_setter: '-> { "gid://shopify/ProductOption/#{_1}" }'
+									}
+								},
+								{
+									existing_entry: {native_key: "name", e_plat_key: "name"}
+								},
+								{
+									existing_entry: {native_key: "position", e_plat_key: "position"}
+								},
+								{
+									existing_entry: {native_key: "values", e_plat_key: "values"}
+								}
+							])
+						end
+						
+					end
+				end
+			end
+		end
+	end
+end

data/lib/e_plat/mapping/shopify/v_2025_01/product/variant/option_value.rb

@@ -0,0 +1,58 @@
+
+
+module EPlat
+	class Mapping
+		module Shopify
+			module V202501
+				class Product::Variant
+					class OptionValue < EPlat::Mapping::Base
+						include_root_in_request_body true
+												
+						def native_top_key
+							:itself
+						end
+						
+						def native_attributes
+							super.concat([
+							])
+						end
+
+
+						def native_attribute_aliases
+							super.concat([
+								# see virtual_collection @ EPlat::Mapping::VirtualCollection::Shopify::Product::Variant::OptionValue
+							])
+						end
+						
+					end
+				end
+			end
+		end
+	end
+end
+
+
+# bigcommerce
+#  option_values => [{
+# 	"id": 174,
+# 	"label": "Beige",
+# 	"option_id": 220,
+# 	"option_display_name": "Color"
+#   }]
+
+# shopify
+#  selected_options => [{
+	# "name"=>"Size",
+	# "value"=>"green",
+	# "option_value" => {
+	# 	"id"=>"gid://shopify/ProductOptionValue/657155129475", 
+	# 	"name"=>"green"
+	# }
+#  }]
+
+# target e_plat schema
+# option_values => [{
+# 	"id": 174,
+# 	"name": "Color",
+# 	"value": "Beige",
+# }]

data/lib/e_plat/mapping/shopify/v_2025_01/product/variant.rb

@@ -0,0 +1,186 @@
+
+
+module EPlat
+	class Mapping
+		module Shopify
+			module V202501
+				class Product
+					class Variant < EPlat::Mapping::Base
+						include_root_in_request_body true
+						virtual_collection :option_values, class: EPlat::Mapping::VirtualCollection::Shopify::Product::Variant::OptionValue, map_from: "selected_options"
+												
+						def native_top_key
+							:itself
+						end
+						
+						def native_attributes
+							super
+						end
+
+						def native_attribute_aliases
+							super.concat([
+								{
+									existing_entry: {native_key: "id", e_plat_key: "id",
+										custom_e_plat_getter: '-> { (_1.is_a? Integer) ? _1 : _1&.split("/")&.last }',
+										custom_native_setter: '-> { (_1.is_a? String)  ? _1 : "gid://shopify/ProductVariant/#{_1}" }'
+									}
+								},
+								{
+									existing_entry: {native_key: "product_id", e_plat_key: "product_id",
+										custom_e_plat_getter: '-> { (_1.is_a? Integer) ? _1 : _1&.split("/")&.last }',
+										custom_native_setter: '-> { (_1.is_a? String)  ? _1 : "gid://shopify/Product/#{_1}" }'
+									}
+								},
+								{
+									existing_entry: {native_key: "title", e_plat_key: "title"}
+								},
+								{
+									existing_entry: {native_key: "price", e_plat_key: "price"}
+								},
+								{
+									existing_entry: {native_key: "sku", e_plat_key: "sku",
+										custom_e_plat_getter: '-> { _1 }',
+										custom_native_setter: '-> do 
+											inventory_item.sku = _1; 
+											inventory_item.attribute_will_change!("sku");
+											_1 
+										end'
+									}
+								},
+								{
+									existing_entry: {native_key: "position", e_plat_key: "position"}
+								},
+								{
+									existing_entry: {native_key: "inventory_policy", e_plat_key: "inventory_policy", 
+										custom_e_plat_getter: '-> { _1&.downcase }',
+										custom_native_setter: '-> { _1&.upcase }'
+									}
+								},
+								{
+									existing_entry: {native_key: "compare_at_price", e_plat_key: "compare_at_price"}
+								},
+								{
+									alias_attribute: {native_key: "inventory_item[tracked]", e_plat_key: "inventory_management"}
+								},
+								{
+									
+									existing_entry: {native_key: "created_at", e_plat_key: "created_at"}
+								},
+								{
+									existing_entry: {native_key: "updated_at", e_plat_key: "updated_at"}
+								},
+								{
+									existing_entry: {native_key: "taxable", e_plat_key: "taxable"}
+								},
+								{
+									existing_entry: {native_key: "barcode", e_plat_key: "barcode"}
+								},
+								{
+									alias_attribute: {native_key: "inventory_item[measurement][weight][unit]", e_plat_key: "weight_unit",
+										custom_native_setter: '-> { warn("Setting weight_unit directly is not supported on ProductVariant via GraphQL."); _1 }'
+									}
+								},
+								{
+									alias_attribute: {native_key: "inventory_item[measurement][weight][value]", e_plat_key: "weight",
+										custom_native_setter: '-> { warn("Setting weight directly is not supported on ProductVariant via GraphQL."); _1 }'
+									}
+								},
+								{
+									alias_attribute: {native_key: "inventory_item[id]", e_plat_key: "inventory_item_id",
+										custom_e_plat_getter: '-> { _1&.split("/")&.last }',
+										custom_native_setter: '-> { "gid://shopify/InventoryItem/#{_1}" }'
+									}
+								},
+								{
+									existing_entry: {native_key: "inventory_quantity", e_plat_key: "inventory_quantity",
+										custom_native_setter: '-> { warn("Setting inventory_quantity directly is not supported on ProductVariant via GraphQL."); _1 }'
+									}
+								},
+								{
+									existing_entry: {native_key: "tax_code", e_plat_key: "tax_code"}
+								},
+								{
+									alias_attribute: {native_key: "inventory_item[requires_shipping]", e_plat_key: "requires_shipping",
+										custom_native_setter: '-> { warn("Setting requires_shipping directly is not supported on ProductVariant via GraphQL."); _1 }'
+									}
+								},
+								{
+									existing_entry: {native_key: "fulfillment_service", e_plat_key: "fulfillment_service"}
+								},
+								{
+									existing_entry: {native_key: "grams", e_plat_key: "grams", # doesnt exist on any current API but we create it
+										custom_e_plat_getter: '-> { 
+											_1
+											case weight_unit
+											when "GRAMS", "grams", "g"
+												weight
+											when "KILOGRAMS", "kilograms", "kg"
+												weight * 1000
+											when "OUNCES", "ounces", "oz"
+												weight * 28.3495
+											when "POUNDS", "pounds", "lb"
+												weight * 453.592
+											else
+												weight
+											end
+										}',
+										custom_native_setter: '-> {
+											warn("Setting grams directly is not supported on ProductVariant via GraphQL. Mutate the inventoryItem.measurement.weight object `value` field instead")
+											case weight_unit
+											when "GRAMS", "grams", "g"
+												_1
+											when "KILOGRAMS", "kilograms", "kg"
+												_1 / 1000
+											when "OUNCES", "ounces", "oz"
+												_1 / 28.3495
+											when "POUNDS", "pounds", "lb"
+												_1 / 453.592
+											else
+												_1
+											end
+										}'
+									}
+								}
+
+							])
+						end
+						
+					end
+				end
+			end
+		end
+	end
+end
+
+# RESOURCE
+# integer :id
+# integer :product_id
+# string :title
+# string :price
+# string :sku
+# integer :position
+# string :inventory_policy
+# string :compare_at_price
+# string :fulfillment_service
+# string :inventory_management
+# datetime :created_at
+# datetime :updated_at
+# boolean :taxable
+# string :barcode
+# integer :grams
+# integer :image_id
+# float :weight
+# string :weight_unit
+# integer :inventory_item_id
+# integer :inventory_quantity
+# string :tax_code
+# boolean :requires_shipping
+# string :admin_graphql_api_id
+
+
+# fields without setter support
+# | grams                 | integer  | getter only: converted node.inventoryItem[measurement][weight][value] | nil                                  | nil |
+# | weight                | float    | getter only: node.inventoryItem[measurement][weight][value]      | weight |
+# | weight_unit           | string   | getter only: node.inventoryItem[measurement][weight][unit]       | nil  |
+# | inventory_item_id     | integer  | getter only: node.inventoryItem[id]| nil                            | nil |
+# | inventory_quantity    | integer  | getter only: node.inventoryQuantity     | inventory_level 

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

@@ -0,0 +1,100 @@
+module EPlat
+	class Mapping
+		module Shopify
+			module V202501 #< :module
+				class Product < EPlat::Mapping::Base
+					
+					def native_top_key
+						"product"
+					end
+					
+					def native_attributes
+						super.concat([
+							"id",
+							"descriptionHtml",
+							"createdAt",
+							"updatedAt",
+							"handle",
+							"productType",
+							"publishedAt",
+							"publishedScope",
+							"status",
+							"tags",
+							"templateSuffix",
+							"title",
+							"vendor"
+						])
+					end
+
+					def native_attribute_aliases
+						super.concat([
+							{
+								alias_attribute: {native_key: "description_html", e_plat_key: "body_html"}
+							},
+							{
+								existing_entry: {native_key: "created_at", e_plat_key: "created_at"}
+							},
+							{
+								existing_entry: {native_key: "updated_at", e_plat_key: "updated_at"}
+							},
+							{
+								existing_entry: {native_key: "handle", e_plat_key: "handle"}
+							},
+							{
+								existing_entry: {native_key: "product_type", e_plat_key: "product_type"}
+							},
+							{
+								existing_entry: {native_key: "published_at", e_plat_key: "published_at"}
+							},
+							{
+								existing_entry: {native_key: "status", e_plat_key: "status",
+									custom_e_plat_getter: '-> { _1&.downcase }',
+									custom_native_setter: '-> { _1&.upcase }'
+								}
+							},
+							{
+								existing_entry: {native_key: "tags", e_plat_key: "tags",
+									custom_e_plat_getter: "-> { _1&.join(',') }",
+									custom_native_setter: "-> { _1&.split(',') }"
+								}
+							},
+							{
+								existing_entry: {native_key: "id", e_plat_key: "id",
+									custom_e_plat_getter: '-> { (_1.is_a? Integer) ? _1 : _1&.split("/")&.last }',
+									custom_native_setter: '-> { (_1.is_a? String)  ? _1 : "gid://shopify/Product/#{_1}" }'
+								}
+							},
+							{
+								existing_entry: {native_key: "template_suffix", e_plat_key: "template_suffix"}
+							}, 
+							{
+								existing_entry: {native_key: "title", e_plat_key: "title"}
+							},
+							{
+								existing_entry: {native_key: "vendor", e_plat_key: "vendor"}
+							}
+						])
+					end
+				end
+			end
+		end
+	end
+end
+
+
+# string 		:body_html
+# datetime 	:created_at
+# string 		:handle
+# integer	 	:id
+# array 		:images
+# array 		:options
+# string 		:product_type
+# datetime 	:published_at
+# string 		:status
+# string 		:tags
+# string 		:admin_graphql_api_id
+# string		:template_suffix
+# string		:title
+# datetime	:updated_at
+# array 		:variants
+# string		:vendor

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

@@ -0,0 +1,26 @@
+module EPlat
+		class Mapping
+			module Shopify
+				module V202501 #< :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_2025_01/shop.rb

@@ -0,0 +1,26 @@
+module EPlat
+		class Mapping
+			module Shopify
+				module V202501 #< :module
+					class Shop < EPlat::Mapping::Base
+						
+						def native_top_key
+							"shop"
+						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_2025_01/webhook.rb

@@ -0,0 +1,29 @@
+module EPlat
+	class Mapping
+		module Shopify
+			module V202501 #< :module
+				class Webhook < EPlat::Mapping::Base
+					DEFAULT_VALUES = {
+						format: "json"
+					}
+					
+					def native_top_key
+						"webhook"
+					end
+					
+					def native_attributes
+						super.concat([
+						])
+					end
+					
+					def native_attribute_aliases
+						super.concat([
+						])
+					end
+						
+				end
+			end
+		end
+	end
+end
+