shopify_api 6.0.0 → 7.0.0

data/test/session_test.rb

@@ -9,43 +9,62 @@ class SessionTest < Test::Unit::TestCase
   end
 
   test "not be valid without a url" do
-    session = ShopifyAPI::Session.new(nil, "any-token")
+    session = ShopifyAPI::Session.new(domain: nil, token: "any-token", api_version: any_api_version)
     assert_not session.valid?
   end
 
   test "not be valid without token" do
-    session = ShopifyAPI::Session.new("testshop.myshopify.com")
+    session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: nil, api_version: any_api_version)
     assert_not session.valid?
   end
 
-  test "be valid with any token and any url" do
-    session = ShopifyAPI::Session.new("testshop.myshopify.com", "any-token")
+  test "not be valid without an api version" do
+    session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: "any-token", api_version: nil)
+    assert_not session.valid?
+  end
+
+  test "be valid with any token, any url and version" do
+    session = ShopifyAPI::Session.new(
+      domain: "testshop.myshopify.com",
+      token: "any-token",
+      api_version: any_api_version
+    )
     assert session.valid?
   end
 
   test "not raise error without params" do
     assert_nothing_raised do
-      session = ShopifyAPI::Session.new("testshop.myshopify.com", "any-token")
+      ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: "any-token", api_version: any_api_version)
     end
   end
 
   test "ignore everything but the subdomain in the shop" do
-    assert_equal "https://testshop.myshopify.com/admin", ShopifyAPI::Session.new("http://user:pass@testshop.notshopify.net/path", "any-token").site
+    assert_equal(
+      "https://testshop.myshopify.com",
+      ShopifyAPI::Session.new(
+        domain: "http://user:pass@testshop.notshopify.net/path",
+        token: "any-token",
+        api_version: any_api_version
+      ).site
+    )
   end
 
   test "append the myshopify domain if not given" do
-    assert_equal "https://testshop.myshopify.com/admin", ShopifyAPI::Session.new("testshop", "any-token").site
+    assert_equal(
+      "https://testshop.myshopify.com",
+      ShopifyAPI::Session.new(domain: "testshop", token: "any-token", api_version: any_api_version).site
+    )
   end
 
   test "not raise error without params" do
     assert_nothing_raised do
-      session = ShopifyAPI::Session.new("testshop.myshopify.com", "any-token")
+      ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: "any-token", api_version: any_api_version)
     end
   end
 
   test "raise error if params passed but signature omitted" do
     assert_raises(ShopifyAPI::ValidationException) do
-      session = ShopifyAPI::Session.new("testshop.myshopify.com")
+      session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: nil, api_version: any_api_version)
       session.request_token({'code' => 'any-code'})
     end
   end
@@ -57,21 +76,84 @@ class SessionTest < Test::Unit::TestCase
   end
 
   test "#temp reset ShopifyAPI::Base.site to original value" do
+    session1 = ShopifyAPI::Session.new(domain: 'fakeshop.myshopify.com', token: 'token1', api_version: '2019-01')
+    ShopifyAPI::Base.activate_session(session1)
+
+    ShopifyAPI::Session.temp(domain: "testshop.myshopify.com", token: "any-token", api_version: :unstable) do
+      @assigned_site = ShopifyAPI::Base.site
+      @assigned_version = ShopifyAPI::Base.api_version
+    end
+
+    assert_equal('https://testshop.myshopify.com', @assigned_site.to_s)
+    assert_equal('https://fakeshop.myshopify.com', ShopifyAPI::Base.site.to_s)
+
+    assert_equal(ShopifyAPI::ApiVersion::Unstable.new, @assigned_version)
+    assert_equal(ShopifyAPI::ApiVersion::Release.new('2019-01'), ShopifyAPI::Base.api_version)
+  end
 
-    ShopifyAPI::Session.setup(:api_key => "key", :secret => "secret")
-    session1 = ShopifyAPI::Session.new('fakeshop.myshopify.com', 'token1')
+  test "#with_session activates the session for the duration of the block" do
+    session1 = ShopifyAPI::Session.new(domain: 'fakeshop.myshopify.com', token: 'token1', api_version: '2019-01')
     ShopifyAPI::Base.activate_session(session1)
 
-    ShopifyAPI::Session.temp("testshop.myshopify.com", "any-token") {
+    other_session = ShopifyAPI::Session.new(
+      domain: "testshop.myshopify.com",
+      token: "any-token",
+      api_version: :unstable
+    )
+
+    ShopifyAPI::Session.with_session(other_session) do
       @assigned_site = ShopifyAPI::Base.site
-    }
-    assert_equal 'https://testshop.myshopify.com/admin', @assigned_site.to_s
-    assert_equal 'https://fakeshop.myshopify.com/admin', ShopifyAPI::Base.site.to_s
+      @assigned_version = ShopifyAPI::Base.api_version
+    end
+
+    assert_equal('https://testshop.myshopify.com', @assigned_site.to_s)
+    assert_equal('https://fakeshop.myshopify.com', ShopifyAPI::Base.site.to_s)
+
+    assert_equal(ShopifyAPI::ApiVersion::Unstable.new, @assigned_version)
+    assert_equal(ShopifyAPI::ApiVersion::Release.new('2019-01'), ShopifyAPI::Base.api_version)
+  end
+
+  test "#with_session resets the activated session even if there an exception during the block" do
+    session1 = ShopifyAPI::Session.new(domain: 'fakeshop.myshopify.com', token: 'token1', api_version: '2019-01')
+    ShopifyAPI::Base.activate_session(session1)
+
+    other_session = ShopifyAPI::Session.new(
+      domain: "testshop.myshopify.com",
+      token: "any-token",
+      api_version: :unstable
+    )
+
+    assert_raises StandardError do
+      ShopifyAPI::Session.with_session(other_session) { raise StandardError, "" }
+    end
+
+    assert_equal('https://fakeshop.myshopify.com', ShopifyAPI::Base.site.to_s)
+    assert_equal(ShopifyAPI::ApiVersion::Release.new('2019-01'), ShopifyAPI::Base.api_version)
+  end
+
+  test "#with_version will adjust the actvated api version for the duration of the block" do
+    session1 = ShopifyAPI::Session.new(domain: 'fakeshop.myshopify.com', token: 'token1', api_version: '2019-01')
+    ShopifyAPI::Base.activate_session(session1)
+
+    ShopifyAPI::Session.with_version(:unstable) do
+      @assigned_site = ShopifyAPI::Base.site
+      @assigned_version = ShopifyAPI::Base.api_version
+    end
+
+    assert_equal('https://fakeshop.myshopify.com', @assigned_site.to_s)
+    assert_equal('https://fakeshop.myshopify.com', ShopifyAPI::Base.site.to_s)
+
+    assert_equal(ShopifyAPI::ApiVersion::Unstable.new, @assigned_version)
+    assert_equal(ShopifyAPI::ApiVersion::Release.new('2019-01'), ShopifyAPI::Base.api_version)
   end
 
   test "create_permission_url returns correct url with single scope no redirect uri" do
     ShopifyAPI::Session.setup(:api_key => "My_test_key", :secret => "My test secret")
-    session = ShopifyAPI::Session.new('http://localhost.myshopify.com')
+    session = ShopifyAPI::Session.new(
+      domain: 'http://localhost.myshopify.com',
+      token: 'any-token',
+      api_version: any_api_version
+    )
     scope = ["write_products"]
     permission_url = session.create_permission_url(scope)
     assert_equal "https://localhost.myshopify.com/admin/oauth/authorize?client_id=My_test_key&scope=write_products", permission_url
@@ -79,7 +161,11 @@ class SessionTest < Test::Unit::TestCase
 
   test "create_permission_url returns correct url with single scope and redirect uri" do
     ShopifyAPI::Session.setup(:api_key => "My_test_key", :secret => "My test secret")
-    session = ShopifyAPI::Session.new('http://localhost.myshopify.com')
+    session = ShopifyAPI::Session.new(
+      domain: 'http://localhost.myshopify.com',
+      token: 'any-token',
+      api_version: any_api_version
+    )
     scope = ["write_products"]
     permission_url = session.create_permission_url(scope, "http://my_redirect_uri.com")
     assert_equal "https://localhost.myshopify.com/admin/oauth/authorize?client_id=My_test_key&scope=write_products&redirect_uri=http://my_redirect_uri.com", permission_url
@@ -87,7 +173,11 @@ class SessionTest < Test::Unit::TestCase
 
   test "create_permission_url returns correct url with dual scope no redirect uri" do
     ShopifyAPI::Session.setup(:api_key => "My_test_key", :secret => "My test secret")
-    session = ShopifyAPI::Session.new('http://localhost.myshopify.com')
+    session = ShopifyAPI::Session.new(
+      domain: 'http://localhost.myshopify.com',
+      token: 'any-token',
+      api_version: any_api_version
+    )
     scope = ["write_products","write_customers"]
     permission_url = session.create_permission_url(scope)
     assert_equal "https://localhost.myshopify.com/admin/oauth/authorize?client_id=My_test_key&scope=write_products,write_customers", permission_url
@@ -95,7 +185,11 @@ class SessionTest < Test::Unit::TestCase
 
   test "create_permission_url returns correct url with no scope no redirect uri" do
     ShopifyAPI::Session.setup(:api_key => "My_test_key", :secret => "My test secret")
-    session = ShopifyAPI::Session.new('http://localhost.myshopify.com')
+    session = ShopifyAPI::Session.new(
+      domain: 'http://localhost.myshopify.com',
+      token: 'any-token',
+      api_version: any_api_version
+    )
     scope = []
     permission_url = session.create_permission_url(scope)
     assert_equal "https://localhost.myshopify.com/admin/oauth/authorize?client_id=My_test_key&scope=", permission_url
@@ -103,25 +197,40 @@ class SessionTest < Test::Unit::TestCase
 
   test "raise exception if code invalid in request token" do
     ShopifyAPI::Session.setup(:api_key => "My test key", :secret => "My test secret")
-    session = ShopifyAPI::Session.new('http://localhost.myshopify.com')
-    fake nil, :url => 'https://localhost.myshopify.com/admin/oauth/access_token',:method => :post, :status => 404, :body => '{"error" : "invalid_request"}'
+    session = ShopifyAPI::Session.new(
+      domain: 'http://localhost.myshopify.com',
+      token: nil,
+      api_version: any_api_version
+    )
+    fake(
+      nil,
+      url: 'https://localhost.myshopify.com/admin/oauth/access_token',
+      method: :post,
+      status: 404,
+      body: '{"error" : "invalid_request"}'
+    )
     assert_raises(ShopifyAPI::ValidationException) do
-      session.request_token(params={:code => "bad-code"})
+      session.request_token(code: "bad-code")
     end
     assert_equal false, session.valid?
   end
 
   test "return site for session" do
-    session = ShopifyAPI::Session.new("testshop.myshopify.com", "any-token")
-    assert_equal "https://testshop.myshopify.com/admin", session.site
+    session = ShopifyAPI::Session.new(
+      domain: "testshop.myshopify.com",
+      token: "any-token",
+      api_version: any_api_version
+    )
+    assert_equal "https://testshop.myshopify.com", session.site
   end
 
   test "return_token_if_signature_is_valid" do
+    api_version = any_api_version
     fake nil,
-      url: 'https://testshop.myshopify.com/admin/oauth/access_token',
+      url: "https://testshop.myshopify.com/admin/oauth/access_token",
       method: :post,
       body: '{"access_token":"any-token"}'
-    session = ShopifyAPI::Session.new("testshop.myshopify.com")
+    session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: nil, api_version: api_version)
 
     params = { code: 'any-code', timestamp: Time.now }
     token = session.request_token(params.merge(hmac: generate_signature(params)))
@@ -131,11 +240,12 @@ class SessionTest < Test::Unit::TestCase
   end
 
   test "extra parameters are stored in session" do
+    api_version = ShopifyAPI::ApiVersion::Unstable.new
     fake nil,
-      url: 'https://testshop.myshopify.com/admin/oauth/access_token',
+      url: "https://testshop.myshopify.com/admin/oauth/access_token",
       method: :post,
       body: '{"access_token":"any-token","foo":"example"}'
-    session = ShopifyAPI::Session.new("testshop.myshopify.com")
+    session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: nil, api_version: api_version)
 
     params = { code: 'any-code', timestamp: Time.now }
     assert session.request_token(params.merge(hmac: generate_signature(params)))
@@ -144,11 +254,12 @@ class SessionTest < Test::Unit::TestCase
   end
 
   test "expires_in is automatically converted in expires_at" do
+    api_version = any_api_version
     fake nil,
-      url: 'https://testshop.myshopify.com/admin/oauth/access_token',
+      url: "https://testshop.myshopify.com/admin/oauth/access_token",
       method: :post,
       body: '{"access_token":"any-token","expires_in":86393}'
-    session = ShopifyAPI::Session.new("testshop.myshopify.com")
+    session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: nil, api_version: api_version)
 
     Timecop.freeze do
       params = { code: 'any-code', timestamp: Time.now }
@@ -172,7 +283,7 @@ class SessionTest < Test::Unit::TestCase
     signature = generate_signature(params)
     params[:foo] = 'world'
     assert_raises(ShopifyAPI::ValidationException) do
-      session = ShopifyAPI::Session.new("testshop.myshopify.com")
+      session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: nil, api_version: any_api_version)
       session.request_token(params.merge(:hmac => signature))
     end
   end
@@ -182,7 +293,7 @@ class SessionTest < Test::Unit::TestCase
     signature = generate_signature(params)
     params[:foo] = 'world'
     assert_raises(ShopifyAPI::ValidationException) do
-      session = ShopifyAPI::Session.new("testshop.myshopify.com")
+      session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: nil, api_version: any_api_version)
       session.request_token(params.merge(:hmac => signature))
     end
   end
@@ -209,6 +320,16 @@ class SessionTest < Test::Unit::TestCase
     assert_equal true, ShopifyAPI::Session.validate_signature(params)
   end
 
+  test "url is aliased to domain to minimize the upgrade changes" do
+    session = ShopifyAPI::Session.new(
+      domain: "http://testshop.myshopify.com",
+      token: "any-token",
+      api_version: any_api_version
+    )
+
+    assert_equal('testshop.myshopify.com', session.url)
+  end
+
   private
 
   def make_sorted_params(params)
@@ -221,4 +342,9 @@ class SessionTest < Test::Unit::TestCase
     params = make_sorted_params(params) if params.is_a?(Hash)
     OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA256.new, ShopifyAPI::Session.secret, params)
   end
+
+  def any_api_version
+    version_name = ['2019-01', :unstable].sample(1).first
+    ShopifyAPI::ApiVersion.coerce_to_version(version_name)
+  end
 end

data/test/test_helper.rb

@@ -31,20 +31,24 @@ class Test::Unit::TestCase < Minitest::Unit::TestCase
 
   def setup
     ActiveResource::Base.format = :json
-    [ShopifyAPI, ShopifyAPI::Ping].each do |mod|
-      mod.constants.each do |const|
-        begin
-          const = mod.const_get(const)
-          const.format = :json if const.respond_to?(:format=)
-        rescue NameError
-        end
+    ShopifyAPI.constants.each do |const|
+      begin
+        const = mod.const_get(const)
+        const.format = :json if const.respond_to?(:format=)
+      rescue NameError
       end
     end
 
+    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"
-    ShopifyAPI::Base.password = nil
-    ShopifyAPI::Base.user = nil
+    session = ShopifyAPI::Session.new(
+      domain: "https://this-is-my-test-shop.myshopify.com",
+      token: "token_test_helper",
+      api_version: '2019-01',
+    )
+
+    ShopifyAPI::Base.activate_session(session)
   end
 
   def teardown
@@ -54,6 +58,9 @@ class Test::Unit::TestCase < Minitest::Unit::TestCase
     ShopifyAPI::Base.site = nil
     ShopifyAPI::Base.password = nil
     ShopifyAPI::Base.user = nil
+
+    ShopifyAPI::ApiVersion.clear_defined_versions
+    ShopifyAPI::ApiVersion.define_known_versions
   end
 
   # Custom Assertions
@@ -85,14 +92,23 @@ class Test::Unit::TestCase < Minitest::Unit::TestCase
     body   = options.has_key?(:body) ? options.delete(:body) : load_fixture(endpoint)
     format = options.delete(:format) || :json
     method = options.delete(:method) || :get
+    api_version = options.delete(:api_version) || ShopifyAPI::ApiVersion.coerce_to_version('2019-01')
     extension = ".#{options.delete(:extension)||'json'}" unless options[:extension]==false
 
     url = if options.has_key?(:url)
       options[:url]
     else
-      "https://this-is-my-test-shop.myshopify.com/admin/#{endpoint}#{extension}"
+      "https://this-is-my-test-shop.myshopify.com#{api_version.construct_api_path("#{endpoint}#{extension}")}"
     end
 
     FakeWeb.register_uri(method, url, {:body => body, :status => 200, :content_type => "text/#{format}", :content_length => 1}.merge(options))
   end
+
+  def ar_version_before?(version_string)
+    Gem::Version.new(ActiveResource::VERSION::STRING) < Gem::Version.new(version_string)
+  end
+
+  def ar_version_after?(version_string)
+    Gem::Version.new(version_string) < Gem::Version.new(ActiveResource::VERSION::STRING)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-11 00:00:00.000000000 Z
+date: 2019-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +128,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -172,27 +192,24 @@ files:
 - CONTRIBUTING.md
 - CONTRIBUTORS
 - Gemfile
-- Gemfile_ar30
-- Gemfile_ar31
-- Gemfile_ar32
-- Gemfile_ar40
+- Gemfile_ar41
+- Gemfile_ar50
+- Gemfile_ar51
 - Gemfile_ar_master
 - LICENSE
 - README.md
 - RELEASING
 - Rakefile
 - bin/shopify
-- lib/active_resource/base_ext.rb
 - lib/active_resource/connection_ext.rb
 - lib/active_resource/detailed_log_subscriber.rb
-- lib/active_resource/disable_prefix_check.rb
 - lib/active_resource/json_errors.rb
-- lib/active_resource/to_query.rb
 - lib/shopify_api.rb
+- lib/shopify_api/api_version.rb
 - lib/shopify_api/connection.rb
 - lib/shopify_api/countable.rb
+- lib/shopify_api/disable_prefix_check.rb
 - lib/shopify_api/events.rb
-- lib/shopify_api/json_format.rb
 - lib/shopify_api/limits.rb
 - lib/shopify_api/metafields.rb
 - lib/shopify_api/resources.rb
@@ -241,7 +258,6 @@ files:
 - lib/shopify_api/resources/marketing_event.rb
 - lib/shopify_api/resources/metafield.rb
 - lib/shopify_api/resources/note_attribute.rb
-- lib/shopify_api/resources/o_auth.rb
 - lib/shopify_api/resources/option.rb
 - lib/shopify_api/resources/order.rb
 - lib/shopify_api/resources/order_risk.rb
@@ -249,9 +265,6 @@ files:
 - lib/shopify_api/resources/payment.rb
 - lib/shopify_api/resources/payment_details.rb
 - lib/shopify_api/resources/ping.rb
-- lib/shopify_api/resources/ping/conversation.rb
-- lib/shopify_api/resources/ping/delivery_confirmation_details.rb
-- lib/shopify_api/resources/ping/message.rb
 - lib/shopify_api/resources/policy.rb
 - lib/shopify_api/resources/price_rule.rb
 - lib/shopify_api/resources/product.rb
@@ -289,9 +302,11 @@ files:
 - shipit.rubygems.yml
 - shopify_api.gemspec
 - test/abandoned_checkouts_test.rb
+- test/access_scope_test.rb
 - test/access_token_test.rb
 - test/active_resource/json_errors_test.rb
 - test/api_permission_test.rb
+- test/api_version_test.rb
 - test/application_charge_test.rb
 - test/application_credit_test.rb
 - test/article_test.rb
@@ -314,6 +329,7 @@ files:
 - test/draft_order_test.rb
 - test/fixtures/abandoned_checkout.json
 - test/fixtures/abandoned_checkouts.json
+- test/fixtures/access_scopes.json
 - test/fixtures/access_token_delegate.json
 - test/fixtures/application_charge.json
 - test/fixtures/application_charges.json
@@ -366,7 +382,6 @@ files:
 - test/fixtures/marketing_events.json
 - test/fixtures/metafield.json
 - test/fixtures/metafields.json
-- test/fixtures/o_auth_revoke.json
 - test/fixtures/order.json
 - test/fixtures/order_risk.json
 - test/fixtures/order_risks.json
@@ -427,12 +442,9 @@ files:
 - test/location_test.rb
 - test/marketing_event_test.rb
 - test/metafield_test.rb
-- test/o_auth_test.rb
 - test/order_risk_test.rb
 - test/order_test.rb
 - test/payment_test.rb
-- test/ping/conversation_test.rb
-- test/ping/message_test.rb
 - test/policy_test.rb
 - test/price_rule_test.rb
 - test/product_listing_test.rb
@@ -472,7 +484,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="