shopify_api 6.0.0 → 7.0.0

data/test/api_version_test.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class ApiVersionTest < Test::Unit::TestCase
+  def teardown
+    super
+    ShopifyAPI::ApiVersion.clear_defined_versions
+    ShopifyAPI::ApiVersion.define_known_versions
+  end
+
+  test "unstable version creates url that start with /admin/api/unstable/" do
+    assert_equal(
+      "/admin/api/unstable/resource_path/id.json",
+      ShopifyAPI::ApiVersion::Unstable.new.construct_api_path("resource_path/id.json")
+    )
+  end
+
+  test "unstable version creates graphql url that start with /admin/api/unstable/" do
+    assert_equal(
+      "/admin/api/unstable/graphql.json",
+      ShopifyAPI::ApiVersion::Unstable.new.construct_graphql_path
+    )
+  end
+
+  test "coerce_to_version returns any version object given" do
+    version = ShopifyAPI::ApiVersion::Unstable.new
+    assert_same(version, ShopifyAPI::ApiVersion.coerce_to_version(version))
+  end
+
+  test "coerce_to_version converts a known version into a version object" do
+    versions = [
+      ShopifyAPI::ApiVersion::Unstable.new,
+      ShopifyAPI::ApiVersion::Release.new('2019-01'),
+    ]
+
+    assert_equal(versions, [
+      ShopifyAPI::ApiVersion.coerce_to_version('unstable'),
+      ShopifyAPI::ApiVersion.coerce_to_version('2019-01'),
+    ])
+  end
+
+  test "coerce_to_version raises when coercing a string that doesn't match a known version" do
+    assert_raises ShopifyAPI::ApiVersion::UnknownVersion do
+      ShopifyAPI::ApiVersion.coerce_to_version('made up version')
+    end
+  end
+
+  test "additional defined versions will also be coerced" do
+    versions = [
+      TestApiVersion.new('my_name'),
+      TestApiVersion.new('other_name'),
+    ]
+
+    versions.each do |version|
+      ShopifyAPI::ApiVersion.define_version(version)
+    end
+
+    assert_equal(versions, [
+      ShopifyAPI::ApiVersion.coerce_to_version('my_name'),
+      ShopifyAPI::ApiVersion.coerce_to_version('other_name'),
+    ])
+  end
+
+  test 'allows a release version with the correct format format to be created' do
+    assert ShopifyAPI::ApiVersion::Release.new('2019-03')
+  end
+
+  test 'release versions must follow the format' do
+    assert_raises ShopifyAPI::ApiVersion::InvalidVersion do
+      assert ShopifyAPI::ApiVersion::Release.new('crazy-name')
+    end
+  end
+
+  test 'release versions create a url that is /admin/api/<version_name>/' do
+    assert_equal(
+      '/admin/api/2022-03/shop.json',
+      ShopifyAPI::ApiVersion::Release.new('2022-03').construct_api_path('shop.json')
+    )
+  end
+
+  test 'two versions with the same version number are equal' do
+    version_1 = ShopifyAPI::ApiVersion::Release.new('2018-09')
+    version_2 = ShopifyAPI::ApiVersion::Release.new('2018-09')
+
+    assert_equal version_2, version_1
+  end
+
+  test 'two versions with the different version numbers are not equal' do
+    version_1 = ShopifyAPI::ApiVersion::Release.new('2019-07')
+    version_2 = ShopifyAPI::ApiVersion::Release.new('2019-11')
+
+    refute_equal version_2, version_1
+  end
+
+  test 'release verions are stable' do
+    assert_predicate ShopifyAPI::ApiVersion::Release.new('2019-11'), :stable?
+  end
+
+  test 'no release version are not stable' do
+    refute_predicate ShopifyAPI::ApiVersion::Unstable.new, :stable?
+  end
+
+  test 'release versions are ordered by version number with unstable always being the newest' do
+    version_1 = ShopifyAPI::ApiVersion::Release.new('2017-11')
+    version_2 = ShopifyAPI::ApiVersion::Release.new('2019-11')
+    version_3 = ShopifyAPI::ApiVersion::Release.new('2039-01')
+    version_4 = ShopifyAPI::ApiVersion::Release.new('2039-02')
+    unstable = ShopifyAPI::ApiVersion::Unstable.new
+
+    assert_equal([
+      version_1,
+      version_2,
+      version_3,
+      version_4,
+      unstable,
+    ], [
+      version_3,
+      version_1,
+      version_4,
+      unstable,
+      version_2,
+    ].sort)
+  end
+
+  test 'latest_stable_version will return the version that is newest and stable' do
+    ShopifyAPI::ApiVersion.clear_defined_versions
+    ShopifyAPI::ApiVersion.define_version(ShopifyAPI::ApiVersion::Release.new('2017-11'))
+    ShopifyAPI::ApiVersion.define_version(ShopifyAPI::ApiVersion::Release.new('2019-11'))
+    ShopifyAPI::ApiVersion.define_version(ShopifyAPI::ApiVersion::Release.new('2039-01'))
+    ShopifyAPI::ApiVersion.define_version(ShopifyAPI::ApiVersion::Release.new('2039-02'))
+    ShopifyAPI::ApiVersion.define_version(ShopifyAPI::ApiVersion::Unstable.new)
+
+    assert_equal(
+      ShopifyAPI::ApiVersion::Release.new('2039-02'),
+      ShopifyAPI::ApiVersion.latest_stable_version
+    )
+  end
+
+  class TestApiVersion < ShopifyAPI::ApiVersion
+    def initialize(name)
+      @version_name = name
+    end
+  end
+end

data/test/base_test.rb

@@ -1,14 +1,15 @@
 require 'test_helper'
-
+require "active_support/log_subscriber/test_helper"
 
 class BaseTest < Test::Unit::TestCase
-
   def setup
-    @session1 = ShopifyAPI::Session.new('shop1.myshopify.com', 'token1')
-    @session2 = ShopifyAPI::Session.new('shop2.myshopify.com', 'token2')
+    super
+    @session1 = ShopifyAPI::Session.new(domain: 'shop1.myshopify.com', token: 'token1', api_version: '2019-01')
+    @session2 = ShopifyAPI::Session.new(domain: 'shop2.myshopify.com', token: 'token2', api_version: '2019-01')
   end
 
   def teardown
+    super
     clear_header('X-Custom')
   end
 
@@ -16,8 +17,8 @@ class BaseTest < Test::Unit::TestCase
     ShopifyAPI::Base.activate_session @session1
 
     assert_nil ActiveResource::Base.site
-    assert_equal 'https://shop1.myshopify.com/admin', ShopifyAPI::Base.site.to_s
-    assert_equal 'https://shop1.myshopify.com/admin', ShopifyAPI::Shop.site.to_s
+    assert_equal 'https://shop1.myshopify.com', ShopifyAPI::Base.site.to_s
+    assert_equal 'https://shop1.myshopify.com', ShopifyAPI::Shop.site.to_s
 
     assert_nil ActiveResource::Base.headers['X-Shopify-Access-Token']
     assert_equal 'token1', ShopifyAPI::Base.headers['X-Shopify-Access-Token']
@@ -56,8 +57,8 @@ class BaseTest < Test::Unit::TestCase
     ShopifyAPI::Base.activate_session @session2
 
     assert_nil ActiveResource::Base.site
-    assert_equal 'https://shop2.myshopify.com/admin', ShopifyAPI::Base.site.to_s
-    assert_equal 'https://shop2.myshopify.com/admin', ShopifyAPI::Shop.site.to_s
+    assert_equal 'https://shop2.myshopify.com', ShopifyAPI::Base.site.to_s
+    assert_equal 'https://shop2.myshopify.com', ShopifyAPI::Shop.site.to_s
 
     assert_nil ActiveResource::Base.headers['X-Shopify-Access-Token']
     assert_equal 'token2', ShopifyAPI::Base.headers['X-Shopify-Access-Token']
@@ -73,7 +74,9 @@ class BaseTest < Test::Unit::TestCase
   test "#delete should send custom headers with request" do
     ShopifyAPI::Base.activate_session @session1
     ShopifyAPI::Base.headers['X-Custom'] = 'abc'
-    ShopifyAPI::Base.connection.expects(:delete).with('/admin/bases/1.json', has_entry('X-Custom', 'abc'))
+    ShopifyAPI::Base.connection
+      .expects(:delete)
+      .with('/admin/api/2019-01/bases/1.json', has_entry('X-Custom', 'abc'))
     ShopifyAPI::Base.delete "1"
   end
 
@@ -86,35 +89,72 @@ class BaseTest < Test::Unit::TestCase
     thread.join
   end
 
-  if ActiveResource::VERSION::MAJOR >= 4
-    test "#headers propagates changes to subclasses" do
-      ShopifyAPI::Base.headers['X-Custom'] = "the value"
-      assert_equal "the value", ShopifyAPI::Base.headers['X-Custom']
-      assert_equal "the value", ShopifyAPI::Product.headers['X-Custom']
-    end
+  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)
 
-    test "#headers clears changes to subclasses" do
-      ShopifyAPI::Base.headers['X-Custom'] = "the value"
-      assert_equal "the value", ShopifyAPI::Product.headers['X-Custom']
-      ShopifyAPI::Base.headers['X-Custom'] = nil
-      assert_nil ShopifyAPI::Product.headers['X-Custom']
+    TestResource.prefix = 'a/regular/path/'
+
+    assert_equal('/admin/api/2019-01/a/regular/path/', TestResource.prefix)
+  end
+
+  test "prefix= will raise an error if value starts with with /admin" do
+    assert_raises ArgumentError do
+      TestResource.prefix = '/admin/old/prefix/structure/'
     end
   end
 
-  if ActiveResource::VERSION::MAJOR >= 5 || (ActiveResource::VERSION::MAJOR >= 4 && ActiveResource::VERSION::PRE == "threadsafe")
-    test "#headers set in the main thread affect spawned threads" do
+  test "#headers propagates changes to subclasses" do
+    ShopifyAPI::Base.headers['X-Custom'] = "the value"
+    assert_equal "the value", ShopifyAPI::Base.headers['X-Custom']
+    assert_equal "the value", ShopifyAPI::Product.headers['X-Custom']
+  end
+
+  test "#headers clears changes to subclasses" do
+    ShopifyAPI::Base.headers['X-Custom'] = "the value"
+    assert_equal "the value", ShopifyAPI::Product.headers['X-Custom']
+    ShopifyAPI::Base.headers['X-Custom'] = nil
+    assert_nil ShopifyAPI::Product.headers['X-Custom']
+  end
+
+  test "#headers set in the main thread affect spawned threads" do
+    ShopifyAPI::Base.headers['X-Custom'] = "the value"
+    Thread.new do
+      assert_equal "the value", ShopifyAPI::Base.headers['X-Custom']
+    end.join
+  end
+
+  test "#headers set in spawned threads do not affect the main thread" do
+    Thread.new do
       ShopifyAPI::Base.headers['X-Custom'] = "the value"
-      Thread.new do
-        assert_equal "the value", ShopifyAPI::Base.headers['X-Custom']
-      end.join
-    end
+    end.join
+    assert_nil ShopifyAPI::Base.headers['X-Custom']
+  end
 
-    test "#headers set in spawned threads do not affect the main thread" do
-      Thread.new do
-        ShopifyAPI::Base.headers['X-Custom'] = "the value"
-      end.join
-      assert_nil ShopifyAPI::Base.headers['X-Custom']
-    end
+  test "using a different version changes the url" do
+    release_2019_01 = ShopifyAPI::Session.new(domain: 'shop1.myshopify.com', token: 'token1', api_version: '2019-01')
+    unstable_version = ShopifyAPI::Session.new(domain: 'shop2.myshopify.com', token: 'token2', api_version: :unstable)
+
+    fake(
+      "shop",
+      url: "https://shop1.myshopify.com/admin/api/2019-01/shop.json",
+      method: :get,
+      status: 201,
+      body: '{ "shop": { "id": 1 } }'
+    )
+    fake(
+      "shop",
+      url: "https://shop2.myshopify.com/admin/api/unstable/shop.json",
+      method: :get,
+      status: 201,
+      body: '{ "shop": { "id": 2 } }'
+    )
+
+    ShopifyAPI::Base.activate_session(release_2019_01)
+    assert_equal 1, ShopifyAPI::Shop.current.id
+
+    ShopifyAPI::Base.activate_session(unstable_version)
+    assert_equal 2, ShopifyAPI::Shop.current.id
   end
 
   def clear_header(header)
@@ -122,4 +162,7 @@ class BaseTest < Test::Unit::TestCase
       klass.headers.delete(header)
     end
   end
+
+  class TestResource < ShopifyAPI::Base
+  end
 end

data/test/detailed_log_subscriber_test.rb

@@ -1,16 +1,29 @@
 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\"=>\"ShopifyAPI/#{ShopifyAPI::VERSION} ActiveResource/#{ActiveResource::VERSION::STRING} Ruby/#{RUBY_VERSION}\""
+    @request_headers = "Headers: {\"Accept\"=>\"application/json\", " \
+      "#{@ua_header}, \"X-Shopify-Access-Token\"=>\"access_token\"}"
+
+    ShopifyAPI::ApiVersion.define_version(ShopifyAPI::ApiVersion::Release.new('2019-01'))
 
     ShopifyAPI::Base.clear_session
-    ShopifyAPI::Base.site = "https://this-is-my-test-shop.myshopify.com/admin"
+    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
@@ -25,11 +38,18 @@ class LogSubscriberTest < Test::Unit::TestCase
 
     ShopifyAPI::Page.find(1)
 
-    assert_equal 4, @logger.logged(:info).size
-    assert_equal "GET https://this-is-my-test-shop.myshopify.com:443/admin/pages/1.json", @logger.logged(:info)[0]
-    assert_match /\-\-\> 200/, @logger.logged(:info)[1]
-    assert_equal "Headers: {\"Accept\"=>\"application/json\", #{@ua_header}}", @logger.logged(:info)[2]
-    assert_match /Response:\n\{\"page\"\:\{((\"id\"\:1)|(\"title\"\:\"Shopify API\")),((\"id\"\:1)|(\"title\"\:\"Shopify API\"))\}\}/,  @logger.logged(:info)[3]
+    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
@@ -39,11 +59,27 @@ class LogSubscriberTest < Test::Unit::TestCase
       ShopifyAPI::Page.find(2)
     end
 
-    assert_equal 4, @logger.logged(:info).size
-    assert_equal "GET https://this-is-my-test-shop.myshopify.com:443/admin/pages/2.json", @logger.logged(:info)[0]
-    assert_match /\-\-\> 404/, @logger.logged(:info)[1]
-    assert_equal "Headers: {\"Accept\"=>\"application/json\", #{@ua_header}}", @logger.logged(:info)[2]
-    assert_equal "Response:", @logger.logged(:info)[3]
+    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
@@ -58,7 +94,10 @@ class LogSubscriberTest < Test::Unit::TestCase
 
     assert_equal 1, @logger.logged(:warn).size
 
-    assert_match %r{\[DEPRECATED\] ShopifyAPI made a call to GET \/admin\/pages\/1.json}, @logger.logged(:warn).first
+    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

data/test/fixtures/access_scopes.json

@@ -0,0 +1,10 @@
+{
+  "access_scopes": [
+    {
+      "handle": "write_product_listings"
+    },
+    {
+      "handle": "read_shipping"
+    }
+  ]
+}

data/test/limits_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 class LimitsTest < Test::Unit::TestCase
   def setup
     super
-    @header_hash = {'http_x_shopify_shop_api_call_limit' => '100/300'}
+    @header_hash = { 'X-Shopify-Shop-Api-Call-Limit' => '100/300' }
     ShopifyAPI::Base.connection.expects(:response).at_least(0).returns(@header_hash)
   end
 
@@ -22,7 +22,7 @@ class LimitsTest < Test::Unit::TestCase
 
     should "flag maxed out credits" do
       assert !ShopifyAPI.maxed?
-      @header_hash = {'http_x_shopify_shop_api_call_limit' => '299/300'}
+      @header_hash = { 'X-Shopify-Shop-Api-Call-Limit' => '299/300' }
       ShopifyAPI::Base.connection.expects(:response).at_least(1).returns(@header_hash)
       assert ShopifyAPI.maxed?
     end

data/test/marketing_event_test.rb

@@ -43,7 +43,7 @@ class MarketingEventTest < Test::Unit::TestCase
 
   def test_count_marketing_events
     fake "marketing_events/count", :method => :get, :body => '{"count": 2}'
-    marketing_events_count = ShopifyAPI::MarketingEvent.get(:count)
+    marketing_events_count = ShopifyAPI::MarketingEvent.count
     assert_equal 2, marketing_events_count
   end
 

data/test/recurring_application_charge_test.rb

@@ -136,14 +136,8 @@ class RecurringApplicationChargeTest < Test::Unit::TestCase
   def test_recurring_application_charge_not_found_error
     fake "recurring_application_charges", body: '{"errors":"Not Found"}', status: 404
 
-    all_application_charges = ShopifyAPI::RecurringApplicationCharge.all
-    if ActiveResource::VERSION::MAJOR >= 5 || (ActiveResource::VERSION::MAJOR == 4 && ActiveResource::VERSION::MINOR >= 2)
-      assert_equal [], all_application_charges
-    else
-      assert_equal nil, all_application_charges
-    end
-
-    assert_equal nil, ShopifyAPI::RecurringApplicationCharge.current
-    assert_equal [],  ShopifyAPI::RecurringApplicationCharge.pending
+    assert_equal(nil, ShopifyAPI::RecurringApplicationCharge.all)
+    assert_equal(nil, ShopifyAPI::RecurringApplicationCharge.current)
+    assert_equal([], ShopifyAPI::RecurringApplicationCharge.pending)
   end
 end