shopify_api 4.9.0 → 9.4.1

data/test/fulfillment_order_test_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module FulfillmentOrderTestHelper
+  def url_prefix_for_activated_session_for(version)
+    available_version = ShopifyAPI::Session.new(domain: 'shop2.myshopify.com', token: 'token2', api_version: version)
+    ShopifyAPI::Base.activate_session(available_version)
+    "https://shop2.myshopify.com/admin/api/#{version}"
+  end
+end

data/test/fulfillment_request_test.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class FulFillmentRequestTest < Test::Unit::TestCase
   def setup
     super
-    fake "orders/450789469/fulfillment_requests/695890229", method: :get, body: load_fixture('fulfillment_request')
+    fake("orders/450789469/fulfillment_requests/695890229", method: :get, body: load_fixture('fulfillment_request'))
   end
 
   context "#mark_as_failed" do
@@ -13,21 +14,22 @@ class FulFillmentRequestTest < Test::Unit::TestCase
       cancelled = ActiveSupport::JSON.decode(load_fixture('fulfillment_request'))
       cancelled['failure_message'] = 'failure reason'
       cancelled['message'] = nil
-      fake "orders/450789469/fulfillment_requests/695890229/mark_as_failed",
+      fake(
+        "orders/450789469/fulfillment_requests/695890229/mark_as_failed",
         method: :put,
         body: ActiveSupport::JSON.encode(cancelled)
-
-      assert fulfillment_request.failure_message.blank?
-      assert fulfillment_request.mark_as_failed
-      assert_equal 'failure reason', fulfillment_request.failure_message
+      )
+      assert(fulfillment_request.failure_message.blank?)
+      assert(fulfillment_request.mark_as_failed)
+      assert_equal('failure reason', fulfillment_request.failure_message)
     end
   end
 
   context "#find" do
     should "be able to find fulfillment request" do
       fulfillment_request = ShopifyAPI::FulfillmentRequest.find(695890229, params: { order_id: 450789469 })
-      assert_equal 695890229, fulfillment_request.id
-      assert_equal 450789469, fulfillment_request.order_id
+      assert_equal(695890229, fulfillment_request.id)
+      assert_equal(450789469, fulfillment_request.order_id)
     end
   end
 end

data/test/fulfillment_service_test.rb

@@ -1,17 +1,18 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class FulFillmentServiceTest < Test::Unit::TestCase
-	test 'new should create fulfillment service' do
-		fake "fulfillment_services", :method => :post, :body => load_fixture('fulfillment_service')
-		fulfillment_service = ShopifyAPI::FulfillmentService.new(:name => "SomeService")
-		fulfillment_service.save
-		assert_equal "SomeService" , fulfillment_service.name
-	end
+  test 'new should create fulfillment service' do
+    fake("fulfillment_services", method: :post, body: load_fixture('fulfillment_service'))
+    fulfillment_service = ShopifyAPI::FulfillmentService.new(name: "SomeService")
+    fulfillment_service.save
+    assert_equal("SomeService", fulfillment_service.name)
+  end
 
-	test 'find should return the fulfillment service' do
-		fake "fulfillment_services/123456", :method => :get, :body => load_fixture('fulfillment_service')
-		fulfillment_service = ShopifyAPI::FulfillmentService.find(123456)
-		assert_equal 123456 , fulfillment_service.id
-		assert_equal "SomeService", fulfillment_service.name
-	end
+  test 'find should return the fulfillment service' do
+    fake("fulfillment_services/123456", method: :get, body: load_fixture('fulfillment_service'))
+    fulfillment_service = ShopifyAPI::FulfillmentService.find(123456)
+    assert_equal(123456, fulfillment_service.id)
+    assert_equal("SomeService", fulfillment_service.name)
+  end
 end

data/test/fulfillment_test.rb

@@ -1,61 +1,239 @@
+# frozen_string_literal: true
 require 'test_helper'
+require 'fulfillment_order_test_helper'
 
 class FulFillmentTest < Test::Unit::TestCase
+  include FulfillmentOrderTestHelper
+
   def setup
     super
-    fake "orders/450789469/fulfillments/255858046", :method => :get, :body => load_fixture('fulfillment')
+    fake("orders/450789469/fulfillments/255858046", method: :get, body: load_fixture('fulfillment'))
   end
 
   context "Fulfillment" do
     context "#complete" do
       should "be able to complete fulfillment" do
-        fulfillment = ShopifyAPI::Fulfillment.find(255858046, :params => {:order_id => 450789469})
+        fulfillment = ShopifyAPI::Fulfillment.find(255858046, params: { order_id: 450789469 })
 
         success = ActiveSupport::JSON.decode(load_fixture('fulfillment'))
         success['fulfillment']['status'] = 'success'
-        fake "orders/450789469/fulfillments/255858046/complete", :method => :post, :body => ActiveSupport::JSON.encode(success)
+        fake(
+          "orders/450789469/fulfillments/255858046/complete", method: :post, body: ActiveSupport::JSON.encode(success)
+        )
 
-        assert_equal 'pending', fulfillment.status
-        assert fulfillment.complete
-        assert_equal 'success', fulfillment.status
+        assert_equal('pending', fulfillment.status)
+        assert(fulfillment.complete)
+        assert_equal('success', fulfillment.status)
       end
     end
 
     context "#cancel" do
       should "be able to cancel fulfillment" do
-        fulfillment = ShopifyAPI::Fulfillment.find(255858046, :params => {:order_id => 450789469})
+        fulfillment = ShopifyAPI::Fulfillment.find(255858046, params: { order_id: 450789469 })
 
         cancelled = ActiveSupport::JSON.decode(load_fixture('fulfillment'))
         cancelled['fulfillment']['status'] = 'cancelled'
-        fake "orders/450789469/fulfillments/255858046/cancel", :method => :post, :body => ActiveSupport::JSON.encode(cancelled)
+        fake(
+          "orders/450789469/fulfillments/255858046/cancel", method: :post, body: ActiveSupport::JSON.encode(cancelled)
+        )
 
-        assert_equal 'pending', fulfillment.status
-        assert fulfillment.cancel
-        assert_equal 'cancelled', fulfillment.status
+        assert_equal('pending', fulfillment.status)
+        assert(fulfillment.cancel)
+        assert_equal('cancelled', fulfillment.status)
       end
     end
 
     context "#open" do
       should "be able to open a fulfillment" do
-        fulfillment = ShopifyAPI::Fulfillment.find(255858046, :params => {:order_id => 450789469})
+        fulfillment = ShopifyAPI::Fulfillment.find(255858046, params: { order_id: 450789469 })
 
         open_fulfillment = ActiveSupport::JSON.decode(load_fixture('fulfillment'))
         open_fulfillment['fulfillment']['status'] = 'open'
-        fake "orders/450789469/fulfillments/255858046/open", :method => :post, :body => ActiveSupport::JSON.encode(open_fulfillment)
+        fake(
+          "orders/450789469/fulfillments/255858046/open",
+          method: :post,
+          body: ActiveSupport::JSON.encode(open_fulfillment)
+        )
 
-        assert_equal 'pending', fulfillment.status
-        assert fulfillment.open
-        assert_equal 'open', fulfillment.status
+        assert_equal('pending', fulfillment.status)
+        assert(fulfillment.open)
+        assert_equal('open', fulfillment.status)
       end
     end
 
     context "#find" do
       should "be able to find fulfillment" do
-        fulfillment = ShopifyAPI::Fulfillment.find(255858046, :params => {:order_id => 450789469})
-        assert_equal 255858046, fulfillment.id
-        assert_equal 450789469, fulfillment.order_id
+        fulfillment = ShopifyAPI::Fulfillment.find(255858046, params: { order_id: 450789469 })
+        assert_equal(255858046, fulfillment.id)
+        assert_equal(450789469, fulfillment.order_id)
       end
     end
-  end
 
+    context "#create" do
+      should "create a fulfillment with line_items_by_fulfillment_order" do
+        create_fulfillment_attributes = {
+          message: "The message for this FO fulfillment",
+          notify_customer: true,
+          tracking_info: {
+            number: "XSDFHYR23475",
+            url: "https://tracking.example.com/XSDFHYR23475",
+            company: "TFTC - the fulfillment/tracking company",
+          },
+          line_items_by_fulfillment_order: [
+            {
+              fulfillment_order_id: 3,
+              fulfillment_order_line_items: [{ id: 2, quantity: 1 }],
+            },
+          ],
+        }
+        request_body = { fulfillment: create_fulfillment_attributes }
+        response_body = { fulfillment: create_fulfillment_attributes.merge(id: 346743624) }
+        url_prefix = url_prefix_for_activated_session_for('2020-01')
+        fake(
+          'fulfillments',
+          url: "#{url_prefix}/fulfillments.json",
+          method: :post,
+          request_body: ActiveSupport::JSON.encode(request_body),
+          body: ActiveSupport::JSON.encode(response_body)
+        )
+        fulfillment = ShopifyAPI::Fulfillment.create(create_fulfillment_attributes)
+        assert(fulfillment.is_a?(ShopifyAPI::Fulfillment))
+        assert(fulfillment.persisted?)
+        assert_equal(346743624, fulfillment.id)
+      end
+
+      should "raise NotImplementedError when api_version is older than 2020-01" do
+        create_fulfillment_attributes = {
+          message: "The message for this FO fulfillment",
+          notify_customer: true,
+          tracking_info: {
+            number: "XSDFHYR23475",
+            url: "https://tracking.example.com/XSDFHYR23475",
+            company: "TFTC - the fulfillment/tracking company",
+          },
+          line_items_by_fulfillment_order: [
+            {
+              fulfillment_order_id: 3,
+              fulfillment_order_line_items: [{ id: 2, quantity: 1 }],
+            },
+          ],
+        }
+        request_body = { fulfillment: create_fulfillment_attributes }
+        response_body = { fulfillment: create_fulfillment_attributes.merge(id: 346743624) }
+        url_prefix = url_prefix_for_activated_session_for('2019-10')
+        fake(
+          'fulfillments',
+          url: "#{url_prefix}/fulfillments.json",
+          method: :post,
+          request_body: ActiveSupport::JSON.encode(request_body),
+          body: ActiveSupport::JSON.encode(response_body)
+        )
+        assert_raises(NotImplementedError) do
+          ShopifyAPI::Fulfillment.create(create_fulfillment_attributes)
+        end
+      end
+    end
+
+    context "#save" do
+      should "save a fulfillment with line_items_by_fulfillment_order" do
+        create_fulfillment_attributes = {
+          message: "The message for this FO fulfillment",
+          notify_customer: true,
+          tracking_info: {
+            number: "XSDFHYR23475",
+            url: "https://tracking.example.com/XSDFHYR23475",
+            company: "TFTC - the fulfillment/tracking company",
+          },
+          line_items_by_fulfillment_order: [
+            {
+              fulfillment_order_id: 3,
+              fulfillment_order_line_items: [{ id: 2, quantity: 1 }],
+            },
+          ],
+        }
+        request_body = { fulfillment: create_fulfillment_attributes }
+        response_body = { fulfillment: create_fulfillment_attributes.merge(id: 346743624) }
+        url_prefix = url_prefix_for_activated_session_for('2020-01')
+        fake(
+          'fulfillments',
+          url: "#{url_prefix}/fulfillments.json",
+          method: :post,
+          request_body: ActiveSupport::JSON.encode(request_body),
+          body: ActiveSupport::JSON.encode(response_body)
+        )
+        fulfillment = ShopifyAPI::Fulfillment.new(create_fulfillment_attributes)
+        assert(fulfillment.save)
+        assert(fulfillment.is_a?(ShopifyAPI::Fulfillment))
+        assert(fulfillment.persisted?)
+        assert_equal(346743624, fulfillment.id)
+      end
+
+      should "save a fulfillment without line_items_by_fulfillment_order" do
+        order_id = 8
+        create_fulfillment_attributes = {
+          message: "The message for this FO fulfillment",
+          notify_customer: true,
+          tracking_info: {
+            number: "XSDFHYR23475",
+            url: "https://tracking.example.com/XSDFHYR23475",
+            company: "TFTC - the fulfillment/tracking company",
+          },
+        }
+        request_body = { fulfillment: create_fulfillment_attributes }
+        response_body = { fulfillment: create_fulfillment_attributes.merge(id: 346743624) }
+        fake(
+          "orders/#{order_id}/fulfillments",
+          method: :post,
+          request_body: ActiveSupport::JSON.encode(request_body),
+          body: ActiveSupport::JSON.encode(response_body)
+        )
+        fulfillment = ShopifyAPI::Fulfillment.new(create_fulfillment_attributes)
+        fulfillment.prefix_options[:order_id] = order_id
+
+        assert(fulfillment.save)
+        assert(fulfillment.is_a?(ShopifyAPI::Fulfillment))
+        assert(fulfillment.persisted?)
+        assert_equal(346743624, fulfillment.id)
+      end
+    end
+
+    context "#update_tracking" do
+      should "be able to update tracking info for a fulfillment" do
+        tracking_info = {
+          number: 'JSDHFHAG',
+          url: 'https://example.com/fulfillment_tracking/JSDHFHAG',
+          company: 'ACME co',
+        }
+        fake_fulfillment = ActiveSupport::JSON.decode(load_fixture('fulfillment'))['fulfillment']
+        fake_fulfillment['tracking_number'] = tracking_info[:number]
+        fake_fulfillment['tracking_numbers'] = [tracking_info[:number]]
+        fake_fulfillment['tracking_url'] = tracking_info[:url]
+        fake_fulfillment['tracking_urls'] = [tracking_info[:url]]
+        fake_fulfillment['tracking_company'] = tracking_info[:company]
+
+        request_body = {
+          fulfillment: {
+            tracking_info: tracking_info,
+            notify_customer: true,
+          },
+        }
+        url_prefix = url_prefix_for_activated_session_for('2020-01')
+        fake(
+          'fulfillments',
+          url: "#{url_prefix}/fulfillments/#{fake_fulfillment['id']}/update_tracking.json",
+          method: :post,
+          request_body: ActiveSupport::JSON.encode(request_body),
+          body: ActiveSupport::JSON.encode(fulfillment: fake_fulfillment)
+        )
+        fulfillment = ShopifyAPI::Fulfillment.new(id: fake_fulfillment['id'])
+        assert(fulfillment.update_tracking(tracking_info: tracking_info, notify_customer: true))
+
+        assert_equal(tracking_info[:number], fulfillment.tracking_number)
+        assert_equal([tracking_info[:number]], fulfillment.tracking_numbers)
+        assert_equal(tracking_info[:url], fulfillment.tracking_url)
+        assert_equal([tracking_info[:url]], fulfillment.tracking_urls)
+        assert_equal(tracking_info[:company], fulfillment.tracking_company)
+      end
+    end
+  end
 end

data/test/fulfillment_v2_test.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+require 'test_helper'
+require 'fulfillment_order_test_helper'
+
+class FulfillmentV2Test < Test::Unit::TestCase
+  include FulfillmentOrderTestHelper
+
+  def setup
+    super
+    @tracking_info = {
+      number: 'JSDHFHAG',
+      url: 'https://example.com/fulfillment_tracking/JSDHFHAG',
+      company: 'ACME co',
+    }
+    @fake_fulfillment = ActiveSupport::JSON.decode(load_fixture('fulfillment'))['fulfillment']
+    @fake_fulfillment['tracking_number'] = @tracking_info[:number]
+    @fake_fulfillment['tracking_numbers'] = [@tracking_info[:number]]
+    @fake_fulfillment['tracking_url'] = @tracking_info[:url]
+    @fake_fulfillment['tracking_urls'] = [@tracking_info[:url]]
+    @fake_fulfillment['tracking_company'] = @tracking_info[:company]
+
+    @request_body = {
+      fulfillment: {
+        tracking_info: @tracking_info,
+        notify_customer: true,
+      },
+    }
+    @url_prefix = url_prefix_for_activated_session_for('2020-01')
+    fake(
+      'fulfillments',
+      url: "#{@url_prefix}/fulfillments/#{@fake_fulfillment['id']}/update_tracking.json",
+      method: :post,
+      request_body: ActiveSupport::JSON.encode(@request_body),
+      body: ActiveSupport::JSON.encode(fulfillment: @fake_fulfillment)
+    )
+  end
+
+  context "FulfillmentV2" do
+    context "#update_tracking" do
+      should "be able to update tracking info for a fulfillment" do
+        fulfillment = ShopifyAPI::FulfillmentV2.new(id: @fake_fulfillment['id'])
+        assert(fulfillment.update_tracking(tracking_info: @tracking_info, notify_customer: true))
+
+        assert_equal(@tracking_info[:number], fulfillment.tracking_number)
+        assert_equal([@tracking_info[:number]], fulfillment.tracking_numbers)
+        assert_equal(@tracking_info[:url], fulfillment.tracking_url)
+        assert_equal([@tracking_info[:url]], fulfillment.tracking_urls)
+        assert_equal(@tracking_info[:company], fulfillment.tracking_company)
+      end
+
+      should "raise NotImplementedError when api_version is older than 2020-01" do
+        @url_prefix = url_prefix_for_activated_session_for('2019-10')
+        fake(
+          'fulfillments',
+          url: "#{@url_prefix}/fulfillments/#{@fake_fulfillment['id']}/update_tracking.json",
+          method: :post,
+          request_body: ActiveSupport::JSON.encode(@request_body),
+          body: ActiveSupport::JSON.encode(fulfillment: @fake_fulfillment)
+        )
+        assert_raises(NotImplementedError) do
+          ShopifyAPI::FulfillmentV2.new(id: @fake_fulfillment['id'])
+        end
+      end
+    end
+  end
+end

data/test/gift_card_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class GiftCardTest < Test::Unit::TestCase
@@ -7,16 +8,17 @@ class GiftCardTest < Test::Unit::TestCase
   end
 
   def test_disable
-    fake 'gift_cards/1023670/disable.json', :body => load_fixture('gift_card_disabled'), :method => :post, :extension => false
+    fake('gift_cards/1023670/disable.json', body: load_fixture('gift_card_disabled'), method: :post, extension: false)
 
-    refute @gift_card.disabled_at
+    refute(@gift_card.disabled_at)
     @gift_card.disable
-    assert @gift_card.disabled_at
+    assert(@gift_card.disabled_at)
   end
 
   private
+
   def load_gift_card
-    fake 'gift_cards/1023670', :body => load_fixture('gift_card')
+    fake('gift_cards/1023670', body: load_fixture('gift_card'))
     @gift_card = ShopifyAPI::GiftCard.find(1023670)
   end
 end

data/test/graphql/http_client_test.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+module GraphQL
+  class HTTPClientTest < Test::Unit::TestCase
+    test '#headers uses the Base headers' do
+      ShopifyAPI::Base.headers['X-Custom'] = 'abc'
+
+      client = ShopifyAPI::GraphQL::HTTPClient.new('2019-07')
+
+      assert_equal 'abc', client.headers({})['X-Custom']
+
+      ShopifyAPI::Base.headers.delete('X-Custom')
+    end
+
+    test '#uri uses the Base site and the API version' do
+      ShopifyAPI::Base.site = 'https://foo:bar@www.zombo.com'
+      api_version = ShopifyAPI::ApiVersion.new(handle: '2019-07')
+
+      client = ShopifyAPI::GraphQL::HTTPClient.new(api_version)
+      expected_uri = URI('https://foo:bar@www.zombo.com/admin/api/2019-07/graphql.json')
+
+      assert_equal expected_uri, client.uri
+    end
+  end
+end