e_plat 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b76ee9e7103fc4e5cb491cb07cd8fd8cf24cc56d28e16cc99d222da3b65db77
-  data.tar.gz: 623f8ef5b141c3b5b24138c7abca5610aec3d7acb840a749e6481320eeff890d
+  metadata.gz: 1f97875697b04e12d0fd6514ae9198d03022199c064d0c752ffa60a7f024c13e
+  data.tar.gz: e8ebc93252048ff24b128d3f46125d6709fccf66dc95578ab5267bb842d0011c
 SHA512:
-  metadata.gz: 878c953fc1ac93d857cbae808664affb031f68d1a9c5198059773373c5c74f9ab7139937ccab4199ae362af3b4bf80e0969a34de972eb3f80e25d7a95aeef92d
-  data.tar.gz: 59679a5b7d68e46a15811e9591e052697c14589b0dbee5597bca550e595fd48878a0e9415f7a55a876a56f676a26a1a93d39699e8cee1126efa0d5f5c5b342b8
+  metadata.gz: 0405d140e821f967cd7266006fd79881b8da73c6fe9bba9e82f337326d5f604392627e7c77e9e399a3a4b278aa8daee2590ca667b2834344e740799acce462a0
+  data.tar.gz: 4305d78ed5fb650cd21034bd450c7fca9ed3cdf4af8432202b2dfc888fc1ee2f9ef6c2d97e3a74f7044d110fffc03cd7255e2ac9abdad09b8fbdf7e65e94c2a6

data/lib/e_plat/resource/collection.rb

@@ -8,6 +8,7 @@ module EPlat
 			EPlat::Shopify::Product
 			EPlat::Shopify::Product::Variant
 		)
+		GRAPHQL_PAGING_PARAMS = %w(after before first last limit).freeze
 
 		def initialize(parsed = [])
 			super parsed
@@ -56,8 +57,8 @@ module EPlat
 			url = "#{ resource_class.collection_path }#{ url }" if client.bigcommerce?
 
 			if paginates_via_graphql?
-				arg_name = (url == @next) ? "after" : "before"
-				resource_class.find(:all, params: {arg_name => url, first: 100})
+				cursor_param = (url == @next) ? "after" : "before"
+				resource_class.find(:all, params: params_for_another_graphql_page(cursor_param, url))
 			elsif client.woocommerce?
 				page_number = extract_page_from_url(url)
 				resource_class.find(:all, params: {page: page_number})
@@ -66,6 +67,12 @@ module EPlat
 			end
 		end
 
+		def params_for_another_graphql_page(cursor_param, cursor)
+			filter_params = (original_params || {}).to_h.reject { |key, _value| GRAPHQL_PAGING_PARAMS.include?(key.to_s) }
+
+			filter_params.merge(cursor_param => cursor, first: 100)
+		end
+
 		def pagination_links
 			return pagination_cursors if paginates_via_graphql?
 

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

@@ -10,6 +10,7 @@ module EPlat
 
         FILTER_ARGS    = [:id, :after, :before, :last, :first, :sort_key, :reverse].freeze
         QUERY_ARG_ARGS = [:available_for_sale, :created_at, :product_type, :product_id, :tag, :tag_not, :title, :updated_at, :vendor].freeze
+        UserErrorsResponse = Struct.new(:body)
 
         class_methods do
 
@@ -60,11 +61,15 @@ module EPlat
                 else
                     case action
                     when :find_one, :find_single
+                        raise_resource_not_found! if resource_missing_from?(response)
+
                         instantiate_record     resources_parsed_from(response)
                     else
-                        instantiate_collection resources_parsed_from(response)
+                        instantiate_collection resources_parsed_from(response), args
                     end
                 end
+            rescue ActiveResource::ResourceNotFound
+                raise
             rescue StandardError => e
                 raise EPlat::GraphqlError.new(e.message)
             end
@@ -79,6 +84,17 @@ module EPlat
                 ).body
             end
 
+            # a 200 with a null resource is Shopify graphql's version of a 404
+            def resource_missing_from?(response)
+                data = response["data"].is_a?(Hash) ? response["data"] : response
+
+                data.key?(graphql_element_name) && data[graphql_element_name].nil?
+            end
+
+            def raise_resource_not_found!
+                raise ActiveResource::ResourceNotFound.new(nil, "#{name} not found")
+            end
+
             #utils
 
             def scope_with_options_hash(args, action)
@@ -214,6 +230,13 @@ module EPlat
             
         end
 
+        def save!
+            return true if save
+
+            invalid_response = UserErrorsResponse.new({message: errors.full_messages.join(", ")}.to_json)
+            raise ActiveResource::ResourceInvalid.new(invalid_response)
+        end
+
         def mutate_graphql(action, graphql_proc_constant, *args)
             callback_name = (action == :delete) ? :destroy : action
 
@@ -224,6 +247,9 @@ module EPlat
                     raise EPlat::GraphqlError.new(response.first["message"])
                 elsif response["errors"]
                     raise EPlat::GraphqlError.new(response["errors"].first["message"])
+                elsif (user_errors_by_mutation = user_errors_by_mutation_from(response)).any?
+                    log_user_errors(user_errors_by_mutation)
+                    raise_resource_invalid_with(user_errors_by_mutation.values.flatten)
                 else
                     response = remove_mutation_root_from(response, graphql_proc_constant)
                     parsed_response = self.class.resources_parsed_from(response)
@@ -238,6 +264,8 @@ module EPlat
                     changed_attributes.clear
                 end
             end
+        rescue ActiveResource::ResourceInvalid
+            raise
         rescue StandardError => e
             raise EPlat::GraphqlError.new(e.message)
         end
@@ -251,6 +279,46 @@ module EPlat
             mutation_proc.call(input, additional_graphql:) 
         end
 
+        # one request can carry several mutation roots, e.g. productUpdate plus productVariantsBulkUpdate
+        def user_errors_by_mutation_from(response)
+            data = response["data"].is_a?(Hash) ? response["data"] : response
+            mutation_payloads = data.select { |_mutation_name, payload| payload.is_a?(Hash) }
+
+            mutation_payloads
+                .transform_values { |payload| payload["userErrors"] || [] }
+                .reject { |_mutation_name, user_errors| user_errors.empty? }
+        end
+
+        def log_user_errors(user_errors_by_mutation)
+            user_errors_by_mutation.each do |mutation_name, user_errors|
+                user_errors_logger&.warn(
+                    "[EPlat] #{mutation_name} userErrors on #{self.class.name} #{id.inspect}: #{user_errors_message(user_errors)}"
+                )
+            end
+        end
+
+        def user_errors_logger
+            defined?(Rails) && Rails.logger ? Rails.logger : self.class.logger
+        end
+
+        def user_errors_message(user_errors)
+            user_errors.map do |user_error|
+                field = Array(user_error["field"]).join(".")
+
+                [field.presence, user_error["message"]].compact.join(": ")
+            end.join(", ")
+        end
+
+        # ActiveResource's save rescues ResourceInvalid into errors and returns false; save! re-raises it
+        def raise_resource_invalid_with(user_errors)
+            error_messages = user_errors.map { |user_error| user_error["message"] }
+            invalid_response = UserErrorsResponse.new(
+                {errors: {base: error_messages}, message: error_messages.join(", ")}.to_json
+            )
+
+            raise ActiveResource::ResourceInvalid.new(invalid_response)
+        end
+
         def remove_mutation_root_from(data, graphql_proc_constant)
             mutation_root = graphql_proc_constant.split(".").last.camelcase(:lower)
             (mutation_root && data[mutation_root]) ? data[mutation_root] : data

data/lib/e_plat/resource/platform_specific/shopify/graph_q_l/v_2026_04/mutation/product/variant.rb

@@ -47,6 +47,10 @@ module EPlat::Shopify::GraphQL::V202604::Mutation::Product::Variant
 					mutation {
 						#{additional_graphql}
 						productVariantsBulkDelete(#{args}) {
+							userErrors {
+								field
+								message
+							}
 							product {
 								id
 							}
@@ -61,6 +65,10 @@ module EPlat::Shopify::GraphQL::V202604::Mutation::Product::Variant
 				<<~GRAPHQL
 					#{additional_graphql}
 					productVariantsBulkCreate(#{args}) {
+						userErrors {
+							field
+							message
+						}
 						productVariants {
 							#{EPlat::Shopify::Product::Variant.graphql_fields}
 						}
@@ -74,6 +82,10 @@ module EPlat::Shopify::GraphQL::V202604::Mutation::Product::Variant
 				<<~GRAPHQL
 					#{additional_graphql}
 					productVariantsBulkUpdate(#{args}) {
+						userErrors {
+							field
+							message
+						}
 						productVariants {
 							#{EPlat::Shopify::Product::Variant.graphql_fields}
 						}

data/lib/e_plat/resource/platform_specific/shopify/graph_q_l/v_2026_04/mutation/product.rb

@@ -10,6 +10,10 @@ module EPlat::Shopify::GraphQL::V202604::Mutation::Product
 					mutation {
 						#{additional_graphql}
 						productCreate(#{args}) {
+							userErrors {
+								field
+								message
+							}
 							product {
 								#{EPlat::Shopify::Product.graphql_fields}
 							}
@@ -25,6 +29,10 @@ module EPlat::Shopify::GraphQL::V202604::Mutation::Product
 					mutation {
 						#{additional_graphql}
 						productUpdate(#{args}) {
+							userErrors {
+								field
+								message
+							}
 							product {
 								#{EPlat::Shopify::Product.graphql_fields}
 							}

data/lib/e_plat/version.rb

@@ -1,3 +1,3 @@
 module EPlat
-  VERSION = "1.3.0"
+  VERSION = "1.5.0"
 end

data/lib/e_plat.rb

@@ -1,13 +1,15 @@
-require "e_plat/version"
-require "e_plat/engine"
-require "zeitwerk"
+# frozen_string_literal: true
 
-require "active_support"
-require "activeresource"
-require "activeresource-response"
+require 'e_plat/version'
+require 'e_plat/engine'
+require 'zeitwerk'
+
+require 'active_support'
+require 'activeresource'
+require 'activeresource-response'
 require 'dry-types'
 require 'active_resource/connection_error'
-require_relative "hash"
+require_relative 'hash'
 # require "e_plat/railtie" if defined?(Rails::Railtie)
 
 Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
@@ -16,66 +18,64 @@ loader.collapse("#{__dir__}/e_plat/resource") # So can call EPlat::Product
 loader.collapse("#{__dir__}/e_plat/resource/shopify_only")
 loader.collapse("#{__dir__}/e_plat/resource/platform_specific")
 loader.collapse("#{__dir__}/e_plat/errors")
-loader.setup 
+loader.setup
 
+module EPlat
+  extend Dry::Configurable
+  SUPPORTED_SHOPIFY_API_VERSIONS = %w[2024_01 2024_07 2025_01 2025_10 2026_04].freeze
+  SUPPORTED_BIGCOMMERCE_API_VERSIONS = ['3'].freeze
+  SUPPORTED_WOOCOMMERCE_API_VERSIONS = ['3'].freeze
+  SUPPORTED_PLATFORMS = %w[shopify bigcommerce woocommerce].freeze
+  SUPPORTED_RESOURCES = [
+    'shop',
+    'product',
+    'product/variant',
+    'product/image',
+    'product/option',
+    'product/image',
+    'order',
+    'order/line_item',
+    'order/shipping_address',
+    'order/billing_address',
+    'script_tag',
+    'webhook',
+    'metafield'
+  ].freeze
+  PROTECTED_PREFIX = '_protected_'
 
+  setting(:shopify_api_version, default: ENV['EPLAT_SHOPIFY_API_VERSION'] || '2026_04', constructor: lambda do |value|
+    SUPPORTED_SHOPIFY_API_VERSIONS.include?(value.underscore) ? value.underscore : raise(ArgumentError, "Shopify API version #{value} is not supported")
+  end)
 
-module EPlat
-    extend Dry::Configurable
-    SUPPORTED_SHOPIFY_API_VERSIONS = ['2024_01', '2024_07', '2025_01', '2025_10', '2026_04']
-    SUPPORTED_BIGCOMMERCE_API_VERSIONS = ['3']
-    SUPPORTED_WOOCOMMERCE_API_VERSIONS = ['3']
-    SUPPORTED_PLATFORMS = ["shopify", "bigcommerce", "woocommerce"]
-    SUPPORTED_RESOURCES = [
-        "shop",
-        "product",
-        "product/variant",
-        "product/image",
-        "product/option",
-        "product/image",
-        "order",
-        "order/line_item",
-        "order/shipping_address",
-        "order/billing_address",
-        "script_tag",
-        "webhook",
-        "metafield"
-    ]
-    PROTECTED_PREFIX = "_protected_"
-    
-    setting(:shopify_api_version, default: ENV['EPLAT_SHOPIFY_API_VERSION'] || "2026_04", 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: ENV['EPLAT_BIGCOMMERCE_API_VERSION'] || 'v3', constructor: lambda do |value|
+    v = value.downcase.gsub('v', '')
+    SUPPORTED_BIGCOMMERCE_API_VERSIONS.include?(v) ? v : raise(ArgumentError, "Bigcommerce API version #{value} is not supported")
+  end)
 
-    setting(:bigcommerce_api_version, default: ENV['EPLAT_BIGCOMMERCE_API_VERSION'] ||  "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(:woocommerce_api_version, default: ENV['EPLAT_WOOCOMMERCE_API_VERSION'] || "v3", constructor: ->(value) do 
-        v = value.downcase.gsub("v", "")
-        SUPPORTED_WOOCOMMERCE_API_VERSIONS.include?(v) ? v : raise(ArgumentError, "WooCommerce API version #{value} is not supported")
-    end)
+  setting(:woocommerce_api_version, default: ENV['EPLAT_WOOCOMMERCE_API_VERSION'] || 'v3', constructor: lambda do |value|
+    v = value.downcase.gsub('v', '')
+    SUPPORTED_WOOCOMMERCE_API_VERSIONS.include?(v) ? v : raise(ArgumentError, "WooCommerce API version #{value} is not supported")
+  end)
 
-    setting(:print_graphql_requests, default:ENV['EPLAT_PRINT_GRAPHQL_REQUESTS'] || false)
+  setting(:print_graphql_requests, default: ENV['EPLAT_PRINT_GRAPHQL_REQUESTS'] || false)
 
-    setting(:mute_woocommerce_variant_warnings, default: ENV['EPLAT_MUTE_WOOCOMMERCE_VARIANT_WARNINGS'] || false)
+  setting(:mute_woocommerce_variant_warnings, default: ENV['EPLAT_MUTE_WOOCOMMERCE_VARIANT_WARNINGS'] || false)
 
-    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
+  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
 
-    def self.shopify_graphql_version
-        "V#{ EPlat.config.shopify_api_version.gsub("_", "") }"
-    end
+  def self.shopify_graphql_version
+    "V#{EPlat.config.shopify_api_version.gsub('_', '')}"
+  end
 
-    class Error < StandardError; end
-    class GraphqlError < Error; end
+  class Error < StandardError; end
+  class GraphqlError < Error; end
 end
 
 EPlat::Initializer.check_required_classes!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: e_plat
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - oliwoodsuk
@@ -503,7 +503,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.5
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Creates a single interface for integrating with ecommerce platform APIs.
 test_files: []