Add save deny list to base REST resource

Author: paulomarg

CHANGELOG.md

@@ -1,3 +1,9 @@
+# Changelog
+
+## Unreleased
+
+- [#919](https://github.com/Shopify/shopify_api/pull/919) Allow REST resources to configure a deny list of attributes to be excluded when saving
+
 ## Version 10.0.0
 
 - Major update to the library to provide _all_ essential functions needed for a Shopify app, supporting embedded apps with session tokens. See the [full list of changes](https://github.com/Shopify/shopify_api#breaking-change-notice-for-version-1000) here

lib/shopify_api/rest/base.rb

@@ -15,6 +15,7 @@ class Base
       @has_many = T.let({}, T::Hash[Symbol, Class])
       @paths = T.let([], T::Array[T::Hash[Symbol, T.any(T::Array[Symbol], String, Symbol)]])
       @custom_prefix = T.let(nil, T.nilable(String))
+      @attribute_save_deny_list = T.let([], T.nilable(T::Array[Symbol]))
 
       sig { returns(T::Hash[Symbol, T.untyped]) }
       attr_accessor :original_state
@@ -118,6 +119,11 @@ def has_one?(attribute)
           @has_one.include?(attribute)
         end
 
+        sig { returns(T.nilable(T::Array[Symbol])) }
+        def attribute_save_deny_list
+          @attribute_save_deny_list&.map { |a| :"@#{a}" }
+        end
+
         sig do
           params(
             http_method: Symbol,
@@ -259,6 +265,7 @@ def to_hash
         hash = {}
         instance_variables.each do |var|
           next if [:"@original_state", :"@session", :"@client", :"@forced_nils", :"@errors"].include?(var)
+          next if self.class.attribute_save_deny_list&.include?(var)
 
           attribute = var.to_s.delete("@").to_sym
           if self.class.has_many?(attribute)

test/clients/base_rest_resource_test.rb

@@ -146,6 +146,23 @@ def test_saves_with_children
         assert_requested(stubbed_request)
       end
 
+      def test_save_ignores_unsaveable_attributes
+        request_body = { fake_resource: { attribute: "attribute" } }.to_json
+        response_body = { fake_resource: { id: 1, attribute: "attribute" } }.to_json
+
+        stubbed_request = stub_request(:post, "#{@prefix}/fake_resources.json")
+          .with(body: request_body)
+          .to_return(status: 201, body: response_body)
+
+        resource = TestHelpers::FakeResource.new(session: @session)
+        resource.attribute = "attribute"
+        resource.unsaveable_attribute = "this is an attribute"
+
+        resource.save
+        assert_requested(stubbed_request)
+        assert_nil(resource.id)
+      end
+
       def test_deletes_existing_resource_and_fails_on_deleting_nonexistent_resource
         resource = TestHelpers::FakeResource.new(session: @session)
         resource.id = 1

test/test_helpers/fake_resource.rb

@@ -16,6 +16,8 @@ class FakeResource < ShopifyAPI::Rest::Base
     @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
     @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
 
+    @attribute_save_deny_list = T.let([:unsaveable_attribute], T::Array[Symbol])
+
     @paths = T.let([
       { http_method: :get, operation: :get, ids: [], path: "fake_resources.json" },
       { http_method: :post, operation: :post, ids: [], path: "fake_resources.json" },
@@ -36,6 +38,7 @@ def initialize(session: nil)
       @has_one_attribute = T.let(nil, T.nilable(FakeResource))
       @has_many_attribute = T.let(nil, T.nilable(T::Array[FakeResource]))
       @other_resource_id = T.let(nil, T.nilable(Integer))
+      @unsaveable_attribute = T.let(nil, T.nilable(String))
     end
 
     sig { returns(T.nilable(Integer)) }
@@ -53,6 +56,9 @@ def initialize(session: nil)
     sig { returns(T.nilable(Integer)) }
     attr_reader :other_resource_id
 
+    sig { returns(T.nilable(String)) }
+    attr_reader :unsaveable_attribute
+
     class << self
       sig do
         params(id: T.any(Integer, String), session: ShopifyAPI::Auth::Session, param: T.untyped,