duodealer_api 1.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 = DuodealerAPI::Session.new(domain: 'shop2.duodealer.com', token: 'token2', api_version: version)
+    DuodealerAPI::Base.activate_session(available_version)
+    "https://shop2.duodealer.com/admin/api/#{version}"
+  end
+end

data/test/fulfillment_request_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+class FulFillmentRequestTest < Test::Unit::TestCase
+  def setup
+    super
+    fake "orders/450789469/fulfillment_requests/695890229", method: :get, body: load_fixture('fulfillment_request')
+  end
+
+  context "#mark_as_failed" do
+    should "be able to mark_as_failed a fulfillment request" do
+      fulfillment_request = DuodealerAPI::FulfillmentRequest.find(695890229, params: { order_id: 450789469 })
+
+      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",
+        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
+    end
+  end
+
+  context "#find" do
+    should "be able to find fulfillment request" do
+      fulfillment_request = DuodealerAPI::FulfillmentRequest.find(695890229, params: { order_id: 450789469 })
+      assert_equal 695890229, fulfillment_request.id
+      assert_equal 450789469, fulfillment_request.order_id
+    end
+  end
+end

data/test/fulfillment_service_test.rb

@@ -0,0 +1,17 @@
+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 = DuodealerAPI::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 = DuodealerAPI::FulfillmentService.find(123456)
+		assert_equal 123456 , fulfillment_service.id
+		assert_equal "SomeService", fulfillment_service.name
+	end
+end

data/test/fulfillment_test.rb

@@ -0,0 +1,224 @@
+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')
+  end
+
+  context "Fulfillment" do
+    context "#complete" do
+      should "be able to complete fulfillment" do
+        fulfillment = DuodealerAPI::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)
+
+        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 = DuodealerAPI::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)
+
+        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 = DuodealerAPI::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)
+
+        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 = DuodealerAPI::Fulfillment.find(255858046, :params => {:order_id => 450789469})
+        assert_equal 255858046, fulfillment.id
+        assert_equal 450789469, fulfillment.order_id
+      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 = DuodealerAPI::Fulfillment.create(create_fulfillment_attributes)
+        assert fulfillment.is_a?(DuodealerAPI::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
+          DuodealerAPI::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 = DuodealerAPI::Fulfillment.new(create_fulfillment_attributes)
+        assert fulfillment.save
+        assert fulfillment.is_a?(DuodealerAPI::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 = DuodealerAPI::Fulfillment.new(create_fulfillment_attributes)
+        fulfillment.prefix_options[:order_id] = order_id
+
+        assert fulfillment.save
+        assert fulfillment.is_a?(DuodealerAPI::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 = DuodealerAPI::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 = DuodealerAPI::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
+          DuodealerAPI::FulfillmentV2.new(id: @fake_fulfillment['id'])
+        end
+      end
+    end
+  end
+end

data/test/gift_card_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class GiftCardTest < Test::Unit::TestCase
+  def setup
+    super
+    load_gift_card
+  end
+
+  def test_disable
+    fake 'gift_cards/1023670/disable.json', :body => load_fixture('gift_card_disabled'), :method => :post, :extension => false
+
+    refute @gift_card.disabled_at
+    @gift_card.disable
+    assert @gift_card.disabled_at
+  end
+
+  private
+  def load_gift_card
+    fake 'gift_cards/1023670', :body => load_fixture('gift_card')
+    @gift_card = DuodealerAPI::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
+      DuodealerAPI::Base.headers['X-Custom'] = 'abc'
+
+      client = DuodealerAPI::GraphQL::HTTPClient.new('2019-07')
+
+      assert_equal 'abc', client.headers({})['X-Custom']
+
+      DuodealerAPI::Base.headers.delete('X-Custom')
+    end
+
+    test '#uri uses the Base site and the API version' do
+      DuodealerAPI::Base.site = 'https://foo:bar@www.zombo.com'
+      api_version = DuodealerAPI::ApiVersion.new(handle: '2019-07')
+
+      client = DuodealerAPI::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
+    DuodealerAPI::ApiVersion.version_lookup_mode = :define_on_unknown
+    @fixture_location = Pathname('test/fixtures/graphql')
+    @site = 'https://this-is-my-test-shop.duodealer.com'
+    DuodealerAPI::Base.site = @site
+  end
+
+  def teardown
+    DuodealerAPI::GraphQL.clear_clients
+  end
+
+  test '#initialize_clients creates a GraphQL::Client from local schema file' do
+    version_fixtures('unstable') do |dir|
+      DuodealerAPI::GraphQL.initialize_clients
+
+      assert DuodealerAPI::GraphQL.client('unstable')
+    end
+  end
+
+  test '#initialize_clients handles multiple schema files' do
+    version_fixtures('unstable', '2019-10') do |dir|
+      DuodealerAPI::GraphQL.initialize_clients
+
+      assert DuodealerAPI::GraphQL.client('unstable')
+      assert DuodealerAPI::GraphQL.client('2019-10')
+    end
+  end
+
+  test '#initialize_clients ignores non JSON schema files' do
+    version_fixtures('unstable', '2019-10') do |dir|
+      FileUtils.touch(DuodealerAPI::GraphQL.schema_location.join('nope.txt'))
+
+      DuodealerAPI::GraphQL.initialize_clients
+
+      assert DuodealerAPI::GraphQL.client('unstable')
+      assert DuodealerAPI::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|
+      DuodealerAPI::GraphQL.schema_location = dir
+      FileUtils.touch(DuodealerAPI::GraphQL.schema_location.join('nope.json'))
+
+      assert_raises DuodealerAPI::GraphQL::InvalidSchema do
+        DuodealerAPI::GraphQL.initialize_clients
+      end
+    end
+  end
+
+  test '#client returns default schema if only one exists' do
+    version_fixtures('unstable') do |dir|
+      DuodealerAPI::Base.api_version = 'unstable'
+
+      DuodealerAPI::GraphQL.initialize_clients
+
+      assert_instance_of ::GraphQL::Client, DuodealerAPI::GraphQL.client
+    end
+  end
+
+  test '#client accepts optional api_version parameter' do
+    version_fixtures('unstable') do |dir|
+      DuodealerAPI::Base.api_version = 'unstable'
+
+      DuodealerAPI::GraphQL.initialize_clients
+
+      assert_instance_of ::GraphQL::Client, DuodealerAPI::GraphQL.client('unstable')
+    end
+  end
+
+  test '#client executes queries on specified API version' do
+    version_fixtures('unstable', '2019-10') do |dir|
+      DuodealerAPI::Base.api_version = 'unstable'
+
+      DuodealerAPI::GraphQL.initialize_clients
+      DuodealerAPI::Base.site = 'https://this-is-my-test-shop.duodealer.com'
+
+      client = DuodealerAPI::GraphQL.client('2019-10')
+
+      assert_instance_of ::GraphQL::Client, client
+
+      query = client.parse <<~GRAPHQL
+        {
+          product {
+            name
+          }
+        }
+      GRAPHQL
+
+      path = DuodealerAPI::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|
+      DuodealerAPI::Base.api_version = '2019-10'
+
+      DuodealerAPI::GraphQL.initialize_clients
+
+      assert_raises DuodealerAPI::GraphQL::InvalidClient do
+        DuodealerAPI::GraphQL.client('2019-10')
+      end
+    end
+  end
+
+  test '#client lazily initializes clients' do
+    version_fixtures('unstable') do |dir|
+      DuodealerAPI::Base.api_version = 'unstable'
+
+      assert_raises DuodealerAPI::GraphQL::InvalidClient do
+        DuodealerAPI::GraphQL.client('2019-10')
+      end
+    end
+  end
+
+  test '#client caches lookups' do
+    version_fixtures('unstable') do |dir|
+      DuodealerAPI::Base.api_version = 'unstable'
+
+      client1 = DuodealerAPI::GraphQL.client
+      client2 = DuodealerAPI::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
+
+      DuodealerAPI::GraphQL.schema_location = dir
+      yield(dir)
+    end
+  end
+end