e_plat 0.2.0

data/lib/e_plat/resource/base.rb

@@ -0,0 +1,145 @@
+
+
+module EPlat
+	class Base < ActiveResource::Base
+		
+		class << self
+			include Dry::Effects.State(:e_plat_session)
+			include Concerns::OverwriteRequestMethods
+			threadsafe_attribute :client, :mapping, :include_root_in_json, :include_format_in_path
+			
+			def initialize_singleton!
+				self.client  = e_plat_session
+
+				self.site 	 = client.base_url
+				self.prefix  = client.url_prefix
+				
+				self.timeout = 5
+				self.include_format_in_path = !client.bigcommerce?
+				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
+			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
+				
+		end	
+		
+		
+		include Dry::Effects.State(:e_plat_session)
+		include Concerns::Aliases, Concerns::OverwriteInstanceMethods
+		
+		attr_accessor :client, :mapping, :mapped_attributes
+		
+		def initialize(attributes = {}, persisted = false)
+			self.client  = e_plat_session
+			site = client.base_url
+			self.mapping = mapping_instance
+			ActiveResource::Base.include_root_in_json = client.shopify? && top_level_resource?
+
+			super
+
+			add_aliases!(mapping.native_attribute_aliases, schema)
+			@mapped_attributes = AttributeInterface.new(self, keys: mappable_keys)
+		end
+		
+		def mapped?(attribute)
+			mapped_attributes.include? attribute.to_s
+		end
+		
+		def native_keys
+			(client.shopify?) ? schema.keys : @mapping.native_attributes.presence
+		end
+		
+		private 
+			
+			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)
+			end
+			
+			def mappable_keys
+				mappable_keys = mapping.mappable_keys
+				(mappable_keys == :all) ? schema.keys : mappable_keys
+			end
+			
+			def type_check!(schema)
+				schema.each{|name, type| type_attr!(name, type) }
+			end
+			
+			def type_attr!(name, type) 
+				current_value = attributes.send(:[], name) || self.send(name.to_sym)
+				return if current_value.nil? and !(type == "array" or type == "hash")
+				
+				typed_value = 
+					case type
+					when "datetime"
+						current_value.to_datetime
+					when "boolean"
+						current_value? 
+					else
+						"EPlat::Types::Coercible::#{ type.capitalize }".constantize[current_value]
+					end
+								
+				self.send("#{name}=", typed_value)
+			end
+			
+			def top_level_resource?
+				[
+					"product",
+					"order"
+				].include? self.class.element_name
+			end
+			
+	end
+
+
+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

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

@@ -0,0 +1,100 @@
+
+module EPlat
+	module Concerns
+		module Aliases
+			extend ActiveSupport::Concern
+			attr_accessor :type_coercer
+		 				
+			def add_aliases!(aliases, type_schema)
+				@type_coercer = EPlat::TypeCoercer.new(type_schema)
+				processed = []
+
+				aliases.each do |action|
+					action_name = action.keys.first
+					args 		= action.values.first
+					e_plat_key	= args[:e_plat_key]
+					native_key	= args[:native_key]
+					
+					case action_name
+					when :alias_attribute
+						add_to_instance! alias_mapped_getter(e_plat_key, native_key, proc: args[:custom_e_plat_getter])
+						add_to_instance! alias_mapped_setter(e_plat_key, native_key, proc: args[:custom_native_setter])
+						processed << e_plat_key
+					end
+				end
+				
+				type_schema.each do |e_plat_key, type|
+					next if processed.include?(e_plat_key)
+					add_to_instance! mapped_getter(e_plat_key)
+				end
+
+			end
+			
+			
+			private 
+
+			
+				def alias_mapped_getter(e_plat_key, native_key, proc: nil)
+					proc_line = (proc) ? "current_value = #{ proc.strip }.call(current_value)" : nil
+					
+					<<-STRING
+						def #{ e_plat_key }
+							current_value = self.attributes['#{ native_key }']
+							#{ proc_line }
+							type_coercer.type_value!('#{ e_plat_key }', current_value)
+						end
+					STRING
+				end
+				
+				def alias_mapped_setter(e_plat_key, native_key, proc: nil)
+					proc_line = (proc) ? "new_value = #{ proc.strip }.call(new_value)" : nil
+					
+					<<-STRING
+						def #{ e_plat_key }=(value)
+							new_value = value
+							#{proc_line}
+							self.attributes['#{ native_key }'] = new_value
+						end
+					STRING
+				end
+				
+				def mapped_getter(e_plat_key)
+					<<-STRING
+						def #{ e_plat_key }
+							type_coercer.type_value!('#{ e_plat_key }', self.attributes['#{ e_plat_key }'])
+						end
+					STRING
+				end
+
+				def add_to_instance!(meta_programming_string)
+					self.instance_eval { eval meta_programming_string }
+				end
+			
+			
+	
+			# Requires an array of hashes which each contain a single :alias_attribute entry. 
+			# This will expose e_plat_key getter and setter methods that interact with the 
+			# native_key attribute.
+
+			# This pattern allows us to interact with the resource via the same universal e_plat interface, whatever the platform.
+			# Then when it's time to make a save back to the platform, the native attributes are already ready.
+			# 
+			# Like the below example, optional stringified procs can be passed in to respect the e_plat or native interfaces version of the value. e.g. enums
+			# 
+			# {
+			# 	alias_attribute: {native_key: "name", e_plat_key: "handle"}	
+			# },
+			# {
+			# 	alias_attribute: {native_key: 	"availability", e_plat_key: "status", 
+			# 		custom_e_plat_getter: "-> (value) { 
+			# 			{'preorder'=>'active', 'available' => 'active', 'disabled' => 'draft'}[value] || value
+			# 		}",
+			# 		custom_native_setter: "-> (value) { 
+			# 			{'available' => 'active', 'disabled' => 'draft'}.invert[value] || value
+			# 		}" #invert will merge new duped keys
+			# 	}
+			# }
+			
+		end
+	end
+end

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

@@ -0,0 +1,11 @@
+module EPlat
+	module Concerns
+		module OverwriteInstanceMethods	
+			
+			def include_root_in_json
+				client.shopify? && top_level_resource?
+			end
+			
+		end
+	end
+end

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

@@ -0,0 +1,50 @@
+module EPlat
+	module Concerns
+		module OverwriteRequestMethods	
+			
+			def find(*arguments)
+				initialize_singleton!
+				arguments.second[:params].merge!(client.send "#{element_name}_default_find_args")  if arguments.second
+				arguments.second[:params].merge!(mapping.to_native_keys arguments.second[:params]) if arguments.second
+				
+				super
+			end
+			
+			def instantiate_collection(collection, original_params = {}, prefix_options = {})
+				collection = collection["data"] if collection.is_a?(Hash) && collection["data"].present?
+				
+				super
+			end
+			
+			def new(attributes, persisted=false)
+				initialize_singleton!
+				self.mapping = EPlat::Mapping.new_instance(specifc_mapping: specifc_mapping_name)
+				
+				attributes = attributes.send( *top_key_method(mapping.native_top_key) ) if attributes[mapping.native_top_key]
+				super
+			end
+			
+			def create(attributes = {})
+				initialize_singleton!
+				super
+			end
+			
+			def include_root_in_json
+				client.shopify? && top_level_resource?
+			end
+			
+			
+			private
+				
+				def top_key_method(top_key)
+					(top_key == :itself) ? top_key : [:[], top_key]
+				end
+				
+				def specifc_mapping_name
+					class_constant_string = self.name.gsub("EPlat::", "")
+					"EPlat::Mapping::#{ client.platform.capitalize }::V#{ client.api_version.camelize }::#{ class_constant_string }"
+				end
+			
+		end
+	end
+end

data/lib/e_plat/resource/order/customer.rb

@@ -0,0 +1,37 @@
+
+module EPlat
+	class Order::Customer < Base
+		
+		schema do
+			array 		:addresses, item_type: :hash
+			string 	  	:currency
+			date_time 	:created_at
+			hash 		:default_address
+			string 		:email
+			hash 		:email_marketing_consent
+			string 		:first_name
+			integer 	:id
+			string 		:last_name
+			integer 	:last_order_id
+			string 		:last_order_name
+			hash 		:metafield
+			string 		:marketing_opt_in_level
+			string 		:multipass_identifier
+			string 		:note
+			integer 	:orders_count
+			string 		:password
+			string 		:password_confirmation
+			string 		:phone
+			hash 		:sms_marketing_consent
+			string 		:state
+			string 		:tags
+			boolean 	:tax_exempt
+			array 		:tax_exemptions
+			decimal 	:total_spent
+			date_time 	:updated_at
+			boolean 	:verified_email
+		end
+		
+	end
+end
+		

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

@@ -0,0 +1,27 @@
+
+module EPlat
+	class Order::Fulfillment < Base
+		
+		schema do
+			string 	:created_at
+			integer :id
+			array 	:line_items
+			integer :location_id
+			string 	:name
+			boolean :notify_customer
+			integer :order_id
+			array 	:origin_address
+			hash 	:receipt
+			string 	:service
+			string 	:shipment_status
+			string 	:status
+			string 	:tracking_company
+			array 	:tracking_numbers
+			array 	:tracking_urls
+			string 	:updated_at
+			string 	:variant_inventory_management
+		end
+		
+	end
+end
+		

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

@@ -0,0 +1,37 @@
+
+module EPlat
+	class Order::LineItem < Base
+		
+		schema do
+		  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
+		end
+		
+	end
+end
+		

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

@@ -0,0 +1,24 @@
+
+module EPlat
+	class Order::ShippingLine < Base
+
+		schema do
+			integer	 	:id
+			string 		:carrier_identifier
+			string 		:code
+			string 		:delivery_category
+			string 		:discounted_price
+			hash 		:discounted_price_set
+			string 		:phone
+			string 		:price
+			hash		:price_set
+			integer		:requested_fulfillment_service_id
+			string		:source
+			string		:title
+			array		:tax_lines
+			array		:discount_allocations
+		end
+		
+	end
+end
+		

data/lib/e_plat/resource/order.rb

@@ -0,0 +1,103 @@
+
+module EPlat
+	class Order < Base
+		
+		schema do
+			integer   :app_id
+			string    :billing_address_address1
+			string    :billing_address_address2
+			string    :billing_address_city
+			string    :billing_address_company
+			string    :billing_address_country
+			string    :billing_address_first_name
+			string    :billing_address_last_name
+			string    :billing_address_phone
+			string    :billing_address_province
+			string    :billing_address_zip
+			string    :billing_address_name
+			string    :billing_address_province_code
+			string    :billing_address_country_code
+			string    :billing_address_latitude
+			string    :billing_address_longitude
+			string    :browser_ip
+			boolean   :buyer_accepts_marketing
+			string    :cancel_reason
+			datetime  :cancelled_at
+			string    :cart_token
+			string    :checkout_token
+			hash      :client_details
+			datetime  :closed_at
+			datetime  :created_at
+			string    :currency
+			string    :current_total_discounts
+			hash      :current_total_discounts_set
+			hash      :current_total_duties_set
+			string    :current_total_price
+			hash      :current_total_price_set
+			string    :current_subtotal_price
+			hash      :current_subtotal_price_set
+			string    :current_total_tax
+			hash      :current_total_tax_set
+			string    :customer_locale
+			integer   :device_id
+			array     :discount_codes
+			string    :email
+			boolean   :estimated_taxes
+			string    :financial_status
+			string    :fulfillment_status
+			string    :gateway
+			string    :landing_site
+			string    :landing_site_ref
+			integer   :location_id
+			integer   :merchant_of_record_app_id
+			string    :name
+			string    :note
+			array     :note_attributes
+			integer   :number
+			integer   :order_number
+			string    :order_status_url
+			hash      :original_total_duties_set
+			array     :payment_gateway_names
+			string    :phone
+			string    :presentment_currency
+			string    :processed_at
+			string    :processing_method
+			string    :reference
+			string    :referring_site
+			string    :source_identifier
+			string    :source_name
+			string    :source_url
+			string    :subtotal_price
+			hash      :subtotal_price_set
+			string    :tags
+			array     :tax_lines
+			boolean   :taxes_included
+			boolean   :test
+			string    :token
+			string    :total_discounts
+			hash      :total_discounts_set
+			string    :total_line_items_price
+			hash      :total_line_items_price_set
+			string    :total_outstanding
+			string    :total_price
+			hash      :total_price_set
+			hash      :total_shipping_price_set
+			string    :total_tax
+			hash      :total_tax_set
+			string    :total_tip_received
+			integer   :total_weight
+			datetime  :updated_at
+			hash      :billing_address
+			hash      :customer
+			array     :discount_applications
+			array     :fulfillments
+			array     :line_items
+			hash      :payment_details
+			hash      :payment_terms
+			array     :refunds
+			hash      :shipping_address
+			array     :shipping_lines
+		end
+		
+end
+		

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

@@ -0,0 +1,25 @@
+
+module EPlat
+	class Product
+		class Image < Base
+			
+			class << self
+			end	
+
+			schema do
+				integer :id
+				integer :product_id
+				integer :position
+				datetime :created_at
+				datetime :updated_at
+				string :alt
+				integer :width
+				integer :height
+				string :src
+				array :variant_ids
+				string :admin_graphql_api_id
+			end
+			
+		end
+	end
+end

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

@@ -0,0 +1,16 @@
+
+module EPlat
+	class Product
+		class Option < Base
+			
+			schema do
+				integer :id
+				integer :product_id
+				string :name
+				integer :position
+				array :values
+			end
+			
+		end
+	end
+end

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

@@ -0,0 +1,51 @@
+
+module EPlat
+	class Product
+		class Variant < Base
+			
+			class << self
+			end
+			
+			schema do
+				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
+				string :option1
+				string :option2
+				string :option3
+				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
+				integer :old_inventory_quantity
+				array :presentment_prices 
+				string :tax_code
+				boolean :requires_shipping
+				string :admin_graphql_api_id
+				
+				hash :e_plat_option_hash
+			end
+			
+			
+			def testing
+				puts "Im just testing"
+			end
+			
+		end
+	end
+end
+
+

data/lib/e_plat/resource/product.rb

@@ -0,0 +1,35 @@
+module EPlat
+	class Product < Base
+		has_many :variant, class_name: "EPlat::Product::Variant"
+		has_many :image,   class_name: "EPlat::Product::Image"
+		
+		schema do
+			string 		:body_html
+			datetime 	:created_at
+			string 		:handle
+			integer	 	:id
+			array 		:images
+			array 		:options
+			string 		:product_type
+			datetime 	:published_at
+			string 		:published_scope
+			string 		:status
+			string 		:tags
+			string 		:admin_graphql_api_id
+			string		:template_suffix
+			string		:title
+			datetime	:updated_at
+			array 		:variants
+			string		:vendor
+		end
+		
+		def handle
+			super&.parameterize
+		end
+
+		def status
+			super || "active"
+		end
+		
+	end
+end