shopify_app 7.3.0 → 7.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7ac19c7d6dc8350502dfc1a432ecdab6292305f
-  data.tar.gz: 0d46aaddf9e228435f64ffba054cc8066f2ac048
+  metadata.gz: b534fe893fb126d699a8e2a0908cc06aab2ea3e9
+  data.tar.gz: 7da8663a89439030d2198be0f4d09e947d68ae63
 SHA512:
-  metadata.gz: 636b704eaee4e2b522b628cf99677073b4c2d1b161689e80f483652203ab0a1420c209093e691e3ad244f256f404020909e850c5cbe76f113816f67ae7695900
-  data.tar.gz: 3e35b142261e9b6e8aad531fec7d5a55027ab36d45dd7fe4a2f67d0bc9f6ad9dcfb01a832c22dfa1ddb80924df01afb814217ef4889329622cf6483c9ff327d9
+  metadata.gz: 189dfc0d53bd7eae968b3270151b00a363a9ecd964b38cbabd378824156fa2eaf5aecb93c9932b1fa3fde2323bd35c9a8fcddec3f8b62b2c02cd6bd2001c8e1f
+  data.tar.gz: 9e11244536e4039e59b1170ab3fcf9717f9f0e53036dbd791cf30e72279d95737cb640cee2a19736e9e74da380c1209a49446aeb32cb2223baf36fe28e8eabcd

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+7.4.0
+-----
+* Add an after_authenticate job which will be run once the shop is authenticated. [[#431]](https://github.com/Shopify/shopify_app/pull/432)
+
 7.3.0
 -----
 * Bump required omniauth-shopify-oauth2 version to 1.2.0.

data/README.md

@@ -27,6 +27,7 @@ Table of Contents
 * [**Managing Api Keys**](#managing-api-keys)
 * [**WebhooksManager**](#webhooksmanager)
 * [**ScripttagsManager**](#scripttagsmanager)
+* [**AfterAuthenticate Job**](#afterauthenticate-job)
 * [**ShopifyApp::SessionRepository**](#shopifyappsessionrepository)
 * [**AuthenticatedController**](#authenticatedcontroller)
 * [**AppProxyVerification**](#appproxyverification)
@@ -54,7 +55,7 @@ Check out this screencast on how to create and deploy a new Shopify App to Herok
 
 [https://vimeo.com/130247240](https://vimeo.com/130247240)
 
-Or if you prefer text instructions the steps in the video are written out [here](https://github.com/Shopify/shopify_app/blob/master/QUICKSTART.md)
+Or if you prefer text instructions the steps in the video are written out [here](https://github.com/Shopify/shopify_app/blob/master/docs/Quickstart.md)
 
 Becoming a Shopify App Developer
 --------------------------------
@@ -185,10 +186,18 @@ Mounting the Engine will provide the basic routes to authenticating a shop with
 The default routes of the Shopify rails engine, which is mounted to the root, can be altered to mount on a different route. The `config/routes.rb` can be modified to put these under a nested route (say `/app-name`) as:
 
 ```ruby
-mount ShopifyApp::Engine, at: '/app-name'
+mount ShopifyApp::Engine, at: '/nested'
 ```
 
-This will create the Shopify engine routes under the specified Subdirectory, as a result it will redirect new consumers to `/app-name/login` and following a similar format for the other engine routes.
+This will create the Shopify engine routes under the specified subpath, as a result it will redirect new consumers to `/nested/login`. If you mount the engine at a subpath you'll also need to update the omniauth initializer to include a custom `callback_path` e.g:
+
+```ruby
+  provider :shopify,
+    ShopifyApp.configuration.api_key,
+    ShopifyApp.configuration.secret,
+    scope: ShopifyApp.configuration.scope,
+    callback_path: '/nested/auth/shopify/callback'
+```
 
 To use named routes with the engine so that it can route between the application and the engine's routes it should be prefixed with `main_app` or `shopify_app`.
 
@@ -290,6 +299,31 @@ Scripttags are created in the same way as the Webhooks, with a background job wh
 
 If `src` responds to `call` its return value will be used as the scripttag's source. It will be called on scripttag creation and deletion.
 
+AfterAuthenticate Job
+---------------------
+
+If your app needs to perform specific actions after it is installed ShopifyApp can queue or run a job of your choosing (note that we already provide support for automatically creating Webhooks and Scripttags). To configure the after authenticate job update your initializer as follows:
+
+```ruby
+ShopifyApp.configure do |config|
+  config.add_after_authenticate_job = { job: Shopify::AfterAuthenticateJob }
+end
+```
+
+If you need the job to run synchronously add the `inline` flag:
+
+```ruby
+ShopifyApp.configure do |config|
+  config.add_after_authenticate_job = { job: Shopify::AfterAuthenticateJob, inline: true }
+end
+```
+
+We've also provided a generator which creates a skeleton job and updates the initializer for you:
+
+```
+bin/rails g shopify_app:add_after_authenticate_job
+```
+
 ShopifyApp::SessionRepository
 -----------------------------
 
@@ -326,7 +360,7 @@ Create your app proxy url in the [Shopify Partners' Dashboard](https://app.shopi
 Troubleshooting
 ---------------
 
-see [TROUBLESHOOTING.md](TROUBLESHOOTING.md)
+see [TROUBLESHOOTING.md](https://github.com/Shopify/shopify_app/blob/master/docs/Troubleshooting.md)
 
 Testing an embedded app outside the Shopify admin
 -------------------------------------------------

data/lib/generators/shopify_app/add_after_authenticate_job/add_after_authenticate_job_generator.rb

@@ -0,0 +1,43 @@
+require 'rails/generators/base'
+
+module ShopifyApp
+  module Generators
+    class AddAfterAuthenticateJobGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      hook_for :test_framework, as: :job, in: :rails do |instance, generator|
+        instance.invoke generator, [ instance.send(:job_file_name) ]
+      end
+
+      def init_after_authenticate_config
+        initializer = load_initializer
+
+       after_authenticate_job_config = "  config.after_authenticate_job = { job: Shopify::AfterAuthenticateJob, inline: false }\n"
+
+        inject_into_file(
+          'config/initializers/shopify_app.rb',
+          after_authenticate_job_config,
+          before: 'end'
+        )
+
+        unless initializer.include?(after_authenticate_job_config)
+          shell.say "Error adding after_authneticate_job to config. Add this line manually: #{after_authenticate_job_config}", :red
+        end
+      end
+
+      def add_after_authenticate_job
+        template 'after_authenticate_job.rb', "app/jobs/#{job_file_name}_job.rb"
+      end
+
+      private
+
+      def load_initializer
+        File.read(File.join(destination_root, 'config/initializers/shopify_app.rb'))
+      end
+
+      def job_file_name
+        'shopify/after_authenticate'
+      end
+    end
+  end
+end

data/lib/generators/shopify_app/add_after_authenticate_job/templates/after_authenticate_job.rb

@@ -0,0 +1,10 @@
+module Shopify
+  class AfterAuthenticateJob < ActiveJob::Base
+    def perform(shop_domain:)
+      shop = Shop.find_by(shopify_domain: shop_domain)
+
+      shop.with_shopify_session do
+      end
+    end
+  end
+end

data/lib/generators/shopify_app/install/templates/shopify_app.rb

@@ -4,4 +4,5 @@ ShopifyApp.configure do |config|
   config.secret = "<%= @secret %>"
   config.scope = "<%= @scope %>"
   config.embedded_app = <%= embedded_app? %>
+  config.after_authenticate_job = false
 end

data/lib/shopify_app/configuration.rb

@@ -12,6 +12,7 @@ module ShopifyApp
     alias_method  :embedded_app?, :embedded_app
     attr_accessor :webhooks
     attr_accessor :scripttags
+    attr_accessor :after_authenticate_job
 
     # customise ActiveJob queue names
     attr_accessor :scripttags_manager_queue_name

data/lib/shopify_app/sessions_concern.rb

@@ -20,6 +20,7 @@ module ShopifyApp
         login_shop
         install_webhooks
         install_scripttags
+        perform_after_authenticate_job
 
         redirect_to return_address
       else
@@ -87,5 +88,16 @@ module ShopifyApp
       session.delete(:return_to) || main_app.root_url
     end
 
+    def perform_after_authenticate_job
+      config = ShopifyApp.configuration.after_authenticate_job
+
+      return unless config && config[:job].present?
+
+      if config[:inline] == true
+        config[:job].perform_now(shop_domain: session[:shopify_domain])
+      else
+        config[:job].perform_later(shop_domain: session[:shopify_domain])
+      end
+    end
   end
 end

data/lib/shopify_app/version.rb

@@ -1,3 +1,3 @@
 module ShopifyApp
-  VERSION = '7.3.0'
+  VERSION = '7.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_app
 version: !ruby/object:Gem::Version
-  version: 7.3.0
+  version: 7.4.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-18 00:00:00.000000000 Z
+date: 2017-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -128,17 +128,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE.md"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- ISSUE_TEMPLATE.md
 - LICENSE
-- QUICKSTART.md
 - README.md
-- RELEASING
 - Rakefile
-- TROUBLESHOOTING.md
 - app/controllers/shopify_app/authenticated_controller.rb
 - app/controllers/shopify_app/sessions_controller.rb
 - app/controllers/shopify_app/webhooks_controller.rb
@@ -149,7 +146,12 @@ files:
 - config/locales/fr.yml
 - config/locales/ja.yml
 - config/routes.rb
+- docs/Quickstart.md
+- docs/Releasing.md
+- docs/Troubleshooting.md
 - images/app-proxy-screenshot.png
+- lib/generators/shopify_app/add_after_authenticate_job/add_after_authenticate_job_generator.rb
+- lib/generators/shopify_app/add_after_authenticate_job/templates/after_authenticate_job.rb
 - lib/generators/shopify_app/add_webhook/add_webhook_generator.rb
 - lib/generators/shopify_app/add_webhook/templates/webhook_job.rb
 - lib/generators/shopify_app/app_proxy_controller/app_proxy_controller_generator.rb