ruby_shopify_api 1.0.0

data/test/pagination_test.rb

@@ -0,0 +1,290 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class PaginationTest < Test::Unit::TestCase
+  def setup
+    super
+
+    @version = ShopifyAPI::ApiVersion.find_version('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 "#next_page_info returns next_page_info 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_equal(@next_page_info, orders.next_page_info)
+  end
+
+  test "#next_page_info returns nil 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
+
+    assert_nil(orders.next_page_info)
+  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 "#previous_page_info returns previous_page_info if next 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_equal(@previous_page_info, orders.previous_page_info)
+  end
+
+  test "#previous_page_info returns nil 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
+
+    assert_nil(orders.previous_page_info)
+  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.find_version('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.find_version('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.find_version('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.find_version('unstable')
+    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\""
+    )
+    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\""
+    )
+    orders = 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/payment_test.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class PaymentTest < Test::Unit::TestCase
+  def setup
+    super
+
+    @checkout_id = JSON.parse(load_fixture('checkout'))['checkout']['token']
+    @expected_payment = JSON.parse(load_fixture('payment'))['payment']
+  end
+
+  test ":create creates a new payment" do
+    fake "checkouts/#{@checkout_id}/payments", method: :post, status: 201, body: load_fixture('payment')
+
+    new_payment = ShopifyAPI::Payment.create(checkout_id: @checkout_id)
+
+    assert_equal @expected_payment['unique_token'], new_payment.attributes['unique_token']
+  end
+end

data/test/policy_test.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class PolicyTest < Test::Unit::TestCase
+  def setup
+    super
+    fake('shop')
+  end
+
+  def test_getting_the_list_of_policies
+    fake('policies')
+
+    policies = ShopifyAPI::Policy.all
+    assert_equal(1, policies.length)
+
+    policy = policies.first
+    assert_equal('Privacy Policy', policy.title)
+    assert_equal('Your privacy is important to us', policy.body)
+  end
+end

data/test/price_rule_test.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class PriceRuleTest < Test::Unit::TestCase
+  def setup
+    super
+    fake('price_rules/102586120', body: load_fixture('price_rule'))
+
+    @price_rule = ShopifyAPI::PriceRule.find(102586120)
+  end
+
+  def test_get_price_rule
+    fake('price_rules/102586120', method: :get, status: 200, body: load_fixture('price_rule'))
+    price_rule = ShopifyAPI::PriceRule.find(102586120)
+
+    assert_equal(102586120, price_rule.id)
+  end
+
+  def test_get_all_price_rules
+    fake('price_rules', method: :get, status: 200, body: load_fixture('price_rules'))
+    price_rules = ShopifyAPI::PriceRule.all
+
+    assert_equal(1, price_rules.length)
+    assert_equal(102586120, price_rules.first.id)
+  end
+
+  def test_get_all_discount_codes_for_a_price_rule
+    fake('price_rules/102586120/discount_codes', method: :get, status: 200, body: load_fixture('discount_codes'))
+    price_rule = ShopifyAPI::PriceRule.find(102586120)
+
+    assert_equal("SUMMERSALE10", price_rule.discount_codes.first.code)
+  end
+
+  def test_create_price_rule
+    fake('price_rules', method: :post, status: 201, body: load_fixture('price_rule'))
+
+    price_rule = ShopifyAPI::PriceRule.create(
+      target_type: "line_item",
+      allocation_method: "across",
+      value_type: "fixed_amount",
+      value: -10.0,
+      customer_selection: "all",
+      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"}}',
+      WebMock.last_request.body
+    )
+    assert_equal(-10, price_rule.value)
+  end
+
+  def test_update_price_rule
+    price_rule_response = ActiveSupport::JSON.decode(load_fixture('price_rule'))
+    price_rule_response['price_rule']['value'] = -50.0
+    @price_rule.value = -50.0
+    fake('price_rules/102586120', method: :put, status: 200, body: ActiveSupport::JSON.encode(price_rule_response))
+
+    @price_rule.save
+
+    assert_equal(price_rule_response['price_rule']['value'], @price_rule.value)
+  end
+
+  def test_delete_price_rule
+    fake('price_rules/102586120', method: :delete, body: 'destroyed')
+
+    assert(@price_rule.destroy)
+  end
+end

data/test/product_listing_test.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class ProductListingTest < Test::Unit::TestCase
+  def test_get_product_listings
+    fake("product_listings", method: :get, status: 201, body: load_fixture('product_listings'))
+
+    product_listings = ShopifyAPI::ProductListing.find(:all)
+    assert_equal(2, product_listings.count)
+    assert_equal(2, product_listings.first.product_id)
+    assert_equal(1, product_listings.last.product_id)
+    assert_equal('Synergistic Silk Chair', product_listings.first.title)
+    assert_equal('Rustic Copper Bottle', product_listings.last.title)
+  end
+
+  def test_get_product_listing
+    fake("product_listings/2", method: :get, status: 201, body: load_fixture('product_listing'))
+
+    product_listing = ShopifyAPI::ProductListing.find(2)
+    assert_equal('Synergistic Silk Chair', product_listing.title)
+  end
+
+  def test_reload_product_listing
+    fake("product_listings/2", method: :get, status: 201, body: load_fixture('product_listing'))
+
+    product_listing = ShopifyAPI::ProductListing.new(product_id: 2)
+    product_listing.reload
+
+    assert_equal('Synergistic Silk Chair', product_listing.title)
+  end
+
+  def test_get_product_listing_product_ids
+    fake("product_listings/product_ids", method: :get, status: 201, body: load_fixture('product_listing_product_ids'))
+
+    product_ids = ShopifyAPI::ProductListing.product_ids
+    assert_equal(2, product_ids.count)
+    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.find_version('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.find_version('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

data/test/product_publication_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class ProductPublicationTest < Test::Unit::TestCase
+  def test_get_all_product_publications
+    fake('publications/55650051/product_publications', body: load_fixture('product_publications'))
+    product_publications = ShopifyAPI::ProductPublication.find(:all, params: { publication_id: 55650051 })
+
+    assert_equal(647162527768, product_publications.first.id)
+    assert_equal(55650051, product_publications.first.publication_id)
+  end
+
+  def test_get_product_publication
+    fake('publications/55650051/product_publications/647162527768', body: load_fixture('product_publication'))
+    product_publication = ShopifyAPI::ProductPublication.find(647162527768, params: { publication_id: 55650051 })
+
+    assert_equal(647162527768, product_publication.id)
+    assert_equal(55650051, product_publication.publication_id)
+  end
+
+  def test_create_product_publication
+    fake('publications/55650051/product_publications', method: :post, body: load_fixture('product_publication'))
+    ShopifyAPI::ProductPublication.create(
+      publication_id: 55650051,
+      published_at: "2018-01-29T14:06:08-05:00",
+      published: true,
+      product_id: 8267093571
+    )
+
+    expected_body = {
+      product_publication: {
+        published_at: "2018-01-29T14:06:08-05:00",
+        published: true,
+        product_id: 8267093571,
+      },
+    }.to_json
+
+    assert_equal(expected_body, WebMock.last_request.body)
+  end
+end

data/test/product_test.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class ProductTest < Test::Unit::TestCase
+  def setup
+    super
+
+    refresh_product
+  end
+
+  def test_add_metafields_to_product
+    fake("products/632910392/metafields", method: :post, status: 201, body: load_fixture('metafield'))
+
+    field = @product.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(WebMock.last_request.body)
+    )
+    assert(!field.new_record?)
+    assert_equal("contact", field.namespace)
+    assert_equal("email", field.key)
+    assert_equal("123@example.com", field.value)
+  end
+
+  def test_get_all_metafields_for_product
+    fake("products/632910392/metafields", body: load_fixture('metafields'))
+
+    metafields = @product.metafields
+
+    assert_equal(3, metafields.length)
+    assert(metafields.all? { |m| m.is_a?(ShopifyAPI::Metafield) })
+  end
+
+  def test_get_2_metafields_for_product
+    body = ActiveSupport::JSON.decode(load_fixture('metafields'))
+    body['metafields'].slice!(2, 1)
+
+    fake('products/632910392/metafields.json?limit=2', body: body.to_json, extension: false)
+
+    metafields = @product.metafields(limit: 2)
+
+    assert_equal(2, metafields.length)
+    assert(metafields.all? { |m| m.is_a?(ShopifyAPI::Metafield) })
+  end
+
+  def test_update_loaded_variant
+    fake("products/632910392/variants/808950810", method: :put, status: 200, body: load_fixture('variant'))
+
+    variant = @product.variants.first
+    variant.price = "0.50"
+    variant.save
+  end
+
+  def test_price_range
+    assert_equal('199.00', @product.price_range)
+  end
+
+  def test_price_range_when_has_different_price
+    @product.variants[0].price = '100.00'
+
+    assert_equal('100.00 - 199.00', @product.price_range)
+  end
+
+  def test_read_only_variant_inventory_fields_not_removed_in_2020_01
+    ShopifyAPI::Base.api_version = '2020-01'
+    refresh_product(api_version: ShopifyAPI::Base.api_version)
+
+    variant = @product.variants.first
+    assert_equal(10, variant.inventory_quantity)
+  end
+
+  def test_deprecated_inventory_fields_are_removed_in_2020_01
+    ShopifyAPI::Base.api_version = '2020-01'
+    refresh_product(api_version: ShopifyAPI::Base.api_version)
+
+    refute(@product.as_json.include?('total_inventory'))
+  end
+
+  def test_setting_product_total_inventory_passes_in_api_before_2019_10
+    ShopifyAPI::Base.api_version = '2019-07'
+    refresh_product(api_version: ShopifyAPI::Base.api_version)
+    @product.total_inventory = 8
+  end
+
+  def test_setting_product_total_inventory_fails_in_2019_10_api
+    ShopifyAPI::Base.api_version = '2019-10'
+    refresh_product(api_version: ShopifyAPI::Base.api_version)
+    assert_raises(ShopifyAPI::ValidationException) do
+      @product.total_inventory = 8
+    end
+  end
+
+  def test_setting_product_total_inventory_fails_in_the_unstable_api
+    ShopifyAPI::Base.api_version = :unstable
+    refresh_product(api_version: ShopifyAPI::Base.api_version)
+    assert_raises(ShopifyAPI::ValidationException) do
+      @product.total_inventory = 8
+    end
+  end
+
+  private
+
+  def refresh_product(api_version: nil)
+    fake("products/632910392", body: load_fixture('product'), api_version: api_version)
+    @product = ShopifyAPI::Product.find(632910392)
+  end
+end

data/test/publication_test.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class PublicationTest < Test::Unit::TestCase
+  def test_find_all_publications
+    fake('publications')
+    publications = ShopifyAPI::Publication.find(:all)
+
+    assert_equal(55650051, publications.first.id)
+    assert_equal("Buy Button", publications.first.name)
+  end
+end