shopify_api 9.0.4 → 9.5

data/lib/shopify_api/resources/custom_collection.rb

@@ -1,18 +1,19 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class CustomCollection < Base
     include Events
     include Metafields
 
     def products
-      Product.find(:all, :params => {:collection_id => self.id})
+      Product.find(:all, params: { collection_id: self.id })
     end
 
     def add_product(product)
-      Collect.create(:collection_id => self.id, :product_id => product.id)
+      Collect.create(collection_id: self.id, product_id: product.id)
     end
 
     def remove_product(product)
-      collect = Collect.find(:first, :params => {:collection_id => self.id, :product_id => product.id})
+      collect = Collect.find(:first, params: { collection_id: self.id, product_id: product.id })
       collect.destroy if collect
     end
   end

data/lib/shopify_api/resources/customer.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Customer < Base
     include Metafields
 
     def orders
-      Order.find(:all, params: {customer_id: self.id})
+      Order.find(:all, params: { customer_id: self.id })
     end
 
     def self.search(params)

data/lib/shopify_api/resources/customer_group.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'shopify_api/resources/customer_saved_search'
 
 module ShopifyAPI

data/lib/shopify_api/resources/customer_invite.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class CustomerInvite < Base
   end

data/lib/shopify_api/resources/customer_saved_search.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'shopify_api/resources/customer'
 
 module ShopifyAPI
@@ -5,7 +6,7 @@ module ShopifyAPI
     early_july_pagination_release!
 
     def customers(params = {})
-      Customer.search(params.merge({:customer_saved_search_id => self.id}))
+      Customer.search(params.merge({ customer_saved_search_id: self.id }))
     end
   end
 end

data/lib/shopify_api/resources/discount_code.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class DiscountCode < Base
     init_prefix :price_rule

data/lib/shopify_api/resources/discount_code_batch.rb

@@ -12,8 +12,10 @@ module ShopifyAPI
     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
+          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|

data/lib/shopify_api/resources/draft_order.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class DraftOrder < Base
     include Metafields

data/lib/shopify_api/resources/draft_order_invoice.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class DraftOrderInvoice < Base
   end

data/lib/shopify_api/resources/event.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Event < Base
     include DisablePrefixCheck

data/lib/shopify_api/resources/fulfillment.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Fulfillment < Base
     init_prefix :order
@@ -6,9 +7,17 @@ module ShopifyAPI
       @prefix_options[:order_id]
     end
 
-    def cancel; load_attributes_from_response(post(:cancel, {}, only_id)); end
-    def complete; load_attributes_from_response(post(:complete, {}, only_id)); end
-    def open; load_attributes_from_response(post(:open, {}, only_id)); end
+    def cancel
+      load_attributes_from_response(post(:cancel, {}, only_id))
+    end
+
+    def complete
+      load_attributes_from_response(post(:complete, {}, only_id))
+    end
+
+    def open
+      load_attributes_from_response(post(:open, {}, only_id))
+    end
 
     def order_id=(order_id)
       prefix_options[:order_id] = order_id

data/lib/shopify_api/resources/fulfillment_event.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class FulfillmentEvent < Base
     self.resource_prefix = "orders/:order_id/fulfillments/:fulfillment_id/"

data/lib/shopify_api/resources/fulfillment_order.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class FulfillmentOrder < Base
     MINIMUM_VERSION = '2020-01'
@@ -37,8 +38,8 @@ module ShopifyAPI
     def move(new_location_id:)
       body = {
         fulfillment_order: {
-          new_location_id: new_location_id
-        }
+          new_location_id: new_location_id,
+        },
       }
       keyed_fulfillment_orders = keyed_fulfillment_orders_from_response(post(:move, {}, body.to_json))
       load_keyed_fulfillment_order(keyed_fulfillment_orders, 'original_fulfillment_order')
@@ -51,11 +52,24 @@ module ShopifyAPI
       keyed_fulfillment_orders
     end
 
+    def open
+      load_attributes_from_response(post(:open, {}, only_id))
+    end
+
+    def reschedule(new_fulfill_at:)
+      body = {
+        fulfillment_order: {
+          new_fulfill_at: new_fulfill_at,
+        },
+      }
+      load_attributes_from_response(post(:reschedule, {}, body.to_json))
+    end
+
     def close(message: nil)
       body = {
         fulfillment_order: {
-          message: message
-        }
+          message: message,
+        },
       }
       load_attributes_from_response(post(:close, {}, body.to_json))
     end
@@ -64,8 +78,8 @@ module ShopifyAPI
       body = {
         fulfillment_request: {
           fulfillment_order_line_items: fulfillment_order_line_items,
-          message: message
-        }
+          message: message,
+        },
       }
       keyed_fulfillment_orders = keyed_fulfillment_orders_from_response(post(:fulfillment_request, {}, body.to_json))
       load_keyed_fulfillment_order(keyed_fulfillment_orders, 'original_fulfillment_order')
@@ -75,8 +89,8 @@ module ShopifyAPI
     def accept_fulfillment_request(message: nil)
       body = {
         fulfillment_request: {
-          message: message
-        }
+          message: message,
+        },
       }
       load_attributes_from_response(post('fulfillment_request/accept', {}, body.to_json))
     end
@@ -84,8 +98,8 @@ module ShopifyAPI
     def reject_fulfillment_request(message: nil)
       body = {
         fulfillment_request: {
-          message: message
-        }
+          message: message,
+        },
       }
       load_attributes_from_response(post('fulfillment_request/reject', {}, body.to_json))
     end
@@ -93,8 +107,8 @@ module ShopifyAPI
     def request_cancellation(message: nil)
       body = {
         cancellation_request: {
-          message: message
-        }
+          message: message,
+        },
       }
       load_attributes_from_response(post(:cancellation_request, {}, body.to_json))
     end
@@ -102,8 +116,8 @@ module ShopifyAPI
     def accept_cancellation_request(message: nil)
       body = {
         cancellation_request: {
-          message: message
-        }
+          message: message,
+        },
       }
       load_attributes_from_response(post('cancellation_request/accept', {}, body.to_json))
     end
@@ -111,8 +125,8 @@ module ShopifyAPI
     def reject_cancellation_request(message: nil)
       body = {
         cancellation_request: {
-          message: message
-        }
+          message: message,
+        },
       }
       load_attributes_from_response(post('cancellation_request/reject', {}, body.to_json))
     end

data/lib/shopify_api/resources/fulfillment_order_locations_for_move.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class FulfillmentOrderLocationsForMove < Base
   end

data/lib/shopify_api/resources/fulfillment_request.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class FulfillmentRequest < Base
     init_prefix :order

data/lib/shopify_api/resources/fulfillment_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class FulfillmentService < Base
   end

data/lib/shopify_api/resources/fulfillment_v2.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class FulfillmentV2 < Base
     self.element_name = 'fulfillment'
@@ -11,8 +12,8 @@ module ShopifyAPI
       body = {
         fulfillment: {
           tracking_info: tracking_info,
-          notify_customer: notify_customer
-        }
+          notify_customer: notify_customer,
+        },
       }
       load_attributes_from_response(post(:update_tracking, {}, body.to_json))
     end

data/lib/shopify_api/resources/gift_card.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class GiftCard < Base
     def disable

data/lib/shopify_api/resources/image.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Image < Base
     init_prefix :product
@@ -5,7 +6,7 @@ module ShopifyAPI
     # generate a method for each possible image variant
     [:pico, :icon, :thumb, :small, :compact, :medium, :large, :grande, :original].each do |m|
       reg_exp_match = "/\\1_#{m}.\\2"
-      define_method(m) { src.gsub(/\/(.*)\.(\w{2,4})/, reg_exp_match) }
+      define_method(m) { src.gsub(%r/\/(.*)\.(\w{2,4})/, reg_exp_match) }
     end
 
     def attach_image(data, filename = nil)

data/lib/shopify_api/resources/inventory_level.rb

@@ -2,10 +2,9 @@
 
 module ShopifyAPI
   class InventoryLevel < Base
-
     # The default path structure in ActiveResource for delete would result in:
     # /admin/api/<version>/inventory_levels/#{ inventory_level.id }.json?#{ params }, but since
-    # InventroyLevels are a second class resource made up of a Where and a What
+    # InventoryLevels are a second class resource made up of a Where and a What
     # (Location and InventoryItem), it does not have a resource ID. Here we
     # redefine element_path to remove the id so HTTP DELETE requests go to
     # /admin/api/<version>/inventory_levels.json?#{ params } instead.
@@ -33,7 +32,7 @@ module ShopifyAPI
       body = {
         location_id: location_id,
         inventory_item_id: inventory_item_id,
-        available: new_available
+        available: new_available,
       }
       body[:disconnect_if_necessary] = disconnect_if_necessary unless disconnect_if_necessary.nil?
       load_attributes_from_response(
@@ -45,7 +44,7 @@ module ShopifyAPI
       body = {
         location_id: location_id,
         inventory_item_id: inventory_item_id,
-        available_adjustment: available_adjustment
+        available_adjustment: available_adjustment,
       }
       load_attributes_from_response(
         self.class.post(:adjust, {}, body.to_json)

data/lib/shopify_api/resources/line_item.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class LineItem < Base
     class Property < Base
       def initialize(*args)
-        attributes = args[0] || {}
-        persisted = args[1] || false
+        self.attributes = args[0] || {}
+        self.persisted = args[1] || false
         super
       rescue NameError
-        attributes = attributes.to_hash
+        self.attributes = attributes.to_hash
         self
       end
     end

data/lib/shopify_api/resources/location.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Location < Base
-
     def inventory_levels
       ShopifyAPI::InventoryLevel.find(:all, from: "#{self.class.prefix}locations/#{id}/inventory_levels.json")
     end

data/lib/shopify_api/resources/marketing_event.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class MarketingEvent < Base
     include Countable

data/lib/shopify_api/resources/metafield.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Metafield < Base
     include DisablePrefixCheck

data/lib/shopify_api/resources/note_attribute.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class NoteAttribute < Base
   end

data/lib/shopify_api/resources/option.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Option < Base
   end

data/lib/shopify_api/resources/order.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Order < Base
     include Events
@@ -16,7 +17,7 @@ module ShopifyAPI
     end
 
     def transactions
-      Transaction.find(:all, :params => { :order_id => id })
+      Transaction.find(:all, params: { order_id: id })
     end
 
     def capture(amount = "", currency: nil)

data/lib/shopify_api/resources/order_risk.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class OrderRisk < Base
     init_prefix :order

data/lib/shopify_api/resources/page.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Page < Base
     include Events

data/lib/shopify_api/resources/payment_details.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class PaymentDetails < Base
   end

data/lib/shopify_api/resources/policy.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Policy < Base
     def self.all

data/lib/shopify_api/resources/price_rule.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class PriceRule < Base
-
     def discount_codes
       DiscountCode.find(:all, params: { price_rule_id: id })
     end

data/lib/shopify_api/resources/product.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Product < Base
     include Events
@@ -5,10 +6,15 @@ 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)
-      format =  "%0.2f"
+      format = "%0.2f"
       if prices.min != prices.max
         "#{format % prices.min} - #{format % prices.max}"
       else
@@ -16,12 +22,17 @@ module ShopifyAPI
       end
     end
 
+    def total_inventory=(new_value)
+      raise_deprecated_inventory_call('total_inventory') unless allow_inventory_params?
+      super
+    end
+
     def collections
-      CustomCollection.find(:all, :params => {:product_id => self.id})
+      CustomCollection.find(:all, params: { product_id: self.id })
     end
 
     def smart_collections
-      SmartCollection.find(:all, :params => {:product_id => self.id})
+      SmartCollection.find(:all, params: { product_id: self.id })
     end
 
     def add_to_collection(collection)
@@ -31,5 +42,18 @@ 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/product_listing.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ProductListing < Base
     self.primary_key = :product_id

data/lib/shopify_api/resources/province.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Province < Base
     init_prefix :country

data/lib/shopify_api/resources/receipt.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Receipt < Base
   end

data/lib/shopify_api/resources/recurring_application_charge.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class RecurringApplicationCharge < Base
     undef_method :test
@@ -25,7 +26,9 @@ module ShopifyAPI
     end
 
     def customize(customize_recurring_app_charge_params = {})
-      load_attributes_from_response(put(:customize, recurring_application_charge: customize_recurring_app_charge_params ))
+      load_attributes_from_response(
+        put(:customize, recurring_application_charge: customize_recurring_app_charge_params)
+      )
     end
   end
 end

data/lib/shopify_api/resources/redirect.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Redirect < Base
   end

data/lib/shopify_api/resources/refund.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Refund < Base
     init_prefix :order
 
     def self.calculate(*args)
-      options = { :refund => args[0] }
+      options = { refund: args[0] }
       params = {}
       params = args[1][:params] if args[1] && args[1][:params]
 

data/lib/shopify_api/resources/report.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Report < Base
   end

data/lib/shopify_api/resources/resource_feedback.rb

@@ -13,7 +13,7 @@ module ShopifyAPI
 
     def save
       return super unless persisted?
-      raise ExistingFeedbackSaved.new(EXISTING_FEEDBACK_SAVED_ERROR_MESSAGE)
+      raise ExistingFeedbackSaved, EXISTING_FEEDBACK_SAVED_ERROR_MESSAGE
     end
   end
 end

data/lib/shopify_api/resources/rule.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Rule < Base
   end

data/lib/shopify_api/resources/script_tag.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ScriptTag < Base
   end

data/lib/shopify_api/resources/shipping_address.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ShippingAddress < Base
   end

data/lib/shopify_api/resources/shipping_line.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ShippingLine < Base
   end

data/lib/shopify_api/resources/shipping_zone.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ShippingZone < Base
   end

data/lib/shopify_api/resources/shop.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   # Shop object. Use Shop.current to receive
   # the shop.
@@ -9,7 +10,7 @@ module ShopifyAPI
     end
 
     def metafields(**options)
-      Metafield.find :all, params: options
+      Metafield.find(:all, params: options)
     end
 
     def add_metafield(metafield)

data/lib/shopify_api/resources/smart_collection.rb

@@ -1,19 +1,15 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class SmartCollection < Base
     include Events
     include Metafields
 
-    def products(options = {})
-      if options.present?
-        Product.find(:all, from: "#{self.class.prefix}smart_collections/#{id}/products.json", params: options)
-      else
-        Product.find(:all, params: { collection_id: id })
-      end
+    def products
+      Product.find(:all, params: { collection_id: id })
     end
 
-    def order(options={})
+    def order(options = {})
       load_attributes_from_response(put(:order, options, only_id))
     end
-
   end
 end

data/lib/shopify_api/resources/storefront_access_token.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class StorefrontAccessToken < Base
   end

data/lib/shopify_api/resources/tax_line.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class TaxLine < Base
   end

data/lib/shopify_api/resources/tax_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class TaxService < Base
   end

data/lib/shopify_api/resources/theme.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Theme < Base
   end