e_plat 0.3.0 → 0.4.1

data/lib/e_plat/mapping/shopify/v_2024_01/webhook.rb

@@ -0,0 +1,29 @@
+module EPlat
+	class Mapping
+		module Shopify
+			module V202401 #< :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/base.rb

@@ -0,0 +1,14 @@
+
+module EPlat
+    class Mapping
+        class VirtualCollection::Base
+            attr_accessor :resource
+            # useful for adding an interface that gets and sets from nested attributes accross nested resources
+            # for example a order.line_items collection that is aliased to attributes in both order.consignments[0].shipping and order.consignments[0].shipping.line_items
+
+            def initialize(resource:, map_from:)
+            end
+            
+        end
+    end
+end

data/lib/e_plat/mapping/virtual_collection/bigcommerce/order_line_items.rb

@@ -0,0 +1,297 @@
+
+module EPlat
+    class Mapping
+        module VirtualCollection
+            module Bigcommerce
+                class OrderLineItems < VirtualCollection::Base
+                    attr_accessor :resource
+                    # will create an array of EPlat::Order::LineItem objects with no proper attributes, only aliases
+                    # i.e. e_plat_key will always be virtual, whilst the native key will point to a proper attributes other resources
+                    # Order line_items do actually exist in BigCommerce, but they're in a much deeper level of the JSON that order.line_items
+                    # Using a virtual collection, allows us to treat the line_items as if they were in the proper position: order.line_items
+
+                    def initialize(resource:, map_from:)
+                        @resource = resource
+                        super
+
+                        return unless @resource.try :consignments #map_from
+
+                        @resource.line_items = 
+                            (@resource.consignments[0].try(:shipping).presence || @resource.consignments[0].try(:pickups))&.first&.line_items.map.with_index do |data, i|
+                                item = EPlat::Order::LineItem.new(order_id: @resource.id)
+                                item.mapping.virtual_collection = self
+                                item.add_aliases!(native_attribute_aliases(i), EPlat::Order::LineItem.schema)
+
+                                item
+                            end
+                    end
+
+                    def native_attribute_aliases(i)
+                        [
+                            {
+                                alias_attribute: {
+                                    native_key: "[consignments][0][shipping][0][line_items][#{i}][id]",
+                                    e_plat_key: "id",
+                                    virtual_collection: true
+                                }
+                            },
+                            {
+                                alias_attribute: {
+                                    native_key: "[consignments][0][shipping][0][line_items][#{i}][variant_id]",
+                                    e_plat_key: "variant_id",
+                                    virtual_collection: true
+                                }
+                            },
+                            {
+                                alias_attribute: {
+                                    native_key: "[consignments][0][shipping][0][line_items][#{i}][name]",
+                                    e_plat_key: "name",
+                                    virtual_collection: true
+                                }
+                            },
+                            {
+                                alias_attribute: {
+                                    native_key: "[consignments][0][shipping][0][line_items][#{i}][price]",
+                                    e_plat_key: "price",
+                                    virtual_collection: true
+                                }
+                            },
+                            {
+                                alias_attribute: {
+                                    native_key: "[consignments][0][shipping][0][line_items][#{i}][product_id]",
+                                    e_plat_key: "product_id",
+                                    virtual_collection: true
+                                }
+                            },
+                            {
+                                alias_attribute: {
+                                    native_key: "[consignments][0][shipping][0][line_items][#{i}][quantity]",
+                                    e_plat_key: "quantity",
+                                    virtual_collection: true
+                                }
+                            },
+                            {
+                                alias_attribute: {
+                                    native_key: "[consignments][0][shipping][0][line_items][#{i}][sku]",
+                                    e_plat_key: "sku",
+                                    virtual_collection: true
+                                }
+                            },
+                        ]
+                    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/mapping.rb

@@ -5,11 +5,11 @@ module EPlat
     
     class << self
       
-      def new_instance(specifc_mapping:)
+      def new_instance(specifc_mapping:, resource: nil)
         if Object.const_defined?(specifc_mapping)
-          mapping = specifc_mapping.constantize.new
+          mapping = specifc_mapping.constantize.new(resource)
         else
-          mapping = EPlat::Mapping::Base.new
+          mapping = EPlat::Mapping::Base.new(resource)
         end
       end
       

data/lib/e_plat/resource/attribute_interface.rb

@@ -1,10 +1,11 @@
 module EPlat
 	class AttributeInterface
-		attr_accessor :parent, :keys
+		attr_accessor :klass, :keys
 
-		def initialize(parent, keys:)
-			@parent, @keys = parent, keys
-			add_convenience_methods
+		def initialize(klass, keys:)
+			@klass, @keys = klass, keys
+			
+			add_to_instance! if keys.present?
 		end
 		
 		def inspect
@@ -12,15 +13,15 @@ module EPlat
 		end
 
 		def entries
-			keys.map{|k| {k => parent.send(k)} }.inject(&:merge)
+			keys.map{|k| {k => klass.send(k)} }.inject(&:merge)
 		end
 		
 		define_method :[] do |key|
-			parent.attributes[key]
+			klass.attributes[key]
 		end
 	
 		define_method :[]= do |key, value|
-			parent.attributes[key] = value
+			klass.attributes[key] = value
 		end
 		
 		def include?(value)
@@ -34,27 +35,26 @@ module EPlat
 		
 		private
 		
-			def add_convenience_methods
-				keys.each do |key|
-					class_eval <<-STRING
-						define_method "#{ key }" do
-							parent.send("#{key}")
-						end
-					STRING
-					
-					class_eval <<-STRING
-						define_method("#{key}=") do |val|
-							parent.send("#{key}=", val)
-						end
-					STRING
-					
-					class_eval <<-STRING
-						define_method "#{ key }?" do
-							ActiveModel::Type::Boolean.new.cast parent.send("#{key}")
-						end
-					STRING
-				end
-	  		end
+			def add_to_instance!
+				meta_programming_string = 
+					keys.map do |key|
+						<<-STRING
+							def #{ key }
+								self.attributes['#{key}']
+							end
+
+							def #{key}=(value)
+								self.attributes['#{key}'] = value
+							end
+
+							def #{ key }?
+								ActiveModel::Type::Boolean.new.cast send '#{key}'
+							end
+						STRING
+					end.join("\n")
+
+				klass.instance_eval { eval meta_programming_string }
+			end
 		
 	end
 end

data/lib/e_plat/resource/base.rb

@@ -2,77 +2,151 @@
 
 module EPlat
 	class Base < ActiveResource::Base
+		include Concerns::OverwriteRequestMethods, Concerns::OverwriteInstanceMethods
+		include Concerns::Aliases, Concerns::Dirty
 		
+		self.connection_class  = EPlat::Connection
+		self.collection_parser = EPlat::Collection
+		self.site = "/" # this is overwritten below in initialize_singleton! when EPlat::Session is initialized
+		add_response_method :full_response
+
 		class << self
-			include Concerns::OverwriteRequestMethods
-			threadsafe_attribute :client, :mapping, :include_root_in_json, :include_format_in_path
+			include Countable
+
+			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
 			
 			def initialize_singleton!
-				self.client  = Current.e_plat_session
-
-				self.site 	 = client.base_url
-				self.prefix  = client.url_prefix
+				self.site  = client.base_url # .site is an ActiveResource method that uses the threadsafe _site attribute underneath
+				self.prefix  = client.url_prefix(klass: self) # this is overwritten below in prefix= for threadsafety
 				
 				self.timeout = 5
-				self.include_format_in_path = !client.bigcommerce?
+				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
-			
-			def find_by(title:)
-				find(:all, params: { title: title })&.first
+
+			def client
+				Current.e_plat_session
+			end
+
+
+			# monkey patch prefix= so we can add thread-local value to the generated prefix_source() method
+			def prefix=(value = "/")
+				# Replace :placeholders with '#{embedded options[:lookups]}'
+				prefix_call = value.gsub(/:\w+/) { |key| "\#{URI::DEFAULT_PARSER.escape options[#{key}].to_s}" }
+		
+				# Clear prefix parameters in case they have been cached
+				@prefix_parameters = nil
+		
+				silence_warnings do
+				  # Redefine the new methods.
+				  instance_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+					def prefix_source() 
+						client.url_prefix(klass: self) || "#{value}" 
+					end
+					def prefix(options={}) "#{prefix_call}" end
+				  RUBY_EVAL
+				end
+			rescue Exception => e
+				logger.error "Couldn't set prefix: #{e}\n  #{code}" if logger
+				raise
+			end
+
+			def exclude_from_json(read_only)
+				self.read_only = read_only
 			end
+
 			
 			private
 				
-				def mapping_instance
-					class_constant_string = element_name.capitalize
-					mapping_class_name = "EPlat::Mapping::#{ client.platform.capitalize }::V#{ client.api_version.camelize }::#{ class_constant_string }"
-					
-					EPlat::Mapping.new_instance(specifc_mapping: mapping_class_name)
-				end
+			def mapping_instance
+				mapping_class_name = "EPlat::Mapping::#{ client.platform.capitalize }::V#{ client.api_version.camelize }::#{ element_name.classify }"
+				
+				EPlat::Mapping.new_instance(specifc_mapping: mapping_class_name, resource: nil)
+			end
 				
 		end	
 		
-		
-		include Concerns::Aliases, Concerns::OverwriteInstanceMethods
-		
-		attr_accessor :client, :mapping, :mapped_attributes
+		attr_accessor :mapping, :mapped_attributes
 		
 		def initialize(attributes = {}, persisted = false)
-			self.client  = Current.e_plat_session
 			site = client.base_url
-			self.mapping = mapping_instance
 			ActiveResource::Base.include_root_in_json = client.shopify? && top_level_resource?
 
 			super
+			
+			self.mapping = mapping_instance
 
-			add_aliases!(mapping.native_attribute_aliases, schema)
-			@mapped_attributes = AttributeInterface.new(self, keys: mappable_keys)
+			@mapped_attributes = ensure_e_plat_attributes!
+			ensure_native_attributes!
+			add_aliases!(mapping.native_attribute_aliases, type_schema || {})
 		end
-		
+
+		def client
+			Current.e_plat_session
+		end
+
 		def mapped?(attribute)
 			mapped_attributes.include? attribute.to_s
 		end
 		
 		def native_keys
-			(client.shopify?) ? schema.keys : @mapping.native_attributes.presence
+			if client.shopify? 
+				schema.keys # EPlat uses Shopify's schema, so keys are always native
+			elsif mapping.class.to_s != EPlat::Mapping::Base && @mapping.native_attributes.present?
+				@mapping.native_attributes.presence
+			else
+				attributes.keys
+			end
+		end
+
+		def read_only?
+			!!self.class.read_only
+		end
+
+		def headers
+			full_response&.each_header&.to_h || {}
+		end
+
+		def include_root_in_json
+			return false unless client.shopify?
+			
+			top_level_resource?
 		end
 		
+		
 		private 
+
+			def ensure_e_plat_attributes!
+				AttributeInterface.new(self, keys: mappable_keys)
+			end
+
+			def ensure_native_attributes!
+				return if client.shopify? # EPlat uses Shopify's schema
+
+				AttributeInterface.new(self, keys: native_keys)
+			end
 			
 			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 }"
-				
-				EPlat::Mapping.new_instance(specifc_mapping: mapping_class_name)
+
+				EPlat::Mapping.new_instance(specifc_mapping: mapping_class_name, resource: self)
 			end
 			
 			def mappable_keys
 				mappable_keys = mapping.mappable_keys
 				(mappable_keys == :all) ? schema.keys : mappable_keys
 			end
+
+			def type_schema
+				return unless schema.present? && schema.values.any?{|value| value == "string" or value == "hash" }
+				schema
+			end
 			
 			def type_check!(schema)
 				schema.each{|name, type| type_attr!(name, type) }
@@ -96,10 +170,11 @@ module EPlat
 			end
 			
 			def top_level_resource?
-				[
-					"product",
-					"order"
-				].include? self.class.element_name
+				self.class.name.split("::").count <= 2
+			end
+
+			def element_name
+				self.class.element_name
 			end
 			
 	end
@@ -107,37 +182,3 @@ module EPlat
 
 end
 
-
-
-
-			
-
-
-###### api call methods
-
-### create new entry
-# product = EPlat::Product.new(:title => 't-shirt')
-# t-shirt.save
-# or... EPlat::Product.create(:title => 't-shirt')
-# new_product = product.dup #duplicates entry without saving
-
-### delete record
-# EPlat::Product.delete(params[:id])
-# EPlat::Product.find(my_id).destroy
-
-### save record
-# product = EPlat::Product.new(:title => 't-shirt')
-# product.save
-
-### get records
-# EPlat::Product.find(1) # => GET /people/1.json  (or EPlat::Product.first(args)) (or EPlat::Product.last(args))
-# EPlat::Product.find(:all) # => GET /people.json
-# EPlat::Product.find(:all, :params => { :title => "tshirt" }) # => GET /product.json?title=tshirt
-# EPlat::Product.find(:one, :from => :leader) # => GET /product/leader.json
-# EPlat::Product.find(:one, :from => "/companies/1/manager.json") # => GET /companies/1/manager.json
-
-
-#### options
-# prefix_options #for nested URLs Comment.collection_path(:post_id => 5) # => /posts/5/comments.json
-# query_options #to add to params ?x=y
-# instance.known_attributes #to return mix of schema and native attributes