e_plat 0.2.4 → 0.4.0

data/lib/active_resource/connection_error.rb

@@ -0,0 +1,29 @@
+
+module ActiveResource
+    class ConnectionError
+
+        def to_s
+            super << " - #{body_message}"
+        rescue
+            super
+        end
+
+        private
+
+        def body_message
+            return '' unless response&.body
+            body = JSON.parse(response.body)
+
+            case body
+            when Hash
+                body['message'] || body['error'] || body.inspect
+            when Array
+                body.first['message']
+            else
+                ''
+            end
+        end
+
+    end
+
+end

data/lib/active_resource/formats.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ActiveResource
+	module Formats
+	  autoload :XmlFormat, "active_resource/formats/xml_format"
+	  autoload :JsonFormat, "active_resource/formats/json_format"
+  
+		# Lookup the format class from a mime type reference symbol. Example:
+		#
+		#   ActiveResource::Formats[:xml]  # => ActiveResource::Formats::XmlFormat
+		#   ActiveResource::Formats[:json] # => ActiveResource::Formats::JsonFormat
+		def self.[](mime_type_reference)
+			ActiveResource::Formats.const_get(ActiveSupport::Inflector.camelize(mime_type_reference.to_s) + "Format")
+		end
+  
+		def self.remove_root(data)
+			if data.is_a?(Hash) && data.keys.size <= 2 && data.values.first.is_a?(Enumerable) #bigcommerce returns {data:{}, meta:{}}, so we need to increase keys.size check to 2
+				data.values.first
+			else
+				data
+			end
+		end
+
+
+	end
+end
+  

data/lib/current.rb

@@ -0,0 +1,7 @@
+class Current < ActiveSupport::CurrentAttributes
+    attribute :e_plat_session
+
+    def e_plat_session
+        super || raise("EPlat session has not been initialized.")
+    end
+end

data/lib/e_plat/client/default_request_args.rb

@@ -4,20 +4,44 @@ module EPlat
 		module DefaultRequestArgs
 			extend ActiveSupport::Concern
 			
-			def product_default_find_args
+			def product_default_request_args
 				case platform
 				when :shopify
 					{}
 				when :bigcommerce
 					{
-						"include" => ["variants", "images"]
+						"include" => "variants,images"
 					}
 				when :woocommerce
 					{}
 				end
 			end
+
+			def variant_default_request_args
+				case platform
+				when :shopify
+					{}
+				when :bigcommerce
+					{}
+				when :woocommerce
+					{}
+				end
+			end
 			
-			def order_default_find_args
+			def order_default_request_args
+				case platform
+				when :shopify
+					{}
+				when :bigcommerce
+					{
+						"include" => "consignments.line_items"
+					}
+				when :woocommerce
+					{}
+				end
+			end
+
+			def metafield_default_request_args
 				case platform
 				when :shopify
 					{}

data/lib/e_plat/client.rb

@@ -1,95 +1,122 @@
 # frozen_string_literal: true
 
 module EPlat
-  class Client 
-    include Client::PlatformConvenienceMethods, Client::DefaultRequestArgs
-    
-    attr_accessor :platform, :store_url, :api_token, :api_version, :store_hash
+	class Client 
+		include Client::PlatformConvenienceMethods, Client::DefaultRequestArgs
 
-    def initialize(platform: nil, store_url: nil, api_token: nil, store_hash: nil)      
-      @platform, @store_url, @api_token, @store_hash = platform&.to_sym, store_url, api_token, store_hash
-      get_api_version
-    end
+		SHOPIFY_PAGINATION_PARAM 	 = "page_info"
+		BIGCOMMERCE_PAGINATION_PARAM = "page"
+		
+		attr_reader :platform, :store_url, :api_token, :api_version, :store_hash
 
-    def headers
-      platform_headers
-    end
-    
-    def inspect
-      "#<#{self.class} platform=#{platform.inspect} store_url=#{store_url.inspect} api_version=#{api_version.inspect}>"
-    end
-    
-    def inactive?
-      !valid?
-    end
-    
-    def active?
-      valid?
-    end
+		def initialize(platform: nil, store_url: nil, api_token: nil, store_hash: nil)      
+			@platform, @store_url, @api_token, @store_hash = platform&.to_sym, store_url, api_token, store_hash
+		end
 
-    def valid?
-      platform.present? && store_url.present? && api_token.present? 
-    end
-    
-    def clear!
-      self.platform = nil
-    end
-    
-    def base_url 
-      case platform
-      when :shopify
-        "https://#{ store_url }"
-      when :bigcommerce
-        "https://api.bigcommerce.com"
-      when :woocommerce
-        "/"
-      end
-    end
-    
-    def url_prefix
-      case platform
-      when :shopify
-        "/admin/api/#{ api_version.dasherize }/"
-      when :bigcommerce
-        "/stores/#{ store_hash }/v#{ api_version }/catalog/"
-      when :woocommerce
-        "/"
-      end
-    end
-  
-    def platform_headers
-      case platform
-      when :shopify
-        {
-          "Content-Type" => "application/json",
-          "X-Shopify-Access-Token" => api_token
-        }
-      when :bigcommerce
-        {
-          "Content-Type" => "application/json",
-          "X-Auth-Token" => api_token,
-          "host" => "api.bigcommerce.com"
-        }
-      when :woocommerce
-        {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{ api_token }"
-        }
-      end
-    end
-    
-    def get_api_version
-      self.api_version = 
-        case platform
-        when :shopify
-          EPlat.config.shopify_api_version
-        when :bigcommerce
-          EPlat.config.bigcommerce_api_version
-        when :woocommerce
-          EPlat.config.woocommerce_api_version
-        end
-    end
+		def headers
+			platform_headers
+		end
+		
+		def inspect
+			"#<#{self.class} platform=#{platform.inspect} store_url=#{store_url.inspect} api_version=#{api_version.inspect}>"
+		end
 
-      
-  end
+		def valid?
+			platform.present? && store_url.present? && api_token.present? 
+		end
+		
+		def clear!
+			self.platform = nil
+		end
+		
+		def base_url 
+			case platform
+			when :shopify
+				"https://#{ store_url }"
+			when :bigcommerce
+				"https://api.bigcommerce.com"
+			when :woocommerce
+				"/"
+			end
+		end
+		
+		def url_prefix(klass: nil)
+			# for nested resources like "/products/:product/variants/:id"
+			collection_path = 
+				if klass.to_s.scan("::").length == 2
+					parent_klass = klass.to_s.split("::")[1].underscore
+					"#{ parent_klass.pluralize }/:#{ parent_klass }/"
+				else
+					nil
+				end
+			
+			return "/stores/#{ store_hash }/v2/#{ collection_path }" if bigcommerce? && klass == EPlat::Order
+			return "/stores/#{ store_hash }/v3/content/"	       	 if bigcommerce? && klass == EPlat::ScriptTag
+			return "/stores/#{ store_hash }/v3/"	       	 	 	 if bigcommerce? && klass == EPlat::Webhook
+
+			case platform
+			when :shopify
+				"/admin/api/#{ api_version.dasherize }/#{ collection_path }"
+			when :bigcommerce
+				"/stores/#{ store_hash }/v#{ api_version }/catalog/#{ collection_path }"
+			when :woocommerce
+				"/" # not yet supported
+			end
+		end
+	
+		def platform_headers
+			case platform
+			when :shopify
+				{
+					"Content-Type" => "application/json",
+					"X-Shopify-Access-Token" => api_token
+				}
+			when :bigcommerce
+				{
+					"Content-Type" => "application/json",
+					"Accept" => "application/json",
+					"X-Auth-Token" => api_token,
+					"host" => "api.bigcommerce.com"
+				}
+			when :woocommerce
+				{
+					"Content-Type" => "application/json",
+					"Authorization" => "Bearer #{ api_token }"
+				}
+			end
+		end
+		
+		def api_version
+			case platform
+			when :shopify
+				EPlat.config.shopify_api_version
+			when :bigcommerce
+				EPlat.config.bigcommerce_api_version
+			when :woocommerce
+				EPlat.config.woocommerce_api_version
+			end
+		end
+
+		def can_update_nested_resources?
+				case platform
+				when :shopify     then true
+				when :bigcommerce then false
+				else false
+				end
+		end
+
+		def pagination_param
+			case platform
+			when :shopify     then SHOPIFY_PAGINATION_PARAM
+			when :bigcommerce then BIGCOMMERCE_PAGINATION_PARAM
+			when :woocommerce then nil
+			end
+		end
+
+		def include_format_in_path?
+			!bigcommerce?
+		end
+
+			
+	end
 end

data/lib/e_plat/connection.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module EPlat
+    class Connection < ActiveResource::Connection; end
+end

data/lib/e_plat/errors/missing_session_error.rb

@@ -1,7 +1,7 @@
 
 module EPlat
 	class MissingSessionError < StandardError
-		def initialize(msg="Missing session state, did you include EPlat::SessionState in your ApplicationController?")
+		def initialize(msg="Missing session state, did you set EPlat::Session")
 			super
 		end
 	end

data/lib/e_plat/mapping/base.rb

@@ -1,7 +1,43 @@
 module EPlat
 	class Mapping
 		class Base
+			include RequestBodyRoot
+			attr_accessor :resource, :virtual_collection
+
+			DEFAULT_VALUES = {} # {location: "head", auto_uninstall: true, ...}
 			
+			class << self
+				attr_accessor :virtual_collections
+
+				# virtual_collection :line_items, class: EPlat::Mapping::VirtualCollection::Bigcommerce::OrderLineItems, map_from: "consignments"
+				def virtual_collection(name, **options)
+					self.virtual_collections ||= []
+
+					self.virtual_collections.push({
+						name: name,
+						class: options[:class],
+						map_from: options[:map_from]
+					})
+
+					define_method("init_#{name}") do |resource:, map_from:|
+						instance_variable_set "@#{name}", "#{ options[:class] }".constantize.new(resource: resource, map_from: map_from)
+					end
+				end
+			end
+
+
+			def initialize(resource_instance)
+				@resource = resource_instance
+
+				init_virtual_collections if @resource.present?
+			end
+
+			def inspect
+				"#<#{self.class} #{ self.instance_variable_names.join(' ') }>"
+			end
+
+			# The below three methods are added to via the individual mapping classes
+
 			def native_top_key
 				:itself # or top key of JSON response e.g. "data", "product", 
 			end
@@ -14,36 +50,107 @@ module EPlat
 				[
 					# {
 					# 	alias_attribute: {native_key: "description",  e_plat_key: "body_html"}
-					# },
-					# {
-					# 	alias_attribute_with_custom_getter: {native_key:, e_plat_key:, via: }
-					# }
+					# }, {
+					# 	alias_attribute: {
+					#		native_key: "description",  
+					#		e_plat_key: "body_html", 
+					#		custom_e_plat_getter: "-> (value) { value&.gsub(' ', '-') }",
+					#		custom_native_setter: "-> (value) { value&.gsub('-', ' ') }" 
+					#	}
+					# }, {
+					#    existing_entry: {native_key: "id", e_plat_key: "id"}
+					# }	
 				]
 			end
+
+			# The below methods add support for getting/setting/converting via e_plat and native keys
 			
-			def aliases
-				native_attribute_aliases.map do |alias_hash|
-					next unless alias_hash[:alias_attribute]
+			def aliases #e.g. {description: "body_html", native_key: "e_plat_key", ...}
+				@aliases ||= native_attribute_aliases.map do |alias_hash|
+					if alias_hash[:alias_attribute]
+						keys = alias_hash[:alias_attribute].values[0..1]
+					elsif alias_hash[:existing_entry]
+						keys = alias_hash[:existing_entry].values[0..1]
+					else
+						next
+					end
 					
-					keys = alias_hash[:alias_attribute].values[0..1]
 					Hash[*keys]
 				end.compact_blank.inject(&:merge) || {}
 			end
+
+			def keys_aliased_to_native_keys
+				@e_plat_to_native_aliases ||= aliases.invert
+			end
+
+			def native_key_to(e_plat_key) #e.g. "description" => "body_html"
+				aliases.invert[e_plat_key]
+			end
+
+			def e_plat_key_to(native_key) #e.g.  "body_html" => "description"
+				aliases[native_key]
+			end
 			
-			def to_native_keys(attributes)
+			def to_native_keys(attributes) #e.g. {body_html: "A great t-shirt"} => {description: "A great t-shirt"}
 				as = aliases.invert
-				attributes.transform_keys{|key| (as[key]) ? as[key] : key }
+				attributes.with_indifferent_access.transform_keys{|key| (as[key]) ? as[key] : key }
 			end
 			
-			def to_e_plat_keys(attributes)
+			def to_e_plat_keys(attributes) #e.g. {description: "A great t-shirt"} => {body_html: "A great t-shirt"}
 				as = aliases
-				attributes.transform_keys{|key| (as[key]) ? as[key] : key }
+				attributes.with_indifferent_access.transform_keys {|key| (as[key]) ? as[key] : key }
 			end
 			
 			def mappable_keys
 				native_attribute_aliases.map{|a| a.values.first[:e_plat_key]}.presence || :all
 			end
 
+			def mappings #e.g. {e_plat_key: native_key, 'body_html' => 'description'}
+				@mapping ||= native_attribute_aliases.map{|a| a[:alias_attribute] }.compact_blank.inject(&:merge) || {}
+			end
+
+			def via_native_attributes_where_possible(params) # e.g. {financial_status: 'paid'} => {status_id: 11}
+				e_plat_key_mappings = keys_aliased_to_native_keys.with_indifferent_access # {e_plat_key: native_key}
+				translated_attributes = {}
+
+				params.each do |e_plat_key, value|
+					native_key = e_plat_key_mappings[e_plat_key]
+
+					if native_key
+						translated_attributes[native_key] = native_setter(e_plat_key.to_s, value) || value
+					else
+						translated_attributes[e_plat_key] = value
+					end
+				end
+
+				translated_attributes
+			end
+
+			def native_setter(e_plat_key, value) # str, proc.call(value) | nil
+				return unless keys_aliased_to_native_keys[e_plat_key]
+				value = value.to_s if value.is_a?(Symbol)
+
+				attribute_aliases = native_attribute_aliases.map{|a| a[:alias_attribute] }.compact_blank
+
+				proc = attribute_aliases.find do |a| 
+					a[:e_plat_key].to_s == e_plat_key.to_s && a[:custom_native_setter]
+				end.try(:[], :custom_native_setter)
+
+				eval(proc).call(value) if proc
+			end
+
+
+			private
+
+			def init_virtual_collections
+				self.class.virtual_collections&.each do |virtual_collection|
+					name 			= virtual_collection[:name]
+					map_from		= virtual_collection[:map_from]
+
+					send("init_#{ name }", resource: @resource, map_from: map_from)
+				end
+			end
+
 		end
 	end
 end

data/lib/e_plat/mapping/bigcommerce/v_3/metafield.rb

@@ -0,0 +1,62 @@
+module EPlat
+    class Mapping
+        module Bigcommerce
+            module V3
+                class Metafield < EPlat::Mapping::Base
+
+                    def native_top_key
+                        "data"
+                    end
+
+                    def native_attributes
+                        super.concat([
+                            "id",
+                            "key",
+                            "value",
+                            "namespace",
+                            "permission_set",
+                            "resource_type",
+                            "resource_id",
+                            "description",
+                            "date_created",
+                            "date_modified"
+                        ])
+                    end
+                    
+                    def native_attribute_aliases
+                        super.concat([
+                            {
+                                existing_entry: {native_key: "id",            e_plat_key: "id"}
+                            },
+                            {
+                                existing_entry: {native_key: "key",           e_plat_key: "key"}
+                            },
+                            {
+                                existing_entry: {native_key: "value",         e_plat_key: "value"}
+                            },
+                            {
+                                existing_entry: {native_key: "namespace",     e_plat_key: "namespace"}
+                            },
+                            {
+                                existing_entry: {native_key: "description",   e_plat_key: "description"}
+                            },
+                            {
+                                alias_attribute: {native_key: "date_created", e_plat_key: "created_at"}
+                            },
+                            {
+                                alias_attribute: {native_key: "date_modified",e_plat_key: "updated_at"}
+                            },
+                            {
+                                alias_attribute: {native_key: "resource_type",e_plat_key: "owner_resource"}
+                            },
+                            {
+                                alias_attribute: {native_key: "resource_id",  e_plat_key: "owner_id"}
+                            }
+                        ])
+                    end
+                    
+                end
+            end
+        end
+    end
+end

data/lib/e_plat/mapping/bigcommerce/v_3/order/billing_address.rb

@@ -0,0 +1,14 @@
+
+
+module EPlat
+	class Mapping
+		module Bigcommerce
+			module V3
+				class Order
+					class Order::BillingAddress < ShippingAddress; end
+				end
+			end
+		end
+	end
+end
+

data/lib/e_plat/mapping/bigcommerce/v_3/order/line_item.rb

@@ -0,0 +1,85 @@
+
+module EPlat
+    class Mapping
+        module Bigcommerce
+            module V3
+                class Order::LineItem < EPlat::Mapping::Base
+                    
+                    def native_top_key
+                        "data"
+                    end
+                    
+                    def native_attributes
+                        super.concat([
+                            "id",
+                            "order_id",
+                            "product_id",
+                            "variant_id",
+                            "order_pickup_method_id",
+                            "order_address_id",
+                            "name",
+                            "name_customer",
+                            "name_merchant",
+                            "sku",
+                            "upc",
+                            "type",
+                            "base_price",
+                            "price_ex_tax",
+                            "price_inc_tax",
+                            "price_tax",
+                            "base_total",
+                            "total_ex_tax",
+                            "total_inc_tax",
+                            "total_tax",
+                            "weight",
+                            "width",
+                            "height",
+                            "depth",
+                            "quantity",
+                            "base_cost_price",
+                            "cost_price_inc_tax",
+                            "cost_price_ex_tax",
+                            "cost_price_tax",
+                            "is_refunded",
+                            "quantity_refunded",
+                            "refund_amount",
+                            "return_id",
+                            "wrapping_id",
+                            "wrapping_name",
+                            "base_wrapping_cost",
+                            "wrapping_cost_ex_tax",
+                            "wrapping_cost_inc_tax",
+                            "wrapping_cost_tax",
+                            "wrapping_message",
+                            "quantity_shipped",
+                            "event_name",
+                            "event_date",
+                            "fixed_shipping_cost",
+                            "ebay_item_id",
+                            "ebay_transaction_id",
+                            "option_set_id",
+                            "parent_order_product_id",
+                            "is_bundled_product",
+                            "bin_picking_number",
+                            "external_id",
+                            "fulfillment_source",
+                            "brand",
+                            "gift_certificate_id",
+                            "applied_discounts",
+                            "product_options",
+                            "configurable_fields",
+                            "discounted_total_inc_tax"                        
+                        ])
+                    end
+                    
+                    def native_attribute_aliases
+                        super.concat([
+                            # see virtual_collection @ EPlat::Mapping::VirtualCollection::Bigcommerce::OrderLineItems
+                        ])
+                    end
+                    
+                end
+            end
+        end
+    end
+end