disco_app 0.15.2 → 0.18.1

data/test/fixtures/api/subscriptions/valid_request.json

@@ -9,7 +9,7 @@
     "domain": null,
     "plan_name": null,
     "name": null,
-    "data": {"timezone": "(GMT+10:00) Melbourne", "country_name": "Australia"}
+    "data": {"timezone": "(GMT+10:00) Melbourne", "country_name": "Australia", "iana_timezone":  "Australia/Melbourne"}
   },
   "subscription": {
     "id": 304261385,

data/test/fixtures/api/widget_store/empty_webhooks.json

@@ -0,0 +1,3 @@
+{
+  "webhooks": []
+}

data/test/fixtures/api/widget_store/existing_webhooks.json

@@ -0,0 +1,43 @@
+{
+  "webhooks": [
+    {
+      "id": 748073353265,
+      "address": "https://test.example.com/webhooks",
+      "topic": "shop/update",
+      "created_at": "2020-04-01T00:00:00Z",
+      "updated_at": "2020-04-01T00:00:00Z",
+      "format": "json",
+      "fields": [],
+      "metafield_namespaces": [],
+      "api_version": "2020-04",
+      "private_metafield_namespaces": []
+    },
+    {
+      "id": 748073353266,
+      "address": "https://old.example.com/webhooks",
+      "topic": "orders/create",
+      "created_at": "2020-04-01T00:00:00Z",
+      "updated_at": "2020-04-01T00:00:00Z",
+      "format": "json",
+      "fields": [],
+      "metafield_namespaces": [],
+      "api_version": "2020-04",
+      "private_metafield_namespaces": []
+    },
+    {
+      "id": 748073353267,
+      "address": "https://test.example.com/webhooks",
+      "topic": "orders/paid",
+      "created_at": "2020-04-01T00:00:00Z",
+      "updated_at": "2020-04-01T00:00:00Z",
+      "format": "json",
+      "fields": [
+        "id",
+        "financial_status"
+      ],
+      "metafield_namespaces": [],
+      "api_version": "2020-04",
+      "private_metafield_namespaces": []
+    }
+  ]
+}

data/test/fixtures/disco_app/shops.yml

@@ -6,6 +6,7 @@ widget_store:
   data:
     country_name: 'Australia'
     timezone: '(GMT+10:00) Melbourne'
+    iana_timezone: 'Australia/Melbourne'
 
 widget_store_dev:
   shopify_domain: widgets-dev.myshopify.com
@@ -14,3 +15,5 @@ widget_store_dev:
   data:
     country_name: 'Sweden'
     primary_locale: 'sv'
+  created_at: "2017-03-07T06:06:25.000Z"
+  updated_at: "2017-03-07T06:06:25.000Z"

data/test/fixtures/webhooks/flow/trigger_usage.json

@@ -0,0 +1,7 @@
+{
+  "flow_trigger_definition_id": "Test trigger",
+  "has_enabled_flow": false,
+  "shop_id": "690933842",
+  "shopify_domain": "widgets.myshopify.com",
+  "timestamp": "2020-04-05T00:34:00.001Z"
+}

data/test/integration/synchronises_test.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
 
 class SynchronisesTest < ActionDispatch::IntegrationTest
+
   include ActiveJob::TestHelper
   fixtures :all
 
@@ -57,7 +58,7 @@ class SynchronisesTest < ActionDispatch::IntegrationTest
   test 'shopify api model still allows synchronisation' do
     assert_equal({}, @product.data)
 
-    shopify_product = ShopifyAPI::Product.new(ActiveSupport::JSON.decode(webhook_fixture('product_updated')))
+    shopify_product = ShopifyAPI::Product.new(JSON.parse(webhook_fixture('product_updated')))
     Product.synchronise(@shop, shopify_product)
 
     # Assert the product was updated locally, with the correct attributes.

data/test/jobs/disco_app/app_installed_job_test.rb

@@ -1,17 +1,18 @@
 require 'test_helper'
 
 class DiscoApp::AppInstalledJobTest < 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(: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)
     stub_request(:get, "#{@shop.admin_url}/shop.json").to_return(status: 200, body: api_fixture('widget_store/shop').to_json)
     stub_request(:get, "#{@shop.admin_url}/carrier_services.json").to_return(status: 200, body: api_fixture('widget_store/carrier_services').to_json)
     stub_request(:post, "#{@shop.admin_url}/carrier_services.json").to_return(status: 200)
-    stub_request(:post, "https://api.discolabs.com/v1/app_subscriptions.json").to_return(status: 200)
+    stub_request(:post, 'https://api.discolabs.com/v1/app_subscriptions.json').to_return(status: 200)
   end
 
   def teardown
@@ -20,9 +21,11 @@ class DiscoApp::AppInstalledJobTest < ActionController::TestCase
   end
 
   test 'app installed job performs shop update job' do
-    # Assert the main install job can be enqueued and performed.
-    perform_enqueued_jobs do
-      DiscoApp::AppInstalledJob.perform_later(@shop)
+    with_suppressed_output do
+      # Assert the main install job can be enqueued and performed.
+      perform_enqueued_jobs do
+        DiscoApp::AppInstalledJob.perform_later(@shop)
+      end
     end
 
     # Assert the update shop job was performed.
@@ -33,8 +36,10 @@ class DiscoApp::AppInstalledJobTest < ActionController::TestCase
   test 'app installed job automatically subscribes stores to the correct default plan' do
     @shop.current_subscription.destroy
 
-    perform_enqueued_jobs do
-      DiscoApp::AppInstalledJob.perform_later(@shop)
+    with_suppressed_output do
+      perform_enqueued_jobs do
+        DiscoApp::AppInstalledJob.perform_later(@shop)
+      end
     end
 
     # Assert the shop was subscribed to the development plan.
@@ -44,8 +49,10 @@ class DiscoApp::AppInstalledJobTest < ActionController::TestCase
   test 'app installed job automatically subscribes stores to the correct default plan with a plan code and a source' do
     @shop.current_subscription.destroy
 
-    perform_enqueued_jobs do
-      DiscoApp::AppInstalledJob.perform_later(@shop, 'PODCAST', 'smp')
+    with_suppressed_output do
+      perform_enqueued_jobs do
+        DiscoApp::AppInstalledJob.perform_later(@shop, 'PODCAST', 'smp')
+      end
     end
 
     # Assert the shop was subscribed to the development plan.
@@ -54,4 +61,16 @@ class DiscoApp::AppInstalledJobTest < ActionController::TestCase
     assert_equal 'smpodcast', @shop.current_subscription.source.name
   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/jobs/disco_app/app_uninstalled_job_test.rb

@@ -1,11 +1,12 @@
 require 'test_helper'
 
 class DiscoApp::AppUninstalledJobTest < ActionController::TestCase
+
   include ActiveJob::TestHelper
 
   def setup
     @shop = disco_app_shops(:widget_store)
-    stub_request(:post, "https://api.discolabs.com/v1/app_subscriptions.json").to_return(status: 200)
+    stub_request(:post, 'https://api.discolabs.com/v1/app_subscriptions.json').to_return(status: 200)
     perform_enqueued_jobs do
       DiscoApp::AppUninstalledJob.perform_later(@shop, {})
     end
@@ -25,6 +26,8 @@ class DiscoApp::AppUninstalledJobTest < ActionController::TestCase
   test 'app uninstalled job can be extended using concerns' do
     assert_performed_jobs 2
     @shop.reload
-    assert_equal 'Nowhere', @shop.data[:country_name] # Assert extended method called.
+    # Assert extended method called.
+    assert_equal 'Nowhere', @shop.data[:country_name]
   end
+
 end

data/test/jobs/disco_app/send_subscription_job_test.rb

@@ -1,11 +1,12 @@
 require 'test_helper'
 
 class DiscoApp::SendSubscriptionJobTest < ActionController::TestCase
+
   include ActiveJob::TestHelper
 
   def setup
     @shop = disco_app_shops(:widget_store)
-    stub_request(:post, "https://api.discolabs.com/v1/app_subscriptions.json").to_return(status: 200)
+    stub_request(:post, 'https://api.discolabs.com/v1/app_subscriptions.json').to_return(status: 200)
   end
 
   def teardown
@@ -18,7 +19,7 @@ class DiscoApp::SendSubscriptionJobTest < ActionController::TestCase
     perform_enqueued_jobs do
       DiscoApp::SendSubscriptionJob.perform_later(@shop)
     end
-    assert_requested(:post, "https://api.discolabs.com/v1/app_subscriptions.json", times: 1)
+    assert_requested(:post, 'https://api.discolabs.com/v1/app_subscriptions.json', times: 1)
   end
 
 end

data/test/jobs/disco_app/synchronise_carrier_service_job_test.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
 
 class DiscoApp::SynchroniseCarrierServiceJobTest < ActionController::TestCase
+
   include ActiveJob::TestHelper
 
   def setup

data/test/jobs/disco_app/synchronise_users_job_test.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
 
 class DiscoApp::SynchroniseUsersJobTest < ActionController::TestCase
+
   include ActiveJob::TestHelper
 
   def setup

data/test/jobs/disco_app/synchronise_webhooks_job_test.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
 
 class DiscoApp::SynchroniseWebhooksJobTest < ActionController::TestCase
+
   include ActiveJob::TestHelper
 
   def setup
@@ -13,30 +14,86 @@ class DiscoApp::SynchroniseWebhooksJobTest < ActionController::TestCase
   end
 
   test 'webhook synchronisation job creates webhooks for all expected topics' do
-    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)
+    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
 
-    perform_enqueued_jobs do
-      DiscoApp::SynchroniseWebhooksJob.perform_later(@shop)
+      # 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)
 
-    # 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) }
+      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 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
-      output = capture_io do
-        perform_enqueued_jobs do
-          DiscoApp::SynchroniseWebhooksJob.perform_later(@shop)
+      with_suppressed_output do
+        output = capture_io do
+          perform_enqueued_jobs do
+            DiscoApp::SynchroniseWebhooksJob.perform_later(@shop)
+          end
         end
-      end
 
-      assert output.first.include?('Invalid topic specified.')
-      assert output.first.include?('orders/create - not registered')
+        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
@@ -14,27 +15,45 @@ class DiscoApp::HasMetafieldsTest < ActiveSupport::TestCase
   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
-      }
-    ) }
+    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 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
-      },
-    ) }
+    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
 
 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

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