disco_app 0.12.7.pre.puma.pre.3 → 0.18.4

data/test/jobs/disco_app/synchronise_webhooks_job_test.rb

@@ -1,30 +1,99 @@
 require 'test_helper'
 
 class DiscoApp::SynchroniseWebhooksJobTest < ActionController::TestCase
+
   include ActiveJob::TestHelper
 
   def setup
     @shop = disco_app_shops(:widget_store)
-
-    stub_request(:get, "#{@shop.admin_url}/webhooks.json").to_return(status: 200, body: api_fixture('widget_store/webhooks').to_json)
-    stub_request(:post, "#{@shop.admin_url}/webhooks.json").to_return(status: 200)
   end
 
   def teardown
     @shop = nil
-
     WebMock.reset!
   end
 
   test 'webhook synchronisation job creates webhooks for all expected topics' do
-    perform_enqueued_jobs do
-      DiscoApp::SynchroniseWebhooksJob.perform_later(@shop)
+    with_suppressed_output do
+      stub_request(:get, "#{@shop.admin_url}/webhooks.json").to_return(status: 200, body: api_fixture('widget_store/empty_webhooks').to_json)
+      stub_request(:post, "#{@shop.admin_url}/webhooks.json").to_return(status: 200)
+
+      perform_enqueued_jobs do
+        DiscoApp::SynchroniseWebhooksJob.perform_later(@shop)
+      end
+
+      # Assert that all 3 webhook topics without field lists were POSTed to.
+      ['app/uninstalled', 'shop/update', 'orders/create'].each do |expected_webhook_topic|
+        assert_requested(:post, "#{@shop.admin_url}/webhooks.json", times: 1) do |request|
+          request.body.include?(%Q("topic":"#{expected_webhook_topic}")) && request.body.include?('"fields":[]')
+        end
+      end
+
+      # Assert that the orders/paid webhook topic was posted to with a field restriction.
+      assert_requested(:post, "#{@shop.admin_url}/webhooks.json", times: 1) do |request|
+        request.body.include?('"topic":"orders/paid"') && request.body.include?('"fields":["id"]')
+      end
     end
+  end
+
+  test 'webhook synchronisation job only creates and updates webhooks when required' do
+    with_suppressed_output do
+      stub_request(:get, "#{@shop.admin_url}/webhooks.json").to_return(status: 200, body: api_fixture('widget_store/existing_webhooks').to_json)
+      stub_request(:put, "#{@shop.admin_url}/webhooks/748073353266.json").to_return(status: 200)
+      stub_request(:put, "#{@shop.admin_url}/webhooks/748073353267.json").to_return(status: 200)
+      stub_request(:post, "#{@shop.admin_url}/webhooks.json").to_return(status: 200)
+
+      perform_enqueued_jobs do
+        DiscoApp::SynchroniseWebhooksJob.perform_later(@shop)
+      end
+
+      # Assert that a missing webhook was created.
+      assert_requested(:post, "#{@shop.admin_url}/webhooks.json", times: 1) do |request|
+        request.body.include?('"topic":"app/uninstalled"')
+      end
 
-    # Assert that all 4 expected webhook topics were POSTed to.
-    ['app/uninstalled', 'shop/update', 'orders/create', 'orders/paid'].each do |expected_webhook_topic|
-      assert_requested(:post, "#{@shop.admin_url}/webhooks.json", times: 1) { |request| request.body.include?(expected_webhook_topic) }
+      # Assert that no request was made to update an existing webhook with the expected values.
+      assert_requested(:post, "#{@shop.admin_url}/webhooks.json", times: 0) do |request|
+        request.body.include?('"topic":"shop/update"')
+      end
+
+      # Assert that a request was made to update the URL of a webhook with an out of date URL.
+      assert_requested(:put, "#{@shop.admin_url}/webhooks/748073353266.json", times: 1) do |request|
+        request.body.include?('"topic":"orders/create"') && request.body.include?('"address":"https://test.example.com/webhooks"')
+      end
+
+      # Assert that a request was made to update the fields of a webhook with out of date fields.
+      assert_requested(:put, "#{@shop.admin_url}/webhooks/748073353267.json", times: 1) do |request|
+        request.body.include?('"topic":"orders/paid"') && request.body.include?('"fields":["id"]')
+      end
     end
   end
 
+  test 'returns error messages for webhooks that cannot be registered' do
+    VCR.use_cassette('webhook_failure') do
+      with_suppressed_output do
+        output = capture_io do
+          perform_enqueued_jobs do
+            DiscoApp::SynchroniseWebhooksJob.perform_later(@shop)
+          end
+        end
+
+        assert output.first.include?('Invalid topic specified.')
+        assert output.first.include?('orders/create - not registered')
+      end
+    end
+  end
+
+  private
+
+    # Prevents the output from the webhook synchronisation from
+    # printing to STDOUT and messing up the test output
+    def with_suppressed_output
+      original_stdout = $stdout.clone
+      $stdout.reopen(File.new('/dev/null', 'w'))
+      yield
+    ensure
+      $stdout.reopen(original_stdout)
+    end
+
 end

data/test/models/disco_app/can_be_liquified_test.rb

@@ -3,6 +3,7 @@ require 'test_helper'
 class DiscoApp::CanBeLiquifiedTest < ActiveSupport::TestCase
 
   class Model
+
     include ActiveModel::Model
     include DiscoApp::Concerns::CanBeLiquified
 
@@ -17,6 +18,7 @@ class DiscoApp::CanBeLiquifiedTest < ActiveSupport::TestCase
     def liquid_model_name
       'model'
     end
+
   end
 
   def setup
@@ -48,7 +50,7 @@ class DiscoApp::CanBeLiquifiedTest < ActiveSupport::TestCase
 
     # Return an asset fixture as a string.
     def liquid_fixture(path)
-      filename = File.join(File.dirname(File.dirname(File.dirname(__FILE__))), 'fixtures', 'liquid', "#{path}")
+      filename = File.join(File.dirname(File.dirname(File.dirname(__FILE__))), 'fixtures', 'liquid', path.to_s)
       File.read(filename).strip
     end
 

data/test/models/disco_app/has_metafields_test.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
 
 class DiscoApp::HasMetafieldsTest < ActiveSupport::TestCase
+
   include DiscoApp::Test::ShopifyAPI
 
   def setup
@@ -13,28 +14,116 @@ class DiscoApp::HasMetafieldsTest < ActiveSupport::TestCase
     @shop = nil
   end
 
-  test 'can write metafields with a single namespace' do
-    stub_api_request(:put, "#{@shop.admin_url}/products/#{@product.id}.json", 'widget_store/products/write_metafields_single_namespace')
-    assert @shop.with_api_context { @product.write_metafields(
-      namespace1: {
-        key1: 'value1',
-        key2: 2
-      }
-    ) }
+  test 'can write product metafields with a single namespace with no existing metafields' do
+    stub_api_request(
+      :get,
+      "#{@shop.admin_url}/products/#{@product.id}/metafields.json",
+      'widget_store/products/get_metafields_empty'
+    )
+
+    stub_api_request(
+      :put,
+      "#{@shop.admin_url}/products/#{@product.id}.json",
+      'widget_store/products/write_metafields_single_namespace'
+    )
+
+    assert(
+      @shop.with_api_context do
+        @product.write_metafields(
+          namespace1: {
+            key1: 'value1',
+            key2: 2
+          }
+        )
+      end
+    )
+  end
+
+  test 'can write product metafields, including json string type, with a single namespace with one existing metafield' do
+    stub_api_request(
+      :get,
+      "#{@shop.admin_url}/products/#{@product.id}/metafields.json",
+      'widget_store/products/get_metafields_with_existing'
+    )
+
+    stub_api_request(
+      :put,
+      "#{@shop.admin_url}/products/#{@product.id}.json",
+      'widget_store/products/write_metafields_with_existing_single_namespace'
+    )
+
+    assert(
+      @shop.with_api_context do
+        @product.write_metafields(
+          namespace1: {
+            key1: 'value1',
+            key2: {
+              'json_key' => 'json_value'
+            }
+          }
+        )
+      end
+    )
+  end
+
+  test 'can write product metafields with multiple namespaces with no existing metafields' do
+    stub_api_request(
+      :get,
+      "#{@shop.admin_url}/products/#{@product.id}/metafields.json",
+      'widget_store/products/get_metafields_empty'
+    )
+
+    stub_api_request(
+      :put,
+      "#{@shop.admin_url}/products/#{@product.id}.json",
+      'widget_store/products/write_metafields_multiple_namespaces'
+    )
+
+    assert(
+      @shop.with_api_context do
+        @product.write_metafields(
+          namespace1: {
+            n1key1: 'value1',
+            n1key2: 2
+          },
+          namespace2: {
+            n2key3: 'value3',
+            n2key4: 2
+          }
+        )
+      end
+    )
   end
 
-  test 'can write metafields with multiple namespaces' do
-    stub_api_request(:put, "#{@shop.admin_url}/products/#{@product.id}.json", 'widget_store/products/write_metafields_multiple_namespaces')
-    assert @shop.with_api_context { @product.write_metafields(
-      namespace1: {
-        n1key1: 'value1',
-        n1key2: 2
-      },
-      namespace2: {
-        n2key3: 'value3',
-        n2key4: 2
-      },
-    ) }
+  test 'can write shop metafields with one existing metafield' do
+    stub_api_request(
+      :get,
+      "#{@shop.admin_url}/metafields.json",
+      'widget_store/shops/get_metafields_with_existing'
+    )
+
+    stub_api_request(
+      :put,
+      "#{@shop.admin_url}/metafields/874857827343.json",
+      'widget_store/shops/write_metafields_with_existing_first'
+    )
+
+    stub_api_request(
+      :post,
+      "#{@shop.admin_url}/metafields.json",
+      'widget_store/shops/write_metafields_with_existing_second'
+    )
+
+    assert(
+      @shop.with_api_context do
+        @shop.write_metafields(
+          namespace1: {
+            key1: 'value1',
+            key2: 2
+          }
+        )
+      end
+    )
   end
 
 end

data/test/models/disco_app/renders_assets_test.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
 
 class DiscoApp::RendersAssetsTest < ActiveSupport::TestCase
+
   include ActiveJob::TestHelper
   include DiscoApp::Test::ShopifyAPI
 
@@ -102,7 +103,7 @@ class DiscoApp::RendersAssetsTest < ActiveSupport::TestCase
 
     # Return an asset fixture as a string.
     def asset_fixture(path)
-      filename = File.join(File.dirname(File.dirname(File.dirname(__FILE__))), 'fixtures', 'assets', "#{path}")
+      filename = File.join(File.dirname(File.dirname(File.dirname(__FILE__))), 'fixtures', 'assets', path.to_s)
       File.read(filename)
     end
 

data/test/models/disco_app/session_test.rb

@@ -7,8 +7,8 @@ class DiscoApp::SessionTest < ActiveSupport::TestCase
     @session = DiscoApp::Session.create(
       session_id: 'a91bfc51fa79c9d09d43e2615d9345d4',
       data: {
-        :shopify => @shop.id,
-        :shopify_domain => @shop.shopify_domain
+        shopify: @shop.id,
+        shopify_domain: @shop.shopify_domain
       }
     )
   end

data/test/models/disco_app/shop_test.rb

@@ -25,7 +25,7 @@ class DiscoApp::ShopTest < ActiveSupport::TestCase
   end
 
   test 'time_zone helper returns correct time zone instance when known timezone defined' do
-    assert_equal 'Melbourne', @shop.time_zone.name
+    assert_equal 'Australia/Melbourne', @shop.time_zone.name
   end
 
   test 'time_zone helper returns default Rails timezone when no known timezone defined' do

data/test/services/disco_app/charges_service_test.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
 
 class DiscoApp::ChargesServiceTest < ActiveSupport::TestCase
+
   include DiscoApp::Test::ShopifyAPI
 
   def setup
@@ -30,15 +31,13 @@ class DiscoApp::ChargesServiceTest < ActiveSupport::TestCase
   end
 
   test 'creating a new charge for a recurring subscription is successful' do
-    res = { "recurring_application_charge": { "name": "Basic",
-                    "price": "9.99",
-                    "trial_days": 14,
-                    "return_url": /^https:\/\/test\.example\.com\/subscriptions\/304261385\/charges\/53297050(1|2)\/activate$/,
-                    "test": true 
-      } }
+    res = { "recurring_application_charge": { "name": 'Basic',
+                                              "price": '9.99',
+                                              "trial_days": 14,
+                                              "return_url": %r{^https://test\.example\.com/subscriptions/304261385/charges/53297050(1|2)/activate$},
+                                              "test": true } }
     stub_request(:post, "#{@shop.admin_url}/recurring_application_charges.json")
-      .with(body: res
-    ).to_return(status: 201, body:api_fixture("widget_store/charges/create_recurring_application_charge_response").to_json)
+      .with(body: res).to_return(status: 201, body: api_fixture('widget_store/charges/create_recurring_application_charge_response').to_json)
 
     new_charge = DiscoApp::ChargesService.create(@shop, @subscription)
     assert_equal 654381179, new_charge.shopify_id
@@ -58,8 +57,7 @@ class DiscoApp::ChargesServiceTest < ActiveSupport::TestCase
   end
 
   test 'activating an accepted recurring charge is successful and cancels any existing recurring charges' do
-    stub_api_request(:get, "#{@shop.admin_url}/recurring_application_charges/654381179.json", 'widget_store/charges/get_accepted_recurring_application_charge')
-    stub_api_request(:post, "#{@shop.admin_url}/recurring_application_charges/654381179/activate.json", 'widget_store/charges/activate_recurring_application_charge')
+    stub_api_request(:get, "#{@shop.admin_url}/recurring_application_charges/654381179.json", 'widget_store/charges/get_active_recurring_application_charge')
 
     old_charge = @subscription.active_charge
     assert old_charge.active?
@@ -72,8 +70,7 @@ class DiscoApp::ChargesServiceTest < ActiveSupport::TestCase
   end
 
   test 'activating an accepted recurring charge cancels other recurring charges' do
-    stub_api_request(:get, "#{@shop.admin_url}/recurring_application_charges/654381179.json", 'widget_store/charges/get_accepted_recurring_application_charge')
-    stub_api_request(:post, "#{@shop.admin_url}/recurring_application_charges/654381179/activate.json", 'widget_store/charges/activate_recurring_application_charge')
+    stub_api_request(:get, "#{@shop.admin_url}/recurring_application_charges/654381179.json", 'widget_store/charges/get_active_recurring_application_charge')
 
     assert DiscoApp::ChargesService.activate(@shop, @new_charge)
     assert @new_charge.active?
@@ -102,8 +99,7 @@ class DiscoApp::ChargesServiceTest < ActiveSupport::TestCase
   end
 
   test 'activating an accepted one-time charge is successful' do
-    stub_api_request(:get, "#{@dev_shop.admin_url}/application_charges/1012637323.json", 'widget_store/charges/get_accepted_application_charge')
-    stub_api_request(:post, "#{@dev_shop.admin_url}/application_charges/1012637323/activate.json", 'widget_store/charges/activate_application_charge')
+    stub_api_request(:get, "#{@dev_shop.admin_url}/application_charges/1012637323.json", 'widget_store/charges/get_active_application_charge')
 
     assert DiscoApp::ChargesService.activate(@dev_shop, @dev_new_charge)
     assert @dev_new_charge.active?

data/test/services/disco_app/flow/create_action_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+module DiscoApp
+  module Flow
+    class CreateActionTest < ActiveSupport::TestCase
+
+      include ActiveJob::TestHelper
+
+      def setup
+        @shop = disco_app_shops(:widget_store)
+      end
+
+      def teardown
+        @shop = nil
+      end
+
+      test 'call to create flow action creates model' do
+        result = CreateAction.call(shop: @shop, action_id: action_id, action_run_id: action_run_id, properties: properties)
+        assert result.success?
+        assert result.action.persisted?
+        assert result.action.pending?
+        assert_equal action_id, result.action.action_id
+        assert_equal action_run_id, result.action.action_run_id
+        assert_equal properties, result.action.properties
+      end
+
+      test 'call to create flow action enqueues processing job' do
+        assert_enqueued_with(job: ProcessActionJob) do
+          CreateAction.call(shop: @shop, action_id: action_id, action_run_id: action_run_id, properties: properties)
+        end
+      end
+
+      private
+
+        def action_id
+          'test_action_id'
+        end
+
+        def action_run_id
+          'bdb15e45-4f9d-4c80-88c8-7b43a24edaac-30892-cc8eb62a-14db-43fc-bc33-d6dea41ae623'
+        end
+
+        def properties
+          {
+            'customer_email' => 'name@example.com'
+          }
+        end
+
+    end
+  end
+end

data/test/services/disco_app/flow/create_trigger_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+module DiscoApp
+  module Flow
+    class CreateTriggerTest < ActiveSupport::TestCase
+
+      include ActiveJob::TestHelper
+
+      def setup
+        @shop = disco_app_shops(:widget_store)
+      end
+
+      def teardown
+        @shop = nil
+      end
+
+      test 'call to create flow trigger creates model' do
+        result = CreateTrigger.call(shop: @shop, title: title, resource_name: resource_name, resource_url: resource_url, properties: properties)
+        assert result.success?
+        assert result.trigger.persisted?
+        assert result.trigger.pending?
+        assert_equal title, result.trigger.title
+        assert_equal resource_name, result.trigger.resource_name
+        assert_equal resource_url, result.trigger.resource_url
+        assert_equal properties, result.trigger.properties
+      end
+
+      test 'call to create flow trigger enqueues processing job' do
+        assert_enqueued_with(job: ProcessTriggerJob) do
+          CreateTrigger.call(shop: @shop, title: title, resource_name: resource_name, resource_url: resource_url, properties: properties)
+        end
+      end
+
+      private
+
+        def title
+          'Test trigger'
+        end
+
+        def resource_name
+          'test_resource_name'
+        end
+
+        def resource_url
+          'https://example.com/test-resource-url'
+        end
+
+        def properties
+          {
+            'Customer email' => 'name@example.com'
+          }
+        end
+
+    end
+  end
+end

data/test/services/disco_app/flow/process_action_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+require 'interactor'
+
+class TestActionId
+
+  include Interactor
+
+  def call
+    # noop
+  end
+
+end
+
+module DiscoApp
+  module Flow
+    class ProcessActionTest < ActiveSupport::TestCase
+
+      include ActiveJob::TestHelper
+
+      def setup
+        @shop = disco_app_shops(:widget_store)
+        @action = @shop.flow_actions.create(
+          action_id: 'test_action_id',
+          action_run_id: 'bdb15e45-4f9d-4c80-88c8-7b43a24edaac-30892-cc8eb62a-14db-43fc-bc33-d6dea41ae623',
+          properties: { 'customer_email' => 'name@example.com' }
+        )
+        @now = Time.zone.parse('2018-12-29T00:00:00Z')
+        Timecop.freeze(@now)
+      end
+
+      def teardown
+        @shop = nil
+        @action = nil
+        @now = nil
+        Timecop.return
+      end
+
+      test 'call to process action that has already succeeded fails' do
+        @action.succeeded!
+        result = ProcessAction.call(action: @action)
+        assert_not result.success?
+      end
+
+      test 'call to process trigger that has already failed fails' do
+        @action.failed!
+        result = ProcessAction.call(action: @action)
+        assert_not result.success?
+      end
+
+      test 'processing pending action with existing service class succeeds' do
+        result = ProcessAction.call(action: @action)
+        assert result.success?
+        assert @action.succeeded?
+        assert_equal @now, @action.processed_at
+      end
+
+      test 'processing pending action with non-existent service class does not succeed' do
+        @action.update!(action_id: 'unknown_test_action_id')
+        result = ProcessAction.call(action: @action)
+        assert_not result.success?
+        assert @action.failed?
+        assert_equal @now, @action.processed_at
+        assert_equal ['Could not find service class for unknown_test_action_id'], @action.processing_errors
+      end
+
+    end
+  end
+end

data/test/services/disco_app/flow/process_trigger_test.rb

@@ -0,0 +1,94 @@
+require 'test_helper'
+
+module DiscoApp
+  module Flow
+    class ProcessTriggerTest < ActiveSupport::TestCase
+
+      include ActiveJob::TestHelper
+
+      def setup
+        @shop = disco_app_shops(:widget_store)
+        @trigger = @shop.flow_triggers.create(
+          title: 'Test trigger',
+          resource_name: 'test_resource_name',
+          resource_url: 'https://example.com/test-resource-url',
+          properties: { 'Customer email' => 'name@example.com' }
+        )
+        @now = Time.zone.parse('2018-12-29T00:00:00Z')
+        Timecop.freeze(@now)
+      end
+
+      def teardown
+        @shop = nil
+        @trigger = nil
+        @now = nil
+        Timecop.return
+      end
+
+      test 'call to process trigger that has already succeeded fails' do
+        @trigger.succeeded!
+        result = ProcessTrigger.call(trigger: @trigger)
+        assert_not result.success?
+      end
+
+      test 'call to process trigger that has already failed fails' do
+        @trigger.failed!
+        result = ProcessTrigger.call(trigger: @trigger)
+        assert_not result.success?
+      end
+
+      test 'call to process trigger that has already been skipped fails' do
+        @trigger.skipped!
+        result = ProcessTrigger.call(trigger: @trigger)
+        assert_not result.success?
+      end
+
+      test 'call to process trigger that we know is not being used succeeds with skipped status logged' do
+        @shop.flow_trigger_usages.create(
+          flow_trigger_definition_id: @trigger.title,
+          has_enabled_flow: false,
+          timestamp: @now
+        )
+        result = ProcessTrigger.call(trigger: @trigger)
+        assert result.success?
+        assert @trigger.skipped?
+        assert_equal @now, @trigger.processed_at
+      end
+
+      test 'processing valid pending trigger succeeds and makes the expected api call' do
+        VCR.use_cassette('flow_trigger_valid') do
+          result = ProcessTrigger.call(trigger: @trigger)
+          assert result.success?
+          assert @trigger.succeeded?
+          assert_equal @now, @trigger.processed_at
+        end
+      end
+
+      test 'processing valid pending trigger that we know is being used succeeds and makes the expected api call' do
+        @shop.flow_trigger_usages.create(
+          flow_trigger_definition_id: @trigger.title,
+          has_enabled_flow: true,
+          timestamp: @now
+        )
+
+        VCR.use_cassette('flow_trigger_valid') do
+          result = ProcessTrigger.call(trigger: @trigger)
+          assert result.success?
+          assert @trigger.succeeded?
+          assert_equal @now, @trigger.processed_at
+        end
+      end
+
+      test 'processing invalid pending trigger makes the expected api call with errors logged' do
+        VCR.use_cassette('flow_trigger_invalid_title') do
+          result = ProcessTrigger.call(trigger: @trigger)
+          assert_not result.success?
+          assert @trigger.failed?
+          assert_equal @now, @trigger.processed_at
+          assert_equal 1, @trigger.processing_errors.size
+        end
+      end
+
+    end
+  end
+end