e_plat 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '00444097bf58036794578e3a6764eb36c94e3a67e8bad39518ffa0730b9785cd'
-  data.tar.gz: 31c18e7ac398c4467fa628fca7d2f804f818ebdb459bf6a4be26b5f75ab553aa
+  metadata.gz: 9b76ee9e7103fc4e5cb491cb07cd8fd8cf24cc56d28e16cc99d222da3b65db77
+  data.tar.gz: 623f8ef5b141c3b5b24138c7abca5610aec3d7acb840a749e6481320eeff890d
 SHA512:
-  metadata.gz: 6558b4247f422366911903821e350a2e9c7b1612358f61a34e39603e60a6343bbfae5d97d65fcb2212c561a2c665fbf64f8764bcc55c88650c10fd19f6ab76fb
-  data.tar.gz: 1a81d8e69249c0d2fcf2edbad8bff4b1b0c49236ae11b114f9c5e14632a4b26757f9f8174bcb016ba4ebe46be4fafd254680a1977100b0cf0386fa43dee86211
+  metadata.gz: 878c953fc1ac93d857cbae808664affb031f68d1a9c5198059773373c5c74f9ab7139937ccab4199ae362af3b4bf80e0969a34de972eb3f80e25d7a95aeef92d
+  data.tar.gz: 59679a5b7d68e46a15811e9591e052697c14589b0dbee5597bca550e595fd48878a0e9415f7a55a876a56f676a26a1a93d39699e8cee1126efa0d5f5c5b342b8

data/README.md

@@ -48,12 +48,12 @@ To your gemfile and then run
 You can configure which platform APIs are used by updating the EPlat config: <br/>
 ```ruby
 #initializers/e_plat.rb
-EPlat.config.shopify_api_version = "2025-10"
+EPlat.config.shopify_api_version = "2026-04"
 EPlat.config.bigcommerce_api_version = "v3"
 EPlat.config.woocommerce_api_version = "v3"
 
-# EPlat.api_display_name.shopify #=> "2024-07" # presents as the platform would display in URL paths
-# EPlat.config.shopify_api_version #=> "2024_07" # coerced interally for creating constants
+# EPlat.api_display_name.shopify #=> "2026-04" # presents as the platform would display in URL paths
+# EPlat.config.shopify_api_version #=> "2026_04" # coerced interally for creating constants
 # EPlat.config.print_graphql_requests #=> false # prints out Shopify graphql queries/mutations to the console
 ```
 <br>
@@ -67,7 +67,7 @@ To run the test for the default versions of all supported platforms:
 
 To run with specific api versions, you can set globals inline
 ```
-  EPLAT_SHOPIFY_API_VERSION=2024_07 EPLAT_BIGCOMMERCE_API_VERSION=v3 rails test
+  EPLAT_SHOPIFY_API_VERSION=2026_04 EPLAT_BIGCOMMERCE_API_VERSION=v3 rails test
 ```
 
 To print out Shopify GraphQL queries/mutations
@@ -75,7 +75,7 @@ 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)
+To upgrade the gem to a new Shopify API version, use the Claude Code skill: `/upgrade_shopify_version 2026-07`
 
 <br>
 
@@ -149,7 +149,7 @@ EPlat is designed to let you mostly use it's universal interface, but then easil
   tag.save 
 
   # ...when session is a Shopify store
-  # POST https://preproduct-test.myshopify.com/admin/api/2024-07/script_tags.json 
+  # POST https://preproduct-test.myshopify.com/admin/api/2026-04/script_tags.json 
   # body: '{"script_tag":{"display_scope":"online_store","event":"onload","src":"https://preproduct.io/mini-script.js"}}'
   # 
   # ...when session is a BigCommerce store
@@ -943,8 +943,8 @@ EPlat::Product.find(99, from: "/product/1/specific_url.json") #GET /product/1/sp
 EPlat::Product.count # 2
 
 # Nested resources - pass in the parent resource's ID to the params hash
-EPlat::Product::Variant.find(variant_id, params: {product: product.id}) # /admin/api/2024-07/products/{{ product.id }}/variants/{{ variant_id }}.json 
-EPlat::Product::Variant.collection_path(product: 5) # /admin/api/2024-07/products/5/variants.json
+EPlat::Product::Variant.find(variant_id, params: {product: product.id}) # /admin/api/2026-04/products/{{ product.id }}/variants/{{ variant_id }}.json 
+EPlat::Product::Variant.collection_path(product: 5) # /admin/api/2026-04/products/5/variants.json
 
 
 

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

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

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

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

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

@@ -0,0 +1,26 @@
+module EPlat
+		class Mapping
+			module Shopify
+				module V202604 #< :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_2026_04/product/image.rb

@@ -0,0 +1,52 @@
+
+
+module EPlat
+	class Mapping
+		module Shopify
+			module V202604
+				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_2026_04/product/option.rb

@@ -0,0 +1,45 @@
+
+
+module EPlat
+	class Mapping
+		module Shopify
+			module V202604
+				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_2026_04/product/variant/option_value.rb

@@ -0,0 +1,58 @@
+
+
+module EPlat
+	class Mapping
+		module Shopify
+			module V202604
+				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_2026_04/product/variant.rb

@@ -0,0 +1,182 @@
+
+
+module EPlat
+	class Mapping
+		module Shopify
+			module V202604
+				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 }'
+									}
+								},
+								{
+									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
+# 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_2026_04/product.rb

@@ -0,0 +1,100 @@
+module EPlat
+	class Mapping
+		module Shopify
+			module V202604 #< :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_2026_04/script_tag.rb

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

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

@@ -0,0 +1,29 @@
+module EPlat
+	class Mapping
+		module Shopify
+			module V202604 #< :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
+