shopify_api 7.0.2 → 7.1.0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+== Version 7.1.0
+
+* Add 2019-10 to known API versions
+* Add support for cursor pagination [#594](https://github.com/Shopify/shopify_api/pull/594) and
+[#611](https://github.com/Shopify/shopify_api/pull/611)
+* `ShopifyAPI::Base.api_version` now defaults to `ShopifyAPI::ApiVersion::NullVersion` instead of `nil`. Making requests without first setting an ApiVersion raises `ApiVersionNotSetError` instead of `NoMethodError: undefined method 'construct_api_path' for nil:NilClass'` [#605](https://github.com/Shopify/shopify_api/pull/605)
+
 == Version 7.0.2
 
 * Add 2019-07 to known API versions.

data/README.md

@@ -365,6 +365,36 @@ ActiveResource is threadsafe as of version 4.1 (which works with Rails 4.x and a
 
 If you were previously using Shopify's [activeresource fork](https://github.com/shopify/activeresource) then you should remove it and use ActiveResource 4.1.
 
+## Pagination
+
+Pagination can occur in one of two ways.
+
+Page based pagination
+```ruby
+page = 1
+products = ShopifyAPI::Product.find(:all, params: { limit: 50, page: page })
+process_products(products)
+while(products.count == 50)
+  page += 1
+  products = ShopifyAPI::Product.find(:all, params: { limit: 50, page: page })
+  process_products(products)
+end
+```
+
+Page based pagination will be deprecated in the `2019-10` API version, in favor of the second method of pagination:
+
+[Relative cursor based pagination](https://help.shopify.com/en/api/guides/paginated-rest-results)
+```ruby
+products = ShopifyAPI::Product.find(:all, params: { limit: 50 })
+process_products(products)
+while products.next_page?
+  products = products.fetch_next_page
+  process_products(products)
+end
+```
+
+Relative cursor pagination is currently available for all endpoints using the `2019-10` and later API versions.
+
 ## Using Development Version
 
 Download the source code and run:

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
   test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
+  test.warning = false
 end
 
 begin

data/lib/shopify_api.rb

@@ -1,5 +1,4 @@
 $:.unshift File.dirname(__FILE__)
-
 require 'active_resource'
 require 'active_support/core_ext/class/attribute_accessors'
 require 'digest/md5'
@@ -9,6 +8,7 @@ require 'shopify_api/limits'
 require 'shopify_api/defined_versions'
 require 'shopify_api/api_version'
 require 'active_resource/json_errors'
+require 'shopify_api/paginated_collection'
 require 'shopify_api/disable_prefix_check'
 
 module ShopifyAPI
@@ -21,6 +21,7 @@ require 'shopify_api/countable'
 require 'shopify_api/resources'
 require 'shopify_api/session'
 require 'shopify_api/connection'
+require 'shopify_api/pagination_link_headers'
 
 if ShopifyAPI::Base.respond_to?(:connection_class)
   ShopifyAPI::Base.connection_class = ShopifyAPI::Connection

data/lib/shopify_api/api_version.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 module ShopifyAPI
   class ApiVersion
+    class ApiVersionNotSetError < StandardError; end
     class UnknownVersion < StandardError; end
     class InvalidVersion < StandardError; end
 
@@ -109,5 +110,21 @@ module ShopifyAPI
         construct_api_path('graphql.json')
       end
     end
+
+    class NullVersion
+      class << self
+        def stable?
+          raise ApiVersionNotSetError, "You must set ShopifyAPI::Base.api_version before making a request."
+        end
+
+        def construct_api_path(*_path)
+          raise ApiVersionNotSetError, "You must set ShopifyAPI::Base.api_version before making a request."
+        end
+
+        def construct_graphql_path
+          raise ApiVersionNotSetError, "You must set ShopifyAPI::Base.api_version before making a request."
+        end
+      end
+    end
   end
 end

data/lib/shopify_api/defined_versions.rb

@@ -5,6 +5,7 @@ module ShopifyAPI
       define_version(ShopifyAPI::ApiVersion::Unstable.new)
       define_version(ShopifyAPI::ApiVersion::Release.new('2019-04'))
       define_version(ShopifyAPI::ApiVersion::Release.new('2019-07'))
+      define_version(ShopifyAPI::ApiVersion::Release.new('2019-10'))
     end
   end
 end

data/lib/shopify_api/paginated_collection.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class PaginatedCollection < ActiveResource::Collection
+    module CollectionPagination
+      def initialize(args)
+        @next_url = pagination_link_headers.next_link&.url&.to_s
+        @previous_url = pagination_link_headers.previous_link&.url&.to_s
+        super(args)
+      end
+
+      def next_page?
+        ensure_available
+        @next_url.present?
+      end
+
+      def previous_page?
+        ensure_available
+        @previous_url.present?
+      end
+
+      def fetch_next_page
+        fetch_page(@next_url)
+      end
+
+      def fetch_previous_page
+        fetch_page(@previous_url)
+      end
+
+      private
+
+      AVAILABLE_IN_VERSION = ShopifyAPI::ApiVersion::Release.new('2019-10')
+      AVAILABLE_IN_VERSION_EARLY = ShopifyAPI::ApiVersion::Release.new('2019-07')
+
+      def fetch_page(url)
+        ensure_available
+        return [] unless url.present?
+
+        resource_class.all(from: url)
+      end
+
+      def pagination_link_headers
+        @pagination_link_headers ||= ShopifyAPI::PaginationLinkHeaders.new(
+          ShopifyAPI::Base.connection.response["Link"]
+        )
+      end
+
+      def ensure_available
+        return if ShopifyAPI::Base.api_version >= AVAILABLE_IN_VERSION
+        return if ShopifyAPI::Base.api_version >= AVAILABLE_IN_VERSION_EARLY && resource_class.early_july_pagination?
+        raise NotImplementedError
+      end
+    end
+
+    include CollectionPagination
+  end
+end

data/lib/shopify_api/pagination_link_headers.rb

@@ -0,0 +1,33 @@
+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 }
+
+      self
+    end
+
+    private
+
+    def parse_link_header(link_header)
+      return [] unless link_header.present?
+      links = link_header.split(',')
+      links.map do |link|
+        parts = link.split('; ')
+        raise ShopifyAPI::InvalidPaginationLinksError.new("Invalid link header: url and rel expected") unless parts.length == 2
+
+        url = parts[0][/<(.*)>/, 1]
+        rel = parts[1][/rel="(.*)"/, 1]&.to_sym
+
+        url = URI.parse(url)
+        LinkHeader.new(url, rel)
+      end
+    end
+  end
+end

data/lib/shopify_api/resources.rb

@@ -1,2 +1,3 @@
 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/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/base.rb

@@ -11,6 +11,8 @@ module ShopifyAPI
                                   "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'
@@ -30,26 +32,13 @@ module ShopifyAPI
 
     class << self
       threadsafe_attribute(:_api_version)
-
-      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
+      def headers
+        if _headers_defined?
+          _headers
+        elsif superclass != Object && superclass.headers
+          superclass.headers
+        else
+          _headers ||= {}
         end
       end
 
@@ -73,11 +62,13 @@ module ShopifyAPI
           _api_version
         elsif superclass != Object && superclass.site
           superclass.api_version.dup.freeze
+        else
+          ApiVersion::NullVersion
         end
       end
 
       def api_version=(version)
-        self._api_version = version.nil? ? nil : ApiVersion.coerce_to_version(version)
+        self._api_version = version.nil? ? ApiVersion::NullVersion : ApiVersion.coerce_to_version(version)
       end
 
       def prefix(options = {})
@@ -136,6 +127,18 @@ module ShopifyAPI
           @prefix_options[resource_id]
         end
       end
+
+      def early_july_pagination?
+        !!early_july_pagination
+      end
+
+      private
+
+      attr_accessor :early_july_pagination
+
+      def early_july_pagination_release!
+        self.early_july_pagination = true
+      end
     end
 
     def persisted?

data/lib/shopify_api/resources/collect.rb

@@ -1,5 +1,6 @@
 module ShopifyAPI
   # For adding/removing products from custom collections
   class Collect < Base
+    early_july_pagination_release!
   end
 end

data/lib/shopify_api/resources/collection_listing.rb

@@ -2,8 +2,17 @@ module ShopifyAPI
   class CollectionListing < Base
     self.primary_key = :collection_id
 
+    early_july_pagination_release!
+
     def product_ids
-      get(:product_ids)
+      ProductId.all(params: { collection_id: collection_id })
+    end
+
+    class ProductId < ArrayBase
+      self.resource_prefix = 'collection_listings/:collection_id/'
+
+      early_july_pagination_release!
     end
+    private_constant :ProductId
   end
 end

data/lib/shopify_api/resources/customer_saved_search.rb

@@ -2,6 +2,8 @@ require 'shopify_api/resources/customer'
 
 module ShopifyAPI
   class CustomerSavedSearch < Base
+    early_july_pagination_release!
+
     def customers(params = {})
       Customer.search(params.merge({:customer_saved_search_id => self.id}))
     end

data/lib/shopify_api/resources/event.rb

@@ -3,5 +3,6 @@ module ShopifyAPI
     include DisablePrefixCheck
 
     conditional_prefix :resource, true
+    early_july_pagination_release!
   end
 end

data/lib/shopify_api/resources/metafield.rb

@@ -3,6 +3,7 @@ module ShopifyAPI
     include DisablePrefixCheck
 
     conditional_prefix :resource, true
+    early_july_pagination_release!
 
     def value
       return if attributes["value"].nil?

data/lib/shopify_api/resources/product.rb

@@ -3,6 +3,8 @@ module ShopifyAPI
     include Events
     include Metafields
 
+    early_july_pagination_release!
+
     # compute the price range
     def price_range
       prices = variants.collect(&:price).collect(&:to_f)

data/lib/shopify_api/resources/product_listing.rb

@@ -2,8 +2,15 @@ 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/version.rb

@@ -1,3 +1,3 @@
 module ShopifyAPI
-  VERSION = "7.0.2"
+  VERSION = "7.1.0"
 end

data/shopify_api.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency("graphql-client")
 
   s.add_development_dependency("mocha", ">= 0.9.8")
-  s.add_development_dependency("fakeweb")
+  s.add_development_dependency("webmock")
   s.add_development_dependency("minitest", ">= 4.0")
   s.add_development_dependency("rake")
   s.add_development_dependency("timecop")

data/test/api_version_test.rb

@@ -136,6 +136,20 @@ class ApiVersionTest < Test::Unit::TestCase
     )
   end
 
+  test "NullVersion raises ApiVersionNotSetError" do
+    assert_raises(ShopifyAPI::ApiVersion::ApiVersionNotSetError) do
+      ShopifyAPI::ApiVersion::NullVersion.construct_api_path(:string)
+    end
+
+    assert_raises(ShopifyAPI::ApiVersion::ApiVersionNotSetError) do
+      ShopifyAPI::ApiVersion::NullVersion.construct_graphql_path
+    end
+
+    assert_raises(ShopifyAPI::ApiVersion::ApiVersionNotSetError) do
+      ShopifyAPI::ApiVersion::NullVersion.stable?
+    end
+  end
+
   class TestApiVersion < ShopifyAPI::ApiVersion
     def initialize(name)
       @version_name = name

data/test/base_test.rb

@@ -33,9 +33,9 @@ class BaseTest < Test::Unit::TestCase
 
     ShopifyAPI::Base.clear_session
 
-    assert_equal nil, ShopifyAPI::Base.user
-    assert_equal nil, ShopifyAPI::Base.password
-    assert_equal nil, ShopifyAPI::Base.site
+    assert_nil ShopifyAPI::Base.user
+    assert_nil ShopifyAPI::Base.password
+    assert_nil ShopifyAPI::Base.site
   end
 
   test '#clear_session should clear site and headers from Base' do
@@ -92,8 +92,9 @@ class BaseTest < Test::Unit::TestCase
   test "prefix= will forward to resource when the value does not start with admin" do
     session = ShopifyAPI::Session.new(domain: 'shop1.myshopify.com', token: 'token1', api_version: '2019-01')
     ShopifyAPI::Base.activate_session(session)
-
-    TestResource.prefix = 'a/regular/path/'
+    silence_warnings do
+      TestResource.prefix = 'a/regular/path/'
+    end
 
     assert_equal('/admin/api/2019-01/a/regular/path/', TestResource.prefix)
   end
@@ -157,11 +158,16 @@ class BaseTest < Test::Unit::TestCase
     assert_equal 2, ShopifyAPI::Shop.current.id
   end
 
-  test "#api_version should set ApiVersion" do
+  test "#api_version= should set ApiVersion" do
     ShopifyAPI::Base.api_version = '2019-04'
     assert_equal '2019-04', ShopifyAPI::Base.api_version.to_s
   end
 
+  test "#api_version= nil should set ApiVersion to ShopifyAPI::ApiVersion::NullVersion" do
+    ShopifyAPI::Base.api_version = nil
+    assert_equal ShopifyAPI::ApiVersion::NullVersion, ShopifyAPI::Base.api_version
+  end
+
   def clear_header(header)
     [ActiveResource::Base, ShopifyAPI::Base, ShopifyAPI::Product].each do |klass|
       klass.headers.delete(header)