e_plat 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3483b03e1f4725af9e8f8eb3b3b98f506212e0508ddb7536e917285eb35a3538
-  data.tar.gz: ccd043d15ce417dd6713bccfcbbc59af215a1e2fbd1357b2b3954bd8b1a5e96d
+  metadata.gz: 6e070573b55b7ee4badc6e492bc04bf13f0edc534f937eaae8b0bafe5f78beea
+  data.tar.gz: e3c7a0b699e11057b08659bdcbe1c9c993d575b8e0ba7988f3f7cdd12c46e7ab
 SHA512:
-  metadata.gz: 9cbcd506b0b37f159eb59032b98c7833436115e610e792b1770cfbc1151dbf9ae2a3749259edf175508371c4de283f65f61260239eb9a159d8e0c6641c6fe6de
-  data.tar.gz: 82f0f4a8b4fc45d2694a60a460b765f0224971832ae2005629bf30b91d4eb4764a611bc77073771b02b70afcea9d27b13acbae8906df2cea6c461438a94c1ba3
+  metadata.gz: f80544f6fdf55208b4b8640631c0d39bc3c21b21dc8b1ee4bad3ebd3d56e343c3bf7164be655db8510bb62fc0cb5f3d8423b32e4f68b1ed47714ae02b312b373
+  data.tar.gz: 0c86da79e297bffad3c1348e92a2b69129298b82818beb4da1352610f1ff7efc0ac30fbe5d9df8a811a7ef7cef2fc989007b11946cbdc9bae2a1751f0452e839

data/README.md

@@ -50,9 +50,7 @@ https://dev.to/doctolib/release-a-new-gem-version-je0
 
 ## Usage
 
-1. Add `include EPlat::SessionState` to the top of your `ApplicationController` class.
-
-2. To make requests, first initialize a session like so:
+1. To make requests, first initialize a session like so:
 ```ruby
 EPlat::Session.new(
   platform: :shopify, 
@@ -62,12 +60,12 @@ EPlat::Session.new(
 )
 ```
 
-3. You can then make requests to the platform via a singleton call on the class:
+2. You can then make requests to the platform via a singleton call on the Resource class:
 ```ruby
 EPlat::Product.find(id: 123)
 ```
 
-4. Which will return an instance of:
+3. Which will return an instance of:
 ```ruby
 EPlat::Product
 ```
@@ -91,6 +89,7 @@ EPlat::Product
 			</li>
 			<li>
 				The EPlat alias interface is just a set of dynamically created getter/setter/predicate methods with types that control the native attributes of the resource.
+        You can check if an attribute has been mapped by calling `@resource.mapped? "attribute_name"`
 			</li>
 		</ul>
 </ol>

data/lib/current.rb

@@ -0,0 +1,7 @@
+class Current < ActiveSupport::CurrentAttributes
+    attribute :e_plat_session
+
+    def e_plat_session
+        super || EPlat::Client.new
+    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/resource/base.rb

@@ -4,12 +4,11 @@ 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.client  = Current.e_plat_session
 
 				self.site 	 = client.base_url
 				self.prefix  = client.url_prefix
@@ -37,13 +36,12 @@ module EPlat
 		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
+			self.client  = Current.e_plat_session
 			site = client.base_url
 			self.mapping = mapping_instance
 			ActiveResource::Base.include_root_in_json = client.shopify? && top_level_resource?

data/lib/e_plat/resource/shop.rb

@@ -65,7 +65,7 @@ module EPlat
 		class << self
 			
 			def element_path(id, prefix_options = {}, query_options = {})
-				"#{ e_plat_session.url_prefix }shop.json"
+				"#{ Current.e_plat_session.url_prefix }shop.json"
 			end
 
 			

data/lib/e_plat/session.rb

@@ -1,20 +1,17 @@
 
 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
+		#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
+			Current.e_plat_session.platform   = platform
+			Current.e_plat_session.store_url  = store_url
+			Current.e_plat_session.api_token  = api_token
+			Current.e_plat_session.store_hash = store_hash
 			
-			e_plat_session.send(:get_api_version) if e_plat_session.active?
-	  	end
+			Current.e_plat_session.send(:get_api_version) if Current.e_plat_session.active?
+		end
 		 
-		  
 	end
 end

data/lib/e_plat/types.rb

@@ -1,7 +1,7 @@
 
 module EPlat
 	module Types
-		include Dry.Types()		
+		include Dry.Types() #used in some typecasting
 	end
 end
 

data/lib/e_plat/version.rb

@@ -1,3 +1,3 @@
 module EPlat
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/lib/e_plat.rb

@@ -5,7 +5,6 @@ require "zeitwerk"
 require "active_support"
 require "activeresource"
 
-require 'dry/effects'
 require 'dry-types'
 # require "e_plat/railtie" if defined?(Rails::Railtie)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: e_plat
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - oliwoodsuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,20 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: dry-effects
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +177,7 @@ files:
 - app/assets/config/e_plat_manifest.js
 - config/routes.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
@@ -225,7 +212,6 @@ files:
 - lib/e_plat/resource/product/variant.rb
 - lib/e_plat/resource/shop.rb
 - lib/e_plat/session.rb
-- lib/e_plat/session_state.rb
 - lib/e_plat/type_coercer.rb
 - lib/e_plat/types.rb
 - lib/e_plat/version.rb

data/lib/e_plat/session_state.rb

@@ -1,25 +0,0 @@
-
-module EPlat
-	module SessionState
-		extend ActiveSupport::Concern
-		include Dry::Effects::Handler.State(:e_plat_session)
-		
-		included do
-			around_action :set_e_plat_session
-		end
-		
-		
-		private
-		
-		def set_e_plat_session
-		  with_e_plat_session(e_plat_session) { yield }
-		end
-		
-		def e_plat_session
-			# create empty client. 
-			# Will be populated later by EPlat::Session.new(..) if needed
-			EPlat::Client.new() 
-		end
-		  
-	end
-end