shopify_api 4.9.0 → 9.4.1

data/test/detailed_log_subscriber_test.rb

@@ -1,19 +1,47 @@
+# 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\"=>\"ShopifyAPI/#{ShopifyAPI::VERSION} ActiveResource/#{ActiveResource::VERSION::STRING} Ruby/#{RUBY_VERSION}\""
+    @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\"=>\"[FILTERED]\"}"
 
     ShopifyAPI::Base.clear_session
-    ShopifyAPI::Base.site = "https://this-is-my-test-shop.myshopify.com/admin"
+    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
+    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)
@@ -21,29 +49,95 @@ class LogSubscriberTest < Test::Unit::TestCase
   end
 
   test "logging on #find" do
-    fake "pages/1", :method => :get, :body => @page
+    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/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
-    fake "pages/2", :method => :get, :body => nil, :status => 404
+    fake("pages/2", method: :get, body: nil, status: 404)
 
-    assert_raises ActiveResource::ResourceNotFound do
+    assert_raises(ActiveResource::ResourceNotFound) do
       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
+    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

data/test/discount_code_test.rb

@@ -1,36 +1,37 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class DiscountCodeTest < Test::Unit::TestCase
   def setup
     super
-    fake 'price_rules/102586120/discount_codes/1002091923', body: load_fixture('discount_code')
+    fake('price_rules/102586120/discount_codes/1002091923', body: load_fixture('discount_code'))
 
-    @discount_code = ShopifyAPI::DiscountCode.find(1002091923, params: {price_rule_id: 102586120})
+    @discount_code = ShopifyAPI::DiscountCode.find(1002091923, params: { price_rule_id: 102586120 })
   end
 
   def test_get_discount_code
-    fake 'price_rules/102586120/discount_codes', method: :get, status: 200, body: load_fixture('discount_code')
-    discount_code = ShopifyAPI::DiscountCode.find 1002091923, params: { price_rule_id: 102586120 }
+    fake('price_rules/102586120/discount_codes', method: :get, status: 200, body: load_fixture('discount_code'))
+    discount_code = ShopifyAPI::DiscountCode.find(1002091923, params: { price_rule_id: 102586120 })
 
-    assert_equal 1002091923, discount_code.id
+    assert_equal(1002091923, discount_code.id)
   end
 
   def test_get_all_discount_codes
-    fake 'price_rules/102586120/discount_codes', method: :get, status: 200, body: load_fixture('discount_codes')
-    discount_codes = ShopifyAPI::DiscountCode.all params: { price_rule_id: 102586120 }
+    fake('price_rules/102586120/discount_codes', method: :get, status: 200, body: load_fixture('discount_codes'))
+    discount_codes = ShopifyAPI::DiscountCode.all(params: { price_rule_id: 102586120 })
 
-    assert_equal 1, discount_codes.length
-    assert_equal 1002091923, discount_codes.first.id
+    assert_equal(1, discount_codes.length)
+    assert_equal(1002091923, discount_codes.first.id)
   end
 
   def test_create_discount_code
-    fake 'price_rules/102586120/discount_codes', method: :post, status: 201, body: load_fixture('discount_code')
+    fake('price_rules/102586120/discount_codes', method: :post, status: 201, body: load_fixture('discount_code'))
     discount_code = ShopifyAPI::DiscountCode.new
     discount_code.prefix_options[:price_rule_id] = 102586120
     discount_code.code = "SUMMERSALE10"
     discount_code.save
 
-    assert_equal '{"discount_code":{"code":"SUMMERSALE10"}}', FakeWeb.last_request.body
+    assert_equal('{"discount_code":{"code":"SUMMERSALE10"}}', WebMock.last_request.body)
   end
 
   def test_update_discount_code
@@ -38,16 +39,21 @@ class DiscountCodeTest < Test::Unit::TestCase
     discount_code_response['discount_code']['code'] = "WINTERSALE50"
     @discount_code.code = "WINTERSALE50"
 
-    fake 'price_rules/102586120/discount_codes/1002091923', method: :put, status: 200, body: ActiveSupport::JSON.encode(discount_code_response)
+    fake(
+      'price_rules/102586120/discount_codes/1002091923',
+      method: :put,
+      status: 200,
+      body: ActiveSupport::JSON.encode(discount_code_response)
+    )
 
     @discount_code.save
-    
-    assert_equal discount_code_response['discount_code']['code'], @discount_code.code
+
+    assert_equal(discount_code_response['discount_code']['code'], @discount_code.code)
   end
 
   def test_delete_discount_code
-    fake 'price_rules/102586120/discount_codes/1002091923', method: :delete, body: 'destroyed'
+    fake('price_rules/102586120/discount_codes/1002091923', method: :delete, body: 'destroyed')
 
-    assert @discount_code.destroy
+    assert(@discount_code.destroy)
   end
 end

data/test/draft_order_test.rb

@@ -1,151 +1,167 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class DraftOrderTest < Test::Unit::TestCase
   def setup
     super
 
-    fake 'draft_orders/517119332', body: load_fixture('draft_order')
+    fake('draft_orders/517119332', body: load_fixture('draft_order'))
 
     @draft_order = ShopifyAPI::DraftOrder.find(517119332)
   end
 
   def test_get_draft_order
-    fake 'draft_orders/517119332', method: :get, status: 200, body: load_fixture('draft_order')
+    fake('draft_orders/517119332', method: :get, status: 200, body: load_fixture('draft_order'))
 
     draft_order = ShopifyAPI::DraftOrder.find(517119332)
 
-    assert_equal 517119332, draft_order.id
+    assert_equal(517119332, draft_order.id)
   end
 
   def test_get_all_draft_orders
-    fake 'draft_orders', method: :get, status: 200, body: load_fixture('draft_orders')
+    fake('draft_orders', method: :get, status: 200, body: load_fixture('draft_orders'))
 
     draft_orders = ShopifyAPI::DraftOrder.all
 
-    assert_equal 1, draft_orders.length
-    assert_equal 517119332, draft_orders.first.id
+    assert_equal(1, draft_orders.length)
+    assert_equal(517119332, draft_orders.first.id)
   end
 
   def test_get_count_draft_orders
-    fake 'draft_orders/count', method: :get, status: 200, body: '{"count": 16}'
+    fake('draft_orders/count', method: :get, status: 200, body: '{"count": 16}')
 
     draft_orders_count = ShopifyAPI::DraftOrder.count
 
-    assert_equal 16, draft_orders_count
+    assert_equal(16, draft_orders_count)
   end
 
   def test_create_draft_order
-    fake 'draft_orders', method: :post, status: 201, body: load_fixture('draft_order')
+    fake('draft_orders', method: :post, status: 201, body: load_fixture('draft_order'))
 
     draft_order = ShopifyAPI::DraftOrder.create(line_items: [{ quantity: 1, variant_id: 39072856 }])
 
-    assert_equal '{"draft_order":{"line_items":[{"quantity":1,"variant_id":39072856}]}}', FakeWeb.last_request.body
-    assert_equal 39072856, draft_order.line_items.first.variant_id
+    assert_equal('{"draft_order":{"line_items":[{"quantity":1,"variant_id":39072856}]}}', WebMock.last_request.body)
+    assert_equal(39072856, draft_order.line_items.first.variant_id)
   end
 
   def test_create_draft_order_202
-    fake 'draft_orders', method: :post, status: 202, body: load_fixture('draft_order')
+    fake('draft_orders', method: :post, status: 202, body: load_fixture('draft_order'))
 
     draft_order = ShopifyAPI::DraftOrder.create(line_items: [{ quantity: 1, variant_id: 39072856 }])
 
-    assert_equal 39072856, draft_order.line_items.first.variant_id
+    assert_equal(39072856, draft_order.line_items.first.variant_id)
   end
 
   def test_update_draft_order
     draft_order_response = ActiveSupport::JSON.decode(load_fixture('draft_order'))
     draft_order_response['draft_order']['note'] = 'Test new note'
     @draft_order.note = 'Test new note'
-    fake 'draft_orders/517119332', method: :put, status: 200, body: ActiveSupport::JSON.encode(draft_order_response)
+    fake('draft_orders/517119332', method: :put, status: 200, body: ActiveSupport::JSON.encode(draft_order_response))
 
     @draft_order.save
 
-    assert_equal draft_order_response['draft_order']['note'], @draft_order.note
+    assert_equal(draft_order_response['draft_order']['note'], @draft_order.note)
   end
 
   def test_send_invoice_with_no_params
     draft_order_invoice_fixture = load_fixture('draft_order_invoice')
     draft_order_invoice = ActiveSupport::JSON.decode(draft_order_invoice_fixture)
-    fake 'draft_orders/517119332/send_invoice', method: :post, body: draft_order_invoice_fixture
+    fake('draft_orders/517119332/send_invoice', method: :post, body: draft_order_invoice_fixture)
 
     draft_order_invoice_response = @draft_order.send_invoice
 
-    assert_equal '{"draft_order_invoice":{}}', FakeWeb.last_request.body
-    assert_kind_of ShopifyAPI::DraftOrderInvoice, draft_order_invoice_response
-    assert_equal draft_order_invoice['draft_order_invoice']['to'], draft_order_invoice_response.to
+    assert_equal('{"draft_order_invoice":{}}', WebMock.last_request.body)
+    assert_kind_of(ShopifyAPI::DraftOrderInvoice, draft_order_invoice_response)
+    assert_equal(draft_order_invoice['draft_order_invoice']['to'], draft_order_invoice_response.to)
   end
 
   def test_send_invoice_with_params
     draft_order_invoice_fixture = load_fixture('draft_order_invoice')
     draft_order_invoice = ActiveSupport::JSON.decode(draft_order_invoice_fixture)
-    fake 'draft_orders/517119332/send_invoice', method: :post, body: draft_order_invoice_fixture
+    fake('draft_orders/517119332/send_invoice', method: :post, body: draft_order_invoice_fixture)
 
-    draft_order_invoice_response = @draft_order.send_invoice(ShopifyAPI::DraftOrderInvoice.new(draft_order_invoice['draft_order_invoice']))
+    draft_order_invoice_response = @draft_order.send_invoice(
+      ShopifyAPI::DraftOrderInvoice.new(draft_order_invoice['draft_order_invoice'])
+    )
 
-    assert_equal draft_order_invoice, ActiveSupport::JSON.decode(FakeWeb.last_request.body)
-    assert_kind_of ShopifyAPI::DraftOrderInvoice, draft_order_invoice_response
-    assert_equal draft_order_invoice['draft_order_invoice']['to'], draft_order_invoice_response.to
+    assert_equal(draft_order_invoice, ActiveSupport::JSON.decode(WebMock.last_request.body))
+    assert_kind_of(ShopifyAPI::DraftOrderInvoice, draft_order_invoice_response)
+    assert_equal(draft_order_invoice['draft_order_invoice']['to'], draft_order_invoice_response.to)
   end
 
   def test_delete_draft_order
-    fake 'draft_orders/517119332', method: :delete, body: 'destroyed'
-    assert @draft_order.destroy
+    fake('draft_orders/517119332', method: :delete, body: 'destroyed')
+    assert(@draft_order.destroy)
   end
 
   def test_add_metafields_to_draft_order
-    fake 'draft_orders/517119332/metafields', method: :post, status: 201, body: load_fixture('metafield')
-
-    field = @draft_order.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(FakeWeb.last_request.body)
-    assert !field.new_record?
-    assert_equal 'contact', field.namespace
-    assert_equal 'email', field.key
-    assert_equal '123@example.com', field.value
+    fake('draft_orders/517119332/metafields', method: :post, status: 201, body: load_fixture('metafield'))
+
+    field = @draft_order.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_draft_order
-    fake 'draft_orders/517119332/metafields', body: load_fixture('metafields')
+    fake('draft_orders/517119332/metafields', body: load_fixture('metafields'))
 
     metafields = @draft_order.metafields
 
-    assert_equal 3, metafields.length
-    assert metafields.all? { |m| m.is_a?(ShopifyAPI::Metafield) }
+    assert_equal(3, metafields.length)
+    assert(metafields.all? { |m| m.is_a?(ShopifyAPI::Metafield) })
   end
 
   def test_get_2_metafields_for_draft_order
-    body = ActiveSupport::JSON.decode load_fixture 'metafields'
-    body['metafields'].slice! 2, 1
+    body = ActiveSupport::JSON.decode(load_fixture('metafields'))
+    body['metafields'].slice!(2, 1)
 
-    fake 'draft_orders/517119332/metafields.json?limit=2', body: body.to_json, extension: false
+    fake('draft_orders/517119332/metafields.json?limit=2', body: body.to_json, extension: false)
 
-    metafields = @draft_order.metafields limit: 2
+    metafields = @draft_order.metafields(limit: 2)
 
-    assert_equal 2, metafields.length
-    assert metafields.all?{ |m| m.is_a? ShopifyAPI::Metafield }
+    assert_equal(2, metafields.length)
+    assert(metafields.all? { |m| m.is_a?(ShopifyAPI::Metafield) })
   end
 
   def test_complete_draft_order_with_no_params
     completed_fixture = load_fixture('draft_order_completed')
     completed_draft = ActiveSupport::JSON.decode(completed_fixture)['draft_order']
-    fake 'draft_orders/517119332/complete', method: :put, status: 200, body: completed_fixture
+    fake('draft_orders/517119332/complete', method: :put, status: 200, body: completed_fixture)
 
     @draft_order.complete
 
-    assert_equal completed_draft['status'], @draft_order.status
-    assert_equal completed_draft['order_id'], @draft_order.order_id
-    refute_nil @draft_order.completed_at
+    assert_equal(completed_draft['status'], @draft_order.status)
+    assert_equal(completed_draft['order_id'], @draft_order.order_id)
+    refute_nil(@draft_order.completed_at)
   end
 
   def test_complete_draft_order_with_params
     completed_fixture = load_fixture('draft_order_completed')
     completed_draft = ActiveSupport::JSON.decode(completed_fixture)['draft_order']
     complete_params = { payment_pending: true }
-    fake 'draft_orders/517119332/complete.json?payment_pending=true', extension: false, method: :put, status: 200, body: completed_fixture
+    fake(
+      'draft_orders/517119332/complete.json?payment_pending=true',
+      extension: false,
+      method: :put,
+      status: 200,
+      body: completed_fixture
+    )
 
     @draft_order.complete(complete_params)
 
-    assert_equal completed_draft['status'], @draft_order.status
-    assert_equal completed_draft['order_id'], @draft_order.order_id
-    refute_nil @draft_order.completed_at
+    assert_equal(completed_draft['status'], @draft_order.status)
+    assert_equal(completed_draft['order_id'], @draft_order.order_id)
+    refute_nil(@draft_order.completed_at)
   end
 end