e_plat 1.0.0 → 1.1.0.pre.rc.1

data/lib/e_plat/client.rb

@@ -7,7 +7,8 @@ module EPlat
 		SHOPIFY_REST_PAGINATION_PARAM 	 		  = "page_info"
 		SHOPIFY_GRAPHQL_FORWARD_PAGINATION_PARAM  = "after"
 		SHOPIFY_GRAPHQL_BACKWARD_PAGINATION_PARAM = "before"
-		BIGCOMMERCE_PAGINATION_PARAM  	 	 	  = "page"
+		BIGCOMMERCE_PAGINATION_PARAM = "page"
+		WOOCOMMERCE_PAGINATION_PARAM = "page"
 		
 		attr_reader :platform, :store_url, :api_token, :api_version, :store_hash
 
@@ -53,7 +54,7 @@ module EPlat
 			when :bigcommerce
 				"https://api.bigcommerce.com"
 			when :woocommerce
-				"/"
+				"https://#{ store_url }"
 			end
 		end
 		
@@ -83,7 +84,7 @@ module EPlat
 			when :bigcommerce
 				"/stores/#{ store_hash }/v#{ api_version }/catalog/#{ collection_path }"
 			when :woocommerce
-				"/" # not yet supported
+				"/wp-json/wc/v#{ api_version }/#{ collection_path }" # not yet supported
 			end
 		end
 
@@ -117,7 +118,7 @@ module EPlat
 			when :woocommerce
 				{
 					"Content-Type" => "application/json",
-					"Authorization" => "Bearer #{ api_token }"
+					"Authorization" => "Basic #{ api_token }"
 				}
 			end
 		end
@@ -143,6 +144,7 @@ module EPlat
 				case platform
 				when :shopify     then true
 				when :bigcommerce then false
+				when :woocommerce then false # haven't tested this is the case yet
 				else false
 				end
 		end
@@ -157,11 +159,13 @@ module EPlat
 				end
 			when :bigcommerce 
 				BIGCOMMERCE_PAGINATION_PARAM
+			when :woocommerce
+				WOOCOMMERCE_PAGINATION_PARAM
 			end
 		end
 
 		def include_format_in_path?
-			!bigcommerce?
+			!bigcommerce? && !woocommerce?
 		end
 
 			

data/lib/e_plat/mapping/base.rb

@@ -25,7 +25,6 @@ module EPlat
 				end
 			end
 
-
 			def initialize(resource_instance)
 				@resource = resource_instance
 
@@ -36,7 +35,7 @@ module EPlat
 				"#<#{self.class} #{ self.instance_variable_names.join(' ') }>"
 			end
 
-			# The below three methods are added to via the individual mapping classes
+			# The below methods are added to via the individual mapping classes
 
 			def native_top_key
 				:itself # or top key of JSON response e.g. "data", "product", 
@@ -63,6 +62,10 @@ module EPlat
 				]
 			end
 
+			# for resources with keys in EPlat::Base::PROTECTED_ATTRIBUTES
+			# we can swap over before init and restore in as_json. {native_key => e_plat_key}
+			def protected_attributes_rename_on_initialize = {}
+
 			# The below methods add support for getting/setting/converting via e_plat and native keys
 			
 			def aliases #e.g. {description: "body_html", native_key: "e_plat_key", ...}
@@ -109,7 +112,19 @@ module EPlat
 				@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}
+			def platform
+				class_name = self.class.name.underscore
+				case
+				when class_name.include?("shopify")
+					:shopify
+				when class_name.include?("bigcommerce")
+					:bigcommerce
+				when class_name.include?("woocommerce")
+					:woocommerce
+				end
+			end
+
+			def via_native_attributes_where_possible(params, search:false) # 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 = {}
 
@@ -123,6 +138,10 @@ module EPlat
 					end
 				end
 
+				if search && platform == :woocommerce
+					translated_attributes.transform_keys!{(_1 == "name" || _1 == "sku") ? "search" : _1}
+				end
+
 				translated_attributes
 			end
 

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

@@ -1,163 +1,163 @@
 module EPlat
 	class Mapping
 	  module Bigcommerce
-		module V3 #v2 used, as v3 order not yet available
-		  class Order < EPlat::Mapping::Base
-			virtual_collection :line_items, class: EPlat::Mapping::VirtualCollection::Bigcommerce::OrderLineItems, map_from: "consignments"
+			module V3 #v2 used, as v3 order not yet available
+				class Order < EPlat::Mapping::Base
+					virtual_collection :line_items, class: EPlat::Mapping::VirtualCollection::Bigcommerce::OrderLineItems, map_from: "consignments"
 
-			def native_top_key
-				"data"
+					def native_top_key
+						"data"
+					end
+					
+					def native_attributes
+						super.concat([
+							"id",
+							"customer_id",
+							"date_created",
+							"date_modified",
+							"date_shipped",
+							"status_id",
+							"status",
+							"subtotal_ex_tax",
+							"subtotal_inc_tax",
+							"subtotal_tax",
+							"base_shipping_cost",
+							"shipping_cost_ex_tax",
+							"shipping_cost_inc_tax",
+							"shipping_cost_tax",
+							"shipping_cost_tax_class_id",
+							"base_handling_cost",
+							"handling_cost_ex_tax",
+							"handling_cost_inc_tax",
+							"handling_cost_tax",
+							"handling_cost_tax_class_id",
+							"base_wrapping_cost",
+							"wrapping_cost_ex_tax",
+							"wrapping_cost_inc_tax",
+							"wrapping_cost_tax",
+							"wrapping_cost_tax_class_id",
+							"total_ex_tax",
+							"total_inc_tax",
+							"total_tax",
+							"items_total",
+							"items_shipped",
+							"payment_method",
+							"payment_provider_id",
+							"payment_status",
+							"refunded_amount",
+							"order_is_digital",
+							"store_credit_amount",
+							"gift_certificate_amount",
+							"ip_address",
+							"ip_address_v6",
+							"geoip_country",
+							"geoip_country_iso2",
+							"currency_id",
+							"currency_code",
+							"currency_exchange_rate",
+							"default_currency_id",
+							"default_currency_code",
+							"staff_notes",
+							"customer_message",
+							"discount_amount",
+							"coupon_discount",
+							"shipping_address_count",
+							"is_deleted",
+							"ebay_order_id",
+							"cart_id",
+							"billing_address",
+							"is_email_opt_in",
+							"credit_card_type",
+							"order_source",
+							"channel_id",
+							"external_source",
+							"products",
+							"shipping_addresses",
+							"coupons",
+							"external_id",
+							"external_merchant_id",
+							"tax_provider_id",
+							"store_default_currency_code",
+							"store_default_to_transactional_exchange_rate",
+							"custom_status",
+							"customer_locale",
+							"external_order_id"
+						])
+					end
+					
+					def native_attribute_aliases
+						super.concat([
+							{
+								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: "status_id", e_plat_key: "financial_status",
+								custom_e_plat_getter: "-> (status_id) { 
+									case status_id.to_i
+									when 1 then 'pending'
+									when 4 then 'refunded'
+									when 5 then 'cancelled' # not a valid status for Shopify. just used in this BG specific mapping
+									when 7 then 'unpaid'
+									when 11 then 'paid'
+									else nil
+									end
+								}",
+								custom_native_setter: "-> (financial_status) { 
+									case financial_status
+									when 'pending' then 1
+									when 'refunded' then 4
+									when 'cancelled' then 5
+									when 'unpaid' then 7
+									when 'paid' then 11
+									else nil
+									end
+								}"
+							}
+							},
+							{
+							existing_entry: {native_key: "billing_address", e_plat_key: "billing_address"}
+							},
+							{
+							alias_attribute: {native_key: "currency_code", e_plat_key: "currency"}
+							},
+							{
+							alias_attribute: {native_key: 'subtotal_ex_tax', e_plat_key: 'subtotal_price'} #poundage string. eg "5.31"
+							},
+							{
+							existing_entry: {native_key: 'total_tax', e_plat_key: 'total_tax'} #poundage string. eg "5.31"
+							},
+							{
+							alias_attribute: {native_key: 'total_inc_tax', e_plat_key: 'total_price'} #poundage string. eg "5.31"
+							},
+							{
+							existing_entry: {native_key: 'id', e_plat_key: 'id'}
+							},
+							{
+							existing_entry: {native_key: 'customer_locale', e_plat_key: 'customer_locale'} #e.g. "en-{optional_country_code}"
+							},
+							{
+							alias_attribute: {native_key: "total_inc_tax", e_plat_key: "current_total_price"}
+							},
+							{
+							alias_attribute: {native_key: "discount_amount", e_plat_key: "current_total_discounts"} #poundage string. eg "9.99"
+							},
+							{
+							alias_attribute: {native_key: "id", e_plat_key: "order_number"}
+							},
+							{
+							alias_attribute: {native_key: "staff_notes", e_plat_key: "note"}
+							},
+							{
+							alias_attribute: {native_key: "billing_address[email]", e_plat_key: "email"}
+							}
+						])
+					end
+					
+				end
 			end
-			
-			def native_attributes
-			  super.concat([
-				"id",
-				"customer_id",
-				"date_created",
-				"date_modified",
-				"date_shipped",
-				"status_id",
-				"status",
-				"subtotal_ex_tax",
-				"subtotal_inc_tax",
-				"subtotal_tax",
-				"base_shipping_cost",
-				"shipping_cost_ex_tax",
-				"shipping_cost_inc_tax",
-				"shipping_cost_tax",
-				"shipping_cost_tax_class_id",
-				"base_handling_cost",
-				"handling_cost_ex_tax",
-				"handling_cost_inc_tax",
-				"handling_cost_tax",
-				"handling_cost_tax_class_id",
-				"base_wrapping_cost",
-				"wrapping_cost_ex_tax",
-				"wrapping_cost_inc_tax",
-				"wrapping_cost_tax",
-				"wrapping_cost_tax_class_id",
-				"total_ex_tax",
-				"total_inc_tax",
-				"total_tax",
-				"items_total",
-				"items_shipped",
-				"payment_method",
-				"payment_provider_id",
-				"payment_status",
-				"refunded_amount",
-				"order_is_digital",
-				"store_credit_amount",
-				"gift_certificate_amount",
-				"ip_address",
-				"ip_address_v6",
-				"geoip_country",
-				"geoip_country_iso2",
-				"currency_id",
-				"currency_code",
-				"currency_exchange_rate",
-				"default_currency_id",
-				"default_currency_code",
-				"staff_notes",
-				"customer_message",
-				"discount_amount",
-				"coupon_discount",
-				"shipping_address_count",
-				"is_deleted",
-				"ebay_order_id",
-				"cart_id",
-				"billing_address",
-				"is_email_opt_in",
-				"credit_card_type",
-				"order_source",
-				"channel_id",
-				"external_source",
-				"products",
-				"shipping_addresses",
-				"coupons",
-				"external_id",
-				"external_merchant_id",
-				"tax_provider_id",
-				"store_default_currency_code",
-				"store_default_to_transactional_exchange_rate",
-				"custom_status",
-				"customer_locale",
-				"external_order_id"
-			  ])
-			end
-			
-			def native_attribute_aliases
-			  super.concat([
-				{
-					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: "status_id", e_plat_key: "financial_status",
-						custom_e_plat_getter: "-> (status_id) { 
-							case status_id.to_i
-							when 1 then 'pending'
-							when 4 then 'refunded'
-							when 5 then 'cancelled' # not a valid status for Shopify. just used in this BG specific mapping
-							when 7 then 'unpaid'
-							when 11 then 'paid'
-							else nil
-							end
-						}",
-						custom_native_setter: "-> (financial_status) { 
-							case financial_status
-							when 'pending' then 1
-							when 'refunded' then 4
-							when 'cancelled' then 5
-							when 'unpaid' then 7
-							when 'paid' then 11
-							else nil
-							end
-						}"
-					}
-				  },
-				  {
-					existing_entry: {native_key: "billing_address", e_plat_key: "billing_address"}
-				  },
-				  {
-					alias_attribute: {native_key: "currency_code", e_plat_key: "currency"}
-				  },
-				  {
-					alias_attribute: {native_key: 'subtotal_ex_tax', e_plat_key: 'subtotal_price'} #poundage string. eg "5.31"
-				  },
-				  {
-					existing_entry: {native_key: 'total_tax', e_plat_key: 'total_tax'} #poundage string. eg "5.31"
-				  },
-				  {
-					alias_attribute: {native_key: 'total_inc_tax', e_plat_key: 'total_price'} #poundage string. eg "5.31"
-				  },
-				  {
-					existing_entry: {native_key: 'id', e_plat_key: 'id'}
-				  },
-				  {
-					existing_entry: {native_key: 'customer_locale', e_plat_key: 'customer_locale'} #e.g. "en-{optional_country_code}"
-				  },
-				  {
-					alias_attribute: {native_key: "total_inc_tax", e_plat_key: "current_total_price"}
-				  },
-				  {
-					alias_attribute: {native_key: "discount_amount", e_plat_key: "current_total_discounts"} #poundage string. eg "9.99"
-				  },
-				  {
-					alias_attribute: {native_key: "id", e_plat_key: "order_number"}
-				  },
-				  {
-					alias_attribute: {native_key: "staff_notes", e_plat_key: "note"}
-				  },
-				  {
-					alias_attribute: {native_key: "billing_address[email]", e_plat_key: "email"}
-				  }
-			  ])
-			end
-  
-		  end
 		end
-	  end
 	end
-  end
+end

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

@@ -0,0 +1,39 @@
+module EPlat
+  class Mapping
+    module Woocommerce
+      module V3
+        class Metafield < EPlat::Mapping::Base
+          # WooCommerce Metafield mapping
+          # In WooCommerce, metafields are part of a resource's returned meta_data array
+          # Each metafield has id, key, and value attributes
+          
+          def native_top_key
+            :itself
+          end
+          
+          def native_attributes
+            super.concat([
+              "id",
+              "key", 
+              "value"
+            ])
+          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"}
+              }
+            ])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+module EPlat
+  class Mapping
+    module Woocommerce
+      module V3
+        class Order
+          class BillingAddress < EPlat::Mapping::Base
+            def native_top_key
+              :itself
+            end
+            
+            def native_attributes
+              super.concat([
+                "first_name",
+                "last_name",
+                "company",
+                "address_1",
+                "address_2",
+                "city",
+                "state",
+                "postcode",
+                "country",
+                "email",
+                "phone"
+              ])
+            end
+            
+            def native_attribute_aliases
+              super.concat([
+                {
+                  alias_attribute: {native_key: "address_1", e_plat_key: "address1"}
+                },
+                {
+                  alias_attribute: {native_key: "address_2", e_plat_key: "address2"}
+                },
+                {
+                  existing_entry: {native_key: "city", e_plat_key: "city"}
+                },
+                {
+                  existing_entry: {native_key: "company", e_plat_key: "company"}
+                },
+                {
+                  existing_entry: {native_key: "country", e_plat_key: "country"}
+                },
+                {
+                  existing_entry: {native_key: "email", e_plat_key: "email"}
+                },
+                {
+                  existing_entry: {native_key: "first_name", e_plat_key: "first_name"}
+                },
+                {
+                  existing_entry: {native_key: "last_name", e_plat_key: "last_name"}
+                },
+                {
+                  existing_entry: {native_key: "phone", e_plat_key: "phone"}
+                },
+                {
+                  alias_attribute: {native_key: "state", e_plat_key: "province"}
+                },
+                {
+                  alias_attribute: {native_key: "state", e_plat_key: "province_code"}
+                },
+                {
+                  alias_attribute: {native_key: "postcode", e_plat_key: "zip"}
+                },
+                {
+                  alias_attribute: {native_key: "country", e_plat_key: "country_code"}
+                },
+                {
+                  custom_e_plat_getter: {native_key: nil, e_plat_key: "name", custom_e_plat_getter: "-> (obj) { [obj['first_name'], obj['last_name']].join(' ').strip }"}
+                }
+                # WooCommerce doesn't provide fields for latitude, longitude in billing address
+              ])
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+module EPlat
+  class Mapping
+    module Woocommerce
+      module V3
+        class Order
+          class LineItem < EPlat::Mapping::Base
+            def native_top_key
+              :itself
+            end
+            
+            def native_attributes
+              super.concat([
+                "id",
+                "name",
+                "product_id",
+                "variation_id",
+                "quantity",
+                "tax_class",
+                "subtotal",
+                "subtotal_tax",
+                "total",
+                "total_tax",
+                "taxes",
+                "meta_data",
+                "sku",
+                "price",
+                "parent_name"
+              ])
+            end
+            
+            def native_attribute_aliases
+              super.concat([
+                {
+                  existing_entry: {native_key: "id", e_plat_key: "id"}
+                },
+                {
+                  existing_entry: {native_key: "name", e_plat_key: "name"}
+                },
+                {
+                  existing_entry: {native_key: "product_id", e_plat_key: "product_id"}
+                },
+                {
+                  existing_entry: {native_key: "quantity", e_plat_key: "quantity"}
+                },
+                {
+                  alias_attribute: {native_key: "quantity", e_plat_key: "current_quantity"}
+                },
+                {
+                  existing_entry: {native_key: "sku", e_plat_key: "sku"}
+                },
+                {
+                  existing_entry: {native_key: "price", e_plat_key: "price"}
+                },
+                {
+                  existing_entry: {native_key: "name", e_plat_key: "title"}
+                },
+                {
+                  alias_attribute: {native_key: "variation_id", e_plat_key: "variant_id"}
+                },
+                {
+                  custom_e_plat_getter: {native_key: nil, e_plat_key: "fulfillable_quantity", custom_e_plat_getter: "-> (obj) { obj['quantity'] }"}
+                },
+                {
+                  custom_e_plat_getter: {native_key: nil, e_plat_key: "taxable", custom_e_plat_getter: "-> (obj) { !obj['tax_class'].empty? }"}
+                },
+                {
+                  custom_e_plat_getter: {native_key: nil, e_plat_key: "requires_shipping", custom_e_plat_getter: "-> (obj) { true }"}
+                },
+                {
+                  custom_e_plat_getter: {native_key: nil, e_plat_key: "gift_card", custom_e_plat_getter: "-> (obj) { false }"}
+                },
+                {
+                  existing_entry: {native_key: "meta_data", e_plat_key: "properties"}
+                },
+                {
+                  existing_entry: {native_key: "taxes", e_plat_key: "tax_lines"}
+                }
+              ])
+            end
+          end
+        end
+      end
+    end
+  end
+end