shopify_app 7.2.0 → 17.1.0

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+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/add_marketing_activity_extension/add_marketing_activity_extension_generator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+
+module ShopifyApp
+  module Generators
+    class AddMarketingActivityExtensionGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_app_extension
+        template("marketing_activities_controller.rb", "app/controllers/marketing_activities_controller.rb")
+        generate_routes
+      end
+
+      private
+
+      def generate_routes
+        inject_into_file(
+          'config/routes.rb',
+          optimize_indentation(routes, 2),
+          after: "root :to => 'home#index'\n"
+        )
+      end
+
+      def routes
+        <<~EOS
+
+          resource :marketing_activities, only: [:create, :update] do
+            patch :resume
+            patch :pause
+            patch :delete
+            post :republish
+            post :preload_form_data
+            post :preview
+            post :errors
+          end
+        EOS
+      end
+    end
+  end
+end

data/lib/generators/shopify_app/add_marketing_activity_extension/templates/marketing_activities_controller.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+class MarketingActivitiesController < ShopifyApp::ExtensionVerificationController
+  def preload_form_data
+    preload_data = {
+      "form_data": {},
+    }
+    render(json: preload_data, status: :ok)
+  end
+
+  def update
+    render(json: {}, status: :accepted)
+  end
+
+  def pause
+    render(json: {}, status: :accepted)
+  end
+
+  def resume
+    render(json: {}, status: :accepted)
+  end
+
+  def delete
+    render(json: {}, status: :accepted)
+  end
+
+  def preview
+    placeholder_img = "https://cdn.shopify.com/s/files/1/0533/2089/files/placeholder-images-image_small.png"
+    preview_response = {
+      "desktop": {
+        "preview_url": placeholder_img,
+        "content_type": "text/html",
+        "width": 360,
+        "height": 200,
+      },
+      "mobile": {
+        "preview_url": placeholder_img,
+        "content_type": "text/html",
+        "width": 360,
+        "height": 200,
+      },
+    }
+    render(json: preview_response, status: :ok)
+  end
+
+  def create
+    render(json: {}, status: :ok)
+  end
+
+  def republish
+    render(json: {}, status: :accepted)
+  end
+
+  def errors
+    request_id = params[:request_id]
+    message = params[:message]
+
+    Rails.logger.info("[Marketing Activity App Error Feedback] Request id: #{request_id}, message: #{message}")
+
+    render(json: {}, status: :ok)
+  end
+end

data/lib/generators/shopify_app/add_webhook/add_webhook_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators/base'
 
 module ShopifyApp
@@ -8,7 +9,7 @@ module ShopifyApp
       class_option :address, type: :string, aliases: "-a", required: true
 
       hook_for :test_framework, as: :job, in: :rails do |instance, generator|
-        instance.invoke generator, [ instance.send(:job_file_name) ]
+        instance.invoke(generator, [instance.send(:job_file_name)])
       end
 
       def init_webhook_config
@@ -32,14 +33,14 @@ module ShopifyApp
         initializer = load_initializer
 
         unless initializer.include?(webhook_config)
-          shell.say "Error adding webhook to config. Add this line manually: #{webhook_config}", :red
+          shell.say("Error adding webhook to config. Add this line manually: #{webhook_config}", :red)
         end
       end
 
       def add_webhook_job
         @job_file_name = job_file_name + '_job'
-        @job_class_name  = @job_file_name.classify
-        template 'webhook_job.rb', "app/jobs/#{@job_file_name}.rb"
+        @job_class_name = @job_file_name.classify
+        template('webhook_job.rb', "app/jobs/#{@job_file_name}.rb")
       end
 
       private

data/lib/generators/shopify_app/add_webhook/templates/{webhook_job.rb → webhook_job.rb.tt}

@@ -2,6 +2,11 @@ class <%= @job_class_name %> < ActiveJob::Base
   def perform(shop_domain:, webhook:)
     shop = Shop.find_by(shopify_domain: shop_domain)
 
+    if shop.nil?
+      logger.error("#{self.class} failed: cannot find shop with domain '#{shop_domain}'")
+      return
+    end
+
     shop.with_shopify_session do
     end
   end

data/lib/generators/shopify_app/app_proxy_controller/app_proxy_controller_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators/base'
 
 module ShopifyApp
@@ -6,11 +7,11 @@ module ShopifyApp
       source_root File.expand_path('../templates', __FILE__)
 
       def create_app_proxy_controller
-        template 'app_proxy_controller.rb', 'app/controllers/app_proxy_controller.rb'
+        template('app_proxy_controller.rb', 'app/controllers/app_proxy_controller.rb')
       end
 
       def create_app_proxy_index_view
-        copy_file 'index.html.erb', 'app/views/app_proxy/index.html.erb'
+        copy_file('index.html.erb', 'app/views/app_proxy/index.html.erb')
       end
 
       def add_app_proxy_route
@@ -18,7 +19,7 @@ module ShopifyApp
           'config/routes.rb',
           File.read(File.expand_path(find_in_source_paths('app_proxy_route.rb'))),
           after: "mount ShopifyApp::Engine, at: '/'\n"
-        )  			 
+        )
       end
     end
   end

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

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
 class AppProxyController < ApplicationController
-   include ShopifyApp::AppProxyVerification
+  include ShopifyApp::AppProxyVerification
 
   def index
-    render layout: false, content_type: 'application/liquid'
+    render(layout: false, content_type: 'application/liquid')
   end
-
 end

data/lib/generators/shopify_app/app_proxy_controller/templates/app_proxy_route.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 
-  namespace :app_proxy do
-    root action: 'index'
-    # simple routes without a specified controller will go to AppProxyController
-    
-    # more complex routes will go to controllers in the AppProxy namespace
-    # 	resources :reviews
-    # GET /app_proxy/reviews will now be routed to
-    # AppProxy::ReviewsController#index, for example
-  end
+namespace :app_proxy do
+  root action: 'index'
+  # simple routes without a specified controller will go to AppProxyController
+
+  # more complex routes will go to controllers in the AppProxy namespace
+  #   resources :reviews
+  # GET /app_proxy/reviews will now be routed to
+  # AppProxy::ReviewsController#index, for example
+end

data/lib/generators/shopify_app/app_proxy_controller/templates/index.html.erb

@@ -14,6 +14,6 @@ Your Shop Details:
 	Shop URL 			: {{ shop.url }}
 	Shop Currency 			: {{ shop.currency }}
 	No. of products in this shop 	: {{ shop.products_count }}
-<br>	
-<hr>	
+<br>
+<hr>
 </pre>

data/lib/generators/shopify_app/authenticated_controller/authenticated_controller_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module ShopifyApp
+  module Generators
+    class AuthenticatedControllerGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_authenticated_controller
+        template('authenticated_controller.rb', 'app/controllers/authenticated_controller.rb')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class AuthenticatedController < ApplicationController
+  include ShopifyApp::Authenticated
+end

data/lib/generators/shopify_app/controllers/controllers_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators/base'
 
 module ShopifyApp
@@ -7,7 +8,7 @@ module ShopifyApp
 
       def create_controllers
         controllers.each do |controller|
-          copy_file controller
+          copy_file(controller)
         end
       end
 

data/lib/generators/shopify_app/home_controller/home_controller_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators/base'
 
 module ShopifyApp
@@ -5,27 +6,48 @@ module ShopifyApp
     class HomeControllerGenerator < Rails::Generators::Base
       source_root File.expand_path('../templates', __FILE__)
 
+      class_option :with_cookie_authentication, type: :boolean, default: false
+      class_option :embedded, type: :string, default: 'true'
+
       def create_home_controller
-        template 'home_controller.rb', 'app/controllers/home_controller.rb'
+        template(home_controller_template, 'app/controllers/home_controller.rb')
+      end
+
+      def create_products_controller
+        generate("shopify_app:products_controller") unless with_cookie_authentication?
       end
 
       def create_home_index_view
-        copy_file 'index.html.erb', 'app/views/home/index.html.erb'
-        if embedded_app?
-          prepend_to_file(
-            'app/views/home/index.html.erb',
-            File.read(File.expand_path(find_in_source_paths('shopify_app_ready_script.html.erb')))
-          )
-        end
+        template('index.html.erb', 'app/views/home/index.html.erb')
       end
 
       def add_home_index_route
-        route "root :to => 'home#index'"
+        route("root :to => 'home#index'")
+      end
+
+      private
+
+      def embedded?
+        options['embedded'] == 'true'
       end
 
       def embedded_app?
         ShopifyApp.configuration.embedded_app?
       end
+
+      def with_cookie_authentication?
+        options['with_cookie_authentication']
+      end
+
+      def home_controller_template
+        return 'unauthenticated_home_controller.rb' unless authenticated_home_controller_required?
+
+        'home_controller.rb'
+      end
+
+      def authenticated_home_controller_required?
+        with_cookie_authentication? || !embedded? || !embedded_app?
+      end
     end
   end
 end

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

@@ -1,5 +1,10 @@
-class HomeController < ShopifyApp::AuthenticatedController
+# frozen_string_literal: true
+
+class HomeController < AuthenticatedController
+  include ShopifyApp::ShopAccessScopesVerification
+
   def index
     @products = ShopifyAPI::Product.find(:all, params: { limit: 10 })
+    @webhooks = ShopifyAPI::Webhook.find(:all)
   end
 end

data/lib/generators/shopify_app/home_controller/templates/index.html.erb

@@ -1,7 +1,71 @@
-<h2>Products</h2>
+<!DOCTYPE html>
+<html lang="<%= I18n.locale %>">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <link
+      rel="stylesheet"
+      href="https://unpkg.com/@shopify/polaris@4.25.0/styles.min.css"
+      />
+<% unless with_cookie_authentication? %>    <script>
+      document.addEventListener("DOMContentLoaded", async function() {
+        var SessionToken = window["app-bridge"].actions.SessionToken
+        var app = window.app;
 
-<ul>
-  <% @products.each do |product| %>
-    <li><%= link_to product.title, "https://#{@shop_session.url}/admin/products/#{product.id}", target: "_top" %></li>
-  <% end %>
-</ul>
+        app.dispatch(
+          SessionToken.request(),
+        );
+
+        // Save a session token for future requests
+        window.sessionToken = await new Promise((resolve) => {
+          app.subscribe(SessionToken.ActionType.RESPOND, (data) => {
+            resolve(data.sessionToken || "");
+          });
+        });
+
+        var fetchProducts = function() {
+          var headers = new Headers({ "Authorization": "Bearer " + window.sessionToken });
+          return fetch("/products", { headers })
+            .then(response => response.json())
+            .then(data => {
+              var products = data.products;
+
+              if (products === undefined || products.length == 0) {
+                document.getElementById("products").innerHTML = "<br>No products to display.";
+              } else {
+                var list = "";
+                products.forEach((product) => {
+                  var link = `<a target="_top" href="https://<%%= @shop_origin %>/admin/products/${product.id}">`
+                  list += "<li>" + link + product.title + "</a></li>";
+                });
+                document.getElementById("products").innerHTML = "<ul>" + list + "</ul>";
+              }
+            });
+        }();
+      });
+    </script>
+<% end %>  </head>
+  <body>
+    <h2>Products</h2>
+<% unless with_cookie_authentication? %>    <div id="products"><br>Loading...</div><% else %>
+    <ul>
+      <%% @products.each do |product| %>
+        <li><%%= link_to product.title, "https://#{@current_shopify_session.domain}/admin/products/#{product.id}", target: "_top" %></li>
+      <%% end %>
+    </ul>
+
+    <hr>
+    <% end %>
+    <h2>Webhooks</h2>
+
+    <%% if @webhooks.present? %>
+    <ul>
+      <%% @webhooks.each do |webhook| %>
+      <li><%%= webhook.topic %> : <%%= webhook.address %></li>
+      <%% end %>
+    </ul>
+    <%% else %>
+    <p>This app has not created any webhooks for this Shop. Add webhooks to your ShopifyApp initializer if you need webhooks</p>
+    <%% end %>
+  </body>
+</html>

data/lib/generators/shopify_app/home_controller/templates/unauthenticated_home_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class HomeController < ApplicationController
+  include ShopifyApp::EmbeddedApp
+  include ShopifyApp::RequireKnownShop
+  include ShopifyApp::ShopAccessScopesVerification
+
+  def index
+    @shop_origin = current_shopify_domain
+  end
+end

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

@@ -1,5 +1,5 @@
+# frozen_string_literal: true
 require 'rails/generators/base'
-require 'rails/generators/active_record'
 
 module ShopifyApp
   module Generators
@@ -7,60 +7,111 @@ module ShopifyApp
       include Rails::Generators::Migration
       source_root File.expand_path('../templates', __FILE__)
 
-      class_option :application_name, type: :string
-      class_option :api_key, type: :string, default: '<api_key>'
-      class_option :secret, type: :string, default: '<secret>'
-      class_option :scope, type: :string, default: 'read_orders, read_products'
+      class_option :application_name, type: :array, default: ['My', 'Shopify', 'App']
+      class_option :scope, type: :array, default: ['read_products']
       class_option :embedded, type: :string, default: 'true'
+      class_option :api_version, type: :string, default: nil
+      class_option :with_cookie_authentication, type: :boolean, default: false
 
       def create_shopify_app_initializer
-        @application_name = options['application_name']
-        @api_key = options['api_key']
-        @secret = options['secret']
-        @scope = options['scope']
+        @application_name = format_array_argument(options['application_name'])
+        @scope = format_array_argument(options['scope'])
+        @api_version = options['api_version'] || ShopifyAPI::Meta.admin_versions.find(&:latest_supported).handle
 
-        template 'shopify_app.rb', 'config/initializers/shopify_app.rb'
+        template('shopify_app.rb', 'config/initializers/shopify_app.rb')
+      end
+
+      def create_session_store_initializer
+        copy_file('session_store.rb', 'config/initializers/session_store.rb')
       end
 
       def create_and_inject_into_omniauth_initializer
-        unless File.exist? "config/initializers/omniauth.rb"
-          copy_file 'omniauth.rb', 'config/initializers/omniauth.rb'
+        unless File.exist?("config/initializers/omniauth.rb")
+          copy_file('omniauth.rb', 'config/initializers/omniauth.rb')
         end
 
+        return if !Rails.env.test? && shopify_provider_exists?
+
         inject_into_file(
           'config/initializers/omniauth.rb',
-          File.read(File.expand_path(find_in_source_paths('shopify_provider.rb'))),
-          after: "Rails.application.config.middleware.use OmniAuth::Builder do\n"
+          shopify_provider_template,
+          after: "Rails.application.config.middleware.use(OmniAuth::Builder) do\n"
         )
       end
 
-      def create_shopify_session_repository_initializer
-        copy_file 'shopify_session_repository.rb', 'config/initializers/shopify_session_repository.rb'
-      end
+      def create_embedded_app_layout
+        return unless embedded_app?
+
+        copy_file('embedded_app.html.erb', 'app/views/layouts/embedded_app.html.erb')
+        copy_file('_flash_messages.html.erb', 'app/views/layouts/_flash_messages.html.erb')
 
-      def inject_embedded_app_options_to_application
-        if embedded_app?
-          application "config.action_dispatch.default_headers.delete('X-Frame-Options')"
-          application "config.action_dispatch.default_headers['P3P'] = 'CP=\"Not used\"'"
+        if ShopifyApp.use_webpacker?
+          copy_file('shopify_app.js', 'app/javascript/shopify_app/shopify_app.js')
+          copy_file('flash_messages.js', 'app/javascript/shopify_app/flash_messages.js')
+          copy_file('shopify_app_index.js', 'app/javascript/shopify_app/index.js')
+          append_to_file('app/javascript/packs/application.js', "require(\"shopify_app\")\n")
+        else
+          copy_file('shopify_app.js', 'app/assets/javascripts/shopify_app.js')
+          copy_file('flash_messages.js', 'app/assets/javascripts/flash_messages.js')
         end
       end
 
-      def create_embedded_app_layout
-        if embedded_app?
-          copy_file 'embedded_app.html.erb', 'app/views/layouts/embedded_app.html.erb'
-          copy_file '_flash_messages.html.erb', 'app/views/layouts/_flash_messages.html.erb'
-        end
+      def create_user_agent_initializer
+        template('user_agent.rb', 'config/initializers/user_agent.rb')
       end
 
       def mount_engine
-        route "mount ShopifyApp::Engine, at: '/'"
+        route("mount ShopifyApp::Engine, at: '/'")
+      end
+
+      def insert_hosts_into_development_config
+        inject_into_file(
+          'config/environments/development.rb',
+          "  config.hosts = (config.hosts rescue []) << /\\w+\\.ngrok\\.io/\n",
+          after: "Rails.application.configure do\n"
+        )
       end
 
       private
 
+      def shopify_provider_exists?
+        File.open("config/initializers/omniauth.rb") do |file|
+          file.each_line do |line|
+            if line =~ /provider :shopify/
+              puts "\e[33m#{omniauth_warning}\e[0m"
+              return true
+            end
+          end
+        end
+        false
+      end
+
+      def omniauth_warning
+        <<~OMNIAUTH
+          \n[WARNING] The Shopify App generator attempted to add the following Shopify Omniauth \
+          provider 'config/initializers/omniauth.rb':
+
+          \e[0m#{shopify_provider_template}\e[33m
+
+          Consider updating 'config/initializers/omniauth.rb' to match the configuration above.
+        OMNIAUTH
+      end
+
+      def shopify_provider_template
+        File.read(File.expand_path(find_in_source_paths('shopify_provider.rb.tt')))
+      end
+
       def embedded_app?
         options['embedded'] == 'true'
       end
+
+      def format_array_argument(array)
+        array.join(' ').tr('"', '')
+      end
+
+      def with_cookie_authentication?
+        options['with_cookie_authentication'] || !embedded_app?
+      end
     end
   end
 end

data/lib/generators/shopify_app/install/templates/_flash_messages.html.erb

@@ -1,15 +1,3 @@
 <% content_for :javascript do %>
-<script type="text/javascript">
-  var eventName = typeof(Turbolinks) !== 'undefined' ? 'page:change' : 'DOMContentLoaded';
-
-  document.addEventListener(eventName, function() {
-    <% if flash[:notice] %>
-      ShopifyApp.flashNotice("<%= j flash[:notice].html_safe %>");
-    <% end %>
-
-    <% if flash[:error] %>
-      ShopifyApp.flashError("<%= j flash[:error].html_safe %>");
-    <% end %>
-  });
-</script>
+  <%= content_tag(:div, nil, id: 'shopify-app-flash', data: { flash: { notice: flash[:notice], error: flash[:error] } }) %>
 <% end %>

data/lib/generators/shopify_app/install/templates/embedded_app.html.erb

@@ -3,9 +3,13 @@
   <head>
     <meta charset="utf-8" />
     <% application_name = ShopifyApp.configuration.application_name %>
-    <title><%= application_name.presence || 'Embedded Shopify App Example' %></title>
+    <title><%= application_name %></title>
     <%= stylesheet_link_tag 'application' %>
-    <%= javascript_include_tag 'application', "data-turbolinks-track" => true %>
+    <% if ShopifyApp.use_webpacker? %>
+      <%= javascript_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
+    <% else %>
+      <%= javascript_include_tag 'application', "data-turbolinks-track" => true %>
+    <% end %>
     <%= csrf_meta_tags %>
   </head>
 
@@ -20,16 +24,13 @@
 
     <%= render 'layouts/flash_messages' %>
 
-    <script src="https://cdn.shopify.com/s/assets/external/app.js?<%= Time.now.strftime('%Y%m%d%H') %>"></script>
+    <script src="https://unpkg.com/@shopify/app-bridge"></script>
 
-    <script type="text/javascript">
-      ShopifyApp.init({
-        apiKey: "<%= ShopifyApp.configuration.api_key %>",
-        shopOrigin: "<%= "https://#{ @shop_session.url }" if @shop_session %>",
-        debug: <%= Rails.env.development? ? 'true' : 'false' %>,
-        forceRedirect: true
-      });
-    </script>
+    <%= content_tag(:div, nil, id: 'shopify-app-init', data: {
+      api_key: ShopifyApp.configuration.api_key,
+      shop_origin: @shop_origin || (@current_shopify_session.domain if @current_shopify_session),
+      debug: Rails.env.development?
+    } ) %>
 
     <% if content_for?(:javascript) %>
       <div id="ContentForJavascript" data-turbolinks-temporary>

data/lib/generators/shopify_app/install/templates/flash_messages.js

@@ -0,0 +1,24 @@
+var eventName = typeof(Turbolinks) !== 'undefined' ? 'turbolinks:load' : 'DOMContentLoaded';
+
+if (!document.documentElement.hasAttribute("data-turbolinks-preview")) {
+  document.addEventListener(eventName, function flash() {
+    var flashData = JSON.parse(document.getElementById('shopify-app-flash').dataset.flash);
+
+    var Toast = window['app-bridge'].actions.Toast;
+
+    if (flashData.notice) {
+      Toast.create(app, {
+        message: flashData.notice,
+        duration: 5000,
+      }).dispatch(Toast.Action.SHOW);
+    }
+
+    if (flashData.error) {
+      Toast.create(app, {
+        message: flashData.error,
+        duration: 5000,
+        isError: true,
+      }).dispatch(Toast.Action.SHOW);
+    }
+  });
+}