disco_app 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1755c833438d9a42cdbc39e3016a20bb83f3110e472282daf58cc9c5fe56f86d
-  data.tar.gz: b2f041535874d1e8ecd4996d8ead0ebab4d6b6e5ac86e3087263fede8fec71c3
+  metadata.gz: a29063430cb2904c29bf74567496355a5f70d5e4e5d942d8f9ad8341ee99f935
+  data.tar.gz: c1ad2a5cf842f792213ef025f948057132bfdede2c78945d965edc925ad3f62f
 SHA512:
-  metadata.gz: 348c5d1933877e55d664eb17afcf73ff3121c705447afe78ce1460ac0a35709a506538c9020dc6d6c644ddb2a7a4a3d1af77178905c869f06acf7e6cd0d6cda4
-  data.tar.gz: 62b3d647d57a6f5ab9860e23940f052251c953de3ea86a9f1f43e4776aad5834fda7cc90f1a90f917f1e37634b5b1c79d3310e49f45cbc99146eef777ec7eb65
+  metadata.gz: 6dd9ac41a62be53b26c1ab0d7aa30d0078a1adbc0ae7cb5342567bca85764da13eba2b6a3cb5dbcfc4867dd8ea7e433811eaa9131549d85a43b2d75fe7a09a89
+  data.tar.gz: 2c06d93aaae37aa4d52b39ae35727e0ebf1bfd9c86f252bbd9bb910e61088c74aaba02037675b8da29beb50b4a8f485ba8f54ac9f0a508c88cb1b2cc05fcb8bc

data/app/jobs/disco_app/app_installed_job.rb

@@ -1,41 +1,3 @@
-module DiscoApp
-  class AppInstalledJob < DiscoApp::ShopJob
-
-    before_enqueue { @shop.awaiting_install! }
-    before_perform { @shop.installing! }
-    after_perform { @shop.installed! }
-
-    def perform(domain)
-
-      # Install webhooks.
-      (base_webhook_topics + webhook_topics).each do |topic|
-        ShopifyAPI::Webhook.create(topic: topic, address: webhooks_url, format: 'json')
-      end
-
-      # Perform initial update of shop information.
-      DiscoApp::ShopUpdateJob.perform_now(domain)
-
-    end
-
-    protected
-
-      # Return a list of additional webhook topics to listen for.
-      # This method should be overridden in the application.
-      def webhook_topics
-        []
-      end
-
-    private
-
-      # Return a list of webhook topics that will always be set up for the application.
-      def base_webhook_topics
-        [:'app/uninstalled', :'shop/update']
-      end
-
-      # Return the absolute URL to the webhooks endpoint.
-      def webhooks_url
-        DiscoApp::Engine.routes.url_helpers.webhooks_url
-      end
-
-  end
+class DiscoApp::AppInstalledJob < DiscoApp::ShopJob
+  include DiscoApp::Concerns::AppInstalledJob
 end

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

@@ -0,0 +1,46 @@
+module DiscoApp::Concerns::AppInstalledJob
+  extend ActiveSupport::Concern
+
+  included do
+    before_enqueue { @shop.awaiting_install! }
+    before_perform { @shop.installing! }
+    after_perform { @shop.installed! }
+  end
+
+  # Perform application installation.
+  #
+  # - Install webhooks, using a list generated from the base_webhook_topics and
+  #   webhook_topics methods.
+  # - Perform initial update of shop information.
+  #
+  def perform(domain)
+    (base_webhook_topics + webhook_topics).each do |topic|
+      ShopifyAPI::Webhook.create(topic: topic, address: webhooks_url, format: 'json')
+    end
+
+    DiscoApp::ShopUpdateJob.perform_now(domain)
+  end
+
+  protected
+
+    # Return a list of additional webhook topics to listen for. This method
+    # can be overridden in the application to provide a list of app-specific
+    # webhooks that should be created during installation.
+    def webhook_topics
+      []
+    end
+
+  private
+
+    # Return a list of webhook topics that will always be set up for the
+  # # application.
+    def base_webhook_topics
+      [:'app/uninstalled', :'shop/update']
+    end
+
+    # Return the absolute URL to the webhooks endpoint.
+    def webhooks_url
+      DiscoApp::Engine.routes.url_helpers.webhooks_url
+    end
+
+end

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

@@ -2,15 +2,16 @@ module DiscoApp::Concerns::AppUninstalledJob
   extend ActiveSupport::Concern
 
   included do
-
     before_enqueue { @shop.awaiting_uninstall! }
     before_perform { @shop.uninstalling! }
     after_perform { @shop.uninstalled! }
-
   end
 
+  # Perform application uninstallation.
+  #
+  # - Mark charge status as "cancelled" unless charges have been waived.
+  #
   def perform(domain, shop_data)
-    # Mark the shop's charge status as "cancelled" unless charges have been waived.
     unless @shop.charge_waived?
       @shop.charge_cancelled!
     end

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

@@ -0,0 +1,16 @@
+module DiscoApp::Concerns::ShopUpdateJob
+  extend ActiveSupport::Concern
+
+  # Perform an update of the current shop's information.
+  def perform(shopify_domain, shop_data = nil)
+    # If we weren't provided with shop data (eg from a webhook), fetch it.
+    shop_data ||= ActiveSupport::JSON::decode(ShopifyAPI::Shop.current.to_json)
+
+    # Ensure we can access shop data through symbols.
+    shop_data = HashWithIndifferentAccess.new(shop_data)
+
+    # Update model attributes present in both our model and the data hash.
+    @shop.update_attributes(shop_data.except(:id, :created_at).slice(*DiscoApp::Shop.column_names))
+  end
+
+end

data/app/jobs/disco_app/shop_job.rb

@@ -1,29 +1,27 @@
-# The base class for all jobs that should be performed in the context of a particular Shop's API session. The first
-# argument to any job inheriting from this class must be the domain of the relevant store, so that the appropriate
+# The base class for all jobs that should be performed in the context of a
+# particular Shop's API session. The first argument to any job inheriting from
+# this class must be the domain of the relevant store, so that the appropriate
 # Shop model can be fetched and the temporary API session created.
+class DiscoApp::ShopJob < ActiveJob::Base
 
-module DiscoApp
-  class ShopJob < ActiveJob::Base
+  queue_as :default
 
-    queue_as :default
+  before_perform { |job| find_shop(job) }
+  before_enqueue { |job| find_shop(job) }
 
-    before_perform { |job| find_shop(job) }
-    before_enqueue { |job| find_shop(job) }
+  around_enqueue { |job, block| shop_context(job, block) }
+  around_perform { |job, block| shop_context(job, block) }
 
-    around_enqueue { |job, block| shop_context(job, block) }
-    around_perform { |job, block| shop_context(job, block) }
+  private
 
-    private
+    def find_shop(job)
+      @shop ||= DiscoApp::Shop.find_by!(shopify_domain: job.arguments.first)
+    end
 
-      def find_shop(job)
-        @shop ||= Shop.find_by!(shopify_domain: job.arguments.first)
-      end
+    def shop_context(job, block)
+      @shop.temp {
+        block.call(job.arguments)
+      }
+    end
 
-      def shop_context(job, block)
-        @shop.temp {
-          block.call(job.arguments)
-        }
-      end
-
-  end
 end

data/app/jobs/disco_app/shop_update_job.rb

@@ -1,16 +1,3 @@
-module DiscoApp
-  class ShopUpdateJob < DiscoApp::ShopJob
-
-    def perform(domain, shop_data = nil)
-      # If we weren't provided with shop data (eg from a webhook), fetch it.
-      shop_data ||= ActiveSupport::JSON::decode(ShopifyAPI::Shop.current.to_json)
-
-      # Ensure we can access shop data through symbols.
-      shop_data = HashWithIndifferentAccess.new(shop_data)
-
-      # Update model attributes present in both our model and the data hash.
-      @shop.update_attributes(shop_data.except(:id, :created_at).slice(*DiscoApp::Shop.column_names))
-    end
-
-  end
+class DiscoApp::ShopUpdateJob < DiscoApp::ShopJob
+  include DiscoApp::Concerns::ShopUpdateJob
 end

data/lib/disco_app/version.rb

@@ -1,3 +1,3 @@
 module DiscoApp
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: disco_app
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Gavin Ballard
@@ -262,7 +262,9 @@ files:
 - app/helpers/disco_app/application_helper.rb
 - app/jobs/disco_app/app_installed_job.rb
 - app/jobs/disco_app/app_uninstalled_job.rb
+- app/jobs/disco_app/concerns/app_installed_job.rb
 - app/jobs/disco_app/concerns/app_uninstalled_job.rb
+- app/jobs/disco_app/concerns/shop_update_job.rb
 - app/jobs/disco_app/shop_job.rb
 - app/jobs/disco_app/shop_update_job.rb
 - app/models/disco_app/concerns/plan.rb