e_plat 1.0.0.pre.rc.9 → 1.1.0.pre.rc.1

data/lib/e_plat/mapping/woocommerce/v_3/product.rb

@@ -0,0 +1,168 @@
+module EPlat
+  class Mapping
+    module Woocommerce
+      module V3
+        class Product < EPlat::Mapping::Base
+          
+          def native_top_key
+            :itself
+          end
+          
+          def native_attributes
+            super.concat([
+              "id",
+              "name",
+              "slug",
+              "permalink",
+              "date_created",
+              "date_created_gmt",
+              "date_modified",
+              "date_modified_gmt",
+              "type",
+              "status",
+              "featured",
+              "catalog_visibility",
+              "description",
+              "short_description",
+              "sku",
+              "price",
+              "regular_price",
+              "sale_price",
+              "date_on_sale_from",
+              "date_on_sale_from_gmt",
+              "date_on_sale_to",
+              "date_on_sale_to_gmt",
+              "on_sale",
+              "purchasable",
+              "total_sales",
+              "virtual",
+              "downloadable",
+              "downloads",
+              "download_limit",
+              "download_expiry",
+              "external_url",
+              "button_text",
+              "tax_status",
+              "tax_class",
+              "manage_stock",
+              "stock_quantity",
+              "backorders",
+              "backorders_allowed",
+              "backordered",
+              "low_stock_amount",
+              "sold_individually",
+              "weight",
+              "dimensions",
+              "shipping_required",
+              "shipping_taxable",
+              "shipping_class",
+              "shipping_class_id",
+              "reviews_allowed",
+              "average_rating",
+              "rating_count",
+              "upsell_ids",
+              "cross_sell_ids",
+              "parent_id",
+              "purchase_note",
+              "categories",
+              "tags",
+              "images",
+              "attributes",
+              "#{EPlat::PROTECTED_PREFIX}attributes", # we don't allow access to attributes directly, so we use this as a proxy
+              "default_attributes",
+              "variations",
+              "grouped_products",
+              "menu_order",
+              "price_html",
+              "related_ids",
+              "meta_data",
+              "stock_status",
+              "has_options",
+              "post_password",
+              "global_unique_id",
+              "brands"
+            ])
+          end
+          
+          def native_attribute_aliases
+            super.concat([
+              {
+                alias_attribute: {native_key: "description", e_plat_key: "body_html"}
+              },
+              {
+                alias_attribute: {native_key: "date_created", e_plat_key: "created_at"}
+              },
+              {
+                alias_attribute: {native_key: "date_created", e_plat_key: "published_at"}
+              },
+              {
+                alias_attribute: {native_key: "slug", e_plat_key: "handle"}
+              },
+              {
+                existing_entry: {native_key: "id", e_plat_key: "id"}
+              },
+              {
+                existing_entry: {native_key: "images", e_plat_key: "images"}
+              },
+              {
+                existing_entry: {native_key: "options", e_plat_key: "options"}
+              },
+              {
+                existing_entry: {native_key: "status", e_plat_key: "status",
+                  custom_e_plat_getter: "-> (value) {
+                    status_map = {
+                      'publish' => 'active',
+                      'draft' => 'draft',
+                      'pending' => 'active',
+                      'private' => 'draft'
+                    }
+                    status_map[value] || 'active'
+                  }",
+                  custom_native_setter: "-> (value) {
+                    status_map = {
+                      'active' => 'publish',
+                      'draft' => 'draft',
+                      'archived' => 'private'
+                    }
+                    status_map[value] || 'publish'
+                  }"
+                }
+              },
+              {
+                alias_attribute: {native_key: "name", e_plat_key: "title"}
+              },
+              {
+                alias_attribute: {native_key: "date_modified", e_plat_key: "updated_at"}
+              },
+              {
+                alias_attribute: {native_key: "lazy_load_variants", e_plat_key: "variants"}
+              },
+              {
+                existing_entry: {native_key: "tags", e_plat_key: "tags",
+                  custom_e_plat_getter: "-> (value) {
+                    (value || []).map do |tag|
+                      tag.is_a?(Hash) ? tag['name'] : tag.name
+                    end.compact.join(', ')
+                  }",
+                  custom_native_setter: "-> (value) {
+                    if value.is_a?(String)
+                      value.split(',').map { |tag| tag.strip }.map { |tag| { 'name' => tag } }
+                    else
+                      value
+                    end
+                  }"
+                }
+              }
+            ])
+          end
+
+          def protected_attributes_rename_on_initialize 
+            {
+              "attributes" => "options"
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/e_plat/mapping/woocommerce/v_3/script_tag.rb

@@ -0,0 +1,22 @@
+module EPlat
+  class Mapping
+    module Woocommerce
+      module V3
+        class ScriptTag < EPlat::Mapping::Base
+          # WooCommerce ScriptTag mapping to be added later
+          def native_top_key
+            :itself
+          end
+          
+          def native_attributes
+            super.concat([])
+          end
+          
+          def native_attribute_aliases
+            super.concat([])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/e_plat/mapping/woocommerce/v_3/shop.rb

@@ -0,0 +1,142 @@
+module EPlat
+  class Mapping
+    module Woocommerce
+      module V3
+        class Shop < EPlat::Mapping::Base
+          
+          # WooCommerce uses the `/settings/general` endpoint to get the shop details
+          # we lazy load the weight unit from `/settings/products/woocommerce_weight_unit` when needed
+          
+          def native_top_key
+            :itself # The response is an array, not a nested object with a specific top key
+          end
+          
+          def native_attributes
+            super.concat([
+              "domain", #fake, as we use client.store_url. This whole class is read_only really
+              "woocommerce_store_address",
+              "woocommerce_store_address_2",
+              "woocommerce_store_city",
+              "woocommerce_store_postcode",
+              "woocommerce_default_country",
+              "woocommerce_currency",
+              "woocommerce_weight_unit" # lazy loaded from settings/products instead of settings/general
+            ])
+          end
+          
+          def native_attribute_aliases
+            super.concat([
+              {
+                alias_attribute: {
+                  native_key: "woocommerce_store_address", 
+                  e_plat_key: "address1",
+                  custom_e_plat_getter: "-> (value) { 
+                    value&.value
+                  }"
+                }
+              },
+              {
+                alias_attribute: {
+                  native_key: "woocommerce_store_address_2", 
+                  e_plat_key: "address2",
+                  custom_e_plat_getter: "-> (value) { 
+                    value&.value
+                  }"
+                }
+              },
+              {
+                alias_attribute: {
+                  native_key: "woocommerce_store_city", 
+                  e_plat_key: "city",
+                  custom_e_plat_getter: "-> (value) { 
+                    value&.value
+                  }"
+                }
+              },
+              {
+                alias_attribute: {
+                  native_key: "woocommerce_store_postcode", 
+                  e_plat_key: "zip",
+                  custom_e_plat_getter: "-> (value) { 
+                    value&.value
+                  }"
+                }
+              },
+              {
+                alias_attribute: {
+                  native_key: "woocommerce_default_country", 
+                  e_plat_key: "country",
+                  custom_e_plat_getter: "-> (value) { 
+                    if value.is_a?(Hash) && value['value']
+                      # Extract just the country code part, safely handling any format
+                      country_code = value['value'].to_s.split(':').first.to_s.gsub(/[^A-Za-z0-9]/, '')
+                      country_code
+                    else
+                      value.to_s.split(':').first.to_s.gsub(/[^A-Za-z0-9]/, '')
+                    end
+                  }"
+                }
+              },
+              {
+                alias_attribute: {
+                  native_key: "woocommerce_default_country", 
+                  e_plat_key: "country_code",
+                  custom_e_plat_getter: "-> (value) { 
+                    # e.g. US:CA => US
+                    value.default.split(':').first
+                  }"
+                }
+              },
+              {
+                alias_attribute: {
+                  native_key: "woocommerce_default_country", 
+                  e_plat_key: "province",
+                  custom_e_plat_getter: "-> (value) { 
+                    # e.g. US:CA => CA
+                    value.default.split(':').last
+                  }"
+                }
+              },
+              {
+                alias_attribute: {
+                  native_key: "woocommerce_currency", 
+                  e_plat_key: "currency",
+                  custom_e_plat_getter: "-> (value) { 
+                    value&.default
+                  }"
+                }
+              },
+              {
+                alias_attribute: {
+                  native_key: "woocommerce_weight_unit", 
+                  e_plat_key: "weight_unit",
+                  custom_e_plat_getter: "-> (value) { 
+                    lazy_load_weight_unit
+                  }"
+                }
+              },
+              # Client store_url as domain
+              {
+                existing_entry: {
+                  native_key: "domain", 
+                  e_plat_key: "domain",
+                  custom_e_plat_getter: "-> (value) { 
+                    client&.store_url
+                  }"
+                }
+              },
+              # Set has_storefront to true for WooCommerce
+              {
+                existing_entry: {
+                  native_key: "has_storefront", 
+                  e_plat_key: "has_storefront",
+                  custom_e_plat_getter: "-> (value) { true }"
+                }
+              }
+            ])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/e_plat/mapping/woocommerce/v_3/webhook.rb

@@ -0,0 +1,52 @@
+module EPlat
+  class Mapping
+    module Woocommerce
+      module V3
+        class Webhook < EPlat::Mapping::Base
+          
+          def native_top_key
+            :itself
+          end
+          
+          def native_attributes
+            super.concat([
+              "id",
+              "name",
+              "status",
+              "topic",
+              "resource",
+              "event",
+              "hooks",
+              "delivery_url",
+              "secret",
+              "date_created",
+              "date_created_gmt",
+              "date_modified",
+              "date_modified_gmt"
+            ])
+          end
+          
+          def native_attribute_aliases
+            super.concat([
+              {
+                existing_entry: {native_key: "id", e_plat_key: "id"}
+              },
+              {
+                existing_entry: {native_key: "topic", e_plat_key: "topic"}
+              },
+              {
+                alias_attribute: {native_key: "delivery_url", e_plat_key: "address"}
+              },
+              {
+                alias_attribute: {native_key: "date_created_gmt", e_plat_key: "created_at"}
+              },
+              {
+                alias_attribute: {native_key: "date_modified_gmt", e_plat_key: "updated_at"}
+              }
+            ])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/e_plat/paginated/woocommerce_pagination.rb

@@ -0,0 +1,45 @@
+module EPlat
+  module Paginated
+    class WooCommercePagination
+      attr_reader :next_link, :previous_link
+      
+      def initialize(headers)
+        return unless headers
+        
+        # WooCommerce uses X-WP-Total and X-WP-TotalPages headers for pagination info
+        # And link headers for next/prev links
+        @total = headers["X-WP-Total"].to_i if headers["X-WP-Total"]
+        @total_pages = headers["X-WP-TotalPages"].to_i if headers["X-WP-TotalPages"]
+        
+        # Parse link headers
+        if headers["Link"]
+          parse_link_headers(headers["Link"])
+        end
+      end
+      
+      private
+      
+      def parse_link_headers(link_header)
+        # Link headers look like:
+        # <https://example.com/wp-json/wc/v3/products?page=2>; rel="next", <https://example.com/wp-json/wc/v3/products?page=1>; rel="prev"
+        return unless link_header.is_a?(String)
+        
+        links = link_header.split(",").map(&:strip)
+        
+        links.each do |link|
+          if link =~ /<([^>]+)>;\s*rel="([^"]+)"/
+            url = $1
+            rel = $2
+            
+            case rel
+            when "next"
+              @next_link = OpenStruct.new(url: url)
+            when "prev"
+              @previous_link = OpenStruct.new(url: url)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/e_plat/resource/attribute_interface.rb

@@ -38,17 +38,20 @@ module EPlat
 			def add_to_instance!
 				meta_programming_string = 
 					keys.map do |key|
+						# Sanitize the key to ensure it's a valid Ruby method name
+						method_name = key.to_s.gsub(/[^a-zA-Z0-9_]/, '_')
+						
 						<<-STRING
-							def #{ key }
+							def #{ method_name }
 								self.attributes['#{key}']
 							end
 
-							def #{key}=(value)
+							def #{method_name}=(value)
 								self.attributes['#{key}'] = value
 							end
 
-							def #{ key }?
-								ActiveModel::Type::Boolean.new.cast send '#{key}'
+							def #{ method_name }?
+								ActiveModel::Type::Boolean.new.cast send '#{method_name}'
 							end
 						STRING
 					end.join("\n")

data/lib/e_plat/resource/base.rb

@@ -12,6 +12,14 @@ module EPlat
 		self.site = "/" # this is overwritten below in initialize_singleton! when EPlat::Session is initialized
 		add_response_method :full_response #full response of the request
 
+		PROTECTED_ATTRIBUTES = [
+			"self", "collection", "password", "api_key", "attributes",
+			"eval", "send", "public_send",
+			"class", "send", "destroy", "delete_all", "__send__", "__id__", "initialize", "method",
+			"delete", "delete_all", "destroy", "destroy_all", "update", "update_all", "save", "save_all",
+			"delete!", "delete_all!", "destroy!", "destroy_all!", "update!", "update_all!", "save!", "save_all!",
+		].freeze
+
 		class << self
 			include Countable
 
@@ -96,6 +104,7 @@ module EPlat
 		def initialize(attributes = {}, persisted = false)
 			site = client.base_url
 			ActiveResource::Base.include_root_in_json = client.shopify? && top_level_resource?
+			# attributes.reject!{ _1.starts_with? "_"} # remove private attributes, e.g. WooCommerce's '_links'
 
 			super
 			
@@ -119,9 +128,9 @@ module EPlat
 			if client.shopify? 
 				@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
+				@mapping.native_attributes.presence - EPlat::Base::PROTECTED_ATTRIBUTES
 			else
-				attributes.keys
+				attributes.keys - EPlat::Base::PROTECTED_ATTRIBUTES
 			end
 		end
 
@@ -168,7 +177,7 @@ module EPlat
 			def ensure_native_attributes!
 				return if client.shopify? && EPlat.config.shopify_api_version == "2024_01"
 
-				AttributeInterface.new(self, keys: native_keys)
+				# AttributeInterface.new(self, keys: native_keys)
 			end
 			
 			def mapping_instance

data/lib/e_plat/resource/collection.rb

@@ -9,7 +9,7 @@ module EPlat
 			EPlat::Shopify::Product::Variant
 		)
 
-		def initialize(parsed = {})
+		def initialize(parsed = [])
 			super parsed
 		end
 
@@ -58,6 +58,9 @@ module EPlat
 			if paginates_via_graphql?
 				arg_name = (url == @next) ? "after" : "before"
 				resource_class.find(:all, params: {arg_name => url, first: 100})
+			elsif client.woocommerce?
+				page_number = extract_page_from_url(url)
+				resource_class.find(:all, params: {page: page_number})
 			else
 				resource_class.all(from: url)
 			end
@@ -80,6 +83,10 @@ module EPlat
 				@pagination_links ||= EPlat::Paginated::LinkParams.new(
 					link_params
 				)
+			when :woocommerce
+				@pagination_links ||= EPlat::Paginated::LinkHeaders.new(
+					(full_response&.headers&.to_h || {})[:link]
+				)
 			else
 				raise "Unknown platform"
 			end
@@ -107,7 +114,17 @@ module EPlat
 			return request_data if paginates_via_graphql?
 
 			query_params = URI.decode_www_form(URI(request_data).query).to_h 
-			query_params[client.pagination_param]
+			
+			if client.woocommerce?
+				query_params["page"]
+			else
+				query_params[client.pagination_param]
+			end
+		end
+
+		def extract_page_from_url(url)
+			query_params = URI.decode_www_form(URI(url).query).to_h
+			query_params["page"]
 		end
 
 

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

@@ -1,4 +1,3 @@
-
 module EPlat
 	module Concerns
 		module Aliases
@@ -31,6 +30,8 @@ module EPlat
 				
 				type_schema.each do |e_plat_key, type|
 					next if processed[:getter].include?(e_plat_key)
+					# next if EPlat::Base::PROTECTED_ATTRIBUTES.include?(e_plat_key)
+					
 					add_to_instance! mapped_getter(e_plat_key), @is_virtual
 				end
 
@@ -46,9 +47,11 @@ module EPlat
 			
 				def alias_mapped_getter(e_plat_key, native_key, proc: '->{_1}')
 					proc_line = (proc) ? "current_value = #{ proc.strip }.call(current_value)" : nil
+					# Sanitize the key to ensure it's a valid Ruby method name
+					method_name = e_plat_key.to_s.gsub(/[^a-zA-Z0-9_]/, '_')
 					
 					<<-STRING
-						def #{ e_plat_key }
+						def #{ method_name }
 							current_value = #{ native_key_path(native_key) }
 							#{ proc_line }
 							type_coercer.type_value!('#{ e_plat_key }', current_value)
@@ -58,9 +61,11 @@ module EPlat
 				
 				def alias_mapped_setter(e_plat_key, native_key, proc: '->{_1}')
 					proc_line = (proc) ? "new_value = #{ proc.strip }.call(new_value)" : nil
+					# Sanitize the key to ensure it's a valid Ruby method name
+					method_name = e_plat_key.to_s.gsub(/[^a-zA-Z0-9_]/, '_')
 					
 					<<-STRING
-						def #{e_plat_key}=(value)
+						def #{method_name}=(value)
 							new_value = value
 							#{proc_line}
 
@@ -75,9 +80,11 @@ module EPlat
 				
 				def mapped_getter(e_plat_key, proc: '->{_1}')
 					proc_line = (proc) ? "value = #{ proc.strip }.call(value)" : nil
+					# Sanitize the key to ensure it's a valid Ruby method name
+					method_name = e_plat_key.to_s.gsub(/[^a-zA-Z0-9_]/, '_')
 
 					<<-STRING
-						def #{ e_plat_key }
+						def #{ method_name }
 							value = self.attributes['#{ e_plat_key }']
 							#{ proc_line }
 							type_coercer.type_value!('#{ e_plat_key }', value)
@@ -89,9 +96,11 @@ module EPlat
 				# we dont want the eplat version of the value in change_attributes, we want the native version.
 				def native_setter(native_key, proc: '->{_1}')
 					proc_line = (proc) ? "value = #{ proc.strip }.call(value)" : nil
+					# Sanitize the key to ensure it's a valid Ruby method name
+					method_name = native_key.to_s.gsub(/[^a-zA-Z0-9_]/, '_')
 
 					<<-STRING
-						def #{native_key}=(value)
+						def #{method_name}=(value)
 							#{proc_line}
 							super
 							attribute_will_change!('#{native_key}', force_value: value) 
@@ -119,7 +128,6 @@ module EPlat
 
 				def add_to_instance!(meta_programming_string, is_virtual=false)
 					# puts meta_programming_string if meta_programming_string.include?('note')
-
 					self.instance_eval { eval meta_programming_string }
 				end
 

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

@@ -5,10 +5,19 @@ module EPlat
 		module Metafieldable #< ActiveResource::CustomMethods
 
 			def metafields(**options)
-				Metafield.find(:all, 
-					from: current_resources_metafield_path, 
-					params: options
-				)
+				if client.woocommerce?
+					meta_data.map do |m|
+						m.owner_id ||= id
+						m.owner_resource ||= self.class.element_name
+						m.owner = self
+						m
+					end
+				else
+					Metafield.find(:all,
+						from: current_resources_metafield_path, 
+						params: options
+					)
+				end
 			end
 
 			def find_metafield(id)
@@ -18,19 +27,31 @@ module EPlat
 			def add_metafield(metafield)
 				raise ArgumentError, "You can only add metafields to a resource that has been saved" if new?
 
-				metafield.owner_id = id
-				metafield.owner_resource = self.class.element_name
-				metafield.save
-				metafield
+				metafield.owner_id ||= id
+				metafield.owner_resource ||= self.class.element_name
+
+				if client.woocommerce?
+					meta_data << metafield
+					save
+
+					meta_data.find{ _1.key == metafield.key }.then do |m|
+						m.owner_id = id
+						m.owner_resource = self.class.element_name
+						m.owner = self
+						m
+					end
+				else
+					metafield.save
+					metafield
+				end
 			end
-
 			
 			private
 
 			def current_resources_metafield_path
 				uri = URI.parse(element_path)
 				uri.path = uri.path.gsub(".json", "/metafields.json")
-				uri.path += "/metafields"  if uri.path.exclude?("json")
+				uri.path += "/metafields" if uri.path.exclude?("json")
 				uri.path.gsub!('v2', 'v3') if client.bigcommerce? # metafield uses v3 API, even though orders are only available in v2
 
 				uri.to_s

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

@@ -41,7 +41,7 @@ module EPlat
 
  				add_root_if_needed(request_json, options[:root]).reject do |k,v| 
 					if v.is_a?(Array) 
-						v.reject(&:empty?).empty?
+						v.reject(&:empty?).empty? && k != "meta_data"
 					else 
 						v.nil? || v.blank?
 					end