e_plat 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 386e1215b6388dde3ca778ad764b974cdd0ccb6826d40b3818d66b06835873a7
-  data.tar.gz: 23d5a40e0cf55a8ad322f6964ebf9d6b78b0bcff4ae087de6bf0d48ee7928684
+  metadata.gz: 21cc14088c5f2804d52659aab7cfedb0ec808d42a1beb5a8a29ad4525f670d36
+  data.tar.gz: 24f4aba2574e129d4b8f00b7a4ddbefe71ddf3465cd2b5336348c94870685be8
 SHA512:
-  metadata.gz: bc3dbea0f0ee2819422cc4fde686fce0a9916810ec7204cc665941f27ac110a9d4c0998beb32752cad3c28549210b3892d8066dd8f41257b35b481da93fb31c1
-  data.tar.gz: 4ed2081d31de4c5217ccdf8de95b019111da428c53046a098d67902d5776e98eb884eb52a0d18dd83257476694b9b02275c15fe0ce48d019373d97f99211a1f8
+  metadata.gz: 3b95cf6b98b113934622fd3a093469646749e51c92dd268626419ca3da8ec0573461908087bb99a3a91c43e895e77c702ed7f6c6149df4c40a2f7632b73ea1a0
+  data.tar.gz: e42d9978e0dcecea62c891a907527a050dbbe89b0a1e7d72cb4c490f633eb21a4dad71ea1d0d0898f905637cc4984175c680309a20b8677cc453b42cb3584230

data/README.md

@@ -82,7 +82,7 @@ EPlat is designed to let you mostly use it's universal interface, but then easil
   )
   tag.name = "mini script" if Current.e_plat_session.bigcommerce?
   tag.save 
-  
+
   # ...when session is a Shopify store
   # POST https://preproduct-test.myshopify.com/admin/api/2024-01/script_tags.json 
   # body: '{"script_tag":{"display_scope":"online_store","event":"onload","src":"https://preproduct.io/mini-script.js"}}'
@@ -829,8 +829,14 @@ product.mapped? "body_html" #check if a platforms resource is mapped to a specif
 
 # In the context of a Bigcommerce product that has aliases:
 product.changed_attributes # {}
-product.name = oi
-product.changed_attributes # {"name"=>"hey", "title"=>"hey"}
+product.title = "oi"
+product.changed_attributes # {"name"=>"oi", "title"=>"oi"}  
+#title is the e_plat key which won't be included in requests to the server. The native key 'name' has automatically been updated and will be sent in requests.
+
+product.as_json # hash of any updated attributes
+product.as_full_json # hash of all attributes, regardless of if they've been updated or not
+product.to_json # JSON string of any updated_attributes
+product.to_full_json # JSON string of all attributes. regardless of if they've been updated or not
 
 ```
 

data/lib/e_plat/resource/base.rb

@@ -3,7 +3,7 @@
 module EPlat
 	class Base < ActiveResource::Base
 		include Concerns::OverwriteRequestMethods, Concerns::OverwriteInstanceMethods
-		include Concerns::Aliases, Concerns::Dirty
+		include Concerns::Aliases, Concerns::Dirty, Concerns::FullJson
 		
 		self.connection_class  = EPlat::Connection
 		self.collection_parser = EPlat::Collection

data/lib/e_plat/resource/concerns/full_json.rb

@@ -0,0 +1,28 @@
+module EPlat
+    module Concerns
+        module FullJson
+            extend ActiveSupport::Concern
+
+			def to_full_json # '{}'
+				as_full_json.to_json
+			end
+
+			def as_full_json # {}
+                self.attributes.each_with_object({}) do |(key, value), result|
+                    result[key] = 
+						case
+						when value.is_a?(EPlat::Base)
+							value.as_full_json
+						when value.is_a?(Array)
+							value.map do |v|
+								v.is_a?(EPlat::Base) ? v.as_full_json : v
+							end
+						else
+							value
+						end
+                end
+            end
+
+        end
+    end
+end

data/lib/e_plat/resource/concerns/metafieldable.rb

@@ -5,8 +5,6 @@ module EPlat
 		module Metafieldable #< ActiveResource::CustomMethods
 
 			def metafields(**options)
-				options.merge!(resource: self.class.collection_name, resource_id: id)
-
 				Metafield.find(:all, 
 					from: current_resources_metafield_path, 
 					params: options

data/lib/e_plat/resource/concerns/overwrite_request_methods.rb

@@ -29,7 +29,7 @@ module EPlat
 					super
 				end
 
-				def new(attributes, persisted = false)
+				def new(attributes={}, persisted = false)
 					initialize_singleton!
 
 					self.mapping = EPlat::Mapping.new_instance(specifc_mapping: specifc_mapping_name, resource: nil)

data/lib/e_plat/version.rb

@@ -1,3 +1,3 @@
 module EPlat
-  VERSION = "0.4.0"
+  VERSION = "0.4.2"
 end

data/lib/e_plat.rb

@@ -20,9 +20,18 @@ loader.setup # ready!
 
 module EPlat
     extend Dry::Configurable
+    SUPPORTED_SHOPIFY_API_VERSIONS = ['2024_01']
+    SUPPORTED_BIGCOMMERCE_API_VERSIONS = ['3']
+    
+    setting(:shopify_api_version, default: "2024_01", constructor: ->(value) do 
+        SUPPORTED_SHOPIFY_API_VERSIONS.include?(value.underscore) ? value.underscore : raise(ArgumentError, "Shopify API version #{value} is not supported")
+    end)
+
+    setting(:bigcommerce_api_version, default: "v3", constructor: ->(value) do 
+        v = value.downcase.gsub("v", "")
+        SUPPORTED_BIGCOMMERCE_API_VERSIONS.include?(v) ? v : raise(ArgumentError, "Bigcommerce API version #{value} is not supported")
+    end)
     
-    setting(:shopify_api_version,     default: "2024_01", constructor: ->(value) { value.underscore })
-    setting(:bigcommerce_api_version, default: "v3",      constructor: ->(value) { value.downcase.gsub("v", "") })
     setting(:woocommerce_api_version, default: "v3",      constructor: ->(value) { value.downcase.gsub("v", "") })
 
     class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: e_plat
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - oliwoodsuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-01 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: activeresource-response
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
@@ -234,6 +248,7 @@ files:
 - lib/e_plat/resource/collection.rb
 - lib/e_plat/resource/concerns/aliases.rb
 - lib/e_plat/resource/concerns/dirty.rb
+- lib/e_plat/resource/concerns/full_json.rb
 - lib/e_plat/resource/concerns/metafieldable.rb
 - lib/e_plat/resource/concerns/overwrite_instance_methods.rb
 - lib/e_plat/resource/concerns/overwrite_request_methods.rb