shopify_api 9.0.2 → 9.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecdf64046f5d81646d89f356cab1bbf7ca3aefddbba51a28901b723f0dec8e4b
-  data.tar.gz: a64041593db78180893580ec8b3581b7927c39452b2ad5004575aa0a7afc209d
+  metadata.gz: a9f98c9f7ec2a7834c9b4f69c4dfa346e23b220173a03690cabc753e9d0b4318
+  data.tar.gz: 5245b531946faf49fc3213e7faadc5b8372ba71ccfa8e26f14d8b2630bff0d36
 SHA512:
-  metadata.gz: 267a96c8839314b7bb195e0e1288d3bad23a9a5e4a524190e59a2ed2e9ffc2ba9f6f78e0a5d93d4edf56dbcbff15f387c2217893b62839c4faa6e969f2ff4fa3
-  data.tar.gz: 42d7b26d80dba411512c86e2be195899527ce106f8450a1b8b4fe6e073a363160431a72771ada837d8f0f008523fa5871b10e5da46c9ebffb3e67d04d724197e
+  metadata.gz: a8b09cb70ebd5ff98dfe08bb4adfb6f25cfa2a2f5023b7e9d703a6e97d33dd6beaac6dfbae29780cf6cab8f9de87718c1e3c5e6cdc8fe2b85b1258a9315c1fa9
+  data.tar.gz: f17ae5b2022d64fe91391dda645e9684b57449dd274f3de0ebbf8c8117072c67d78849646ba914c1432f60b4cfce46ed4b62432e7ecdb00651e1f59210d26c2a

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## Version 9.0.3
+
+* We now raise a `ShopifyAPI::ValidationException` exception when clients try to use `Product` and `Variant` with deprecated inventory-related fields in API version `2019-10` or later. [#655](https://github.com/shopify/shopify_api/pull/655) Deprecation and migration information can be found in the following documents:
+  * [Product Variant REST API Reference](https://shopify.dev/docs/admin-api/rest/reference/products/product-variant)
+  * [Migrate your app to support multiple locations](https://shopify.dev/tutorials/migrate-your-app-to-support-multiple-locations)
+  * [Manage product inventory with the Admin API](https://shopify.dev/tutorials/manage-product-inventory-with-admin-api)
+* Added support for the Discount Code API batch endpoints [#701](https://github.com/shopify/shopify_api/pull/701)
+  * [Create](https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2020-01)
+  * [Show](https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2020-01)
+  * [List](https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-01)
+* Fix issue in the README to explicitly say clients need to require the `shopify_api` gem [#700](https://github.com/Shopify/shopify_api/pull/700)
+
 ## Version 9.0.2
 
 * Added optional flag passed to `initialize_clients` to prevent from raising the `InvalidSchema` exception [#693](https://github.com/Shopify/shopify_api/pull/693)

data/README.md

@@ -73,6 +73,12 @@ Or install via [gem](http://rubygems.org/)
 gem install shopify_api
 ```
 
+Once the gem is installed, it must be added to your project by placing the following line in your app :
+
+```ruby
+require 'shopify_api'
+```
+
 ## Getting Started
 
 ShopifyAPI sessions need to be configured with a fully authorized URL of a particular store before they can start making API calls. To obtain that URL, you can follow these steps:

data/lib/shopify_api/resources/discount_code_batch.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module ShopifyAPI
+  class DiscountCodeBatch < Base
+    init_prefix :price_rule
+
+    self.collection_name = 'batch'
+
+    def price_rule_id
+      @prefix_options[:price_rule_id]
+    end
+
+    def discount_code_job
+      @discount_codes ||= begin
+        if id
+          path = self.class.api_version.construct_api_path("price_rules/#{price_rule_id}/batch/#{id}/discount_codes.json")
+          discount_codes = ShopifyAPI::DiscountCode.find :all, from: path
+          discount_codes.each do |code|
+            errors = code.attributes['errors']
+            errors.attributes.each do |key, values|
+              values.each { |message| code.errors.add(key, message) }
+            end
+          end
+          discount_codes
+        end
+      end
+    end
+
+    def encode(options = {})
+      send("to_#{self.class.format.extension}", options)
+    end
+  end
+end

data/lib/shopify_api/resources/product.rb

@@ -16,6 +16,15 @@ module ShopifyAPI
       end
     end
 
+    def total_inventory=(new_value)
+      raise_deprecated_inventory_call('total_inventory') unless allow_inventory_params?
+      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
@@ -31,5 +40,17 @@ module ShopifyAPI
     def remove_from_collection(collection)
       collection.remove_product(self)
     end
+
+    private
+
+    def raise_deprecated_inventory_call(parameter)
+      raise(ShopifyAPI::ValidationException,
+        "'#{parameter}' is deprecated - see https://help.shopify.com/en/api/guides/inventory-migration-guide",
+        )
+    end
+
+    def allow_inventory_params?
+      Base.api_version < ApiVersion.find_version('2019-10')
+    end
   end
 end

data/lib/shopify_api/resources/variant.rb

@@ -4,5 +4,36 @@ module ShopifyAPI
     include DisablePrefixCheck
 
     conditional_prefix :product
+
+    def inventory_quantity_adjustment=(new_value)
+      raise_deprecated_inventory_call('inventory_quantity_adjustment') unless allow_inventory_params?
+      super
+    end
+
+    def inventory_quantity=(new_value)
+      raise_deprecated_inventory_call('inventory_quantity') unless allow_inventory_params?
+      super
+    end
+
+    def old_inventory_quantity=(new_value)
+      raise_deprecated_inventory_call('old_inventory_quantity') unless allow_inventory_params?
+      super
+    end
+
+    def serializable_hash(options = {})
+      allow_inventory_params? ? super(options) : super(options).except('inventory_quantity', 'old_inventory_quantity')
+    end
+
+    private
+
+    def raise_deprecated_inventory_call(parameter)
+      raise(ShopifyAPI::ValidationException,
+        "'#{parameter}' is deprecated - see https://help.shopify.com/en/api/guides/inventory-migration-guide",
+        )
+    end
+
+    def allow_inventory_params?
+      Base.api_version < ApiVersion.find_version('2019-10')
+    end
   end
 end

data/lib/shopify_api/version.rb

@@ -1,3 +1,3 @@
 module ShopifyAPI
-  VERSION = "9.0.2"
+  VERSION = "9.0.3"
 end

data/shopify_api.gemspec

@@ -11,6 +11,8 @@ Gem::Specification.new do |s|
   s.email = %q{developers@jadedpixel.com}
   s.homepage = %q{http://www.shopify.com/partners/apps}
 
+  s.metadata['allowed_push_host'] = 'https://rubygems.org'
+
   s.extra_rdoc_files = [
     "LICENSE",
     "README.md"

data/test/discount_code_batch_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class DiscountCodeBatchTest < Test::Unit::TestCase
+  def setup
+    super
+    fake 'price_rules/102586120/batch/989355119', body: load_fixture('discount_code_batch')
+  end
+
+  def test_get_batch
+    batch = ShopifyAPI::DiscountCodeBatch.find 989355119, params: { price_rule_id: 102586120 }
+
+    assert_equal 989355119, batch.id
+  end
+
+  def test_get_batch_discount_codes
+    fake 'price_rules/102586120/batch/989355119/discount_codes',
+      method: :get,
+      status: 200,
+      body: load_fixture('discount_code_batch_discount_codes')
+
+    batch = ShopifyAPI::DiscountCodeBatch.find 989355119, params: { price_rule_id: 102586120 }
+    discount_code_job = batch.discount_code_job
+
+    assert_equal 3, discount_code_job.count
+    assert discount_code_job[2].errors.present?
+  end
+
+  def test_create_batch
+    fake 'price_rules/102586120/batch', method: :post, status: 201, body: load_fixture('discount_code_batch')
+    batch = ShopifyAPI::DiscountCodeBatch.new
+    batch.prefix_options[:price_rule_id] = 102586120
+    discount_codes = [{ "code": "SUMMER1" }, { "code": "SUMMER2" }, { "code": "SUMMER3" }]
+    batch.discount_codes = discount_codes
+    batch.save
+
+    expected_body = { discount_codes: discount_codes }.to_json
+    assert_equal expected_body, WebMock.last_request.body
+  end
+end

data/test/fixtures/discount_code_batch.json

@@ -0,0 +1,14 @@
+{
+  "discount_code_creation": {
+    "id": 989355119,
+    "price_rule_id": 102586120,
+    "started_at": null,
+    "completed_at": null,
+    "created_at": "2018-07-05T13:04:29-04:00",
+    "updated_at": "2018-07-05T13:04:29-04:00",
+    "status": "queued",
+    "codes_count": 3,
+    "imported_count": 0,
+    "failed_count": 0
+  }
+}

data/test/fixtures/discount_code_batch_discount_codes.json

@@ -0,0 +1,21 @@
+{
+  "discount_codes": [
+    {
+      "id": null,
+      "code": "SUMMER1",
+      "errors": {}
+    },
+    {
+      "id": null,
+      "code": "SUMMER2",
+      "errors": {}
+    },
+    {
+      "id": null,
+      "code": "SUMMER2",
+      "errors": {
+        "code": ["must be unique"]
+      }
+    }
+  ]
+}

data/test/product_test.rb

@@ -57,4 +57,43 @@ class ProductTest < Test::Unit::TestCase
 
     assert_equal('100.00 - 199.00', @product.price_range)
   end
+
+  def test_deprecated_variant_inventory_fields_are_included_in_2019_07
+    ShopifyAPI::Base.api_version = '2019-07'
+    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'
+    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'
+    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')})
+    @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')})
+    assert_raises(ShopifyAPI::ValidationException) do
+      @product.total_inventory = 8
+    end
+  end
+
+  def test_setting_product_total_inventory_fails_in_the_unstable_api
+    ShopifyAPI::Base.api_version = :unstable
+    fake("products/632910392", {:body => load_fixture('product')})
+    assert_raises(ShopifyAPI::ValidationException) do
+      @product.total_inventory = 8
+    end
+  end
 end

data/test/test_helper.rb

@@ -96,7 +96,7 @@ module Test
         body   = options.has_key?(:body) ? options.delete(:body) : load_fixture(endpoint)
         format = options.delete(:format) || :json
         method = options.delete(:method) || :get
-        api_version = options.delete(:api_version) || ShopifyAPI::ApiVersion.find_version('2019-01')
+        api_version = options.delete(:api_version) || ShopifyAPI::Base.api_version
         extension = ".#{options.delete(:extension)||'json'}" unless options[:extension]==false
         status = options.delete(:status) || 200
         url = if options.has_key?(:url)

data/test/variant_test.rb

@@ -43,4 +43,93 @@ class VariantTest < Test::Unit::TestCase
     v = ShopifyAPI::Variant.find(808950810, :params => {:product_id => 632910392})
     assert v.destroy
   end
+
+  def test_deprecated_inventory_fields_are_included_in_2019_07
+    ShopifyAPI::Base.api_version = '2019-07'
+    fake "products/632910392/variants/808950810", :method => :get, :body => load_fixture('variant')
+    variant = ShopifyAPI::Variant.find(808950810, :params => {:product_id => 632910392})
+    assert variant.as_json.include?('inventory_quantity')
+  end
+
+  def test_deprecated_inventory_fields_are_removed_in_2020_01
+    ShopifyAPI::Base.api_version = '2020-01'
+    fake "products/632910392/variants/808950810", :method => :get, :body => load_fixture('variant')
+    variant = ShopifyAPI::Variant.find(808950810, :params => {:product_id => 632910392})
+    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'
+    fake "products/632910392/variants/808950810", :method => :get, :body => load_fixture('variant')
+    variant = ShopifyAPI::Variant.find(808950810, :params => {:product_id => 632910392})
+    variant.inventory_quantity_adjustment = 8
+  end
+
+  def test_setting_variant_inventory_quantity_adjustment_fails_in_2019_10_api
+    ShopifyAPI::Base.api_version = '2019-10'
+    fake "products/632910392/variants/808950810", :method => :get, :body => load_fixture('variant')
+    variant = ShopifyAPI::Variant.find(808950810, :params => {:product_id => 632910392})
+    assert_raises(ShopifyAPI::ValidationException) do
+      variant.inventory_quantity_adjustment = 8
+    end
+  end
+
+  def test_setting_variant_inventory_quantity_adjustment_fails_in_the_unstable_api
+    ShopifyAPI::Base.api_version = :unstable
+    fake "products/632910392/variants/808950810", :method => :get, :body => load_fixture('variant')
+    variant = ShopifyAPI::Variant.find(808950810, :params => {:product_id => 632910392})
+    assert_raises(ShopifyAPI::ValidationException) do
+      variant.inventory_quantity_adjustment = 8
+    end
+  end
+
+  def test_setting_variant_inventory_quantity_passes_in_api_before_2019_10
+    ShopifyAPI::Base.api_version = '2019-07'
+    fake "products/632910392/variants/808950810", :method => :get, :body => load_fixture('variant')
+    variant = ShopifyAPI::Variant.find(808950810, :params => {:product_id => 632910392})
+    variant.inventory_quantity = 8
+  end
+
+  def test_setting_variant_inventory_quantity_fails_in_2019_10_api
+    ShopifyAPI::Base.api_version = '2019-10'
+    fake "products/632910392/variants/808950810", :method => :get, :body => load_fixture('variant')
+    variant = ShopifyAPI::Variant.find(808950810, :params => {:product_id => 632910392})
+    assert_raises(ShopifyAPI::ValidationException) do
+      variant.inventory_quantity = 8
+    end
+  end
+
+  def test_setting_variant_inventory_quantity_fails_in_the_unstable_api
+    ShopifyAPI::Base.api_version = :unstable
+    fake "products/632910392/variants/808950810", :method => :get, :body => load_fixture('variant')
+    variant = ShopifyAPI::Variant.find(808950810, :params => {:product_id => 632910392})
+    assert_raises(ShopifyAPI::ValidationException) do
+      variant.inventory_quantity = 8
+    end
+  end
+
+  def test_setting_variant_old_inventory_quantity_passes_in_api_before_2019_10
+    ShopifyAPI::Base.api_version = '2019-07'
+    fake "products/632910392/variants/808950810", :method => :get, :body => load_fixture('variant')
+    variant = ShopifyAPI::Variant.find(808950810, :params => {:product_id => 632910392})
+    variant.old_inventory_quantity = 8
+  end
+
+  def test_setting_variant_old_inventory_quantity_fails_in_2019_10_api
+    ShopifyAPI::Base.api_version = '2019-10'
+    fake "products/632910392/variants/808950810", :method => :get, :body => load_fixture('variant')
+    variant = ShopifyAPI::Variant.find(808950810, :params => {:product_id => 632910392})
+    assert_raises(ShopifyAPI::ValidationException) do
+      variant.old_inventory_quantity = 8
+    end
+  end
+
+  def test_setting_variant_old_inventory_quantity_fails_in_the_unstable_api
+    ShopifyAPI::Base.api_version = :unstable
+    fake "products/632910392/variants/808950810", :method => :get, :body => load_fixture('variant')
+    variant = ShopifyAPI::Variant.find(808950810, :params => {:product_id => 632910392})
+    assert_raises(ShopifyAPI::ValidationException) do
+      variant.old_inventory_quantity = 8
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 9.0.2
+  version: 9.0.3
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-06 00:00:00.000000000 Z
+date: 2020-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -255,6 +255,7 @@ files:
 - lib/shopify_api/resources/customer_invite.rb
 - lib/shopify_api/resources/customer_saved_search.rb
 - lib/shopify_api/resources/discount_code.rb
+- lib/shopify_api/resources/discount_code_batch.rb
 - lib/shopify_api/resources/draft_order.rb
 - lib/shopify_api/resources/draft_order_invoice.rb
 - lib/shopify_api/resources/event.rb
@@ -343,6 +344,7 @@ files:
 - test/customer_saved_search_test.rb
 - test/customer_test.rb
 - test/detailed_log_subscriber_test.rb
+- test/discount_code_batch_test.rb
 - test/discount_code_test.rb
 - test/draft_order_test.rb
 - test/fixtures/abandoned_checkout.json
@@ -385,6 +387,8 @@ files:
 - test/fixtures/customers_account_activation_url.json
 - test/fixtures/customers_search.json
 - test/fixtures/discount_code.json
+- test/fixtures/discount_code_batch.json
+- test/fixtures/discount_code_batch_discount_codes.json
 - test/fixtures/discount_codes.json
 - test/fixtures/draft_order.json
 - test/fixtures/draft_order_completed.json
@@ -515,7 +519,8 @@ files:
 homepage: http://www.shopify.com/partners/apps
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"