e_plat 0.6.0 → 0.7.0

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

@@ -0,0 +1,180 @@
+
+
+module EPlat
+	class Mapping
+		module Shopify
+			module V202407
+				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: "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_2024_07/product.rb

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

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

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

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

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

@@ -0,0 +1,272 @@
+
+module EPlat
+    class Mapping
+        module VirtualCollection
+            module Shopify
+                module Product
+                    module Variant
+                        class OptionValue < VirtualCollection::Base
+                            attr_accessor :resource
+
+                            def initialize(resource:, map_from:)
+                                @resource = resource
+                                super
+
+                                return unless @resource.try :selected_options
+
+                                @resource.option_values = 
+                                    @resource.selected_options.map.with_index do |data, i|
+                                        item = EPlat::Product::Variant::OptionValue.new(variant_id: @resource.id)
+                                        item.mapping.virtual_collection = self
+                                        item.add_aliases!(native_attribute_aliases(i), EPlat::Product::Variant::OptionValue.schema)
+
+                                        item
+                                    end
+                            end
+
+                            def native_attribute_aliases(i)
+                                [                                
+                                    {
+                                        alias_attribute: {
+                                            native_key: "[selected_options][#{i}][option_value][id]",
+                                            e_plat_key: "id",
+                                            virtual_collection: true,
+                                            custom_e_plat_getter: '-> { _1&.split("/")&.last }',
+                                            custom_native_setter: '-> { "gid://shopify/ProductOptionValue/#{_1}" }'
+                                        }
+                                    },
+                                    {
+                                        alias_attribute: {
+                                            native_key: "[selected_options][#{i}][name]",
+                                            e_plat_key: "name",
+                                            virtual_collection: true
+                                        }
+                                    },
+                                    {
+                                        alias_attribute: {
+                                            native_key: "[selected_options][#{i}][value]",
+                                            e_plat_key: "value",
+                                            virtual_collection: true
+                                        }
+                                    }
+                                ]
+                            end
+
+                        end
+
+                    end
+                end
+            end
+        end
+    end
+end
+
+
+
+# consignments are deliveries, we're just going to operate within the context on one delivery per order
+# this should be reasonable to tie us over for now
+
+# integer 	:id
+# string 	:admin_graphql_api_id
+# integer 	:fulfillable_quantity
+# string 	:fulfillment_service
+# string 	:fulfillment_status
+# boolean 	:gift_card
+# integer 	:grams
+# string 	:name
+# string 	:price
+# hash 		:price_set
+# boolean 	:product_exists
+# integer 	:product_id
+# array 	:properties
+# integer 	:quantity
+# boolean 	:requires_shipping
+# string 	:sku
+# boolean 	:taxable
+# string 	:title
+# string 	:total_discount
+# hash 		:total_discount_set
+# integer 	:variant_id
+# string 	:variant_inventory_management
+# string 	:variant_title
+# string 	:vendor
+# array 	:tax_lines
+# array 	:duties
+# array 	:discount_allocations
+
+
+# BG = {
+# 	"consignments": [
+# 		{
+# 			"pickups": [],
+# 			"shipping": [
+# 				{
+# 					"id": 3,
+# 					"first_name": "Jane",
+# 					"last_name": "Doe",
+# 					"company": "",
+# 					"street_1": "123 Main Street",
+# 					"street_2": "",
+# 					"city": "Austin",
+# 					"zip": "78751",
+# 					"country": "United States",
+# 					"country_iso2": "US",
+# 					"state": "Texas",
+# 					"email": "oli@example.com",
+# 					"phone": "",
+# 					"form_fields": [],
+# 					"line_items": [
+# 						{
+# 							"id": 3,
+# 							"order_id": 102,
+# 							"product_id": 88,
+# 							"variant_id": 81,
+# 							"order_pickup_method_id": 0,
+# 							"order_address_id": 3,
+# 							"name": "Chemex Coffeemaker",
+# 							"name_customer": "Chemex Coffeemaker",
+# 							"name_merchant": "Chemex Coffeemaker",
+# 							"sku": "CC3C-SM",
+# 							"upc": "",
+# 							"type": "physical",
+# 							"base_price": "83.3300",
+# 							"price_ex_tax": "83.3300",
+# 							"price_inc_tax": "83.3300",
+# 							"price_tax": "0.0000",
+# 							"base_total": "83.3300",
+# 							"total_ex_tax": "83.3300",
+# 							"total_inc_tax": "83.3300",
+# 							"total_tax": "0.0000",
+# 							"weight": "1.0000",
+# 							"width": "0.0000",
+# 							"height": "0.0000",
+# 							"depth": "0.0000",
+# 							"quantity": 1,
+# 							"base_cost_price": "0.0000",
+# 							"cost_price_inc_tax": "0.0000",
+# 							"cost_price_ex_tax": "0.0000",
+# 							"cost_price_tax": "0.0000",
+# 							"is_refunded": false,
+# 							"quantity_refunded": 0,
+# 							"refund_amount": "0.0000",
+# 							"return_id": 0,
+# 							"wrapping_id": 0,
+# 							"wrapping_name": "",
+# 							"base_wrapping_cost": "0.0000",
+# 							"wrapping_cost_ex_tax": "0.0000",
+# 							"wrapping_cost_inc_tax": "0.0000",
+# 							"wrapping_cost_tax": "0.0000",
+# 							"wrapping_message": "",
+# 							"quantity_shipped": 0,
+# 							"event_name": null,
+# 							"event_date": null,
+# 							"fixed_shipping_cost": "0.0000",
+# 							"ebay_item_id": "",
+# 							"ebay_transaction_id": "",
+# 							"option_set_id": 18,
+# 							"parent_order_product_id": null,
+# 							"is_bundled_product": false,
+# 							"bin_picking_number": "0",
+# 							"external_id": "",
+# 							"fulfillment_source": "",
+# 							"brand": "",
+# 							"gift_certificate_id": null,
+# 							"applied_discounts": [],
+# 							"product_options": [
+# 								{
+# 									"id": 2,
+# 									"option_id": 34,
+# 									"order_product_id": 3,
+# 									"product_option_id": 114,
+# 									"display_name": "Size",
+# 									"display_name_customer": "Size",
+# 									"display_name_merchant": "Size",
+# 									"display_value": "Small",
+# 									"display_value_customer": "Small",
+# 									"display_value_merchant": "Small",
+# 									"value": "101",
+# 									"type": "Multiple choice",
+# 									"name": "Size1699441692-88",
+# 									"display_style": "Dropdown"
+# 								}
+# 							],
+# 							"configurable_fields": [],
+# 							"discounted_total_inc_tax": "83.3300"
+# 						}
+# 					]
+# 				}
+# 			],
+# 			"items_total": 1,
+# 			"items_shipped": 0,
+# 			"shipping_method": "None",
+# 			"base_cost": 0,
+# 			"cost_ex_tax": 0,
+# 			"cost_inc_tax": 0,
+# 			"cost_tax": 0,
+# 			"cost_tax_class_id": 0,
+# 			"base_handling_cost": 0,
+# 			"handling_cost_ex_tax": 0,
+# 			"handling_cost_inc_tax": 0,
+# 			"handling_cost_tax": 0,
+# 			"handling_cost_tax_class_id": 0,
+# 			"shipping_zone_id": 0,
+# 			"shipping_zone_name": "",
+# 			"shipping_quotes": {
+# 				"url": "https://api.bigcommerce.com/stores/d0kmq3bory/v2/orders/102/consignments/shipping/3/shipping_quotes",
+# 				"resource": "/orders/102/consignments/shipping/3/shipping_quotes"
+# 			}
+# 		}
+# 	]
+# }
+
+# Shopify = {
+# 	"line_items": [
+# 		{
+# 			"id": 13120677806211,
+# 			"admin_graphql_api_id": "gid://shopify/LineItem/13120677806211",
+# 			"fulfillable_quantity": 1,
+# 			"fulfillment_service": "manual",
+# 			"fulfillment_status": null,
+# 			"gift_card": false,
+# 			"grams": 0,
+# 			"name": "Winter Luggage - Sienna the longest name variant in the world",
+# 			"price": "150.00",
+# 			"price_set": {
+# 				"shop_money": {
+# 					"amount": "150.00",
+# 					"currency_code": "GBP"
+# 				},
+# 				"presentment_money": {
+# 					"amount": "150.00",
+# 					"currency_code": "GBP"
+# 				}
+# 			},
+# 			"product_exists": true,
+# 			"product_id": 6610509627523,
+# 			"properties": [],
+# 			"quantity": 1,
+# 			"requires_shipping": true,
+# 			"sku": "skusku123",
+# 			"taxable": true,
+# 			"title": "Winter Luggage",
+# 			"total_discount": "0.00",
+# 			"total_discount_set": {
+# 				"shop_money": {
+# 					"amount": "0.00",
+# 					"currency_code": "GBP"
+# 				},
+# 				"presentment_money": {
+# 					"amount": "0.00",
+# 					"currency_code": "GBP"
+# 				}
+# 			},
+# 			"variant_id": 39428269408387,
+# 			"variant_inventory_management": "shopify",
+# 			"variant_title": "Sienna the longest name variant in the world",
+# 			"vendor": "PreProduct Test",
+# 			"tax_lines": [],
+# 			"duties": [],
+# 			"discount_allocations": []
+# 		}
+# 	]
+# }

data/lib/e_plat/resource/base.rb

@@ -4,6 +4,7 @@ module EPlat
 	class Base < ActiveResource::Base
 		include Concerns::OverwriteRequestMethods, Concerns::OverwriteInstanceMethods
 		include Concerns::Aliases, Concerns::Dirty, Concerns::FullJson
+		include Concerns::GraphQLable
 		
 		self.connection_class  = EPlat::Connection
 		self.collection_parser = EPlat::Collection
@@ -92,6 +93,7 @@ module EPlat
 
 			@mapped_attributes = ensure_e_plat_attributes!
 			ensure_native_attributes!
+			
 			add_aliases!(mapping.native_attribute_aliases, type_schema || {})
 		end
 
@@ -105,7 +107,7 @@ module EPlat
 		
 		def native_keys
 			if client.shopify? 
-				schema.keys # EPlat uses Shopify's schema, so keys are always native
+				@mapping.native_attributes.presence || schema.keys # EPlat uses Shopify's schema, apar from a couple of Graphql only fields
 			elsif mapping.class.to_s != EPlat::Mapping::Base && @mapping.native_attributes.present?
 				@mapping.native_attributes.presence
 			else
@@ -126,6 +128,26 @@ module EPlat
 			
 			top_level_resource?
 		end
+
+		def formatted_id(id)
+			return id unless client.shopify? && client.api_version != "2024_01"
+			return if id.to_s.include?("gid://")
+
+			case element_name
+			when "product"
+				"gid://shopify/Product/#{id}"
+			when "variant"
+				"gid://shopify/ProductVariant/#{id}"
+			when "image"
+				"gid://shopify/ProductImage/#{id}"
+			else
+				raise EPlat::Errors.new("Unsupported element name")
+			end
+		end
+
+		def graphql_input
+			raise EPlat::Error.new("GraphQL input not supported for this resource and platform")
+		end
 		
 		private 
 
@@ -134,7 +156,7 @@ module EPlat
 			end
 
 			def ensure_native_attributes!
-				return if client.shopify? # EPlat uses Shopify's schema
+				return if client.shopify? && EPlat.config.shopify_api_version == "2024_01"
 
 				AttributeInterface.new(self, keys: native_keys)
 			end