shopify_api 9.2.0 → 9.3.0

data/test/redirect_test.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class RedirectTest < Test::Unit::TestCase
   test "#create should create a redirect" do
-    fake "redirects", :method => :post, :status => 201, :body => load_fixture('redirect')
-    redirect = ShopifyAPI::Redirect.create(:path => "/ipod", :target => "/pages/itunes")
-    assert_equal 979034150, redirect.id
+    fake("redirects", method: :post, status: 201, body: load_fixture('redirect'))
+    redirect = ShopifyAPI::Redirect.create(path: "/ipod", target: "/pages/itunes")
+    assert_equal(979034150, redirect.id)
   end
 end

data/test/refund_test.rb

@@ -1,32 +1,37 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class RefundTest < Test::Unit::TestCase
-
   test '#create should create a refund' do
-    fake "orders/450789469/refunds", :method => :post, :status => 201, :body => load_fixture('refund')
+    fake("orders/450789469/refunds", method: :post, status: 201, body: load_fixture('refund'))
     refund = ShopifyAPI::Refund.create(
-      :order_id => 450789469,
-      :restock => true,
-      :note => "wrong size",
-      :shipping => { :full_refund => true },
-      :refund_line_items => [{ :line_item_id => 518995019, :quantity => 1 }]
+      order_id: 450789469,
+      restock: true,
+      note: "wrong size",
+      shipping: { full_refund: true },
+      refund_line_items: [{ line_item_id: 518995019, quantity: 1 }]
     )
-    assert_equal 703073504, refund.refund_line_items.first.line_item_id
+    assert_equal(703073504, refund.refund_line_items.first.line_item_id)
   end
 
   test '#find should return a refund' do
-    fake "orders/450789469/refunds/509562969.json?order_id=450789469", :extension => false, :method => :get, :body => load_fixture('refund')
-    fake "orders/450789469/refunds/509562969", :method => :get, :body => load_fixture('refund')
-    refund = ShopifyAPI::Refund.find(509562969, :params => {:order_id => 450789469})
-    assert_equal 509562969, refund.id
+    fake(
+      "orders/450789469/refunds/509562969.json?order_id=450789469",
+      extension: false,
+      method: :get,
+      body: load_fixture('refund')
+    )
+    fake("orders/450789469/refunds/509562969", method: :get, body: load_fixture('refund'))
+    refund = ShopifyAPI::Refund.find(509562969, params: { order_id: 450789469 })
+    assert_equal(509562969, refund.id)
   end
 
   test '#calculate a refund' do
-    fake "orders/450789469/refunds/calculate", :method => :post, :body => load_fixture('refund')
-    data = { :shipping => { :amount => 0 } }
+    fake("orders/450789469/refunds/calculate", method: :post, body: load_fixture('refund'))
+    data = { shipping: { amount: 0 } }
 
-    refund = ShopifyAPI::Refund.calculate(data, :params => {:order_id => 450789469})
-    assert_equal 2, refund.refund_line_items.count
-    assert_equal 703073504, refund.refund_line_items.first.line_item_id
+    refund = ShopifyAPI::Refund.calculate(data, params: { order_id: 450789469 })
+    assert_equal(2, refund.refund_line_items.count)
+    assert_equal(703073504, refund.refund_line_items.first.line_item_id)
   end
 end

data/test/report_test.rb

@@ -1,35 +1,37 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class ReportTest < Test::Unit::TestCase
   test 'get should get a report' do
-    fake 'reports/987', method: :get, status: 200, body: load_fixture('report')
+    fake('reports/987', method: :get, status: 200, body: load_fixture('report'))
 
     report = ShopifyAPI::Report.find(987)
-    assert_equal 987, report.id
+    assert_equal(987, report.id)
   end
 
   test 'get all should get all reports' do
-    fake 'reports', method: :get, status: 200, body: load_fixture('reports')
+    fake('reports', method: :get, status: 200, body: load_fixture('reports'))
 
     reports = ShopifyAPI::Report.all
-    assert_equal 'custom_app_reports', reports.first.category
+    assert_equal('custom_app_reports', reports.first.category)
   end
 
   test 'create should create a report' do
-    fake 'reports', method: :post, status: 201, body: load_fixture('report')
+    fake('reports', method: :post, status: 201, body: load_fixture('report'))
 
     report = ShopifyAPI::Report.create(
       name: 'Custom App Report',
-      shopify_ql: 'SHOW quantity_count, total_sales BY product_type, vendor, product_title FROM products SINCE -1m UNTIL -0m ORDER BY total_sales DESC'
+      shopify_ql: 'SHOW quantity_count, total_sales BY product_type, vendor, product_title ' \
+        'FROM products SINCE -1m UNTIL -0m ORDER BY total_sales DESC'
     )
-    assert_equal 'custom_app_reports', report.category
+    assert_equal('custom_app_reports', report.category)
   end
 
   test 'delete should delete report' do
-    fake 'reports/987', method: :get, status: 200, body: load_fixture('report')
-    fake 'reports/987', method: :delete, status: 200, body: '[]'
+    fake('reports/987', method: :get, status: 200, body: load_fixture('report'))
+    fake('reports/987', method: :delete, status: 200, body: '[]')
 
     report = ShopifyAPI::Report.find(987)
-    assert report.destroy
+    assert(report.destroy)
   end
 end

data/test/resource_feedback_test.rb

@@ -1,41 +1,42 @@
+# frozen_string_literal: true
 class ResourceFeedbackTest < Test::Unit::TestCase
   def test_get_resource_feedback
-    body = { resource_feedback: [ { resource_type: 'Shop' } ] }.to_json
-    fake 'resource_feedback', method: :get, body: body
+    body = { resource_feedback: [{ resource_type: 'Shop' }] }.to_json
+    fake('resource_feedback', method: :get, body: body)
     resource_feedback = ShopifyAPI::ResourceFeedback.find(:all)
-    assert_equal 'Shop', resource_feedback.first.resource_type
+    assert_equal('Shop', resource_feedback.first.resource_type)
   end
 
   def test_save_with_resource_feedback_endpoint
     body = { resource_feedback: {} }.to_json
-    fake 'resource_feedback', method: :post, body: body
+    fake('resource_feedback', method: :post, body: body)
     ShopifyAPI::ResourceFeedback.new.save
-    assert_request_body body
+    assert_request_body(body)
   end
 
   def test_get_resource_feedback_with_product_id
-    body = { resource_feedback: [ { resource_type: 'Product' } ] }.to_json
-    fake 'products/42/resource_feedback', method: :get, body: body
+    body = { resource_feedback: [{ resource_type: 'Product' }] }.to_json
+    fake('products/42/resource_feedback', method: :get, body: body)
     resource_feedback = ShopifyAPI::ResourceFeedback.find(:all, params: { product_id: 42 })
-    assert_equal 'Product', resource_feedback.first.resource_type
+    assert_equal('Product', resource_feedback.first.resource_type)
   end
 
   def test_save_with_product_id_resource_feedback_endpoint
     body = { resource_feedback: {} }.to_json
-    fake 'products/42/resource_feedback', method: :post, body: body
+    fake('products/42/resource_feedback', method: :post, body: body)
     ShopifyAPI::ResourceFeedback.new(product_id: 42).save
-    assert_request_body body
+    assert_request_body(body)
   end
 
   def test_save_raises_exception_when_already_persisted
     body = { resource_feedback: {} }.to_json
-    fake 'resource_feedback', method: :post, body: body
+    fake('resource_feedback', method: :post, body: body)
     resource_feedback = ShopifyAPI::ResourceFeedback.new
     resource_feedback.save
-    assert_request_body body
+    assert_request_body(body)
 
     ShopifyAPI::ResourceFeedback.any_instance.expects(:persisted?).returns(true)
-    assert_raises ShopifyAPI::ResourceFeedback::ExistingFeedbackSaved do
+    assert_raises(ShopifyAPI::ResourceFeedback::ExistingFeedbackSaved) do
       resource_feedback.save
     end
   end

data/test/script_tag_test.rb

@@ -1,30 +1,31 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class ScriptTagTest < Test::Unit::TestCase
   test "get all should get all script tags" do
-    fake 'script_tags', :method => :get, :status => 200, :body => load_fixture('script_tags')
+    fake('script_tags', method: :get, status: 200, body: load_fixture('script_tags'))
     script_tags = ShopifyAPI::ScriptTag.all
-    assert_equal "http://js-aplenty.com/bar.js", script_tags.first.src
+    assert_equal("http://js-aplenty.com/bar.js", script_tags.first.src)
   end
 
   test "get should get a script tag" do
-    fake 'script_tags/421379493', :method => :get, :status => 200, :body => load_fixture('script_tag')
+    fake('script_tags/421379493', method: :get, status: 200, body: load_fixture('script_tag'))
     script_tag = ShopifyAPI::ScriptTag.find(421379493)
-    assert_equal "http://js-aplenty.com/bar.js", script_tag.src
+    assert_equal("http://js-aplenty.com/bar.js", script_tag.src)
   end
 
   test "create should create a new script tag" do
-    fake 'script_tags', :method => :post, :status => 201, :body => load_fixture('script_tag')
+    fake('script_tags', method: :post, status: 201, body: load_fixture('script_tag'))
     script_tag = ShopifyAPI::ScriptTag.create(event: "onload", src: "http://js-aplenty.com/bar.js")
-    assert_equal "http://js-aplenty.com/bar.js", script_tag.src
+    assert_equal("http://js-aplenty.com/bar.js", script_tag.src)
   end
 
   test "editing script tag should update script tag" do
-    fake 'script_tags/421379493', :method => :get, :status => 200, :body => load_fixture('script_tag')
+    fake('script_tags/421379493', method: :get, status: 200, body: load_fixture('script_tag'))
     script_tag = ShopifyAPI::ScriptTag.find(421379493)
     script_tag.src = "http://js-aplenty.com/bar.js"
-    fake 'script_tags/421379493', :method => :put, :status => 200, :body => load_fixture('script_tag')
+    fake('script_tags/421379493', method: :put, status: 200, body: load_fixture('script_tag'))
     script_tag.save
-    assert_equal "http://js-aplenty.com/bar.js", script_tag.src
+    assert_equal("http://js-aplenty.com/bar.js", script_tag.src)
   end
 end

data/test/session_test.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 require 'test_helper'
 require 'timecop'
 
 class SessionTest < Test::Unit::TestCase
+  SECONDS_IN_A_DAY = 24 * 60 * 60
 
   def setup
     super
@@ -10,33 +12,37 @@ class SessionTest < Test::Unit::TestCase
 
   test "not be valid without a url" do
     session = ShopifyAPI::Session.new(domain: nil, token: "any-token", api_version: any_api_version)
-    assert_not session.valid?
+    assert_not(session.valid?)
   end
 
   test "not be valid without token" do
     session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: nil, api_version: any_api_version)
-    assert_not session.valid?
+    assert_not(session.valid?)
   end
 
   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?
+    assert_not(session.valid?)
 
-    session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: "any-token", api_version: ShopifyAPI::ApiVersion::NullVersion)
-    assert_not session.valid?
+    session = ShopifyAPI::Session.new(
+      domain: "testshop.myshopify.com", token: "any-token", api_version: ShopifyAPI::ApiVersion::NullVersion
+    )
+    assert_not(session.valid?)
   end
 
   test "default to base API version" do
     session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: "any-token")
-    assert session.valid?
-    assert_equal session.api_version, ShopifyAPI::Base.api_version
+    assert(session.valid?)
+    assert_equal(session.api_version, ShopifyAPI::Base.api_version)
   end
 
   test "can override the base API version" do
     different_api_version = '2020-01'
-    session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: "any-token", api_version: different_api_version)
-    assert session.valid?
-    assert_equal session.api_version, ShopifyAPI::ApiVersion.find_version(different_api_version)
+    session = ShopifyAPI::Session.new(
+      domain: "testshop.myshopify.com", token: "any-token", api_version: different_api_version
+    )
+    assert(session.valid?)
+    assert_equal(session.api_version, ShopifyAPI::ApiVersion.find_version(different_api_version))
   end
 
   test "be valid with any token, any url and version" do
@@ -45,7 +51,7 @@ class SessionTest < Test::Unit::TestCase
       token: "any-token",
       api_version: any_api_version
     )
-    assert session.valid?
+    assert(session.valid?)
   end
 
   test "not raise error without params" do
@@ -81,14 +87,14 @@ class SessionTest < Test::Unit::TestCase
   test "raise error if params passed but signature omitted" do
     assert_raises(ShopifyAPI::ValidationException) do
       session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: nil, api_version: any_api_version)
-      session.request_token({'code' => 'any-code'})
+      session.request_token({ 'code' => 'any-code' })
     end
   end
 
   test "setup api_key and secret for all sessions" do
-    ShopifyAPI::Session.setup(:api_key => "My test key", :secret => "My test secret")
-    assert_equal "My test key", ShopifyAPI::Session.api_key
-    assert_equal "My test secret", ShopifyAPI::Session.secret
+    ShopifyAPI::Session.setup(api_key: "My test key", secret: "My test secret")
+    assert_equal("My test key", ShopifyAPI::Session.api_key)
+    assert_equal("My test secret", ShopifyAPI::Session.secret)
   end
 
   test "#temp reset ShopifyAPI::Base values to original value" do
@@ -168,7 +174,7 @@ class SessionTest < Test::Unit::TestCase
       api_version: :unstable
     )
 
-    assert_raises StandardError do
+    assert_raises(StandardError) do
       ShopifyAPI::Session.with_session(other_session) { raise StandardError, "" }
     end
 
@@ -214,7 +220,11 @@ class SessionTest < Test::Unit::TestCase
     )
     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
+    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
+    )
   end
 
   test "create_permission_url returns correct url with dual scope" do
@@ -224,9 +234,13 @@ class SessionTest < Test::Unit::TestCase
       token: 'any-token',
       api_version: any_api_version
     )
-    scope = ["write_products","write_customers"]
+    scope = ["write_products", "write_customers"]
     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,write_customers&redirect_uri=http://my_redirect_uri.com", permission_url
+    assert_equal(
+      "https://localhost.myshopify.com/admin/oauth/authorize?client_id=My_test_key&" \
+        "scope=write_products,write_customers&redirect_uri=http://my_redirect_uri.com",
+      permission_url
+    )
   end
 
   test "create_permission_url returns correct url with no scope" do
@@ -238,7 +252,11 @@ class SessionTest < Test::Unit::TestCase
     )
     scope = []
     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=&redirect_uri=http://my_redirect_uri.com", permission_url
+    assert_equal(
+      "https://localhost.myshopify.com/admin/oauth/authorize?client_id=My_test_key&" \
+        "scope=&redirect_uri=http://my_redirect_uri.com",
+      permission_url
+    )
   end
 
   test "create_permission_url returns correct url with state" do
@@ -250,11 +268,15 @@ class SessionTest < Test::Unit::TestCase
     )
     scope = []
     permission_url = session.create_permission_url(scope, "http://my_redirect_uri.com", state: "My nonce")
-    assert_equal "https://localhost.myshopify.com/admin/oauth/authorize?client_id=My_test_key&scope=&redirect_uri=http://my_redirect_uri.com&state=My%20nonce", permission_url
+    assert_equal(
+      "https://localhost.myshopify.com/admin/oauth/authorize?client_id=My_test_key&" \
+        "scope=&redirect_uri=http://my_redirect_uri.com&state=My%20nonce",
+      permission_url
+    )
   end
 
   test "raise exception if code invalid in request token" do
-    ShopifyAPI::Session.setup(:api_key => "My test key", :secret => "My test secret")
+    ShopifyAPI::Session.setup(api_key: "My test key", secret: "My test secret")
     session = ShopifyAPI::Session.new(
       domain: 'http://localhost.myshopify.com',
       token: nil,
@@ -270,7 +292,7 @@ class SessionTest < Test::Unit::TestCase
     assert_raises(ShopifyAPI::ValidationException) do
       session.request_token(code: "bad-code")
     end
-    assert_equal false, session.valid?
+    assert_equal(false, session.valid?)
   end
 
   test "return site for session" do
@@ -279,87 +301,93 @@ class SessionTest < Test::Unit::TestCase
       token: "any-token",
       api_version: any_api_version
     )
-    assert_equal "https://testshop.myshopify.com", session.site
+    assert_equal("https://testshop.myshopify.com", session.site)
   end
 
   test "return_token_if_signature_is_valid" do
     api_version = any_api_version
-    fake nil,
+    fake(
+      nil,
       url: "https://testshop.myshopify.com/admin/oauth/access_token",
       method: :post,
       body: '{"access_token":"any-token"}'
+    )
     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)))
 
-    assert_equal "any-token", token
-    assert_equal "any-token", session.token
+    assert_equal("any-token", token)
+    assert_equal("any-token", session.token)
   end
 
   test "extra parameters are stored in session" do
     api_version = ShopifyAPI::ApiVersion.new(handle: :unstable)
-    fake nil,
+    fake(
+      nil,
       url: "https://testshop.myshopify.com/admin/oauth/access_token",
       method: :post,
       body: '{"access_token":"any-token","foo":"example"}'
+    )
     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)))
+    assert(session.request_token(params.merge(hmac: generate_signature(params))))
 
-    assert_equal ({ "foo" => "example" }), session.extra
+    assert_equal({ "foo" => "example" }, session.extra)
   end
 
   test "expires_in is automatically converted in expires_at" do
     api_version = any_api_version
-    fake nil,
+    fake(
+      nil,
       url: "https://testshop.myshopify.com/admin/oauth/access_token",
       method: :post,
       body: '{"access_token":"any-token","expires_in":86393}'
+    )
     session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: nil, api_version: api_version)
 
     Timecop.freeze do
       params = { code: 'any-code', timestamp: Time.now }
-      assert session.request_token(params.merge(hmac: generate_signature(params)))
+      assert(session.request_token(params.merge(hmac: generate_signature(params))))
 
       expires_at = Time.now.utc + 86393
-      assert_equal ({ "expires_at" => expires_at.to_i }), session.extra
-      assert session.expires_at.is_a?(Time)
-      assert_equal expires_at.to_i, session.expires_at.to_i
-      assert_equal 86393, session.expires_in
-      assert_equal false, session.expired?
+      assert_equal({ "expires_at" => expires_at.to_i }, session.extra)
+      assert(session.expires_at.is_a?(Time))
+      assert_equal(expires_at.to_i, session.expires_at.to_i)
+      assert_equal(86393, session.expires_in)
+      assert_equal(false, session.expired?)
 
       Timecop.travel(session.expires_at) do
-        assert_equal true, session.expired?
+        assert_equal(true, session.expired?)
       end
     end
   end
 
   test "raise error if signature does not match expected" do
-    params = {:code => "any-code", :timestamp => Time.now}
+    params = { code: "any-code", timestamp: Time.now }
     signature = generate_signature(params)
     params[:foo] = 'world'
     assert_raises(ShopifyAPI::ValidationException) do
       session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: nil, api_version: any_api_version)
-      session.request_token(params.merge(:hmac => signature))
+      session.request_token(params.merge(hmac: signature))
     end
   end
 
   test "raise error if timestamp is too old" do
-    params = {:code => "any-code", :timestamp => Time.now - 2.days}
+    params = { code: "any-code", timestamp: Time.now - 2 * SECONDS_IN_A_DAY }
     signature = generate_signature(params)
     params[:foo] = 'world'
     assert_raises(ShopifyAPI::ValidationException) do
       session = ShopifyAPI::Session.new(domain: "testshop.myshopify.com", token: nil, api_version: any_api_version)
-      session.request_token(params.merge(:hmac => signature))
+      session.request_token(params.merge(hmac: signature))
     end
   end
 
   test "return true when the signature is valid and the keys of params are strings" do
     params = { 'code' => 'any-code', 'timestamp' => Time.now }
     params[:hmac] = generate_signature(params)
-    assert_equal true, ShopifyAPI::Session.validate_signature(params)
+    assert_equal(true, ShopifyAPI::Session.validate_signature(params))
   end
 
   test "return true when validating signature of params with ampersand and equal sign characters" do
@@ -367,7 +395,7 @@ class SessionTest < Test::Unit::TestCase
     params = { 'a' => '1&b=2', 'c=3&d' => '4' }
     to_sign = 'a=1%26b=2&c%3D3%26d=4'
     params[:hmac] = generate_signature(to_sign)
-    assert_equal true, ShopifyAPI::Session.validate_signature(params)
+    assert_equal(true, ShopifyAPI::Session.validate_signature(params))
   end
 
   test "return true when validating signature of params with percent sign characters" do
@@ -375,7 +403,7 @@ class SessionTest < Test::Unit::TestCase
     params = { 'a%3D1%26b' => '2%26c%3D3' }
     to_sign = 'a%253D1%2526b=2%2526c%253D3'
     params[:hmac] = generate_signature(to_sign)
-    assert_equal true, ShopifyAPI::Session.validate_signature(params)
+    assert_equal(true, ShopifyAPI::Session.validate_signature(params))
   end
 
   test "url is aliased to domain to minimize the upgrade changes" do
@@ -519,7 +547,7 @@ class SessionTest < Test::Unit::TestCase
 
   def generate_signature(params)
     params = make_sorted_params(params) if params.is_a?(Hash)
-    OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA256.new, ShopifyAPI::Session.secret, params)
+    OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('SHA256'), ShopifyAPI::Session.secret, params)
   end
 
   def any_api_version