e_plat 0.2.4 → 0.4.0

data/lib/e_plat/resource/metafield.rb

@@ -0,0 +1,70 @@
+module EPlat
+	class Metafield < Base
+        BIGCOMMERCE_DEFAULT_PERMISSION_SET = "read_and_sf_access"
+        READ_ONLY_ATTRIBUTES = [:created_at, :id, :updated_at, :date_created, :date_modified]
+
+        before_save :normalize_attributes
+
+        schema do
+            datetime :created_at
+            string   :description
+            integer  :id
+            string   :key
+            string   :namespace
+            integer  :owner_id
+            string   :owner_resource
+            datetime :updated_at
+            string   :value
+            string   :type
+        end
+
+        
+        def element_path(options = {})
+            raise "owner_id is not defined" unless owner_id.present?
+
+            parents_metafield_path super(options)
+        end
+
+        def collection_path(options = {})
+            raise "owner_id is not defined" unless owner_id.present?
+
+            parents_metafield_path super(options)
+        end
+
+        def normalize_attributes
+            attributes.each {|k,v| attribute_will_change!(k) if READ_ONLY_ATTRIBUTES.exclude?(k.to_sym) }
+
+            return unless client.bigcommerce?
+
+            if permission_set.nil?
+                self.permission_set = BIGCOMMERCE_DEFAULT_PERMISSION_SET 
+            end
+
+            if value?
+                self.value = value.to_s
+                self.value = "" if value == "false"
+            end
+        end
+
+        def parent_class
+            raise "owner_resource is not defined" unless owner_resource.present?
+
+            "EPlat::#{ owner_resource.classify }".constantize # e.g EPlat::Product
+        end
+
+
+        private
+
+            def parents_metafield_path(path)
+                id_suffix = id.present? ? "/#{ id }" : ""
+                uri = URI.parse(path)
+
+                uri.path = parent_class.element_path(owner_id).gsub(".json", "") + "/metafields#{ id_suffix }"
+                uri.path += ".json" if self.client.include_format_in_path?
+                uri.path.gsub!('v2', 'v3') if client.bigcommerce? # metafield uses v3 API, even though orders are only available in v2
+
+                uri.to_s
+            end
+
+    end
+end

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

@@ -0,0 +1,8 @@
+
+module EPlat
+	class Order::Consignment < Base
+		belongs_to :order, class_name: "EPlat::Order"
+		exclude_from_json true
+	end
+end
+		

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

@@ -0,0 +1,6 @@
+
+module EPlat
+	class Order::BillingAddress < Order::ShippingAddress; end
+end
+
+

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

@@ -1,6 +1,7 @@
 
 module EPlat
 	class Order::Fulfillment < Base
+		belongs_to :order, class_name: "EPlat::Order"
 		
 		schema do
 			string 	:created_at

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

@@ -1,6 +1,7 @@
 
 module EPlat
 	class Order::LineItem < Base
+		belongs_to :order, class_name: "EPlat::Order"
 		
 		schema do
 		  integer 	:id

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

@@ -0,0 +1,44 @@
+
+module EPlat
+	class Order::ShippingAddress < Base
+		belongs_to :order, class_name: "EPlat::Order" # only include if belongs_to is needed
+
+        schema do
+            string :address1
+            string :address2
+            string :city
+            string :company
+            string :country
+            string :first_name
+            string :last_name
+            string :latitude
+            string :longitude
+            string :phone
+            string :province
+            string :zip
+            string :name
+            string :country_code
+            string :province_code
+        end
+
+    end
+end
+
+
+# "shipping_address": {
+#     "address1": "123 Amoebobacterieae St",
+#     "address2": "",
+#     "city": "Ottawa",
+#     "company": null,
+#     "country": "Canada",
+#     "first_name": "Bob",
+#     "last_name": "Bobsen",
+#     "latitude": "45.41634",
+#     "longitude": "-75.6868",
+#     "phone": "555-625-1199",
+#     "province": "Ontario",
+#     "zip": "K2P0V6",
+#     "name": "Bob Bobsen",
+#     "country_code": "CA",
+#     "province_code": "ON"
+#   },

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

@@ -1,22 +1,23 @@
 
 module EPlat
 	class Order::ShippingLine < Base
+		belongs_to :order, class_name: "EPlat::Order"
 
 		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
+			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

data/lib/e_plat/resource/order.rb

@@ -1,8 +1,12 @@
 
 module EPlat
 	class Order < Base
+		has_many :line_items, class_name: "EPlat::Order::LineItem"
+
+		include Concerns::Metafieldable
 		
 		schema do
+			integer	  :id
 			integer   :app_id
 			string    :billing_address_address1
 			string    :billing_address_address2
@@ -99,6 +103,34 @@ module EPlat
 			array     :shipping_lines
 		end
 
+		def cancel(options = {})
+			if client.bigcommerce?
+				self.status_id = 5
+				save
+			else
+				load_attributes_from_response(post(:cancel, {}, options.to_json))
+			end
+		end
+
+		def cancelled?
+			case client.platform
+			when :shopify
+				cancelled_at.present?
+			when :bigcommerce
+				status_id == 5
+			end
+		end
+
+		# abstract to class method call
+		# def consignments=(consignment_data)
+		# 	@consignments = consignment_data.map do |consignment_attrs|
+		# 		EPlat::Order::LineItem.new(consignment_attrs) 
+		# 	end
+		# end
+
+		# alias is virtual interfact, so it can pick and push from/to the various native interfaces, whether nested or not
+
 	end
 end
 		
+

data/lib/e_plat/resource/paginated/link_headers.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module EPlat
+	module Paginated
+		class LinkHeaders
+			LinkHeader = Struct.new(:url, :rel)
+			attr_reader :previous_link, :next_link
+
+			def initialize(link_header)
+				links = parse_link_header(link_header)
+
+				@previous_link = links.find { |link| link.rel == :previous }
+				@next_link 	   = links.find { |link| link.rel == :next }
+			end
+
+			
+			private
+
+			def parse_link_header(link_header)
+				return [] unless link_header.present?
+
+				links = link_header[0].split(',')
+				links.map do |link|
+					parts = link.split('; ')
+
+					unless parts.length == 2
+					raise "Invalid link header: url and rel expected"
+					end
+			
+					url = parts[0][/<(.*)>/, 1]
+					rel = parts[1][/rel="(.*)"/, 1]&.to_sym
+			
+					url = URI.parse(url).request_uri
+					LinkHeader.new(url, rel)
+				end
+			end
+			
+		end
+	end
+end

data/lib/e_plat/resource/paginated/link_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module EPlat
+	module Paginated
+		class LinkParams
+			LinkParam = Struct.new(:rel, :url)
+			attr_reader :previous_link, :next_link
+
+			def initialize(link_params) #{"next"=>"?include=variants%2Cimages&limit=2&page=2", "current"=>"?include=variants%2Cimages&limit=2&page=1"}
+				links = link_params.map do |key, value|
+					if key == "next"
+						LinkParam.new(rel: key.to_sym, url: value)
+					else key == "previous"
+						LinkParam.new(rel: key.to_sym, url: value)
+					end
+				end
+
+				@previous_link = links.find { |link| link.rel == :previous }
+				@next_link 	   = links.find { |link| link.rel == :next }
+			end
+
+		end
+	end
+end

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

@@ -2,6 +2,7 @@
 module EPlat
 	class Product
 		class Image < Base
+			belongs_to :product, class_name: "EPlat::Product"
 			
 			class << self
 			end	
@@ -19,6 +20,11 @@ module EPlat
 				array :variant_ids
 				string :admin_graphql_api_id
 			end
+
+			def save
+				prefix_options[:product] ||= product.id
+				super
+			end
 			
 		end
 	end

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

@@ -2,6 +2,7 @@
 module EPlat
 	class Product
 		class Option < Base
+			belongs_to :product, class_name: "EPlat::Product"
 			
 			schema do
 				integer :id

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

@@ -1,11 +1,11 @@
-
 module EPlat
 	class Product
 		class Variant < Base
-			
+			belongs_to :product, class_name: "EPlat::Product"
+
 			class << self
 			end
-			
+
 			schema do
 				integer :id
 				integer :product_id
@@ -35,17 +35,13 @@ module EPlat
 				string :tax_code
 				boolean :requires_shipping
 				string :admin_graphql_api_id
-				
-				hash :e_plat_option_hash
 			end
-			
-			
-			def testing
-				puts "Im just testing"
+
+			def save
+				prefix_options[:product] ||= product.id
+				super
 			end
-			
+
 		end
 	end
 end
-
-

data/lib/e_plat/resource/product.rb

@@ -1,7 +1,9 @@
 module EPlat
 	class Product < Base
-		has_many :variant, class_name: "EPlat::Product::Variant"
-		has_many :image,   class_name: "EPlat::Product::Image"
+		has_many :variants, class_name: "EPlat::Product::Variant"
+		has_many :images,   class_name: "EPlat::Product::Image"
+
+		include Concerns::Metafieldable
 		
 		schema do
 			string 		:body_html
@@ -30,6 +32,10 @@ module EPlat
 		def status
 			super || "active"
 		end
+
+		def find_variant(id)
+			variants.find { |v| v.id && v.id.to_i == id.to_i }
+		end
 		
 	end
 end

data/lib/e_plat/resource/script_tag.rb

@@ -0,0 +1,56 @@
+
+module EPlat
+    class ScriptTag < Base
+
+        schema do
+            datetime :created_at
+            datetime :updated_at
+            string   :event
+            integer  :id
+            string   :src
+            string   :display_scope
+            boolean  :cache
+        end
+
+        def to_param  
+            if client.bigcommerce?
+                uuid && uuid.to_s
+            else
+                super
+            end
+        end
+
+        def self.element_path(id, prefix_options = {}, query_options = nil)
+            if client.bigcommerce?
+                super(id, prefix_options, query_options).gsub("script_tags", "scripts")
+            else
+                super(id, prefix_options, query_options)
+            end
+        end
+
+        def self.collection_path(prefix_options = {}, query_options = nil)
+            if client.bigcommerce?
+                super(prefix_options, query_options).gsub("script_tags", "scripts")
+            else
+                super(prefix_options, query_options)
+            end
+        end
+
+        def element_path(options = {})
+            if client.bigcommerce?
+                super(options).gsub("script_tags", "scripts")
+            else
+                super(options)
+            end
+        end
+
+        def collection_path(options = {})
+            if client.bigcommerce?
+                super(options).gsub("script_tags", "scripts")
+            else
+                super(options)
+            end
+        end
+
+    end
+end

data/lib/e_plat/resource/shop.rb

@@ -1,6 +1,23 @@
 
 module EPlat
 	class Shop < Base
+
+		class << self
+
+			# Need to override for BigCommerce, since it doesn't have a /shop endpoint
+			# Is threadsafe as the path is determined and used all within this method
+			def find_single(scope, options) 
+				prefix_options, query_options = split_options(options[:params])
+				path = (client.bigcommerce?) ? "/stores/#{ client.store_hash }/v2/store.json" : "#{ client.url_prefix }shop.json"
+				
+				instantiate_record(format.decode(connection.get(path, headers).body), prefix_options)
+			end
+			
+			def current
+				find(1)
+			end
+		end
+
 		
 		schema do
 			integer	 	:id
@@ -62,18 +79,5 @@ module EPlat
 			boolean		:marketing_sms_consent_enabled_at_checkout
 		end
 		
-		class << self
-			
-			def element_path(id, prefix_options = {}, query_options = {})
-				"#{ e_plat_session.url_prefix }shop.json"
-			end
-
-			
-			def current
-				find(1)
-			end
-			
-		end
-		
 	end
 end

data/lib/e_plat/resource/shopify_only/recurring_application_charge/usage_charge.rb

@@ -0,0 +1,32 @@
+
+module EPlat
+	class RecurringApplicationCharge
+		class UsageCharge < Base
+			belongs_to :recurring_application_charge, class_name: "EPlat::RecurringApplicationCharge"
+
+			schema do
+				datetime :created_at
+				string :description
+				integer :id
+				string :price
+				integer :recurring_application_charge_id
+				datetime :updated_at
+				string :currency
+			end
+
+			def element_path(options = {})
+				options['recurring_application_charge'] = recurring_application_charge_id
+	
+				super(options)
+			end
+	
+			def collection_path(options = {})
+				options['recurring_application_charge'] = recurring_application_charge_id
+	
+				super(options)
+			end
+		
+
+		end
+	end
+end

data/lib/e_plat/resource/shopify_only/recurring_application_charge.rb

@@ -0,0 +1,47 @@
+module EPlat
+    class RecurringApplicationCharge < Base
+        has_many :usage_charges, class_name: "EPlat::RecurringApplicationCharge::UsageCharge"
+  
+		schema do
+			datetime :activated_on
+			datetime :cancelled_on
+			string :capped_amount
+			string :confirmation_url
+			datetime :created_at
+			integer :id
+			string :name
+			string :price
+			string :return_url
+			string :status # pending | active | declined | expired | frozen | cancelled
+			string :terms
+			boolean :test
+			integer :trial_days
+			datetime :trial_ends_on
+			datetime :updated_at
+			string :currency
+		end
+
+		def self.current
+			(all || []).find { |c| c.status == 'active' }
+		end
+
+		def save
+			if new_record?
+				super
+			else
+				load_attributes_from_response(
+					put(:customize, {}, to_json)
+				)
+			end
+		end
+
+		def cancel
+			self.destroy
+		end
+
+		def usage_charges
+			RecurringApplicationCharge::UsageCharge.find(:all, params: {recurring_application_charge: id})
+		end
+	  
+	end
+end

data/lib/e_plat/resource/webhook.rb

@@ -0,0 +1,50 @@
+module EPlat
+    class Webhook < Base
+
+        schema do
+            string   :address
+            string   :api_version
+            datetime :created_at
+            array    :fields
+            string   :format
+            integer  :id
+            array    :metafield_namespaces
+            array    :private_metafield_namespaces
+            string   :topic
+            datetime :updated_at
+        end
+
+        def self.element_path(id, prefix_options = {}, query_options = nil)
+            if client.bigcommerce?
+                super(id, prefix_options, query_options).gsub("webhooks", "hooks")
+            else
+                super(id, prefix_options, query_options)
+            end
+        end
+
+        def self.collection_path(prefix_options = {}, query_options = nil)
+            if client.bigcommerce?
+                super(prefix_options, query_options).gsub("webhooks", "hooks")
+            else
+                super(prefix_options, query_options)
+            end
+        end
+
+        def element_path(options = {})
+            if client.bigcommerce?
+                super(options).gsub("webhooks", "hooks")
+            else
+                super(options)
+            end
+        end
+
+        def collection_path(options = {})
+            if client.bigcommerce?
+                super(options).gsub("webhooks", "hooks")
+            else
+                super(options)
+            end
+        end
+
+    end
+end

data/lib/e_plat/session.rb

@@ -1,20 +1,20 @@
 
 module EPlat
 	class Session
-		include Dry::Effects.State(:e_plat_session)
-		#the session is an instance of EPlat::Client made available via dry-effects
-		# e_plat_session is an instance of EPlat::Client
-		
-		
-	  	def initialize(platform:, store_url:, api_token:, store_hash: nil)
-			e_plat_session.platform   = platform
-			e_plat_session.store_url  = store_url
-			e_plat_session.api_token  = api_token
-			e_plat_session.store_hash = store_hash
-			
-			e_plat_session.send(:get_api_version) if e_plat_session.active?
-	  	end
+		#the session is an instance of EPlat::Client made available via Rails Current::Attributes
+
+		def initialize(platform:, store_url:, api_token:, store_hash: nil)
+			Current.e_plat_session = EPlat::Client.new(
+				platform: platform,
+				store_url: store_url,
+				api_token: api_token,
+				store_hash: store_hash
+			).freeze
+		end
+
+		def self.clear!
+			Current.e_plat_session = nil
+		end
 		 
-		  
 	end
 end