Merge pull request #781 from Shopify/fix_variant_serialization

Filter unwanted product / variant attributes on creation

lib/shopify_api/resources/product.rb

@@ -5,6 +5,11 @@ module ShopifyAPI
 
     early_july_pagination_release!
 
+    def initialize(*)
+      super
+      self.attributes.except!('total_inventory') unless allow_inventory_params?
+    end
+
     # compute the price range
     def price_range
       prices = variants.collect(&:price).collect(&:to_f)
@@ -21,10 +26,6 @@ module ShopifyAPI
       super
     end
 
-    def serializable_hash(options = {})
-      allow_inventory_params? ? super(options) : super(options).except('total_inventory')
-    end
-
     def collections
       CustomCollection.find(:all, :params => { :product_id => self.id })
     end

lib/shopify_api/resources/variant.rb

@@ -4,7 +4,14 @@ module ShopifyAPI
     include DisablePrefixCheck
 
     conditional_prefix :product
-    
+
+    def initialize(*)
+      super
+      unless allow_inventory_params?
+        attributes.except!('inventory_quantity_adjustment', 'inventory_quantity', 'old_inventory_quantity')
+      end
+    end
+
     def inventory_quantity_adjustment=(new_value)
       raise_deprecated_inventory_call('inventory_quantity_adjustment') unless allow_inventory_params?
       super
@@ -20,16 +27,6 @@ module ShopifyAPI
       super
     end
 
-    def serializable_hash(options = {})
-      if allow_inventory_params?
-        super(options)
-      else
-        super(options).tap do |resource|
-          (resource['variant'] || resource).except!('inventory_quantity', 'old_inventory_quantity')
-        end
-      end
-    end
-
     private
 
     def raise_deprecated_inventory_call(parameter)

test/product_test.rb

@@ -4,8 +4,7 @@ class ProductTest < Test::Unit::TestCase
   def setup
     super
 
-    fake "products/632910392", :body => load_fixture('product')
-    @product = ShopifyAPI::Product.find(632910392)
+    refresh_product
   end
 
   def test_add_metafields_to_product
@@ -60,30 +59,36 @@ class ProductTest < Test::Unit::TestCase
 
   def test_deprecated_variant_inventory_fields_are_included_in_2019_07
     ShopifyAPI::Base.api_version = '2019-07'
+    refresh_product(api_version: ShopifyAPI::Base.api_version)
+
     variant = @product.variants.first
     assert variant.as_json.include?('inventory_quantity')
   end
 
   def test_deprecated_variant_inventory_fields_are_removed_in_2020_01
     ShopifyAPI::Base.api_version = '2020-01'
+    refresh_product(api_version: ShopifyAPI::Base.api_version)
+
     variant = @product.variants.first
     refute variant.as_json.include?('inventory_quantity')
   end
 
   def test_deprecated_inventory_fields_are_removed_in_2020_01
     ShopifyAPI::Base.api_version = '2020-01'
+    refresh_product(api_version: ShopifyAPI::Base.api_version)
+
     refute @product.as_json.include?('total_inventory')
   end
 
   def test_setting_product_total_inventory_passes_in_api_before_2019_10
     ShopifyAPI::Base.api_version = '2019-07'
-    fake("products/632910392", { :body => load_fixture('product') })
+    refresh_product(api_version: ShopifyAPI::Base.api_version)
     @product.total_inventory = 8
   end
 
   def test_setting_product_total_inventory_fails_in_2019_10_api
     ShopifyAPI::Base.api_version = '2019-10'
-    fake("products/632910392", { :body => load_fixture('product') })
+    refresh_product(api_version: ShopifyAPI::Base.api_version)
     assert_raises(ShopifyAPI::ValidationException) do
       @product.total_inventory = 8
     end
@@ -91,9 +96,16 @@ class ProductTest < Test::Unit::TestCase
 
   def test_setting_product_total_inventory_fails_in_the_unstable_api
     ShopifyAPI::Base.api_version = :unstable
-    fake("products/632910392", { :body => load_fixture('product') })
+    refresh_product(api_version: ShopifyAPI::Base.api_version)
     assert_raises(ShopifyAPI::ValidationException) do
       @product.total_inventory = 8
     end
   end
+
+  private
+
+  def refresh_product(api_version: nil)
+    fake "products/632910392", :body => load_fixture('product'), api_version: api_version
+    @product = ShopifyAPI::Product.find(632910392)
+  end
 end

test/variant_test.rb

@@ -3,8 +3,7 @@ require 'test_helper'
 class VariantTest < Test::Unit::TestCase
   def setup
     super
-    fake "products/632910392/variants/808950810", method: :get, body: load_fixture('variant')
-    @variant = ShopifyAPI::Variant.find(808950810, :params => { :product_id => 632910392 })
+    refresh_variant
   end
 
   def test_get_variants
@@ -37,21 +36,25 @@ class VariantTest < Test::Unit::TestCase
 
   def test_deprecated_inventory_fields_are_included_in_2019_07
     ShopifyAPI::Base.api_version = '2019-07'
+    refresh_variant(api_version: ShopifyAPI::Base.api_version)
     assert @variant.as_json.include?('inventory_quantity')
   end
 
   def test_deprecated_inventory_fields_are_removed_in_2020_01
     ShopifyAPI::Base.api_version = '2020-01'
+    refresh_variant(api_version: ShopifyAPI::Base.api_version)
     refute @variant.as_json.include?('inventory_quantity')
   end
 
   def test_setting_variant_inventory_quantity_adjustment_passes_in_api_before_2019_10
     ShopifyAPI::Base.api_version = '2019-07'
+    refresh_variant(api_version: ShopifyAPI::Base.api_version)
     @variant.inventory_quantity_adjustment = 8
   end
 
   def test_setting_variant_inventory_quantity_adjustment_fails_in_2019_10_api
     ShopifyAPI::Base.api_version = '2019-10'
+    refresh_variant(api_version: ShopifyAPI::Base.api_version)
     assert_raises(ShopifyAPI::ValidationException) do
       @variant.inventory_quantity_adjustment = 8
     end
@@ -101,4 +104,11 @@ class VariantTest < Test::Unit::TestCase
       @variant.old_inventory_quantity = 8
     end
   end
+
+  private
+
+  def refresh_variant(api_version: nil)
+    fake "products/632910392/variants/808950810", method: :get, body: load_fixture('variant'), api_version: api_version
+    @variant = ShopifyAPI::Variant.find(808950810, :params => { :product_id => 632910392 })
+  end
 end