shopify_api 4.9.0 → 9.4.1

data/lib/shopify_api/pagination_link_headers.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+module ShopifyAPI
+  class InvalidPaginationLinksError < StandardError; end
+
+  class PaginationLinkHeaders
+    LinkHeader = Struct.new(:url, :rel)
+    attr_reader :previous_link, :next_link
+
+    def initialize(link_header)
+      links = parse_link_header(link_header)
+      @previous_link = links.find { |link| link.rel == :previous }
+      @next_link = links.find { |link| link.rel == :next }
+    end
+
+    private
+
+    def parse_link_header(link_header)
+      return [] unless link_header.present?
+      links = link_header.split(',')
+      links.map do |link|
+        parts = link.split('; ')
+        unless parts.length == 2
+          raise ShopifyAPI::InvalidPaginationLinksError, "Invalid link header: url and rel expected"
+        end
+
+        url = parts[0][/<(.*)>/, 1]
+        rel = parts[1][/rel="(.*)"/, 1]&.to_sym
+
+        url = URI.parse(url).request_uri
+        LinkHeader.new(url, rel)
+      end
+    end
+  end
+end

data/lib/shopify_api/resources.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
 require 'shopify_api/resources/base'
-Dir.glob("#{File.dirname(__FILE__)}/resources/*").each { |file| require(file) } 
+require 'shopify_api/resources/array_base'
+Dir.glob("#{File.dirname(__FILE__)}/resources/*").each { |file| require(file) }

data/lib/shopify_api/resources/abandoned_checkout.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class AbandonedCheckout < Base
+    self.element_name = "checkout"
+  end
+end

data/lib/shopify_api/resources/access_scope.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module ShopifyAPI
+  class AccessScope < Base
+    class << self
+      def prefix(_options = {})
+        '/admin/oauth/'
+      end
+    end
+  end
+end

data/lib/shopify_api/resources/access_token.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyAPI
   class AccessToken < Base
     def self.delegate(access_scope, expires_in = nil)

data/lib/shopify_api/resources/address.rb

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

data/lib/shopify_api/resources/announcement.rb

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

data/lib/shopify_api/resources/api_permission.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class ApiPermission < Base
+    def self.destroy
+      delete(:current)
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class ArrayBase < Base
+    class << self
+      private
+
+      def instantiate_record(record, *)
+        record
+      end
+    end
+  end
+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,25 +10,25 @@ 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
-  # 
+  #
   # You can provide new data for assets in a few different ways:
-  # 
+  #
   #   * assign text data for the value directly:
   #       asset.value = "div.special {color:red;}"
-  #     
+  #
   #   * provide binary data for the value:
   #       asset.attach(File.read('image.png'))
-  #     
+  #
   #   * set a URL from which Shopify will fetch the value:
   #       asset.src = "http://mysite.com/image.png"
-  #     
+  #
   #   * set a source key of another of your assets from which
   #     the value will be copied:
   #       asset.source_key = "assets/another_image.png"
@@ -38,26 +39,30 @@ 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
       else
-        params = {:asset => {:key => args[0]}}
+        params = { asset: { key: args[0] } }
         params = params.merge(args[1][:params]) if args[1] && args[1][:params]
-        path_prefix = params[:theme_id] ? "/admin/themes/#{params[:theme_id]}" : "/admin"
-        resource = find(:one, :from => "#{path_prefix}/assets.#{format.extension}", :params => params)
+        path_prefix = params[:theme_id] ? "themes/#{params[:theme_id]}/" : ""
+        resource = find(
+          :one,
+          from: api_version.construct_api_path("#{path_prefix}assets.#{format.extension}"),
+          params: params
+        )
         resource.prefix_options[:theme_id] = params[:theme_id] if resource && params[:theme_id]
         resource
       end
     end
-    
+
     # For text assets, Shopify returns the data in the 'value' attribute.
     # For binary assets, the data is base-64-encoded and returned in the
     # 'attachment' attribute. This accessor returns the data in both cases.
@@ -65,28 +70,28 @@ module ShopifyAPI
       attributes['value'] ||
       (attributes['attachment'] ? Base64.decode64(attributes['attachment']) : nil)
     end
-    
+
     def attach(data)
       self.attachment = Base64.encode64(data)
     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?
       false
     end
-    
+
     def method_missing(method_symbol, *arguments) #:nodoc:
       if %w{value= attachment= src= source_key=}.include?(method_symbol)
         wipe_value_attributes
       end
       super
     end
-    
+
     private
-    
+
     def wipe_value_attributes
       %w{value attachment src source_key}.each do |attr|
         attributes.delete(attr)

data/lib/shopify_api/resources/assigned_fulfillment_order.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module ShopifyAPI
+  class AssignedFulfillmentOrder < Base
+    def initialize(attributes = {}, persisted = false)
+      ShopifyAPI::Base.version_validation!(FulfillmentOrder::MINIMUM_VERSION)
+      super(attributes, persisted)
+    end
+
+    def self.find(scope, *args)
+      ShopifyAPI::Base.version_validation!(FulfillmentOrder::MINIMUM_VERSION)
+
+      assigned_fulfillment_orders = super(scope, *args)
+      assigned_fulfillment_orders.map { |afo| FulfillmentOrder.new(afo.attributes) }
+    end
+  end
+end

data/lib/shopify_api/resources/base.rb

@@ -1,18 +1,22 @@
+# frozen_string_literal: true
 require 'shopify_api/version'
 
 module ShopifyAPI
   class Base < ActiveResource::Base
     class InvalidSessionError < StandardError; end
     extend Countable
+
     self.timeout = 90
     self.include_root_in_json = false
     self.headers['User-Agent'] = ["ShopifyAPI/#{ShopifyAPI::VERSION}",
                                   "ActiveResource/#{ActiveResource::VERSION::STRING}",
                                   "Ruby/#{RUBY_VERSION}"].join(' ')
 
+    self.collection_parser = ShopifyAPI::PaginatedCollection
+
     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
@@ -28,32 +32,22 @@ module ShopifyAPI
     end
 
     class << self
-      if ActiveResource::Base.respond_to?(:_headers) && ActiveResource::Base.respond_to?(:_headers_defined?)
-        def headers
-          if _headers_defined?
-            _headers
-          elsif superclass != Object && superclass.headers
-            superclass.headers
-          else
-            _headers ||= {}
-          end
-        end
-      else
-        def headers
-          if defined?(@headers)
-            @headers
-          elsif superclass != Object && superclass.headers
-            superclass.headers
-          else
-            @headers ||= {}
-          end
+      threadsafe_attribute(:_api_version)
+      def headers
+        if _headers_defined?
+          _headers
+        elsif superclass != Object && superclass.headers
+          superclass.headers
+        else
+          _headers ||= {}
         end
       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
       end
 
       def clear_session
@@ -63,17 +57,100 @@ module ShopifyAPI
         self.headers.delete('X-Shopify-Access-Token')
       end
 
+      def api_version
+        if _api_version_defined?
+          _api_version
+        elsif superclass != Object && superclass.site
+          superclass.api_version.dup.freeze
+        else
+          ApiVersion::NullVersion
+        end
+      end
+
+      def api_version=(version)
+        self._api_version = if ApiVersion::NullVersion.matches?(version)
+          ApiVersion::NullVersion
+        else
+          ApiVersion.find_version(version)
+        end
+      end
+
+      def prefix(options = {})
+        api_version.construct_api_path(resource_prefix(options))
+      end
+
+      def prefix_source
+        ''
+      end
+
+      def resource_prefix(_options = {})
+        ''
+      end
+
+      # Sets the \prefix for a resource's nested URL (e.g., <tt>prefix/collectionname/1.json</tt>).
+      # Default value is <tt>site.path</tt>.
+      def resource_prefix=(value)
+        @prefix_parameters = nil
+
+        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)
+            def prefix_source() "#{value}" end
+            def resource_prefix(options={}) "#{resource_prefix_call}" end
+          RUBY_EVAL
+        end
+      rescue => e
+        logger&.error("Couldn't set prefix: #{e}\n  #{code}")
+        raise
+      end
+
+      def prefix=(value)
+        if value.start_with?('/admin')
+          raise ArgumentError, "'#{value}' can no longer start /admin/. Change to using resource_prefix="
+        end
+
+        warn(
+          '[DEPRECATED] ShopifyAPI::Base#prefix= is deprecated and will be removed in a future version. ' \
+            'Use `self.resource_prefix=` instead.'
+        )
+        self.resource_prefix = value
+      end
+
+      alias_method :set_prefix, :prefix=
+
       def init_prefix(resource)
         init_prefix_explicit(resource.to_s.pluralize, "#{resource}_id")
       end
 
       def init_prefix_explicit(resource_type, resource_id)
-        self.prefix = "/admin/#{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
+
+      def early_july_pagination?
+        !!early_july_pagination
+      end
+
+      def version_validation!(minimum_version)
+        available_in_version = ShopifyAPI::ApiVersion.find_version(minimum_version)
+
+        unless ShopifyAPI::Base.api_version >= available_in_version
+          raise NotImplementedError, "The minimum supported version is #{minimum_version}."
+        end
+      end
+
+      private
+
+      attr_accessor :early_july_pagination
+
+      def early_july_pagination_release!
+        self.early_july_pagination = true
+      end
     end
 
     def persisted?
@@ -83,7 +160,7 @@ module ShopifyAPI
     private
 
     def only_id
-      encode(:only => :id, :include => [], :methods => [])
+      encode(only: :id, include: [], methods: [])
     end
   end
 end