shopify_api 7.0.2 → 7.1.0

data/test/blog_test.rb

@@ -3,6 +3,6 @@ class BlogTest < Test::Unit::TestCase
   test "blog creation" do
     fake "blogs", :method => :post, :status => 202, :body => load_fixture('blog')
     blog = ShopifyAPI::Blog.create(:title => "Test Blog")
-    assert_equal '{"blog":{"title":"Test Blog"}}', FakeWeb.last_request.body
+    assert_equal '{"blog":{"title":"Test Blog"}}', WebMock.last_request.body
   end
 end

data/test/collection_listing_test.rb

@@ -38,4 +38,42 @@ class CollectionListingTest < Test::Unit::TestCase
 
     assert_equal [1, 2], collection_listing.product_ids
   end
+
+  def test_get_collection_listing_product_ids_multi_page_with_cursor
+    version = ShopifyAPI::ApiVersion::Release.new('2019-07')
+    ShopifyAPI::Base.api_version = version.to_s
+
+    collection_listing = ShopifyAPI::CollectionListing.new(collection_id: 1)
+
+    url = "https://this-is-my-test-shop.myshopify.com/admin/api/2019-07/collection_listings/1/product_ids.json"
+
+    next_page_info = "notarealpageinfobutthatsokay"
+    next_page_url = "#{url}?page_info=#{next_page_info}"
+    link_header = "<#{next_page_url}>; rel=\"next\""
+
+    fake(
+      "collection_listings/1/product_ids",
+      method: :get,
+      status: 201,
+      url: url,
+      body: load_fixture('collection_listing_product_ids'),
+      link: link_header,
+    )
+
+    product_ids = collection_listing.product_ids
+    assert_equal [1, 2], product_ids
+    assert product_ids.next_page?
+
+    fake(
+      "collection_listings/1/product_ids",
+      method: :get,
+      status: 201,
+      url: next_page_url,
+      body: load_fixture('collection_listing_product_ids2'),
+      link: link_header,
+    )
+
+    next_page = product_ids.fetch_next_page
+    assert_equal [3, 4], next_page
+  end
 end

data/test/collection_publication_test.rb

@@ -35,6 +35,6 @@ class CollectionPublicationTest < Test::Unit::TestCase
       },
     }.to_json
 
-    assert_equal expected_body, FakeWeb.last_request.body
+    assert_equal expected_body, WebMock.last_request.body
   end
 end

data/test/customer_test.rb

@@ -30,7 +30,7 @@ class CustomerTest < Test::Unit::TestCase
 
     customer_invite_response = @customer.send_invite
 
-    assert_equal '{"customer_invite":{}}', FakeWeb.last_request.body
+    assert_equal '{"customer_invite":{}}', WebMock.last_request.body
     assert_kind_of ShopifyAPI::CustomerInvite, customer_invite_response
     assert_equal customer_invite['customer_invite']['to'], customer_invite_response.to
   end
@@ -43,7 +43,7 @@ class CustomerTest < Test::Unit::TestCase
 
     customer_invite_response = @customer.send_invite(ShopifyAPI::CustomerInvite.new(customer_invite['customer_invite']))
 
-    assert_equal customer_invite, ActiveSupport::JSON.decode(FakeWeb.last_request.body)
+    assert_equal customer_invite, ActiveSupport::JSON.decode(WebMock.last_request.body)
     assert_kind_of ShopifyAPI::CustomerInvite, customer_invite_response
     assert_equal customer_invite['customer_invite']['to'], customer_invite_response.to
   end

data/test/discount_code_test.rb

@@ -30,7 +30,7 @@ class DiscountCodeTest < Test::Unit::TestCase
     discount_code.code = "SUMMERSALE10"
     discount_code.save
 
-    assert_equal '{"discount_code":{"code":"SUMMERSALE10"}}', FakeWeb.last_request.body
+    assert_equal '{"discount_code":{"code":"SUMMERSALE10"}}', WebMock.last_request.body
   end
 
   def test_update_discount_code
@@ -41,7 +41,7 @@ class DiscountCodeTest < Test::Unit::TestCase
     fake 'price_rules/102586120/discount_codes/1002091923', method: :put, status: 200, body: ActiveSupport::JSON.encode(discount_code_response)
 
     @discount_code.save
-    
+
     assert_equal discount_code_response['discount_code']['code'], @discount_code.code
   end
 

data/test/draft_order_test.rb

@@ -39,7 +39,7 @@ class DraftOrderTest < Test::Unit::TestCase
 
     draft_order = ShopifyAPI::DraftOrder.create(line_items: [{ quantity: 1, variant_id: 39072856 }])
 
-    assert_equal '{"draft_order":{"line_items":[{"quantity":1,"variant_id":39072856}]}}', FakeWeb.last_request.body
+    assert_equal '{"draft_order":{"line_items":[{"quantity":1,"variant_id":39072856}]}}', WebMock.last_request.body
     assert_equal 39072856, draft_order.line_items.first.variant_id
   end
 
@@ -69,7 +69,7 @@ class DraftOrderTest < Test::Unit::TestCase
 
     draft_order_invoice_response = @draft_order.send_invoice
 
-    assert_equal '{"draft_order_invoice":{}}', FakeWeb.last_request.body
+    assert_equal '{"draft_order_invoice":{}}', WebMock.last_request.body
     assert_kind_of ShopifyAPI::DraftOrderInvoice, draft_order_invoice_response
     assert_equal draft_order_invoice['draft_order_invoice']['to'], draft_order_invoice_response.to
   end
@@ -81,7 +81,7 @@ class DraftOrderTest < Test::Unit::TestCase
 
     draft_order_invoice_response = @draft_order.send_invoice(ShopifyAPI::DraftOrderInvoice.new(draft_order_invoice['draft_order_invoice']))
 
-    assert_equal draft_order_invoice, ActiveSupport::JSON.decode(FakeWeb.last_request.body)
+    assert_equal draft_order_invoice, ActiveSupport::JSON.decode(WebMock.last_request.body)
     assert_kind_of ShopifyAPI::DraftOrderInvoice, draft_order_invoice_response
     assert_equal draft_order_invoice['draft_order_invoice']['to'], draft_order_invoice_response.to
   end
@@ -96,7 +96,7 @@ class DraftOrderTest < Test::Unit::TestCase
 
     field = @draft_order.add_metafield(ShopifyAPI::Metafield.new(namespace: 'contact', key: 'email', value: '123@example.com', value_type: 'string'))
 
-    assert_equal ActiveSupport::JSON.decode('{"metafield":{"namespace":"contact","key":"email","value":"123@example.com","value_type":"string"}}'), ActiveSupport::JSON.decode(FakeWeb.last_request.body)
+    assert_equal ActiveSupport::JSON.decode('{"metafield":{"namespace":"contact","key":"email","value":"123@example.com","value_type":"string"}}'), ActiveSupport::JSON.decode(WebMock.last_request.body)
     assert !field.new_record?
     assert_equal 'contact', field.namespace
     assert_equal 'email', field.key

data/test/fixtures/collection_listing_product_ids2.json

@@ -0,0 +1 @@
+[3, 4]

data/test/fixtures/product_listing_product_ids.json

@@ -1 +1 @@
-[2, 1]
+[4, 3]

data/test/fixtures/product_listing_product_ids2.json

@@ -0,0 +1 @@
+[2, 1]

data/test/lib/webmock_extensions/last_request.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module LastRequest
+  def last_request
+    @last_request
+  end
+
+  def last_request=(request_signature)
+    @last_request = request_signature
+  end
+end
+
+WebMock.extend(LastRequest)
+WebMock.after_request do |request_signature, response|
+  WebMock.last_request = request_signature
+end

data/test/metafield_test.rb

@@ -24,7 +24,7 @@ class MetafieldTest < Test::Unit::TestCase
     blog = ShopifyAPI::Blog.find(1008414260)
     metafield = blog.add_metafield(ShopifyAPI::Metafield.new(:namespace => "summaries", :key => "First Summary", :value => "Make commerce better", :value_type => "string"))
 
-    assert_equal ActiveSupport::JSON.decode('{"metafield":{"namespace":"summaries","key":"First Summary","value":"Make commerce better","value_type":"string"}}'), ActiveSupport::JSON.decode(FakeWeb.last_request.body)
+    assert_equal ActiveSupport::JSON.decode('{"metafield":{"namespace":"summaries","key":"First Summary","value":"Make commerce better","value_type":"string"}}'), ActiveSupport::JSON.decode(WebMock.last_request.body)
     assert !metafield.new_record?
   end
 

data/test/pagination_test.rb

@@ -0,0 +1,229 @@
+require 'test_helper'
+
+class PaginationTest < Test::Unit::TestCase
+  def setup
+    super
+
+    @version = ShopifyAPI::ApiVersion::Release.new('2019-10')
+    ShopifyAPI::Base.api_version = @version.to_s
+    @next_page_info = "eyJkaXJlY3Rpb24iOiJuZXh0IiwibGFzdF9pZCI6NDQwMDg5NDIzLCJsYXN0X3ZhbHVlIjoiNDQwMDg5NDIzIn0%3D"
+    @previous_page_info = "eyJsYXN0X2lkIjoxMDg4MjgzMDksImxhc3RfdmFsdWUiOiIxMDg4MjgzMDkiLCJkaXJlY3Rpb24iOiJuZXh0In0%3D"
+
+    @next_link_header = "<https://this-is-my-test-shop.myshopify.com/admin/api/2019-10/orders.json?page_info=#{@next_page_info}>; rel=\"next\""
+    @previous_link_header = "<https://this-is-my-test-shop.myshopify.com/admin/api/2019-10/orders.json?page_info=#{@previous_page_info}>; rel=\"previous\""
+  end
+
+  test "navigates using next and previous link headers with no original params" do
+    link_header ="#{@previous_link_header}, #{@next_link_header}"
+
+    fake 'orders', :method => :get, :status => 200, api_version: @version, :body => load_fixture('orders'), :link => link_header
+    orders = ShopifyAPI::Order.all
+
+    fake(
+      'orders',
+      url: "https://this-is-my-test-shop.myshopify.com/admin/api/2019-10/orders.json?page_info=#{@next_page_info}",
+      method: :get,
+      status: 200,
+      body: load_fixture('orders')
+    )
+    next_page = orders.fetch_next_page
+    assert_equal 450789469, next_page.first.id
+
+    fake(
+      'orders',
+      url: "https://this-is-my-test-shop.myshopify.com/admin/api/2019-10/orders.json?page_info=#{@previous_page_info}",
+      method: :get,
+      status: 200,
+      body: load_fixture('orders').gsub("450789469", "1122334455")
+    )
+
+    previous_page = orders.fetch_previous_page
+    assert_equal 1122334455, previous_page.first.id
+  end
+
+  test "uses all passed in querystring parameters" do
+    params = "page_info=#{@next_page_info}&limit=50&fields=#{CGI.escape('id,created_at')}"
+    @next_link_header = "<https://this-is-my-test-shop.myshopify.com/admin/api/2019-10/orders.json?#{params}>; rel=\"next\""
+    fake(
+      'orders',
+      method: :get,
+      status: 200,
+      api_version: @version,
+      url: "https://this-is-my-test-shop.myshopify.com/admin/api/2019-10/orders.json?fields=id%2Cupdated_at&limit=100",
+      body: load_fixture('orders'),
+      link: @next_link_header
+    )
+    orders = ShopifyAPI::Order.where(fields: 'id,updated_at', limit: 100)
+
+    fake(
+      'orders',
+      method: :get,
+      status: 200,
+      api_version: @version,
+      url: "https://this-is-my-test-shop.myshopify.com/admin/api/2019-10/orders.json?fields=id%2Ccreated_at&limit=50&page_info=#{@next_page_info}",
+      body: load_fixture('orders')
+    )
+    next_page = orders.fetch_next_page
+    assert_equal 450789469, next_page.first.id
+  end
+
+  test "returns empty next page if just the previous page is present" do
+    fake 'orders', :method => :get, :status => 200, api_version: @version, :body => load_fixture('orders'), :link => @previous_link_header
+    orders = ShopifyAPI::Order.all
+
+    next_page = orders.fetch_next_page
+    assert_empty next_page
+  end
+
+  test "returns an empty previous page if just the next page is present" do
+    fake 'orders', :method => :get, :status => 200, api_version: @version, :body => load_fixture('orders'), :link => @next_link_header
+    orders = ShopifyAPI::Order.all
+
+    next_page = orders.fetch_previous_page
+    assert_empty next_page
+  end
+
+  test "#next_page? returns true if next page is present" do
+    fake 'orders', :method => :get, :status => 200, api_version: @version, :body => load_fixture('orders'), :link => @next_link_header
+    orders = ShopifyAPI::Order.all
+
+    assert orders.next_page?
+  end
+
+  test "#next_page? returns false if next page is not present" do
+    fake 'orders', :method => :get, :status => 200, api_version: @version, :body => load_fixture('orders'), :link => @previous_link_header
+    orders = ShopifyAPI::Order.all
+
+    refute orders.next_page?
+  end
+
+  test "#previous_page? returns true if previous page is present" do
+    fake 'orders', :method => :get, :status => 200, api_version: @version, :body => load_fixture('orders'), :link => @previous_link_header
+    orders = ShopifyAPI::Order.all
+
+    assert orders.previous_page?
+  end
+
+  test "#previous_page? returns false if next page is not present" do
+    fake 'orders', :method => :get, :status => 200, api_version: @version, :body => load_fixture('orders'), :link => @next_link_header
+    orders = ShopifyAPI::Order.all
+
+    refute orders.previous_page?
+  end
+
+  test "pagination handles no link headers" do
+    fake 'orders', :method => :get, :status => 200, api_version: @version, :body => load_fixture('orders')
+    orders = ShopifyAPI::Order.all
+
+    refute orders.next_page?
+    refute orders.previous_page?
+    assert_empty orders.fetch_next_page
+    assert_empty orders.fetch_previous_page
+  end
+
+  test "raises on invalid pagination links" do
+    link_header = "<https://this-is-my-test-shop.myshopify.com/admin/api/2019-10/orders.json?page_info=#{@next_page_info}>;"
+    fake 'orders', :method => :get, :status => 200, api_version: @version, :body => load_fixture('orders'), :link => link_header
+
+    assert_raises ShopifyAPI::InvalidPaginationLinksError do
+      ShopifyAPI::Order.all
+    end
+  end
+
+  test "raises on an older API version" do
+    version = ShopifyAPI::ApiVersion::Release.new('2019-04')
+    ShopifyAPI::Base.api_version = version.to_s
+
+    fake 'orders', :method => :get, :status => 200, api_version: version, :body => load_fixture('orders')
+    orders = ShopifyAPI::Order.all
+
+    assert_raises NotImplementedError do
+      orders.fetch_next_page
+    end
+  end
+
+  test "raises on 2019-07 API version for models that don't support new pagination yet" do
+    version = ShopifyAPI::ApiVersion::Release.new('2019-07')
+    ShopifyAPI::Base.api_version = version.to_s
+
+    fake 'orders', :method => :get, :status => 200, api_version: version, :body => load_fixture('orders')
+    orders = ShopifyAPI::Order.all
+
+    assert_raises NotImplementedError do
+      orders.fetch_next_page
+    end
+  end
+
+  test "new pagination works on 2019-07 API version for select models" do
+    version = ShopifyAPI::ApiVersion::Release.new('2019-07')
+    ShopifyAPI::Base.api_version = version.to_s
+
+    fake 'events', :method => :get, :status => 200, api_version: version, :body => load_fixture('events')
+    events = ShopifyAPI::Event.all
+
+    assert_empty events.fetch_next_page
+    assert_empty events.fetch_previous_page
+  end
+
+  test "does not raise on the unstable version" do
+    version = ShopifyAPI::ApiVersion::Unstable.new
+    ShopifyAPI::Base.api_version = version.to_s
+    @next_link_header = "<https://this-is-my-test-shop.myshopify.com/admin/api/unstable/orders.json?page_info=#{@next_page_info}>; rel=\"next\""
+
+    link_header ="#{@previous_link_header}, #{@next_link_header}"
+
+    fake 'orders', :method => :get, :status => 200, api_version: version, :body => load_fixture('orders'), :link => link_header
+    orders = ShopifyAPI::Order.all
+
+    fake(
+      'orders',
+      url: "https://this-is-my-test-shop.myshopify.com/admin/api/unstable/orders.json?page_info=#{@next_page_info}",
+      method: :get,
+      status: 200,
+      body: load_fixture('orders')
+    )
+    assert_nothing_raised do
+      next_page = orders.fetch_next_page
+      assert_equal 450789469, next_page.first.id
+    end
+  end
+
+  test "allows for multiple concurrent API collection objects" do
+    first_request_params = "page_info=#{@next_page_info}&limit=5"
+    fake(
+      'orders',
+      method: :get,
+      status: 200,
+      api_version: @version,
+      url: "https://this-is-my-test-shop.myshopify.com/admin/api/2019-10/orders.json?limit=5",
+      body: load_fixture('orders'),
+      link: "<https://this-is-my-test-shop.myshopify.com/admin/api/2019-10/orders.json?#{first_request_params}>; rel=\"next\""
+    )
+    orders = ShopifyAPI::Order.where(limit: 5)
+
+    second_request_params = "page_info=#{@next_page_info}&limit=5"
+    fake(
+      'orders',
+      method: :get,
+      status: 200,
+      api_version: @version,
+      url: "https://this-is-my-test-shop.myshopify.com/admin/api/2019-10/orders.json?limit=10",
+      body: load_fixture('orders'),
+      link: "<https://this-is-my-test-shop.myshopify.com/admin/api/2019-10/orders.json?#{second_request_params}>; rel=\"next\""
+    )
+
+    orders2 = ShopifyAPI::Order.where(limit: 10)
+
+    fake(
+      'orders',
+      method: :get,
+      status: 200,
+      api_version: @version,
+      url: "https://this-is-my-test-shop.myshopify.com/admin/api/2019-10/orders.json?limit=5&page_info=#{@next_page_info}",
+      body: load_fixture('orders')
+    )
+    next_page = orders.fetch_next_page
+    assert_equal 450789469, next_page.first.id
+  end
+
+end

data/test/price_rule_test.rb

@@ -42,7 +42,7 @@ class PriceRuleTest < Test::Unit::TestCase
       starts_at: "2017-01-19T00:00:00Z"
     )
 
-    assert_equal '{"price_rule":{"target_type":"line_item","allocation_method":"across","value_type":"fixed_amount","value":-10.0,"customer_selection":"all","starts_at":"2017-01-19T00:00:00Z"}}', FakeWeb.last_request.body
+    assert_equal '{"price_rule":{"target_type":"line_item","allocation_method":"across","value_type":"fixed_amount","value":-10.0,"customer_selection":"all","starts_at":"2017-01-19T00:00:00Z"}}', WebMock.last_request.body
     assert_equal -10, price_rule.value
   end
 

data/test/product_listing_test.rb

@@ -34,7 +34,64 @@ class ProductListingTest < Test::Unit::TestCase
 
     product_ids = ShopifyAPI::ProductListing.product_ids
     assert_equal 2, product_ids.count
-    assert_equal 2, product_ids.first
-    assert_equal 1, product_ids.last
+    assert_equal 4, product_ids.first
+    assert_equal 3, product_ids.last
+  end
+
+  def test_get_product_listing_product_ids_multi_page_with_cursor
+    version = ShopifyAPI::ApiVersion::Release.new('2019-10')
+    ShopifyAPI::Base.api_version = version.to_s
+
+    url = "https://this-is-my-test-shop.myshopify.com/admin/api/2019-10/product_listings/product_ids.json"
+
+    next_page_info = "notarealpageinfobutthatsokay"
+    next_page_url = "#{url}?page_info=#{next_page_info}"
+    link_header = "<#{next_page_url}>; rel=\"next\""
+
+    fake(
+      "product_listings/product_ids",
+      method: :get,
+      status: 201,
+      url: url,
+      body: load_fixture('product_listing_product_ids'),
+      link: link_header,
+    )
+
+    product_ids = ShopifyAPI::ProductListing.product_ids
+    assert_equal [4, 3], product_ids
+    assert product_ids.next_page?
+
+    fake(
+      "product_listings/product_ids",
+      method: :get,
+      status: 201,
+      url: next_page_url,
+      body: load_fixture('product_listing_product_ids2'),
+      link: link_header,
+    )
+
+    next_page = product_ids.fetch_next_page
+    assert_equal [2, 1], next_page
+  end
+
+  def test_get_product_listing_product_ids_multi_page_with_cursor_fails_on_older_api_version
+    version = ShopifyAPI::ApiVersion::Release.new('2019-07')
+    ShopifyAPI::Base.api_version = version.to_s
+
+    url = "https://this-is-my-test-shop.myshopify.com/admin/api/2019-07/product_listings/product_ids.json"
+
+    fake(
+      "product_listings/product_ids",
+      method: :get,
+      status: 201,
+      url: url,
+      body: load_fixture('product_listing_product_ids'),
+    )
+
+    product_ids = ShopifyAPI::ProductListing.product_ids
+    assert_equal [4, 3], product_ids
+    assert_raises NotImplementedError do
+      product_ids.next_page?
+    end
   end
 end