shopify_api 8.1.0 → 9.0.0

data/test/fulfillment_order_test_helper.rb

@@ -0,0 +1,7 @@
+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_test.rb

@@ -1,6 +1,9 @@
 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')
@@ -56,6 +59,166 @@ class FulFillmentTest < Test::Unit::TestCase
         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,62 @@
+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/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

data/test/graphql_test.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+require 'test_helper'
+require_relative 'fixtures/graphql/dummy_schema'
+
+class GraphQLTest < Test::Unit::TestCase
+  def setup
+    ShopifyAPI::ApiVersion.version_lookup_mode = :define_on_unknown
+    @fixture_location = Pathname('test/fixtures/graphql')
+    @site = 'https://this-is-my-test-shop.myshopify.com'
+    ShopifyAPI::Base.site = @site
+  end
+
+  def teardown
+    ShopifyAPI::GraphQL.clear_clients
+  end
+
+  test '#initialize_clients creates a GraphQL::Client from local schema file' do
+    version_fixtures('unstable') do |dir|
+      ShopifyAPI::GraphQL.initialize_clients
+
+      assert ShopifyAPI::GraphQL.client('unstable')
+    end
+  end
+
+  test '#initialize_clients handles multiple schema files' do
+    version_fixtures('unstable', '2019-10') do |dir|
+      ShopifyAPI::GraphQL.initialize_clients
+
+      assert ShopifyAPI::GraphQL.client('unstable')
+      assert ShopifyAPI::GraphQL.client('2019-10')
+    end
+  end
+
+  test '#initialize_clients ignores non JSON schema files' do
+    version_fixtures('unstable', '2019-10') do |dir|
+      FileUtils.touch(ShopifyAPI::GraphQL.schema_location.join('nope.txt'))
+
+      ShopifyAPI::GraphQL.initialize_clients
+
+      assert ShopifyAPI::GraphQL.client('unstable')
+      assert ShopifyAPI::GraphQL.client('2019-10')
+    end
+  end
+
+  test '#initialize_clients raises if a JSON schema file is not named after a version' do
+    version_fixtures do |dir|
+      ShopifyAPI::GraphQL.schema_location = dir
+      FileUtils.touch(ShopifyAPI::GraphQL.schema_location.join('nope.json'))
+
+      assert_raises ShopifyAPI::GraphQL::InvalidSchema do
+        ShopifyAPI::GraphQL.initialize_clients
+      end
+    end
+  end
+
+  test '#client returns default schema if only one exists' do
+    version_fixtures('unstable') do |dir|
+      ShopifyAPI::Base.api_version = 'unstable'
+
+      ShopifyAPI::GraphQL.initialize_clients
+
+      assert_instance_of ::GraphQL::Client, ShopifyAPI::GraphQL.client
+    end
+  end
+
+  test '#client accepts optional api_version parameter' do
+    version_fixtures('unstable') do |dir|
+      ShopifyAPI::Base.api_version = 'unstable'
+
+      ShopifyAPI::GraphQL.initialize_clients
+
+      assert_instance_of ::GraphQL::Client, ShopifyAPI::GraphQL.client('unstable')
+    end
+  end
+
+  test '#client executes queries on specified API version' do
+    version_fixtures('unstable', '2019-10') do |dir|
+      ShopifyAPI::Base.api_version = 'unstable'
+
+      ShopifyAPI::GraphQL.initialize_clients
+      ShopifyAPI::Base.site = 'https://this-is-my-test-shop.myshopify.com'
+
+      client = ShopifyAPI::GraphQL.client('2019-10')
+
+      assert_instance_of ::GraphQL::Client, client
+
+      query = client.parse <<~GRAPHQL
+        {
+          product {
+            name
+          }
+        }
+      GRAPHQL
+
+      path = ShopifyAPI::ApiVersion.new('2019-10').construct_graphql_path
+      stub_request(:post, "#{@site}#{path}").to_return(body: { product: { name: 'Shirt' } }.to_json)
+
+      client.query(query)
+    end
+  end
+
+  test '#client raises exception for version that does not exist' do
+    version_fixtures('unstable') do |dir|
+      ShopifyAPI::Base.api_version = '2019-10'
+
+      ShopifyAPI::GraphQL.initialize_clients
+
+      assert_raises ShopifyAPI::GraphQL::InvalidClient do
+        ShopifyAPI::GraphQL.client('2019-10')
+      end
+    end
+  end
+
+  test '#client lazily initializes clients' do
+    version_fixtures('unstable') do |dir|
+      ShopifyAPI::Base.api_version = 'unstable'
+
+      assert_raises ShopifyAPI::GraphQL::InvalidClient do
+        ShopifyAPI::GraphQL.client('2019-10')
+      end
+    end
+  end
+
+  test '#client caches lookups' do
+    version_fixtures('unstable') do |dir|
+      ShopifyAPI::Base.api_version = 'unstable'
+
+      client1 = ShopifyAPI::GraphQL.client
+      client2 = ShopifyAPI::GraphQL.client('unstable')
+
+      assert_equal client1, client2
+    end
+  end
+
+  private
+
+  def version_fixtures(*versions)
+    Dir.mktmpdir do |dir|
+      versions.each do |version|
+        FileUtils.cp(@fixture_location.join("#{version}.json"), dir)
+      end
+
+      ShopifyAPI::GraphQL.schema_location = dir
+      yield(dir)
+    end
+  end
+end

data/test/order_test.rb

@@ -1,6 +1,8 @@
 require 'test_helper'
+require 'fulfillment_order_test_helper'
 
 class OrderTest < Test::Unit::TestCase
+  include FulfillmentOrderTestHelper
 
   test "create should create order" do
     fake 'orders', :method => :post, :status => 201, :body => load_fixture('order')
@@ -72,4 +74,52 @@ class OrderTest < Test::Unit::TestCase
       },
     }.to_json)
   end
+
+  test "fulfillment_orders should get fulfillment orders for an order with 2020-01 version" do
+    url_prefix = url_prefix_for_activated_session_for('2020-01')
+
+    fake(
+      'orders',
+      url: "#{url_prefix}/orders/450789469.json",
+      method: :get,
+      status: 200,
+      body: load_fixture('order'),
+      extension: false
+    )
+    order = ShopifyAPI::Order.find(450789469)
+
+    fake(
+      'orders',
+      url: "#{url_prefix}/orders/450789469/fulfillment_orders.json",
+      method: :get,
+      status: 200,
+      body: load_fixture('fulfillment_orders'),
+      extension: false
+    )
+    fulfillment_orders = order.fulfillment_orders
+
+    assert_equal [519788021, 519788022], fulfillment_orders.map(&:id).sort
+    fulfillment_orders.each do |fulfillment_order|
+      assert fulfillment_order.is_a?(ShopifyAPI::FulfillmentOrder)
+      assert_equal 450789469, fulfillment_order.order_id
+    end
+  end
+
+  test "fulfillment_orders raises NotImplementedError when api_version is older than 2020-01" do
+    url_prefix = url_prefix_for_activated_session_for('2019-10')
+
+    fake(
+      'orders',
+      url: "#{url_prefix}/orders/450789469.json",
+      method: :get,
+      status: 200,
+      body: load_fixture('order'),
+      extension: false
+    )
+    order = ShopifyAPI::Order.find(450789469)
+
+    assert_raises NotImplementedError do
+      order.fulfillment_orders
+    end
+  end
 end