e_plat 0.7.3 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5577cb6f825d656e170ae63d33c027e9b50080040347496bdf96d3c4f09920c3
-  data.tar.gz: 75cde1f016be6b06f07ba9201655496c7262e47d1611e320193c9d994549561a
+  metadata.gz: dd6ef96f210a4ce19e39876714cf947410ad47c6a93794c5f06aee1d8ec1f0f4
+  data.tar.gz: 6b83f5036d786165bfc0a36e3a651bea55679f1cf3c2c0672adc9b3b90ca26a1
 SHA512:
-  metadata.gz: 12484df951bb9fe2311ceb78e1b6ee3f990a82dcddc06702153da350b14e7b1e3c87180591536e80965eeff731c3a1d63f5012c8dceb8df7e86014c29d95479a
-  data.tar.gz: fe491070587b5284dc61d52db7bea1c2951e38bd6e0847b06d11b19077cf0468b7c35f8a7a19993bfac37632be6c9cabf863a30b76abcfab7c6929d064da26c3
+  metadata.gz: 7dc8395400075cc15f5e2437257b7147ff6331dc92c78ea93377b70b85d7711d5ce0c6dd9f2557608b2425834a5d2f68881b8b62a132d1053bbfd6c102bac0ca
+  data.tar.gz: a5cbdad7ccfaad6d49d633225665ee920124ecf12f2a20a8533fb8244a93db0988a66a47f9e2bc081c279ee249e3e9b83caa449744cd9a2b20650027cf958534

data/README.md

@@ -560,6 +560,7 @@ Unfortunately it's in a Time Integer format. Haven't yet got dynamic conversion
 
 <br>
 <hr>
+
 <br>
 
 ## API Coverage
@@ -806,6 +807,13 @@ Unfortunately it's in a Time Integer format. Haven't yet got dynamic conversion
  <br>
 
 
+> [!NOTE]
+> For all resources, we also have a EPlat::ShopifyWebhook::{resource} class. These use the old REST API mappings that the webhooks still use.
+> At PreProduct we interact with cached webhook hashes using these classes, e.g. `EPlat::ShopifyWebhook::Product.new({...})`. 
+> Meaning we can safely call getter methods and access the usual EPlat schema.
+
+
+
 
 <hr>
 <br>
@@ -895,6 +903,8 @@ product.as_json # hash of any updated attributes
 product.as_full_json # hash of all attributes, regardless of if they've been updated or not
 product.to_json # JSON string of any updated_attributes
 product.to_full_json # JSON string of all attributes. regardless of if they've been updated or not
+product.as_eplat_json # hash of all resource's EPlat attributes, values as EPlat getters produce
+product.to_eplat_json # JSON of all resource's EPlat attributes, values as EPlat getters produce
 
 ```
 

data/lib/e_plat/client.rb

@@ -23,6 +23,7 @@ module EPlat
 		# needs to return nil if there isn't a more specific class than the klass passed in
 		def platform_klass(klass)
 			return if klass.to_s.include? "EPlat::#{platform.capitalize}"
+			
 			platform_specific_class_name = klass.to_s.gsub("EPlat::", "EPlat::#{platform.capitalize}::")
 
 			platform_specific_class = platform_specific_class_name.safe_constantize

data/lib/e_plat/resource/base.rb

@@ -18,7 +18,7 @@ module EPlat
 			attr_accessor :read_only
 
 			threadsafe_attribute :_headers, :_connection, :_user, :_password, :_bearer_token, :_site, :_proxy, # active resource
-								 :mapping, :include_root_in_json, :include_format_in_path # e_plat specific
+								 :mapping, :include_root_in_json, :include_format_in_path, :mapping_class # e_plat specific
 			
 			def inherited(subclass)
 				super
@@ -33,7 +33,7 @@ module EPlat
 				self.timeout = 5
 				self.include_format_in_path = client.include_format_in_path?
 				self.mapping = mapping_instance
-				
+
 				client.platform_headers.each {|name, value| self.headers[name] = value}
 			end
 
@@ -71,12 +71,18 @@ module EPlat
 			def platform_specific_class?
 				self.class.to_s.include? client.platform.to_s.capitalize
 			end
+
+			def cached_shopify_webhook?
+				self.to_s.include?("EPlat::ShopifyWebhook")
+			end
+				
 			
 			private
 				
 			def mapping_instance
-				mapping_class_name = "EPlat::Mapping::#{ client.platform.capitalize }::V#{ client.api_version.camelize }::#{ element_name.classify }"
-				
+				api_version = (client.shopify? && self.to_s.include?("EPlat::ShopifyWebhook")) ? "2024_01" : client.api_version
+				mapping_class_name = "EPlat::Mapping::#{ client.platform.capitalize }::V#{ api_version.camelize }::#{ element_name.classify }"
+
 				EPlat::Mapping.new_instance(specifc_mapping: mapping_class_name, resource: nil)
 			end
 				
@@ -164,7 +170,9 @@ module EPlat
 			
 			def mapping_instance
 				class_constant_string = self.class.to_s.gsub("EPlat::", "")
-				mapping_class_name = "EPlat::Mapping::#{ client.platform.capitalize }::V#{ client.api_version.camelize }::#{ class_constant_string }"
+				class_constant_string.gsub!("ShopifyWebhook", "Shopify")
+				api_version = (client.shopify? && self.class.to_s.include?("EPlat::ShopifyWebhook")) ? "2024_01" : client.api_version
+				mapping_class_name = "EPlat::Mapping::#{ client.platform.capitalize }::V#{ api_version.camelize }::#{ class_constant_string }"
 
 				EPlat::Mapping.new_instance(specifc_mapping: mapping_class_name, resource: self)
 			end

data/lib/e_plat/resource/concerns/graph_q_lable.rb

@@ -97,7 +97,7 @@ module EPlat
                     when :find_one
                         {first: 1}
                     when :find_every
-                        {first: scope || 200}
+                        {first: scope || 20}
                     end
                 
                 (options[:params] || {}).with_defaults(scope_arg)

data/lib/e_plat/resource/concerns/overwrite_instance_methods.rb

@@ -48,6 +48,35 @@ module EPlat
 				end
 			end
 
+			def to_eplat_json(options = {})
+				root_at_top_of_json = self.mapping.include_root_in_request_body?(self)
+				options[:root] 		= self.element_name if root_at_top_of_json 
+
+				result = '{'
+				result << as_eplat_json.map do |key, value|
+					"#{ActiveSupport::JSON.encode(key.to_s)}:#{ActiveSupport::JSON.encode(value, options)}"
+				end * ','
+				result << '}'
+			end
+
+			
+			def as_eplat_json
+				schema_keys = self.class.schema.keys
+				schema_keys.each_with_object({}) do |key, hash|
+					value = send(key)
+		
+					hash[key] = 
+						if value.is_a?(Array)
+							value.map { |item| item.respond_to?(:as_eplat_json) ? item.as_eplat_json : item }
+						elsif value.respond_to?(:as_eplat_json)
+							value.as_eplat_json
+						else
+							value
+						end
+				end
+			end
+			
+
 			# Create and return a class definition for a resource inside the current resource
 			def create_resource_for(resource_name)
 				resource = Class.new(EPlat::Base) # <- this line changed

data/lib/e_plat/resource/concerns/overwrite_request_methods.rb

@@ -9,6 +9,7 @@ module EPlat
 			module ClassMethods
 				def find(*arguments)
 					client = EPlat::Current.e_plat_session
+					cached_shopify_webhook_warning if cached_shopify_webhook?
 
 					if client.platform_klass(self) and not platform_specific_class?
 						client.platform_klass(self).find(*arguments)
@@ -54,6 +55,7 @@ module EPlat
 
 				def create(attributes = {})
 					client = EPlat::Current.e_plat_session
+					cached_shopify_webhook_warning if cached_shopify_webhook?
 
 					if client.platform_klass(self)
 						client.platform_klass(self).create(attributes)
@@ -66,6 +68,7 @@ module EPlat
 
 				def update(attributes = {})
 					client = EPlat::Current.e_plat_session
+					cached_shopify_webhook_warning if cached_shopify_webhook?
 
 					if client.platform_klass(self)
 						client.platform_klass(self).update(attributes)
@@ -79,6 +82,7 @@ module EPlat
 
 				def delete(id, options = {})
 					client = EPlat::Current.e_plat_session
+					cached_shopify_webhook_warning if cached_shopify_webhook?
 
 					if client.platform_klass(self)
 						client.platform_klass(self).delete(id, options)
@@ -90,6 +94,7 @@ module EPlat
 
 				def exists?(id, options = {})
 					client = EPlat::Current.e_plat_session
+					cached_shopify_webhook_warning if cached_shopify_webhook?
 
 					if client.platform_klass(self)
 						client.platform_klass(self).exists?(id, options)
@@ -109,6 +114,11 @@ module EPlat
 					class_constant_string = self.name.gsub("EPlat::", "")
 					"EPlat::Mapping::#{client.platform.capitalize}::V#{client.api_version.camelize}::#{class_constant_string}"
 				end
+
+				def cached_shopify_webhook_warning
+					warn "***EPlat Warning this is a cached webhook. request a live resource instead to request with***"
+				end
+
 			end
 
 

data/lib/e_plat/resource/platform_specific/shopify_webhook/metafield.rb

@@ -0,0 +1,4 @@
+
+module EPlat::ShopifyWebhook
+	class Metafield < EPlat::Metafield; end
+end

data/lib/e_plat/resource/platform_specific/shopify_webhook/order/Consignment.rb

@@ -0,0 +1,2 @@
+
+class EPlat::ShopifyWebhook::Order::Consignment < EPlat::Order::Consignment; end

data/lib/e_plat/resource/platform_specific/shopify_webhook/order/billing_address.rb

@@ -0,0 +1,2 @@
+
+class EPlat::ShopifyWebhook::Order::BillingAddress < EPlat::Order::BillingAddress; end

data/lib/e_plat/resource/platform_specific/shopify_webhook/order/fulfillment.rb

@@ -0,0 +1,2 @@
+
+class EPlat::ShopifyWebhook::Order::Fulfillment < EPlat::Order::Fulfillment; end

data/lib/e_plat/resource/platform_specific/shopify_webhook/order/line_item.rb

@@ -0,0 +1,2 @@
+
+class EPlat::ShopifyWebhook::Order::LineItem < EPlat::Order::LineItem; end

data/lib/e_plat/resource/platform_specific/shopify_webhook/order/shipping_address.rb

@@ -0,0 +1,2 @@
+
+class EPlat::ShopifyWebhook::Order::ShippingAddress < EPlat::Order::ShippingAddress; end

data/lib/e_plat/resource/platform_specific/shopify_webhook/order/shipping_line.rb

@@ -0,0 +1,2 @@
+
+class EPlat::ShopifyWebhook::Order::ShippingLine < EPlat::Order::ShippingLine; end

data/lib/e_plat/resource/platform_specific/shopify_webhook/order.rb

@@ -0,0 +1,6 @@
+
+module EPlat::ShopifyWebhook
+	class Order < EPlat::Order
+		has_many :line_items, class_name: "EPlat::ShopifyWebhook::Order::LineItem"
+	end
+end

data/lib/e_plat/resource/platform_specific/shopify_webhook/product/image.rb

@@ -0,0 +1,7 @@
+
+class EPlat::ShopifyWebhook::Product::Image < EPlat::Product::Image
+    def self.graphql_fields
+        warn "this is a cached webhook. request a live resource instead"
+        EPlat::Shopify::Product::Image.graphql_fields
+    end
+end

data/lib/e_plat/resource/platform_specific/shopify_webhook/product/option.rb

@@ -0,0 +1,9 @@
+
+class EPlat::ShopifyWebhook::Product::Option < EPlat::Product::Option
+    
+    def self.graphql_fields
+        warn "this is a cached webhook. request a live resource instead"
+        EPlat::Shopify::Product::Option.graphql_fields
+    end
+
+end

data/lib/e_plat/resource/platform_specific/shopify_webhook/product/variant/option_value.rb

@@ -0,0 +1,7 @@
+
+class EPlat::ShopifyWebhook::Product::Variant::OptionValue < EPlat::Product::Variant::OptionValue
+    def self.graphql_fields
+        warn "this is a cached webhook. request a live resource instead"
+        EPlat::Shopify::Product::Variant::OptionValue.graphql_fields
+    end    
+end

data/lib/e_plat/resource/platform_specific/shopify_webhook/product/variant.rb

@@ -0,0 +1,9 @@
+
+class EPlat::ShopifyWebhook::Product::Variant < EPlat::Product::Variant
+    
+    def self.graphql_fields
+        warn "this is a cached webhook. request a live resource instead"
+        EPlat::Shopify::Product::Variant.graphql_fields
+    end
+    
+end

data/lib/e_plat/resource/platform_specific/shopify_webhook/product.rb

@@ -0,0 +1,14 @@
+
+module EPlat::ShopifyWebhook
+	class Product < EPlat::Product
+		has_many :variants, class_name: "EPlat::ShopifyWebhook::Product::Variant"
+		has_many :images, 	class_name: "EPlat::ShopifyWebhook::Product::Image"
+		has_many :options, 	class_name: "EPlat::ShopifyWebhook::Product::Option"
+
+		def self.graphql_fields
+			warn "this is a cached webhook. request a live resource instead"
+			EPlat::Shopify::Product.graphql_fields
+		end
+		
+	end
+end

data/lib/e_plat/resource/platform_specific/shopify_webhook/recurring_application_charge/usage_charge.rb

@@ -0,0 +1,2 @@
+
+class EPlat::ShopifyWebhook::RecurringApplicationCharge::UsageCharge < EPlat::RecurringApplicationCharge::UsageCharge; end

data/lib/e_plat/resource/platform_specific/shopify_webhook/recurring_application_charge.rb

@@ -0,0 +1,6 @@
+
+module EPlat::ShopifyWebhook
+	class RecurringApplicationCharge < EPlat::RecurringApplicationCharge
+		has_many :usage_charges, class_name: "EPlat::ShopifyWebhook::RecurringApplicationCharge::UsageCharge"
+	end
+end

data/lib/e_plat/resource/platform_specific/shopify_webhook/script_tag.rb

@@ -0,0 +1,4 @@
+
+module EPlat::ShopifyWebhook
+	class ScriptTag < EPlat::ScriptTag; end
+end

data/lib/e_plat/resource/platform_specific/shopify_webhook/shop.rb

@@ -0,0 +1,4 @@
+
+module EPlat::ShopifyWebhook
+	class Shop < EPlat::Shop; end
+end

data/lib/e_plat/resource/platform_specific/shopify_webhook/webhook.rb

@@ -0,0 +1,4 @@
+
+module EPlat::ShopifyWebhook
+	class Webhook < EPlat::Webhook; end
+end

data/lib/e_plat/resource/product/image.rb

@@ -23,7 +23,7 @@ module EPlat
 			end
 
 			def variant_ids
-				product.variants.map(&:id)
+				product&.variants&.map(&:id) || []
 			end
 
 			def variant_ids=(ids)

data/lib/e_plat/resource/product/variant.rb

@@ -28,6 +28,8 @@ module EPlat
 				string :tax_code
 				boolean :requires_shipping
 				string :admin_graphql_api_id
+				array :option_values
+				# hash :image # default: {}, just for Shopify Webhooks
 			end
 
 			def save
@@ -35,10 +37,12 @@ module EPlat
 				super
 			end
 
-			def image_src
+			def image_src(images=[]) # EPlat::Product::Image => string
 				if client.bigcommerce?
 					image_url
-				elsif client.shopify? && client.uses_graphql_for_products?
+				elsif is_a?(EPlat::ShopifyWebhook::Product::Variant)
+					images.to_a.find{ |i| i.id == image_id }.try(:src)
+				elsif is_a?(EPlat::Shopify::Product::Variant)
 					image&.src
 				end
 			end

data/lib/e_plat/version.rb

@@ -1,3 +1,3 @@
 module EPlat
-  VERSION = "0.7.3"
+  VERSION = "0.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: e_plat
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.9.1
 platform: ruby
 authors:
 - oliwoodsuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-31 00:00:00.000000000 Z
+date: 2024-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -382,6 +382,24 @@ files:
 - lib/e_plat/resource/platform_specific/shopify/script_tag.rb
 - lib/e_plat/resource/platform_specific/shopify/shop.rb
 - lib/e_plat/resource/platform_specific/shopify/webhook.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/metafield.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/order.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/order/Consignment.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/order/billing_address.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/order/fulfillment.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/order/line_item.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/order/shipping_address.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/order/shipping_line.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/product.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/product/image.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/product/option.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/product/variant.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/product/variant/option_value.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/recurring_application_charge.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/recurring_application_charge/usage_charge.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/script_tag.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/shop.rb
+- lib/e_plat/resource/platform_specific/shopify_webhook/webhook.rb
 - lib/e_plat/resource/product.rb
 - lib/e_plat/resource/product/image.rb
 - lib/e_plat/resource/product/option.rb