ruby_shopify_api 1.0.0

data/test/carrier_service_test.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class CarrierServiceTest < Test::Unit::TestCase
+  test 'new should create carrier service' do
+    fake("carrier_services", method: :post, body: load_fixture('carrier_service'))
+    carrier_service = ShopifyAPI::CarrierService.new(name: "Some Postal Service")
+    carrier_service.save
+    assert_equal("Some Postal Service", carrier_service.name)
+  end
+
+  test 'find should return the carrier service' do
+    fake("carrier_services/123456", method: :get, body: load_fixture('carrier_service'))
+    carrier_service = ShopifyAPI::CarrierService.find(123456)
+    assert_equal(123456, carrier_service.id)
+    assert_equal("Some Postal Service", carrier_service.name)
+  end
+end

data/test/cart_test.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class CartTest < Test::Unit::TestCase
+  test 'all should return all carts' do
+    fake 'carts'
+    carts = ShopifyAPI::Cart.all
+    assert_equal carts.size, 2
+    assert_equal 2, carts.first.id
+    assert_equal "3eed8183d4281db6ea82ee2b8f23e9cc", carts.first.token
+    assert_equal 1, carts.first.line_items.size
+    assert_equal 'test', carts.first.line_items.first.title
+  end
+end

data/test/checkouts_test.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class CheckoutsTest < Test::Unit::TestCase
+  def setup
+    super
+
+    @expected_checkouts = JSON.parse(load_fixture('checkouts'))['checkouts']
+    @expected_checkout_id = JSON.parse(load_fixture('checkout'))['checkout']['token']
+  end
+
+  test ".headers includes a version" do
+    assert_equal "2016-09-06", ShopifyAPI::Checkout.headers["X-Shopify-Checkout-Version"]
+    assert_nil ShopifyAPI::Base.headers["X-Shopify-Checkout-Version"]
+  end
+
+  test ":create creates a checkout" do
+    fake 'checkouts', method: :post, status: 201, body: load_fixture('checkout')
+
+    checkout = ShopifyAPI::Checkout.create
+
+    assert_equal @expected_checkout_id, checkout.id
+  end
+
+  test "get all checkouts indexed by token" do
+    fake 'checkouts', method: :get, status: 200, body: load_fixture('checkouts')
+
+    checkouts = ShopifyAPI::Checkout.all
+
+    assert_equal @expected_checkout_id, checkouts.first.id
+    assert_equal @expected_checkouts.size, checkouts.size
+  end
+
+  test ":complete completes a checkout" do
+    fake "checkouts/#{@expected_checkout_id}", method: :get, status: 200, body: load_fixture('checkout')
+
+    checkout = ShopifyAPI::Checkout.find(@expected_checkout_id)
+
+    fake "checkouts/#{@expected_checkout_id}/complete", method: :post, status: 200, body: load_fixture('checkouts')
+
+    checkout.complete
+  end
+
+  test ":ready? returns true when status is 201" do
+    fake "checkouts/#{@expected_checkout_id}", method: :get, status: 201, body: load_fixture('checkout')
+    checkout = ShopifyAPI::Checkout.find(@expected_checkout_id)
+
+    assert_predicate checkout, :ready?
+  end
+
+  test ":ready? returns false when status is 202" do
+    fake "checkouts/#{@expected_checkout_id}", method: :get, status: 202, body: load_fixture('checkout')
+    checkout = ShopifyAPI::Checkout.find(@expected_checkout_id)
+
+    refute_predicate checkout, :ready?
+  end
+
+  test ":payments returns payments for a checkout" do
+    fake "checkouts/#{@expected_checkout_id}", method: :get, status: 200, body: load_fixture('checkout')
+    checkout = ShopifyAPI::Checkout.find(@expected_checkout_id)
+
+    fake "checkouts/#{@expected_checkout_id}/payments", method: :get, status: 202, body: load_fixture('payments')
+
+    assert_equal 10.00, checkout.payments.first.amount
+  end
+
+  test ":shipping_rates returns shipping rates for a checkout" do
+    fake "checkouts/#{@expected_checkout_id}", method: :get, status: 200, body: load_fixture('checkout')
+    checkout = ShopifyAPI::Checkout.find(@expected_checkout_id)
+
+    fake("checkouts/#{@expected_checkout_id}/shipping_rates",
+      method: :get,
+      status: 202,
+      body: load_fixture('shipping_rates'))
+    assert_equal "canada_post-INT.TP.BOGUS-4.00", checkout.shipping_rates.first.id
+  end
+end

data/test/collect_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class CollectTest < Test::Unit::TestCase
+  test "#create should create a collect" do
+    fake("collects", method: :post, status: 201, body: load_fixture('collect'))
+    link = ShopifyAPI::Collect.create(product_id: 921728736, collection_id: 841564295)
+    assert_equal(841564295, link.id)
+  end
+end

data/test/collection_listing_test.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class CollectionListingTest < Test::Unit::TestCase
+  def test_get_collection_listings
+    fake("collection_listings", method: :get, status: 201, body: load_fixture('collection_listings'))
+
+    collection_listings = ShopifyAPI::CollectionListing.find(:all)
+
+    assert_equal(1, collection_listings.count)
+    assert_equal(1, collection_listings.first.collection_id)
+    assert_equal('Home page', collection_listings.first.title)
+  end
+
+  def test_get_collection_listing
+    fake("collection_listings/1", method: :get, status: 201, body: load_fixture('collection_listing'))
+
+    collection_listing = ShopifyAPI::CollectionListing.find(1)
+
+    assert_equal(1, collection_listing.collection_id)
+    assert_equal('Home page', collection_listing.title)
+  end
+
+  def test_get_collection_listing_reload
+    fake("collection_listings/1", method: :get, status: 201, body: load_fixture('collection_listing'))
+
+    collection_listing = ShopifyAPI::CollectionListing.new(collection_id: 1)
+    collection_listing.reload
+
+    assert_equal(1, collection_listing.collection_id)
+    assert_equal('Home page', collection_listing.title)
+  end
+
+  def test_get_collection_listing_product_ids
+    fake(
+      "collection_listings/1/product_ids",
+      method: :get,
+      status: 201,
+      body: load_fixture('collection_listing_product_ids')
+    )
+
+    collection_listing = ShopifyAPI::CollectionListing.new(collection_id: 1)
+
+    assert_equal([1, 2], collection_listing.product_ids)
+  end
+
+  def test_get_collection_listing_product_ids_multi_page_with_cursor
+    version = ShopifyAPI::ApiVersion.find_version('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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class CollectionPublicationTest < Test::Unit::TestCase
+  def test_get_all_collection_publications
+    fake('publications/55650051/collection_publications', body: load_fixture('collection_publications'))
+    collection_publications = ShopifyAPI::CollectionPublication.find(:all, params: { publication_id: 55650051 })
+
+    assert_equal(96062799894, collection_publications.first.id)
+    assert_equal(55650051, collection_publications.first.publication_id)
+  end
+
+  def test_get_collection_publication
+    fake('publications/55650051/collection_publications/647162527768', body: load_fixture('collection_publication'))
+    collection_publication = ShopifyAPI::CollectionPublication.find(647162527768, params: { publication_id: 55650051 })
+
+    assert_equal(96062799894, collection_publication.id)
+    assert_equal(55650051, collection_publication.publication_id)
+  end
+
+  def test_create_collection_publication
+    fake('publications/55650051/collection_publications', method: :post, body: load_fixture('collection_publication'))
+    ShopifyAPI::CollectionPublication.create(
+      publication_id: 55650051,
+      published_at: "2018-01-29T14:06:08-05:00",
+      published: true,
+      collection_id: 8267093571
+    )
+
+    expected_body = {
+      collection_publication: {
+        published_at: "2018-01-29T14:06:08-05:00",
+        published: true,
+        collection_id: 8267093571,
+      },
+    }.to_json
+
+    assert_equal(expected_body, WebMock.last_request.body)
+  end
+end

data/test/collection_test.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class CollectionTest < Test::Unit::TestCase
+  test "Collection get products gets all products in a collection on 2020-01 version" do
+    available_version = ShopifyAPI::Session.new(domain: 'shop2.myshopify.com', token: 'token2', api_version: '2020-01')
+    ShopifyAPI::Base.activate_session(available_version)
+
+    fake(
+      'collections',
+      url: 'https://shop2.myshopify.com/admin/api/2020-01/collections/1.json',
+      method: :get,
+      status: 200,
+      body: load_fixture('collection'),
+      extension: false
+    )
+
+    collection = ShopifyAPI::Collection.find(1)
+
+    fake(
+      'products',
+      url: 'https://shop2.myshopify.com/admin/api/2020-01/collections/1/products.json',
+      method: :get,
+      status: 200,
+      body: load_fixture('collection_products'),
+      extension: false
+    )
+    assert_equal [632910392, 921728736], collection.products.map(&:id)
+  end
+
+  test "Collection get products fails on older api version" do
+    old_version = ShopifyAPI::Session.new(domain: 'shop2.myshopify.com', token: 'token2', api_version: '2019-10')
+    ShopifyAPI::Base.activate_session(old_version)
+
+    fake(
+      'collections',
+      url: 'https://shop2.myshopify.com/admin/api/2019-10/collections/1.json',
+      method: :get,
+      status: 200,
+      body: load_fixture('collection'),
+      extension: false
+    )
+
+    collection = ShopifyAPI::Collection.find(1)
+
+    assert_raises(NotImplementedError) do
+      collection.products
+    end
+  end
+end

data/test/countable_test.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class CountableTest < Test::Unit::TestCase
+  def setup
+    super
+    fake("products/count", body: '{"count": 16}')
+  end
+
+  def test_count_products
+    count = ShopifyAPI::Product.count
+    assert_equal(16, count)
+  end
+end

data/test/currency_test.rb

@@ -0,0 +1,21 @@
+
+# frozen_string_literal: true
+require 'test_helper'
+class CurrencyTest < Test::Unit::TestCase
+  def setup
+    super
+    fake("currencies", method: :get, body: load_fixture('currencies'))
+  end
+
+  context "Currency" do
+    should 'return a list of enabled currencies' do
+      currencies = ShopifyAPI::Currency.all
+      assert_equal(4, currencies.count)
+      assert_equal(%w(AUD EUR GBP HKD), currencies.map(&:currency))
+      assert_equal([true, true, true, false], currencies.map(&:enabled))
+      currencies.each do |currency|
+        assert_equal("2018-10-03T14:44:08-04:00", currency.rate_updated_at)
+      end
+    end
+  end
+end

data/test/custom_collection_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class CustomCollectionTest < Test::Unit::TestCase
+  test "#create should create a custom collection" do
+    fake("custom_collections", method: :post, status: 201, body: load_fixture('custom_collection'))
+    link = ShopifyAPI::CustomCollection.create(title: "Macbooks", image: { src: "http://example.com/rails_logo.gif" })
+    assert_equal(1063001463, link.id)
+  end
+end

data/test/customer_saved_search_test.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class CustomerSavedSearchTest < Test::Unit::TestCase
+  def setup
+    super
+    load_customer_saved_search
+  end
+
+  def test_get_customers_from_customer_saved_search
+    fake(
+      'customers/search.json?customer_saved_search_id=8899730',
+      body: load_fixture('customer_saved_search_customers'),
+      extension: false
+    )
+    assert_equal(1, @customer_saved_search.customers.length)
+    assert_equal(112223902, @customer_saved_search.customers.first.id)
+  end
+
+  def test_get_customers_from_customer_saved_search_with_params
+    fake(
+      'customers/search.json?customer_saved_search_id=8899730&limit=1',
+      body: load_fixture('customer_saved_search_customers'),
+      extension: false
+    )
+    customers = @customer_saved_search.customers(limit: 1)
+    assert_equal(1, customers.length)
+    assert_equal(112223902, customers.first.id)
+  end
+
+  private
+
+  def load_customer_saved_search
+    fake('customer_saved_searches/8899730', body: load_fixture('customer_saved_search'))
+    @customer_saved_search = ShopifyAPI::CustomerSavedSearch.find(8899730)
+  end
+end

data/test/customer_test.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class CustomerTest < Test::Unit::TestCase
+  def setup
+    super
+
+    fake('customers/207119551', body: load_fixture('customers'))
+
+    @customer = ShopifyAPI::Customer.find(207119551)
+  end
+
+  test "search should get a customers collection" do
+    fake(
+      "customers/search.json?query=Bob+country%3AUnited+States",
+      extension: false,
+      body: load_fixture('customers_search')
+    )
+
+    results = ShopifyAPI::Customer.search(query: 'Bob country:United States')
+    assert_equal('Bob', results.first.first_name)
+  end
+
+  test "account_activation_url should create an account activation url" do
+    fake(
+      "customers/207119551/account_activation_url",
+      method: :post,
+      body: load_fixture('customers_account_activation_url')
+    )
+
+    activation_url = "http://apple.myshopify.com/account/activate/207119551/86688abf23572680740b1c062fa37111-1458248616"
+    assert_equal(activation_url, @customer.account_activation_url)
+  end
+
+  test "#send_invite with no params" do
+    customer_invite_fixture = load_fixture('customer_invite')
+    customer_invite = ActiveSupport::JSON.decode(customer_invite_fixture)
+    fake('customers/207119551/send_invite', method: :post, body: customer_invite_fixture)
+
+    customer_invite_response = @customer.send_invite
+
+    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
+
+  test "#send_invite with params" do
+    customer_invite_fixture = load_fixture('customer_invite')
+    customer_invite = ActiveSupport::JSON.decode(customer_invite_fixture)
+    fake('customers/207119551/send_invite', method: :post, body: customer_invite_fixture)
+
+    customer_invite_response = @customer.send_invite(ShopifyAPI::CustomerInvite.new(customer_invite['customer_invite']))
+
+    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
+end

data/test/detailed_log_subscriber_test.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+require 'test_helper'
+require "active_support/log_subscriber/test_helper"
+require 'json'
+
+class LogSubscriberTest < Test::Unit::TestCase
+  include ActiveSupport::LogSubscriber::TestHelper
+
+  attr_reader :request_headers
+
+  def setup
+    super
+    @page = { page: { id: 1, title: 'Shopify API' } }.to_json
+    @ua_header = "\"User-Agent\"=>\"RubyShopifyAPI/#{ShopifyAPI::VERSION} " \
+      "ActiveResource/#{ActiveResource::VERSION::STRING} Ruby/#{RUBY_VERSION}\""
+    @request_headers = "Headers: {\"Accept\"=>\"application/json\", " \
+      "#{@ua_header}, \"X-Shopify-Access-Token\"=>\"[FILTERED]\"}"
+
+    ShopifyAPI::Base.clear_session
+    fake(
+      "apis",
+      url: "https://app.shopify.com/services/apis.json",
+      method: :get,
+      status: 200,
+      api_version: :stub,
+      body: load_fixture('apis')
+    )
+    ShopifyAPI::ApiVersion.fetch_known_versions
+    session = ShopifyAPI::Session.new(
+      domain: "https://this-is-my-test-shop.myshopify.com",
+      token: "access_token",
+      api_version: '2019-01'
+    )
+
+    ShopifyAPI::Base.activate_session(session)
+
+    ActiveResource::LogSubscriber.attach_to(:active_resource)
+    ActiveResource::DetailedLogSubscriber.attach_to(:active_resource_detailed)
+  end
+
+  def teardown
+    super
+    ShopifyAPI::ApiVersion.clear_known_versions
+    ShopifyAPI::ApiVersion.version_lookup_mode = :raise_on_unknown
+  end
+
+  def set_logger(logger)
+    ActiveResource::Base.logger = logger
+  end
+
+  test "logging on #find" do
+    fake("pages/1", method: :get, body: @page)
+
+    ShopifyAPI::Page.find(1)
+
+    assert_equal(4, @logger.logged(:info).size)
+    assert_equal(
+      "GET https://this-is-my-test-shop.myshopify.com:443/admin/api/2019-01/pages/1.json",
+      @logger.logged(:info)[0]
+    )
+    assert_match(/\-\-\> 200/, @logger.logged(:info)[1])
+    assert_equal(request_headers, @logger.logged(:info)[2])
+    assert_match(
+      %r{(Response:\n\{\"page\"\:\{\"id\"\:1,\"title\"\:\"Shopify API\"\}\})|
+        (Response:\n\{\"page\"\:\{\"title\"\:\"Shopify API\",\"id\"\:1\}\})},
+      @logger.logged(:info)[3]
+    )
+  end
+
+  test "logging on #find with an error" do
+    fake("pages/2", method: :get, body: nil, status: 404)
+
+    assert_raises(ActiveResource::ResourceNotFound) do
+      ShopifyAPI::Page.find(2)
+    end
+
+    if ar_version_before?('5.1.0')
+      assert_equal(4, @logger.logged(:info).size)
+      assert_equal(
+        "GET https://this-is-my-test-shop.myshopify.com:443/admin/api/2019-01/pages/2.json",
+        @logger.logged(:info)[0]
+      )
+      assert_match(/\-\-\> 404/, @logger.logged(:info)[1])
+      assert_equal(request_headers, @logger.logged(:info)[2])
+      assert_equal("Response:", @logger.logged(:info)[3])
+    else
+      assert_equal(2, @logger.logged(:error).size)
+      assert_equal(
+        "GET https://this-is-my-test-shop.myshopify.com:443/admin/api/2019-01/pages/2.json",
+        @logger.logged(:error)[0]
+      )
+      assert_match(/\-\-\> 404/, @logger.logged(:error)[1])
+
+      assert_equal(2, @logger.logged(:info).size)
+      assert_equal(request_headers, @logger.logged(:info)[0])
+      assert_equal("Response:", @logger.logged(:info)[1])
+    end
+  end
+
+  test "warns when the server responds with a x-shopify-api-deprecated-reason header" do
+    fake(
+      "pages/1",
+      method: :get,
+      body: @page,
+      x_shopify_api_deprecated_reason: 'https://help.shopify.com/en/api/getting-started/api-deprecations'
+    )
+
+    ShopifyAPI::Page.find(1)
+
+    assert_equal(1, @logger.logged(:warn).size)
+
+    assert_match(
+      %r{\[DEPRECATED\] ShopifyAPI made a call to GET /admin/api/2019-01/pages/1.json},
+      @logger.logged(:warn).first
+    )
+    assert_match(
+      %r{See https:\/\/help.shopify.com\/en\/api\/getting-started\/api-deprecations for more details.},
+      @logger.logged(:warn).first
+    )
+  end
+
+  test "warns when the server responds with a x-shopify-api-version-warning header" do
+    fake(
+      "pages/1",
+      method: :get,
+      body: @page,
+      x_shopify_api_version_warning: 'https://shopify.dev/concepts/about-apis/versioning'
+    )
+
+    ShopifyAPI::Page.find(1)
+
+    assert_equal(1, @logger.logged(:warn).size)
+
+    assert_match(
+      %r{\[API Version Warning\] ShopifyAPI made a call to GET /admin/api/2019-01/pages/1.json},
+      @logger.logged(:warn).first
+    )
+    assert_match(
+      %r{See https:\/\/shopify.dev\/concepts\/about-apis\/versioning for more details.},
+      @logger.logged(:warn).first
+    )
+  end
+end

data/test/discount_code_batch_test.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class DiscountCodeBatchTest < Test::Unit::TestCase
+  def setup
+    super
+    fake('price_rules/102586120/batch/989355119', body: load_fixture('discount_code_batch'))
+  end
+
+  def test_get_batch
+    batch = ShopifyAPI::DiscountCodeBatch.find(989355119, params: { price_rule_id: 102586120 })
+
+    assert_equal(989355119, batch.id)
+  end
+
+  def test_get_batch_discount_codes
+    fake(
+      'price_rules/102586120/batch/989355119/discount_codes',
+      method: :get,
+      status: 200,
+      body: load_fixture('discount_code_batch_discount_codes')
+    )
+    batch = ShopifyAPI::DiscountCodeBatch.find(989355119, params: { price_rule_id: 102586120 })
+    discount_code_job = batch.discount_code_job
+
+    assert_equal(3, discount_code_job.count)
+    assert(discount_code_job[2].errors.present?)
+  end
+
+  def test_create_batch
+    fake('price_rules/102586120/batch', method: :post, status: 201, body: load_fixture('discount_code_batch'))
+    batch = ShopifyAPI::DiscountCodeBatch.new
+    batch.prefix_options[:price_rule_id] = 102586120
+    discount_codes = [{ "code": "SUMMER1" }, { "code": "SUMMER2" }, { "code": "SUMMER3" }]
+    batch.discount_codes = discount_codes
+    batch.save
+
+    expected_body = { discount_codes: discount_codes }.to_json
+    assert_equal(expected_body, WebMock.last_request.body)
+  end
+end