e_plat 0.7.2 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5af5d23022fca18e27cc070f5975bd15c7aba8f7df53b3a764c9c1ba0a285284
-  data.tar.gz: c4b5f3ad678da9135a7f840028ede728ea16b0ee15f66d0d5edac60f5b805bf0
+  metadata.gz: d034aa67ea9c09ef394c0f55c26bb2d41032e7a8c8e958fe4fdc0d2bd24222b5
+  data.tar.gz: 3ba4c808ae422b28a12470957f87f88283985dbaf193767e9a3d7ae5a1f9c58c
 SHA512:
-  metadata.gz: d0bdc8f94fb56bf2f7b36ea92cfbe3664caeb7ebd200d9d6215247f61b92b90f0f7e4a48b1aa860e4a8d6de35621f20621fe6ba2824389580bfb3109c15ab428
-  data.tar.gz: 801cd77a5959527f12b62d24a104e829069049a1d66664db2fbe18aa04cb09944d9971dbe8f78496684409e20efc4d5e298b0b289ddcc2087f07443051558b7c
+  metadata.gz: 394fc11195351f359b3c001b11e0a7fcab32763e8c5fd24a2c0a1be811690a0d736f5393a09e1f9d566b8bbdb06553c9df699e75d08b6b15f4e0172af546d561
+  data.tar.gz: ee2c4ad95ec889f72f0653a8167787457529ef505fcfdf31c4287b9d478914659915633e50d80b979cc22e01d506e6a108e2567966db347c87646f36236e4739

data/README.md

@@ -267,6 +267,10 @@ EPlat is designed to let you mostly use it's universal interface, but then easil
 | inventory_quantity    | integer  | getter only: node.inventoryQuantity     | inventory_level                      | nil |
 | tax_code              | string   | *       | nil                                  | nil |
 | requires_shipping     | boolean  | InventoryItem[requiresShipping] | nil              | nil |
+
+helper methods: <br>
+`image_src` => `String | nil`, platforms supported: Shopify, Bigcommerce
+
  *Bigcommerce variant.title= setter is not supported
  
  
@@ -290,7 +294,6 @@ EPlat is designed to let you mostly use it's universal interface, but then easil
  | width                | integer  | *       | nil          | nil         |
  | height               | integer  | *       | nil          | nil         |
  | src                  | string   | *       | url_standard | nil         |
- | variant_ids          | array    | *       | nil          | nil         |
 
 
  ### EPlat::Product::Variant::OptionValue 
@@ -835,6 +838,7 @@ EPlat::Product.find(my_id).destroy
 product = EPlat::Product.new(title: 't-shirt')
 product.save # true or false
 product.errors # active record like errors if .save returned false
+product.formatted_id #returns the resource ID in the platform's format. i.e. Shopify Product would be "gid://shopify/Product/xxx", Shopify Order would be 123, BC order: 123
 
 product.full_response # <Net::HTTPOK>
 product.headers # { "date"=>"Fri, 17 Nov 2023 14:25:53 GMT", ...}

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

@@ -8,6 +8,7 @@ module EPlat
 		
 		self.connection_class  = EPlat::Connection
 		self.collection_parser = EPlat::Collection
+		self.timeout = 10
 		self.site = "/" # this is overwritten below in initialize_singleton! when EPlat::Session is initialized
 		add_response_method :full_response #full response of the request
 
@@ -17,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
@@ -32,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
 
@@ -70,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
 				
@@ -129,7 +136,7 @@ module EPlat
 			top_level_resource?
 		end
 
-		def formatted_id(id)
+		def formatted_id
 			return id unless client.shopify? && client.api_version != "2024_01"
 			return if id.to_s.include?("gid://")
 
@@ -163,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

@@ -236,7 +236,7 @@ module EPlat
             additional_graphql = self.class.before_graphql_callbacks[action.to_sym]&.call(self)
             input  = 
                 if action == :delete 
-                    self.is_a?(EPlat::Product::Variant) ? graphql_input.new(id: formatted_id(id)) : graphql_input.new({id: formatted_id(id)})
+                    self.is_a?(EPlat::Product::Variant) ? graphql_input.new(id: formatted_id) : graphql_input.new({id: formatted_id})
                 else
                     graphql_input.new mapping.via_native_attributes_where_possible(self.class.remove_root_from as_json)
                 end

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

@@ -90,7 +90,7 @@ module EPlat
 			def unrepresented_collection_ids(key, array_of_hashes)
 				return [] unless client.can_update_nested_resources?
 				
-				all_instance_ids 		 = send(key).map{|resource| resource.formatted_id resource.id} || [] 
+				all_instance_ids 		 = send(key).map{|resource| resource.formatted_id} || [] 
 				represented_instance_ids = array_of_hashes.map{|item| item["id"] }
 				
 				all_instance_ids.compact - represented_instance_ids.compact

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/product/variant.rb

@@ -29,7 +29,7 @@ class EPlat::Shopify::Product::Variant < EPlat::Product::Variant
                 barcode
                 weight
                 image {
-                    id
+                    #{ EPlat::Shopify::Product::Image.graphql_fields }
                 }
                 inventoryItem {
                     id

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

@@ -9,6 +9,7 @@ module EPlat
 
 			schema do
 				integer :id
+				integer :product_id # nil-able because of Shopify GraphQL
 				string :alt
 				integer :width
 				integer :height

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

@@ -28,12 +28,22 @@ module EPlat
 				string :tax_code
 				boolean :requires_shipping
 				string :admin_graphql_api_id
+				hash :image # default: {}, just for Shopify Webhooks
 			end
 
 			def save
 				prefix_options[:product] ||= try(:product)&.id
 				super
 			end
+
+			def image_src
+				if client.bigcommerce?
+					image_url
+				elsif client.shopify? && client.uses_graphql_for_products?
+					image.try(:src)
+				end
+			end
+
 		end
 	end
 end

data/lib/e_plat/version.rb

@@ -1,3 +1,3 @@
 module EPlat
-  VERSION = "0.7.2"
+  VERSION = "0.7.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: e_plat
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.4
 platform: ruby
 authors:
 - oliwoodsuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-30 00:00:00.000000000 Z
+date: 2024-05-31 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