disco_app 0.18.1 → 0.18.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e64f5353b2ff61d1c3dfb3687437e41a5b0bcd95341997a50a94a1f514b9b87
-  data.tar.gz: 995cdd1d825a71b2a27e0fb9bee55bd95a24b5b89967e1719875c413a1882dca
+  metadata.gz: a75590acf98965732300783166f37bc5b7424d85e39b602831f6d79ac496cf9b
+  data.tar.gz: 4ef13a5f01e043a3464698539245bd4982a0bb82c4a20a7c4081176f795f30b6
 SHA512:
-  metadata.gz: b5195516feed35026a348bf3842c64e9fd7235a25eaf6544dad2b69ba7be8fdf885bf731bba300cdfe6dcea1f76a2d37da1c75d315b45d6fb62d68791a3d7bc4
-  data.tar.gz: e43fcbd82c8b9804e3cb574436bf406fcede8b12c3dc9ae7e65323ab8c4bdb5b8b605162f3efc036fd37ad7a1d22fad817e2a52b585a43f3ca718cd89cec38e1
+  metadata.gz: e1179214f99827a732d322c1361707625578872484baa6430a946f887750d6b5b6d299c7c0558505d743993dc38db713ee1853338cd2ebd8552d391968d761a8
+  data.tar.gz: d835598d84013984dfa24c565e8868e21225b166dab8ca9ea09d05b7907568ec71d8eba4ab846cc6af5f03459df82e31786094a3b5fc7f1d438469e0c2ac7138

data/app/controllers/disco_app/charges_controller.rb

@@ -21,9 +21,14 @@ class DiscoApp::ChargesController < ApplicationController
     end
   end
 
-  # Attempt to activate a charge after a user has accepted or declined it.
+  # Attempt to activate a charge (locally) after a user has accepted or declined it.
   # Redirect to the main application's root URL immediately afterwards - if the
   # charge wasn't accepted, the flow will start again.
+  #
+  # Previously, the activation of a charge also required updating Shopify via the
+  # API, but that requirement has been removed.
+  #
+  # See https://shopify.dev/changelog/auto-activation-of-charges-and-subscriptions
   def activate
     # First attempt to find a matching charge.
     if (charge = @subscription.charges.find_by(id: params[:id], shopify_id: params[:charge_id])).nil?

data/app/jobs/disco_app/concerns/synchronise_resources_job.rb

@@ -2,12 +2,8 @@ module DiscoApp::Concerns::SynchroniseResourcesJob
 
   extend ActiveSupport::Concern
 
-  def perform(_shop, class_name, params)
-    klass = class_name.constantize
-
-    klass::SHOPIFY_API_CLASS.find(:all, params: params).map do |shopify_resource|
-      klass.synchronise(@shop, shopify_resource.serializable_hash)
-    end
+  def perform(shop, class_name, params, since_id = 0)
+    DiscoApp::SynchroniseResourcesService.synchronise_all(shop, class_name, params, since_id)
   end
 
 end

data/app/models/disco_app/concerns/has_metafields.rb

@@ -1,47 +1,104 @@
-module DiscoApp::Concerns::HasMetafields
-
-  extend ActiveSupport::Concern
-
-  included do
-    # Write multiple metafields for this object in a single call.
-    #
-    # Expects an argument in a nested hash structure with :namespace => :key =>
-    # :value, eg:
-    #
-    #   Product.write_metafields(myapp: {
-    #      key1: 'value1',
-    #      key2: 'value2'
-    #   })
-    #
-    # This method assumes that it is being called within a valid Shopify API
-    # session context, eg @shop.with_api_context { ... }.
-    #
-    # It also assumes that the including class has defined the appropriate value
-    # for SHOPIFY_API_CLASS and that calling the `id` method on the instance
-    # will return the relevant object's Shopify ID.
-    #
-    # Returns true on success, false otherwise.
-    def write_metafields(metafields)
-      self.class::SHOPIFY_API_CLASS.new(
-        id: id,
-        metafields: build_metafields(metafields)
-      ).save
-    end
+module DiscoApp
+  module Concerns
+    module HasMetafields
+
+      extend ActiveSupport::Concern
+
+      included do
+        # Write multiple metafields for this object in a single call.
+        #
+        # Expects an argument in a nested hash structure with :namespace => :key => :value, eg:
+        #
+        #   Product.write_metafields(myapp: {
+        #     key1: 'value1',
+        #     key2: 3,
+        #     key3: { 'value_key' => 'value_value' }
+        #   })
+        #
+        # String, integer and hash values will have their value type detected and set accordingly.
+        #
+        # This method assumes that it is being called within a valid Shopify API session context,
+        # eg @shop.with_api_context { ... }.
+        #
+        # It also assumes that the including class has defined the appropriate value for
+        # SHOPIFY_API_CLASS.
+        #
+        # To avoid an issue with trying to set metafield values for namespace and key pairs that
+        # already exist, this method also performs a lookup of existing metafields as part of the
+        # write process and ensures we set the corresponding metafield ID on the update call if
+        # needed.
+        #
+        # Returns true on success, raises an exception otherwise.
+        def write_metafields(metafields)
+          return write_shop_metafields(metafields) if shopify_api_class_is_shop?
+
+          write_resource_metafields(metafields)
+        end
+
+        # Writing shop metafields is a special case - they need to be saved one by one.
+        def write_shop_metafields(metafields)
+          build_metafields(metafields).all?(&:save!)
+        end
+
+        # Writing regular resource metafields can be done in a single request.
+        def write_resource_metafields(metafields)
+          self.class::SHOPIFY_API_CLASS.new(
+            id: id,
+            metafields: build_metafields(metafields)
+          ).save!
+        end
+
+        # Give a nested hash of metafields in the format described above, return an array of
+        # corresponding ShopifyAPI::Metafield instances.
+        def build_metafields(metafields)
+          metafields.flat_map do |namespace, keys|
+            keys.map do |key, value|
+              ShopifyAPI::Metafield.new(
+                id: existing_metafield_id(namespace, key),
+                namespace: namespace,
+                key: key,
+                value: build_value(value),
+                value_type: build_value_type(value)
+              )
+            end
+          end
+        end
+
+        # Return the metafield value based on the provided value.
+        def build_value(value)
+          return value.to_json if value.is_a?(Hash)
+
+          value
+        end
+
+        # Return the metafield type based on the provided value type.
+        def build_value_type(value)
+          return :json_string if value.is_a?(Hash)
+          return :integer if value.is_a?(Integer)
+
+          :string
+        end
+
+        # Given a namespace and key, attempt to find the ID of a corresponding metafield in the
+        # given set of existing metafields.
+        def existing_metafield_id(namespace, key)
+          existing_metafields.find do |existing_metafield|
+            (existing_metafield.namespace.to_sym == namespace.to_sym) && (existing_metafield.key.to_sym == key.to_sym)
+          end&.id
+        end
+
+        # Fetch and cache existing metafields for this object from the Shopify API.
+        def existing_metafields
+          @existing_metafields ||= begin
+            self.class::SHOPIFY_API_CLASS.new(id: id).metafields
+          end
+        end
+
+        def shopify_api_class_is_shop?
+          self.class::SHOPIFY_API_CLASS == ShopifyAPI::Shop
+        end
+      end
 
-    # Give a nested hash of metafields in the format described above, return
-    # an array of corresponding ShopifyAPI::Metafield instances.
-    def build_metafields(metafields)
-      metafields.map do |namespace, keys|
-        keys.map do |key, value|
-          ShopifyAPI::Metafield.new(
-            namespace: namespace,
-            key: key,
-            value: value,
-            value_type: value.is_a?(Integer) ? :integer : :string
-          )
-        end
-      end.flatten
     end
   end
-
 end

data/app/models/disco_app/concerns/synchronises.rb

@@ -47,11 +47,7 @@ module DiscoApp::Concerns::Synchronises
     end
 
     def synchronise_all(shop, params = {})
-      resource_count = shop.with_api_context { self::SHOPIFY_API_CLASS.count(params) }
-
-      (1..(resource_count / SYNCHRONISES_PAGE_LIMIT.to_f).ceil).each do |page|
-        DiscoApp::SynchroniseResourcesJob.perform_later(shop, name, params.merge(page: page, limit: SYNCHRONISES_PAGE_LIMIT))
-      end
+      DiscoApp::SynchroniseResourcesJob.perform_later(shop, name, params)
     end
   end
 

data/app/models/disco_app/concerns/taggable.rb

@@ -3,7 +3,7 @@ module DiscoApp::Concerns::Taggable
   extend ActiveSupport::Concern
 
   def tags
-    data[:tags].split(',').map(&:strip)
+    data[:tags].to_s.split(',').map(&:strip)
   end
 
   def add_tag(tag)

data/app/services/disco_app/charges_service.rb

@@ -32,8 +32,13 @@ class DiscoApp::ChargesService
     charge
   end
 
-  # Attempt to activate the given Shopify charge for the given Shop using the
-  # Shopify API. Returns true on successful activation, false otherwise.
+  # Synchronises the status of a given charge from the Shopify API and returns
+  # true if it's active (and false otherwise).
+  #
+  # Previously, the activation of a charge also required updating Shopify via the
+  # API, but that requirement has been removed.
+  #
+  # See https://shopify.dev/changelog/auto-activation-of-charges-and-subscriptions
   def self.activate(shop, charge)
     # Start by fetching the Shopify charge to check that it was accepted.
     shopify_charge = shop.with_api_context do
@@ -43,20 +48,13 @@ class DiscoApp::ChargesService
     # Update the status of the local charge based on the Shopify charge.
     charge.send("#{shopify_charge.status}!") if charge.respond_to? "#{shopify_charge.status}!"
 
-    # If the charge wasn't accepted, fail and return.
-    return false unless charge.accepted?
-
-    # If the charge was indeed accepted, activate it via Shopify.
-    charge.shop.with_api_context do
-      shopify_charge.activate
-    end
+    # If the charge isn't active, fail and return.
+    return false unless charge.active?
 
     # If the charge was recurring, make sure that all other local recurring
     # charges are marked inactive.
     cancel_recurring_charges(shop, charge) if charge.recurring?
 
-    charge.active!
-
     true
   rescue StandardError
     false

data/app/services/disco_app/synchronise_resources_service.rb

@@ -0,0 +1,54 @@
+module DiscoApp
+  class SynchroniseResourcesService
+
+    PAGE_LIMIT = 250
+
+    attr_reader :shop, :class_name, :params, :since_id
+
+    def self.synchronise_all(shop, class_name, params, since_id = 0)
+      new(shop, class_name, params, since_id).synchronise_all
+    end
+  
+    def initialize(shop, class_name, params, since_id)
+      @shop = shop
+      @class_name = class_name
+      @params = params
+      @since_id = since_id
+    end
+
+    def synchronise_all
+      synchronise_page
+      finish_or_loop
+    end
+
+    private
+
+      attr_reader :shopify_records
+
+      def synchronise_page(_last_shopify_record = since_id)
+        request_params = params.merge({
+          limit: PAGE_LIMIT,
+          since_id: since_id
+        })
+
+        @shopify_records = shop.with_api_context do
+          synchronise_class::SHOPIFY_API_CLASS.find(:all, params: request_params)
+        end
+
+        shopify_records.each do |shopify_record|
+          synchronise_class.synchronise(shop, shopify_record)
+        end
+      end
+
+      def finish_or_loop
+        return if shopify_records.empty? || shopify_records.size < PAGE_LIMIT
+
+        DiscoApp::SynchroniseResourcesJob.perform_later(shop, class_name, params, shopify_records.last.id)
+      end
+
+      def synchronise_class
+        @synchronise_class ||= class_name.constantize
+      end
+
+  end
+end

data/lib/disco_app/version.rb

@@ -1,5 +1,5 @@
 module DiscoApp
 
-  VERSION = '0.18.1'.freeze
+  VERSION = '0.18.4'.freeze
 
 end

data/lib/generators/disco_app/install/install_generator.rb

@@ -39,7 +39,7 @@ module DiscoApp
         gem 'classnames-rails'
         gem 'nokogiri'
         gem 'oj'
-        gem 'pg'
+        gem 'pg', '~> 1.1'
         gem 'premailer-rails'
         gem 'react-rails'
         gem 'render_anywhere'

data/lib/generators/disco_app/install/templates/root/.gitignore

@@ -2,8 +2,10 @@
 *.pgdump
 capybara-*.html
 .rspec
-/log
-/tmp
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
 /db/*.sqlite3
 /db/*.sqlite3-journal
 /public/system
@@ -17,6 +19,7 @@ pickle-email-*.html
 .disco_app
 /public/packs
 /public/packs-test
+/public/assets
 /node_modules
 yarn-debug.log*
 .yarn-integrity
@@ -29,6 +32,18 @@ yarn-debug.log*
 .envrc
 .pryrc
 
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+
 # these should all be checked in to normalise the environment:
 # Gemfile.lock, .ruby-version, .ruby-gemset
 
@@ -37,6 +52,7 @@ yarn-debug.log*
 
 # if using bower-rails ignore default bower_components path bower.json files
 /vendor/assets/bower_components
+
 *.bowerrc
 bower.json
 

data/test/controllers/disco_app/charges_controller_test.rb

@@ -86,8 +86,7 @@ class DiscoApp::ChargesControllerTest < ActionController::TestCase
   end
 
   test 'user trying to activate accepted charge succeeds and is redirected to the root page' 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')
 
     @current_subscription.active_charge.destroy
     get :activate, params: { subscription_id: @current_subscription, id: @new_charge.id, charge_id: @new_charge.shopify_id }

data/test/dummy/app/models/disco_app/shop.rb

@@ -4,6 +4,9 @@ class DiscoApp::Shop < ApplicationRecord
 
   include DiscoApp::Concerns::Shop
 
+  include DiscoApp::Concerns::HasMetafields
+  SHOPIFY_API_CLASS = ShopifyAPI::Shop
+
   has_one :js_configuration
   has_one :widget_configuration
   has_many :carts

data/test/dummy/package.json

@@ -1,8 +1,10 @@
 {
   "dependencies": {
-    "@rails/webpacker": "^4.0.7"
+    "@rails/webpacker": "5.4.3",
+    "webpack": "^4.46.0",
+    "webpack-cli": "^3.3.12"
   },
   "devDependencies": {
-    "webpack-dev-server": "^3.9.0"
+    "webpack-dev-server": "^3"
   }
 }