shopify_api 9.0.2 → 9.3.0

data/lib/shopify_api/resources/application_charge.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class ApplicationCharge < Base
     undef_method :test

data/lib/shopify_api/resources/application_credit.rb

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

data/lib/shopify_api/resources/article.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Article < Base
     include Events
@@ -7,14 +8,14 @@ module ShopifyAPI
     conditional_prefix :blog
 
     def comments
-      Comment.find(:all, :params => { :article_id => id })
+      Comment.find(:all, params: { article_id: id })
     end
 
     def self.authors(options = {})
       get(:authors, options)
     end
 
-    def self.tags(options={})
+    def self.tags(options = {})
       get(:tags, options)
     end
   end

data/lib/shopify_api/resources/asset.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   # Assets represent the files that comprise your theme.
   # There are different buckets which hold different kinds
@@ -9,10 +10,10 @@ module ShopifyAPI
   # or assets/bg-body.gif.
   #
   # Initialize with a key:
-  #   asset = ShopifyAPI::Asset.new(:key => 'assets/special.css', :theme_id => 12345)
+  #   asset = ShopifyAPI::Asset.new(key: 'assets/special.css', theme_id: 12345)
   #
   # Find by key:
-  #   asset = ShopifyAPI::Asset.find('assets/image.png', :params => {:theme_id => 12345})
+  #   asset = ShopifyAPI::Asset.find('assets/image.png', params: {theme_id: 12345})
   #
   # Get the text or binary value:
   #   asset.value # decodes from attachment attribute if necessary
@@ -38,13 +39,13 @@ module ShopifyAPI
 
     conditional_prefix :theme
 
-    def self.element_path(id, prefix_options = {}, query_options = nil) #:nodoc:
+    def self.element_path(_id, prefix_options = {}, query_options = nil) #:nodoc:
       prefix_options, query_options = split_options(prefix_options) if query_options.nil?
       "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
     end
 
     # find an asset by key:
-    #   ShopifyAPI::Asset.find('layout/theme.liquid', :params => { theme_id: 99 })
+    #   ShopifyAPI::Asset.find('layout/theme.liquid', params: { theme_id: 99 })
     def self.find(*args)
       if args[0].is_a?(Symbol)
         super
@@ -75,7 +76,7 @@ module ShopifyAPI
     end
 
     def destroy
-      connection.delete(element_path(prefix_options.merge(:asset => {:key => key})), self.class.headers)
+      connection.delete(element_path(prefix_options.merge(asset: { key: key })), self.class.headers)
     end
 
     def new?

data/lib/shopify_api/resources/assigned_fulfillment_order.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class AssignedFulfillmentOrder < Base
-
     def initialize(attributes = {}, persisted = false)
       ShopifyAPI::Base.version_validation!(FulfillmentOrder::MINIMUM_VERSION)
       super(attributes, persisted)

data/lib/shopify_api/resources/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'shopify_api/version'
 
 module ShopifyAPI
@@ -15,7 +16,7 @@ module ShopifyAPI
 
     def encode(options = {})
       same = dup
-      same.attributes = {self.class.element_name => same.attributes} if self.class.format.extension == 'json'
+      same.attributes = { self.class.element_name => same.attributes } if self.class.format.extension == 'json'
 
       same.send("to_#{self.class.format.extension}", options)
     end
@@ -43,7 +44,7 @@ module ShopifyAPI
       end
 
       def activate_session(session)
-        raise InvalidSessionError.new("Session cannot be nil") if session.nil?
+        raise InvalidSessionError, "Session cannot be nil" if session.nil?
         self.site = session.site
         self.headers.merge!('X-Shopify-Access-Token' => session.token)
         self.api_version = session.api_version
@@ -53,7 +54,6 @@ module ShopifyAPI
         self.site = nil
         self.password = nil
         self.user = nil
-        self.api_version = nil
         self.headers.delete('X-Shopify-Access-Token')
       end
 
@@ -68,7 +68,11 @@ module ShopifyAPI
       end
 
       def api_version=(version)
-        self._api_version = ApiVersion::NullVersion.matches?(version) ? ApiVersion::NullVersion : ApiVersion.find_version(version)
+        self._api_version = if ApiVersion::NullVersion.matches?(version)
+          ApiVersion::NullVersion
+        else
+          ApiVersion.find_version(version)
+        end
       end
 
       def prefix(options = {})
@@ -88,11 +92,11 @@ module ShopifyAPI
       def resource_prefix=(value)
         @prefix_parameters = nil
 
-        resource_prefix_call = value.gsub(/:\w+/) { |key| "\#{URI.parser.escape options[#{key}].to_s}" }
+        resource_prefix_call = value.gsub(/:\w+/) { |key| "\#{URI::DEFAULT_PARSER.escape options[#{key}].to_s}" }
 
         silence_warnings do
           # Redefine the new methods.
-          instance_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+          instance_eval(<<-RUBY_EVAL, __FILE__, __LINE__ + 1)
             def prefix_source() "#{value}" end
             def resource_prefix(options={}) "#{resource_prefix_call}" end
           RUBY_EVAL
@@ -123,7 +127,7 @@ module ShopifyAPI
       def init_prefix_explicit(resource_type, resource_id)
         self.resource_prefix = "#{resource_type}/:#{resource_id}/"
 
-        define_method resource_id.to_sym do
+        define_method(resource_id.to_sym) do
           @prefix_options[resource_id]
         end
       end
@@ -156,7 +160,7 @@ module ShopifyAPI
     private
 
     def only_id
-      encode(:only => :id, :include => [], :methods => [])
+      encode(only: :id, include: [], methods: [])
     end
   end
 end

data/lib/shopify_api/resources/billing_address.rb

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

data/lib/shopify_api/resources/blog.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Blog < Base
     include Events
     include Metafields
 
     def articles
-      Article.find(:all, :params => { :blog_id => id })
+      Article.find(:all, params: { blog_id: id })
     end
   end
 end

data/lib/shopify_api/resources/carrier_service.rb

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

data/lib/shopify_api/resources/cart.rb

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

data/lib/shopify_api/resources/collect.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   # For adding/removing products from custom collections
   class Collect < Base

data/lib/shopify_api/resources/collection_listing.rb

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

data/lib/shopify_api/resources/comment.rb

@@ -1,9 +1,24 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class Comment < Base
-    def remove;   load_attributes_from_response(post(:remove, {}, only_id)); end
-    def spam;     load_attributes_from_response(post(:spam, {}, only_id)); end
-    def approve;  load_attributes_from_response(post(:approve, {}, only_id)); end
-    def restore;  load_attributes_from_response(post(:restore, {}, only_id)); end
-    def not_spam; load_attributes_from_response(post(:not_spam, {}, only_id)); end
+    def remove
+      load_attributes_from_response(post(:remove, {}, only_id))
+    end
+
+    def spam
+      load_attributes_from_response(post(:spam, {}, only_id))
+    end
+
+    def approve
+      load_attributes_from_response(post(:approve, {}, only_id))
+    end
+
+    def restore
+      load_attributes_from_response(post(:restore, {}, only_id))
+    end
+
+    def not_spam
+      load_attributes_from_response(post(:not_spam, {}, only_id))
+    end
   end
 end

data/lib/shopify_api/resources/country.rb

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

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

@@ -0,0 +1,34 @@
+# 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/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