shopify_app 13.5.0

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+
+module ShopifyApp
+  module Generators
+    class AddWebhookGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      class_option :topic, type: :string, aliases: "-t", required: true
+      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)])
+      end
+
+      def init_webhook_config
+        initializer = load_initializer
+        return if initializer.include?("config.webhooks")
+
+        inject_into_file(
+          'config/initializers/shopify_app.rb',
+          "  config.webhooks = [\n  ]\n",
+          before: 'end'
+        )
+      end
+
+      def inject_webhook_to_shopify_app_initializer
+        inject_into_file(
+          'config/initializers/shopify_app.rb',
+          webhook_config,
+          after: "config.webhooks = ["
+        )
+
+        initializer = load_initializer
+
+        unless initializer.include?(webhook_config)
+          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")
+      end
+
+      private
+
+      def job_file_name
+        address.split('/').last
+      end
+
+      def load_initializer
+        File.read(File.join(destination_root, 'config/initializers/shopify_app.rb'))
+      end
+
+      def webhook_config
+        "\n    {topic: '#{topic}', address: '#{address}', format: 'json'},"
+      end
+
+      def topic
+        options['topic']
+      end
+
+      def address
+        options['address']
+      end
+    end
+  end
+end

data/lib/generators/shopify_app/add_webhook/templates/webhook_job.rb.tt

@@ -0,0 +1,13 @@
+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
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+
+module ShopifyApp
+  module Generators
+    class AppProxyControllerGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_app_proxy_controller
+        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')
+      end
+
+      def add_app_proxy_route
+        inject_into_file(
+          '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
+end

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

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

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

@@ -0,0 +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

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

@@ -0,0 +1,19 @@
+<h2>App Proxy Page</h2>
+
+<p>Congratulations! You have successfully configured App Proxy for your shopify application.</p>
+<p>Any valid liquid code included in this page will be parsed and rendered by Shopify.</p>
+
+<br>
+
+<pre>
+Your Shop Details:
+<hr>
+	Shop Name 			: {{ shop.name }}
+	myshopify name 			: {{ shop.permanent_domain }}
+	Primary Domain of Shop 		: {{ shop.domain }}
+	Shop URL 			: {{ shop.url }}
+	Shop Currency 			: {{ shop.currency }}
+	No. of products in this shop 	: {{ shop.products_count }}
+<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_home_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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+
+module ShopifyApp
+  module Generators
+    class ControllersGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../..", __FILE__)
+
+      def create_controllers
+        controllers.each do |controller|
+          copy_file controller
+        end
+      end
+
+      private
+
+      def controllers
+        files_within_root('.', 'app/controllers/shopify_app/*.*')
+      end
+
+      def files_within_root(prefix, glob)
+        root = "#{self.class.source_root}/#{prefix}"
+
+        Dir["#{root}/#{glob}"].sort.map do |full_path|
+          full_path.sub(root, '.').gsub('/./', '/')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+
+module ShopifyApp
+  module Generators
+    class HomeControllerGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_home_controller
+        template('home_controller.rb', 'app/controllers/home_controller.rb')
+      end
+
+      def create_home_index_view
+        copy_file('index.html.erb', 'app/views/home/index.html.erb')
+      end
+
+      def add_home_index_route
+        route("root :to => 'home#index'")
+      end
+
+      def embedded_app?
+        ShopifyApp.configuration.embedded_app?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class HomeController < AuthenticatedController
+  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

@@ -0,0 +1,21 @@
+<h2>Products</h2>
+
+<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>
+
+<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 %>

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+
+module ShopifyApp
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+
+      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
+
+      def create_shopify_app_initializer
+        @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')
+      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')
+        end
+
+        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"
+        )
+      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')
+
+        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_user_agent_initializer
+        template('user_agent.rb', 'config/initializers/user_agent.rb')
+      end
+
+      def mount_engine
+        route("mount ShopifyApp::Engine, at: '/'")
+      end
+
+      def insert_hosts_into_development_config
+        inject_into_file(
+          'config/environments/development.rb',
+          "  config.hosts = (config.hosts rescue []) << /\\h+.ngrok.io/\n",
+          after: "Rails.application.configure do\n"
+        )
+      end
+
+      private
+
+      def embedded_app?
+        options['embedded'] == 'true'
+      end
+
+      def format_array_argument(array)
+        array.join(' ').tr('"', '')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+<% content_for :javascript do %>
+  <%= 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

@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <% application_name = ShopifyApp.configuration.application_name %>
+    <title><%= application_name %></title>
+    <%= stylesheet_link_tag 'application' %>
+    <% 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>
+
+  <body>
+    <div class="app-wrapper">
+      <div class="app-content">
+        <main role="main">
+          <%= yield %>
+        </main>
+      </div>
+    </div>
+
+    <%= render 'layouts/flash_messages' %>
+
+    <script src="https://unpkg.com/@shopify/app-bridge"></script>
+
+    <%= content_tag(:div, nil, id: 'shopify-app-init', data: {
+      api_key: ShopifyApp.configuration.api_key,
+      shop_origin: (@current_shopify_session.domain if @current_shopify_session),
+      debug: Rails.env.development?
+    } ) %>
+
+    <% if content_for?(:javascript) %>
+      <div id="ContentForJavascript" data-turbolinks-temporary>
+        <%= yield :javascript %>
+      </div>
+    <% end %>
+  </body>
+</html>

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);
+    }
+  });
+}

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+Rails.application.config.middleware.use(OmniAuth::Builder) do
+end

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

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.session_store(:cookie_store, key: '_example_session', expire_after: 14.days)

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

@@ -0,0 +1,15 @@
+document.addEventListener('DOMContentLoaded', () => {
+  var data = document.getElementById('shopify-app-init').dataset;
+  var AppBridge = window['app-bridge'];
+  var createApp = AppBridge.default;
+  window.app = createApp({
+    apiKey: data.apiKey,
+    shopOrigin: data.shopOrigin,
+  });
+
+  var actions = AppBridge.actions;
+  var TitleBar = actions.TitleBar;
+  TitleBar.create(app, {
+    title: data.page,
+  });
+});