e_plat 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee797b0b23712947fd4ed9e566a4a26548b887fc7958254343eab9b97073e708
-  data.tar.gz: d26e103052bf4fbf770890e5b05d0f49dcf4c6cd9ae4f473e3737640837fa148
+  metadata.gz: 7940bc3d4b8d6b21b3ac8b36eba083a7cfea37fabd1161bca997c47338038b9b
+  data.tar.gz: 1d8ce726804d61e44f5b1c5e9675309219cfc03619b6bb7be3733cbd1f683e9e
 SHA512:
-  metadata.gz: 213183bc25f835b78a18245f01cab417cd37625baf056e08a89500f492d3b019ee8691da997e33e60c8c4b7ea894eaf5120d7806b943fe001be3f888b58e74ce
-  data.tar.gz: 464bb8e454266a48d6e157bd5e51f689216e59afc3bde7506a3ec3ae4ea1030bf4b0b3e3288b205ba88976885be76a1f6df2829dd93f5d7cae9d87ea977b8742
+  metadata.gz: 04c6492c9a0d3d79769e5223c6b16ba1672a088cc5ff7baa9a94e942c555b9e0b6134881c96db1f8f7cb5bc32cff70d97a796e1725a6a6a998d69835a50a6dd6
+  data.tar.gz: 6355bcf307dbe5d0ef1fe660510f142390ee01a7e0a0e45fe1fc2b3379a00b28350b5b5151625dde045e0e73b2ac74ead4e591d6539afffd1d76f0d239a24b12

data/README.md

@@ -44,6 +44,9 @@ You can configure which platform APIs are used by updating the EPlat config: <br
 EPlat.config.shopify_api_version = "2024-01"
 EPlat.config.bigcommerce_api_version = "v3"
 EPlat.config.woocommerce_api_version = "v3"
+
+# EPlat.api_display_name.shopify #=> "2024-01" # presents as the platform would display in URL paths
+# EPlat.config.shopify_api_version #=> "2024_01" # coerced interally for creating constants
 ```
 <br>
 
@@ -80,7 +83,7 @@ EPlat is designed to let you mostly use it's universal interface, but then easil
     event: :onload,
     src: "https://preproduct.io/mini-script.js"
   )
-  tag.name = "mini script" if Current.e_plat_session.bigcommerce?
+  tag.name = "mini script" if EPlat::Current.e_plat_session.bigcommerce?
   tag.save 
 
   # ...when session is a Shopify store
@@ -579,7 +582,7 @@ Unfortunately it's in a Time Integer format. Haven't yet got dynamic conversion
   # <%= link_to "previous products", "/", page_info: products.previous_page_info %>
   # <%= link_to "Next products",     "/", page_info: products.next_page_info %>
 
-  EPlat::Product.find(:all, params: {limit: 2, Current.e_plat_session.pagination_param => params['page_info'] })
+  EPlat::Product.find(:all, params: {limit: 2, EPlat::Current.e_plat_session.pagination_param => params['page_info'] })
 ```
  
 

data/lib/e_plat/current.rb

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

data/lib/e_plat/resource/base.rb

@@ -30,7 +30,7 @@ module EPlat
 			end
 
 			def client
-				Current.e_plat_session
+				EPlat::Current.e_plat_session
 			end
 
 
@@ -87,7 +87,7 @@ module EPlat
 		end
 
 		def client
-			Current.e_plat_session
+			EPlat::Current.e_plat_session
 		end
 
 		def mapped?(attribute)

data/lib/e_plat/resource/collection.rb

@@ -85,7 +85,7 @@ module EPlat
 		private
 
 			def client
-				Current.e_plat_session
+				EPlat::Current.e_plat_session
 			end
 
 	end

data/lib/e_plat/session.rb

@@ -1,10 +1,10 @@
 
 module EPlat
 	class Session
-		#the session is an instance of EPlat::Client made available via Rails Current::Attributes
+		#the session is an instance of EPlat::Client made available via Rails EPlat::Current::Attributes
 
 		def initialize(platform:, store_url:, api_token:, store_hash: nil)
-			Current.e_plat_session = EPlat::Client.new(
+			EPlat::Current.e_plat_session = EPlat::Client.new(
 				platform: platform,
 				store_url: store_url,
 				api_token: api_token,
@@ -13,7 +13,7 @@ module EPlat
 		end
 
 		def self.clear!
-			Current.e_plat_session = nil
+			EPlat::Current.e_plat_session = nil
 		end
 		 
 	end

data/lib/e_plat/version.rb

@@ -1,3 +1,3 @@
 module EPlat
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

data/lib/e_plat.rb

@@ -32,7 +32,16 @@ module EPlat
         SUPPORTED_BIGCOMMERCE_API_VERSIONS.include?(v) ? v : raise(ArgumentError, "Bigcommerce API version #{value} is not supported")
     end)
     
-    setting(:woocommerce_api_version, default: "v3",      constructor: ->(value) { value.downcase.gsub("v", "") })
+    setting(:woocommerce_api_version, default: "v3", constructor: ->(value) { value.downcase.gsub("v", "") })
+
+    def self.api_display_name
+        apis = Struct.new(:shopify, :bigcommerce, :woocommerce)
+        apis.new(
+            shopify: config.shopify_api_version&.dasherize,    # "2024-01" 
+            bigcommerce: "v#{config.bigcommerce_api_version}", # "v3"
+            woocommerce: "v#{config.woocommerce_api_version}"  # "v3"
+        )
+    end
 
     class Error < StandardError; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: e_plat
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - oliwoodsuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-08 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -207,12 +207,12 @@ files:
 - lib/active_resource/connection_error.rb
 - lib/active_resource/formats.rb
 - lib/active_resource/schema.rb
-- lib/current.rb
 - lib/e_plat.rb
 - lib/e_plat/client.rb
 - lib/e_plat/client/default_request_args.rb
 - lib/e_plat/client/platform_convenience_methods.rb
 - lib/e_plat/connection.rb
+- lib/e_plat/current.rb
 - lib/e_plat/engine.rb
 - lib/e_plat/errors/incorrect_type_error.rb
 - lib/e_plat/errors/missing_migration_key_error.rb

data/lib/current.rb

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