shopify_api 4.9.0 → 9.4.1

data/lib/shopify_api/resources/fulfillment_order_locations_for_move.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module ShopifyAPI
+  class FulfillmentOrderLocationsForMove < Base
+  end
+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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module ShopifyAPI
+  class FulfillmentV2 < Base
+    self.element_name = 'fulfillment'
+
+    def initialize(attributes = {}, persisted = false)
+      ShopifyAPI::Base.version_validation!(FulfillmentOrder::MINIMUM_VERSION)
+      super(attributes, persisted)
+    end
+
+    def update_tracking(tracking_info:, notify_customer:)
+      body = {
+        fulfillment: {
+          tracking_info: tracking_info,
+          notify_customer: notify_customer,
+        },
+      }
+      load_attributes_from_response(post(:update_tracking, {}, body.to_json))
+    end
+  end
+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,13 +1,14 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Image < Base
     init_prefix :product
-    
+
     # 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)
       attributes['attachment'] = Base64.encode64(data)
       attributes['filename'] = filename unless filename.nil?

data/lib/shopify_api/resources/inventory_item.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class InventoryItem < Base
+  end
+end

data/lib/shopify_api/resources/inventory_level.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+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
+    # 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.
+    #
+    def self.element_path(prefix_options = {}, query_options = nil)
+      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+      "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
+    end
+
+    def destroy
+      load_attributes_from_response(
+        self.class.delete('/', location_id: location_id, inventory_item_id: inventory_item_id)
+      )
+    end
+
+    def connect(relocate_if_necessary: nil)
+      body = { location_id: location_id, inventory_item_id: inventory_item_id }
+      body[:relocate_if_necessary] = relocate_if_necessary unless relocate_if_necessary.nil?
+      load_attributes_from_response(
+        self.class.post(:connect, {}, body.to_json)
+      )
+    end
+
+    def set(new_available, disconnect_if_necessary: nil)
+      body = {
+        location_id: location_id,
+        inventory_item_id: inventory_item_id,
+        available: new_available,
+      }
+      body[:disconnect_if_necessary] = disconnect_if_necessary unless disconnect_if_necessary.nil?
+      load_attributes_from_response(
+        self.class.post(:set, {}, body.to_json)
+      )
+    end
+
+    def adjust(available_adjustment)
+      body = {
+        location_id: location_id,
+        inventory_item_id: inventory_item_id,
+        available_adjustment: available_adjustment,
+      }
+      load_attributes_from_response(
+        self.class.post(:adjust, {}, body.to_json)
+      )
+    end
+  end
+end

data/lib/shopify_api/resources/line_item.rb

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

data/lib/shopify_api/resources/location.rb

@@ -1,4 +1,8 @@
+# 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
   end
 end

data/lib/shopify_api/resources/marketing_event.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class MarketingEvent < Base
+    include Countable
+
     def add_engagements(engagements)
       engagements = { engagements: Array.wrap(engagements) }
       post(:engagements, {}, engagements.to_json)

data/lib/shopify_api/resources/metafield.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Metafield < Base
     include DisablePrefixCheck
 
     conditional_prefix :resource, true
+    early_july_pagination_release!
 
     def value
       return if attributes["value"].nil?

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,21 +1,41 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Order < Base
     include Events
     include Metafields
 
-    def close;  load_attributes_from_response(post(:close, {}, only_id)); end
-    def open;   load_attributes_from_response(post(:open, {}, only_id)); end
+    def close
+      load_attributes_from_response(post(:close, {}, only_id))
+    end
+
+    def open
+      load_attributes_from_response(post(:open, {}, only_id))
+    end
 
     def cancel(options = {})
       load_attributes_from_response(post(:cancel, {}, options.to_json))
     end
 
     def transactions
-      Transaction.find(:all, :params => { :order_id => id })
+      Transaction.find(:all, params: { order_id: id })
     end
 
-    def capture(amount = "")
-      Transaction.create(:amount => amount, :kind => "capture", :order_id => id)
+    def capture(amount = "", currency: nil)
+      capture_transaction = {
+        amount: amount,
+        kind: "capture",
+        order_id: id,
+      }
+      capture_transaction[:currency] = currency if currency
+
+      Transaction.create(capture_transaction)
+    end
+
+    def fulfillment_orders(options = {})
+      ShopifyAPI::Base.version_validation!(FulfillmentOrder::MINIMUM_VERSION)
+
+      fulfillment_order_hashes = get(:fulfillment_orders, options)
+      fulfillment_order_hashes.map { |fulfillment_order_hash| FulfillmentOrder.new(fulfillment_order_hash) }
     end
 
     class ClientDetails < Base

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.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class Payment < Base
+    self.resource_prefix = "checkouts/:checkout_id/"
+  end
+end

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/ping.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Dir.glob("#{File.dirname(__FILE__)}/ping/*").each { |file| require file }

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,33 +1,59 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Product < Base
     include Events
     include Metafields
 
+    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
         format % prices.min
       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)
       collection.add_product(self)
     end
-    
+
     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,9 +1,17 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ProductListing < Base
     self.primary_key = :product_id
 
+    early_july_pagination_release!
+
     def self.product_ids
-      get(:product_ids)
+      ProductId.all
+    end
+
+    class ProductId < ArrayBase
+      self.resource_prefix = 'product_listings/'
     end
+    private_constant :ProductId
   end
 end

data/lib/shopify_api/resources/product_publication.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module ShopifyAPI
+  class ProductPublication < Base
+    init_prefix :publication
+
+    def publication_id
+      @prefix_options[:publication_id]
+    end
+  end
+end

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/publication.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module ShopifyAPI
+  class Publication < Base
+  end
+end

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,12 +1,14 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Refund < Base
     init_prefix :order
 
     def self.calculate(*args)
-      options = { :refund => args[0] }
-      params = options.merge(args[1][:params]) if args[1] && args[1][:params]
-      self.prefix = "/admin/orders/#{params[:order_id]}/"
-      resource = post(:calculate, {}, options.to_json)
+      options = { refund: args[0] }
+      params = {}
+      params = args[1][:params] if args[1] && args[1][:params]
+
+      resource = post(:calculate, params, options.to_json)
       instantiate_record(format.decode(resource.body), {})
     end
   end