RubyGems - ruby_shopify_app - Versions diffs - 1.0.0 - Mend

ruby_shopify_app 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (186) hide show

checksums.yaml +7 -0
data/.babelrc +5 -0
data/.github/CODEOWNERS +2 -0
data/.github/ISSUE_TEMPLATE/bug-report.md +63 -0
data/.github/ISSUE_TEMPLATE/config.yml +1 -0
data/.github/ISSUE_TEMPLATE/feature-request.md +33 -0
data/.github/PULL_REQUEST_TEMPLATE.md +22 -0
data/.github/probots.yml +2 -0
data/.github/workflows/build.yml +40 -0
data/.github/workflows/release.yml +24 -0
data/.github/workflows/rubocop.yml +22 -0
data/.gitignore +14 -0
data/.nvmrc +1 -0
data/.rubocop.yml +18 -0
data/.ruby-version +1 -0
data/CHANGELOG-OLD.md +643 -0
data/CHANGELOG.md +6 -0
data/CONTRIBUTING.md +81 -0
data/Gemfile +11 -0
data/Gemfile.lock +280 -0
data/LICENSE +19 -0
data/README.md +132 -0
data/Rakefile +7 -0
data/SECURITY.md +59 -0
data/app/assets/images/storage_access.svg +1 -0
data/app/assets/javascripts/shopify_app/app_bridge_2.0.12.js +10 -0
data/app/assets/javascripts/shopify_app/app_bridge_redirect.js +22 -0
data/app/assets/javascripts/shopify_app/enable_cookies.js +3 -0
data/app/assets/javascripts/shopify_app/itp_helper.js +40 -0
data/app/assets/javascripts/shopify_app/partition_cookies.js +8 -0
data/app/assets/javascripts/shopify_app/post_redirect.js +9 -0
data/app/assets/javascripts/shopify_app/redirect.js +31 -0
data/app/assets/javascripts/shopify_app/request_storage_access.js +3 -0
data/app/assets/javascripts/shopify_app/storage_access.js +148 -0
data/app/assets/javascripts/shopify_app/storage_access_redirect.js +17 -0
data/app/assets/javascripts/shopify_app/top_level.js +2 -0
data/app/assets/javascripts/shopify_app/top_level_interaction.js +11 -0
data/app/controllers/concerns/shopify_app/authenticated.rb +16 -0
data/app/controllers/concerns/shopify_app/ensure_authenticated_links.rb +39 -0
data/app/controllers/concerns/shopify_app/require_known_shop.rb +40 -0
data/app/controllers/concerns/shopify_app/shop_access_scopes_verification.rb +32 -0
data/app/controllers/shopify_app/authenticated_controller.rb +8 -0
data/app/controllers/shopify_app/callback_controller.rb +195 -0
data/app/controllers/shopify_app/extension_verification_controller.rb +15 -0
data/app/controllers/shopify_app/sessions_controller.rb +202 -0
data/app/controllers/shopify_app/webhooks_controller.rb +36 -0
data/app/views/shopify_app/partials/_button_styles.html.erb +109 -0
data/app/views/shopify_app/partials/_card_styles.html.erb +33 -0
data/app/views/shopify_app/partials/_empty_state_styles.html.erb +98 -0
data/app/views/shopify_app/partials/_form_styles.html.erb +56 -0
data/app/views/shopify_app/partials/_layout_styles.html.erb +182 -0
data/app/views/shopify_app/partials/_typography_styles.html.erb +35 -0
data/app/views/shopify_app/sessions/enable_cookies.html.erb +70 -0
data/app/views/shopify_app/sessions/new.html.erb +51 -0
data/app/views/shopify_app/sessions/request_storage_access.html.erb +68 -0
data/app/views/shopify_app/sessions/top_level_interaction.html.erb +63 -0
data/app/views/shopify_app/shared/post_redirect_to_auth_shopify.html.erb +13 -0
data/app/views/shopify_app/shared/redirect.html.erb +23 -0
data/config/locales/cs.yml +23 -0
data/config/locales/da.yml +20 -0
data/config/locales/de.yml +22 -0
data/config/locales/en.yml +15 -0
data/config/locales/es.yml +22 -0
data/config/locales/fi.yml +20 -0
data/config/locales/fr.yml +23 -0
data/config/locales/it.yml +21 -0
data/config/locales/ja.yml +17 -0
data/config/locales/ko.yml +19 -0
data/config/locales/nb.yml +21 -0
data/config/locales/nl.yml +21 -0
data/config/locales/pl.yml +21 -0
data/config/locales/pt-BR.yml +21 -0
data/config/locales/pt-PT.yml +22 -0
data/config/locales/sv.yml +21 -0
data/config/locales/th.yml +20 -0
data/config/locales/tr.yml +22 -0
data/config/locales/vi.yml +22 -0
data/config/locales/zh-CN.yml +16 -0
data/config/locales/zh-TW.yml +16 -0
data/config/routes.rb +23 -0
data/docs/Quickstart.md +31 -0
data/docs/Releasing.md +21 -0
data/docs/Troubleshooting.md +159 -0
data/docs/Upgrading.md +132 -0
data/docs/shopify_app/authentication.md +124 -0
data/docs/shopify_app/engine.md +82 -0
data/docs/shopify_app/generators.md +127 -0
data/docs/shopify_app/handling-access-scopes-changes.md +24 -0
data/docs/shopify_app/script-tags.md +28 -0
data/docs/shopify_app/session-repository.md +88 -0
data/docs/shopify_app/testing.md +38 -0
data/docs/shopify_app/webhooks.md +72 -0
data/images/app-proxy-screenshot.png +0 -0
data/karma.conf.js +44 -0
data/lib/generators/shopify_app/add_after_authenticate_job/add_after_authenticate_job_generator.rb +47 -0
data/lib/generators/shopify_app/add_after_authenticate_job/templates/after_authenticate_job.rb +11 -0
data/lib/generators/shopify_app/add_marketing_activity_extension/add_marketing_activity_extension_generator.rb +40 -0
data/lib/generators/shopify_app/add_marketing_activity_extension/templates/marketing_activities_controller.rb +62 -0
data/lib/generators/shopify_app/add_webhook/add_webhook_generator.rb +69 -0
data/lib/generators/shopify_app/add_webhook/templates/webhook_job.rb.tt +13 -0
data/lib/generators/shopify_app/app_proxy_controller/app_proxy_controller_generator.rb +26 -0
data/lib/generators/shopify_app/app_proxy_controller/templates/app_proxy_controller.rb +8 -0
data/lib/generators/shopify_app/app_proxy_controller/templates/app_proxy_route.rb +11 -0
data/lib/generators/shopify_app/app_proxy_controller/templates/index.html.erb +19 -0
data/lib/generators/shopify_app/authenticated_controller/authenticated_controller_generator.rb +15 -0
data/lib/generators/shopify_app/authenticated_controller/templates/authenticated_controller.rb +5 -0
data/lib/generators/shopify_app/controllers/controllers_generator.rb +30 -0
data/lib/generators/shopify_app/home_controller/home_controller_generator.rb +53 -0
data/lib/generators/shopify_app/home_controller/templates/home_controller.rb +18 -0
data/lib/generators/shopify_app/home_controller/templates/index.html.erb +75 -0
data/lib/generators/shopify_app/home_controller/templates/unauthenticated_home_controller.rb +12 -0
data/lib/generators/shopify_app/install/install_generator.rb +121 -0
data/lib/generators/shopify_app/install/templates/_flash_messages.html.erb +3 -0
data/lib/generators/shopify_app/install/templates/embedded_app.html.erb +44 -0
data/lib/generators/shopify_app/install/templates/flash_messages.js +24 -0
data/lib/generators/shopify_app/install/templates/omniauth.rb +4 -0
data/lib/generators/shopify_app/install/templates/session_store.rb +4 -0
data/lib/generators/shopify_app/install/templates/shopify_app.js +15 -0
data/lib/generators/shopify_app/install/templates/shopify_app.rb.tt +25 -0
data/lib/generators/shopify_app/install/templates/shopify_app_importmap.js +13 -0
data/lib/generators/shopify_app/install/templates/shopify_app_index.js +2 -0
data/lib/generators/shopify_app/install/templates/shopify_provider.rb.tt +8 -0
data/lib/generators/shopify_app/install/templates/user_agent.rb +6 -0
data/lib/generators/shopify_app/products_controller/products_controller_generator.rb +19 -0
data/lib/generators/shopify_app/products_controller/templates/products_controller.rb +8 -0
data/lib/generators/shopify_app/rotate_shopify_token_job/rotate_shopify_token_job_generator.rb +16 -0
data/lib/generators/shopify_app/rotate_shopify_token_job/templates/rotate_shopify_token.rake +17 -0
data/lib/generators/shopify_app/rotate_shopify_token_job/templates/rotate_shopify_token_job.rb +42 -0
data/lib/generators/shopify_app/routes/routes_generator.rb +32 -0
data/lib/generators/shopify_app/routes/templates/routes.rb +12 -0
data/lib/generators/shopify_app/shop_model/shop_model_generator.rb +70 -0
data/lib/generators/shopify_app/shop_model/templates/db/migrate/add_shop_access_scopes_column.erb +5 -0
data/lib/generators/shopify_app/shop_model/templates/db/migrate/create_shops.erb +15 -0
data/lib/generators/shopify_app/shop_model/templates/shop.rb +8 -0
data/lib/generators/shopify_app/shop_model/templates/shops.yml +3 -0
data/lib/generators/shopify_app/shopify_app_generator.rb +18 -0
data/lib/generators/shopify_app/user_model/templates/db/migrate/add_user_access_scopes_column.erb +5 -0
data/lib/generators/shopify_app/user_model/templates/db/migrate/create_users.erb +16 -0
data/lib/generators/shopify_app/user_model/templates/user.rb +8 -0
data/lib/generators/shopify_app/user_model/templates/users.yml +4 -0
data/lib/generators/shopify_app/user_model/user_model_generator.rb +70 -0
data/lib/generators/shopify_app/views/views_generator.rb +30 -0
data/lib/shopify_app/access_scopes/noop_strategy.rb +13 -0
data/lib/shopify_app/access_scopes/shop_strategy.rb +24 -0
data/lib/shopify_app/access_scopes/user_strategy.rb +41 -0
data/lib/shopify_app/configuration.rb +119 -0
data/lib/shopify_app/controller_concerns/app_proxy_verification.rb +38 -0
data/lib/shopify_app/controller_concerns/csrf_protection.rb +15 -0
data/lib/shopify_app/controller_concerns/embedded_app.rb +20 -0
data/lib/shopify_app/controller_concerns/itp.rb +45 -0
data/lib/shopify_app/controller_concerns/localization.rb +23 -0
data/lib/shopify_app/controller_concerns/login_protection.rb +259 -0
data/lib/shopify_app/controller_concerns/payload_verification.rb +24 -0
data/lib/shopify_app/controller_concerns/webhook_verification.rb +23 -0
data/lib/shopify_app/engine.rb +47 -0
data/lib/shopify_app/jobs/scripttags_manager_job.rb +16 -0
data/lib/shopify_app/jobs/webhooks_manager_job.rb +16 -0
data/lib/shopify_app/managers/scripttags_manager.rb +78 -0
data/lib/shopify_app/managers/webhooks_manager.rb +62 -0
data/lib/shopify_app/middleware/jwt_middleware.rb +43 -0
data/lib/shopify_app/middleware/same_site_cookie_middleware.rb +34 -0
data/lib/shopify_app/omniauth/omniauth_configuration.rb +64 -0
data/lib/shopify_app/session/in_memory_session_store.rb +31 -0
data/lib/shopify_app/session/in_memory_shop_session_store.rb +16 -0
data/lib/shopify_app/session/in_memory_user_session_store.rb +16 -0
data/lib/shopify_app/session/jwt.rb +67 -0
data/lib/shopify_app/session/null_user_session_store.rb +22 -0
data/lib/shopify_app/session/session_repository.rb +56 -0
data/lib/shopify_app/session/session_storage.rb +20 -0
data/lib/shopify_app/session/shop_session_storage.rb +42 -0
data/lib/shopify_app/session/shop_session_storage_with_scopes.rb +58 -0
data/lib/shopify_app/session/user_session_storage.rb +42 -0
data/lib/shopify_app/session/user_session_storage_with_scopes.rb +58 -0
data/lib/shopify_app/test_helpers/all.rb +2 -0
data/lib/shopify_app/test_helpers/webhook_verification_helper.rb +17 -0
data/lib/shopify_app/utils.rb +37 -0
data/lib/shopify_app/version.rb +4 -0
data/lib/shopify_app.rb +80 -0
data/package.json +27 -0
data/service.yml +4 -0
data/shipit.rubygems.yml +4 -0
data/shopify_app.gemspec +39 -0
data/translation.yml +7 -0
data/webpack.config.js +24 -0
data/yarn.lock +5230 -0
metadata +465 -0

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+class HomeController < AuthenticatedController
+  include ShopifyApp::ShopAccessScopesVerification
+  before_action :set_host
+  def index
+    @products = ShopifyAPI::Product.find(:all, params: { limit: 10 })
+    @webhooks = ShopifyAPI::Webhook.find(:all)
+  end
+  private
+  def set_host
+    @host = params[:host]
+  end
+end

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

@@ -0,0 +1,75 @@
+<!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() {
+        <% if ShopifyApp.use_importmap? %>
+          await import("lib/shopify_app")
+        <% end %>
+        var SessionToken = window["app-bridge"].actions.SessionToken
+        var app = window.app;
+        app.dispatch(
+          SessionToken.request(),
+        );
+        // Save a session token for future requests
+        window.sessionToken = await new Promise((resolve) => {
+          app.subscribe(SessionToken.Action.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 ADDED Viewed

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

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

@@ -0,0 +1,121 @@
+# 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
+      class_option :with_cookie_authentication, type: :boolean, default: false
+      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
+        return if !Rails.env.test? && shopify_provider_exists?
+        inject_into_file(
+          'config/initializers/omniauth.rb',
+          shopify_provider_template,
+          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")
+        elsif ShopifyApp.use_importmap?
+          copy_file('shopify_app_importmap.js', 'app/javascript/lib/shopify_app.js')
+          copy_file('flash_messages.js', 'app/javascript/lib/flash_messages.js')
+          append_to_file('config/importmap.rb', "pin_all_from \"app/javascript/lib\", under: \"lib\"\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 []) << /\[-\\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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -0,0 +1,44 @@
+<!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' %>
+    <% elsif ShopifyApp.use_importmap? %>
+      <%= javascript_importmap_tags %>
+    <% 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@2"></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),
+      host: @host,
+      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 ADDED Viewed

@@ -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 ADDED Viewed

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

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

@@ -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 ADDED Viewed

@@ -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,
+    host: data.host,
+  });
+  var actions = AppBridge.actions;
+  var TitleBar = actions.TitleBar;
+  TitleBar.create(app, {
+    title: data.page,
+  });
+});

data/lib/generators/shopify_app/install/templates/shopify_app.rb.tt ADDED Viewed

@@ -0,0 +1,25 @@
+ShopifyApp.configure do |config|
+  config.application_name = "<%= @application_name %>"
+  config.old_secret = "<%= @old_secret %>"
+  config.scope = "<%= @scope %>" # Consult this page for more scope options:
+                                  # https://help.shopify.com/en/api/getting-started/authentication/oauth/scopes
+  config.embedded_app = <%= embedded_app? %>
+  config.after_authenticate_job = false
+  config.api_version = "<%= @api_version %>"
+  config.shop_session_repository = 'Shop'
+  config.reauth_on_access_scope_changes = true
+  config.allow_jwt_authentication = <%= !with_cookie_authentication? %>
+  config.allow_cookie_authentication = <%= with_cookie_authentication? %>
+  config.api_key = ENV.fetch('SHOPIFY_API_KEY', '').presence
+  config.secret = ENV.fetch('SHOPIFY_API_SECRET', '').presence
+  if defined? Rails::Server
+    raise('Missing SHOPIFY_API_KEY. See https://github.com/Shopify/shopify_app#requirements') unless config.api_key
+    raise('Missing SHOPIFY_API_SECRET. See https://github.com/Shopify/shopify_app#requirements') unless config.secret
+  end
+end
+# ShopifyApp::Utils.fetch_known_api_versions                        # Uncomment to fetch known api versions from shopify servers on boot
+# ShopifyAPI::ApiVersion.version_lookup_mode = :raise_on_unknown    # Uncomment to raise an error if attempting to use an api version that was not previously known

data/lib/generators/shopify_app/install/templates/shopify_app_importmap.js ADDED Viewed

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

data/lib/generators/shopify_app/install/templates/shopify_app_index.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ require('./shopify_app')
2	+ require('./flash_messages')

data/lib/generators/shopify_app/install/templates/shopify_provider.rb.tt ADDED Viewed

@@ -0,0 +1,8 @@
+  provider :shopify,
+      ShopifyApp.configuration.api_key,
+      ShopifyApp.configuration.secret,
+      scope: ShopifyApp.configuration.scope,
+      setup: lambda { |env|
+        configuration = ShopifyApp::OmniAuthConfiguration.new(env['omniauth.strategy'], Rack::Request.new(env))
+        configuration.build_options
+      }

data/lib/generators/shopify_app/install/templates/user_agent.rb ADDED Viewed

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module ShopifyAPI
+  class Base < ActiveResource::Base
+    headers['User-Agent'] << " | ShopifyApp/#{ShopifyApp::VERSION}"
+  end
+end

data/lib/generators/shopify_app/products_controller/products_controller_generator.rb ADDED Viewed

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+module ShopifyApp
+  module Generators
+    class ProductsControllerGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      def create_products_controller
+        template('products_controller.rb', 'app/controllers/products_controller.rb')
+      end
+      def add_products_route
+        route("get '/products', :to => 'products#index'")
+      end
+    end
+  end
+end

data/lib/generators/shopify_app/products_controller/templates/products_controller.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+class ProductsController < AuthenticatedController
+  def index
+    @products = ShopifyAPI::Product.find(:all, params: { limit: 10 })
+    render(json: { products: @products })
+  end
+end

data/lib/generators/shopify_app/rotate_shopify_token_job/rotate_shopify_token_job_generator.rb ADDED Viewed

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+module ShopifyApp
+  module Generators
+    class RotateShopifyTokenJobGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      def add_rotate_shopify_token_job
+        copy_file('rotate_shopify_token_job.rb', "app/jobs/shopify/rotate_shopify_token_job.rb")
+        copy_file('rotate_shopify_token.rake', "lib/tasks/shopify/rotate_shopify_token.rake")
+      end
+    end
+  end
+end

data/lib/generators/shopify_app/rotate_shopify_token_job/templates/rotate_shopify_token.rake ADDED Viewed

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+namespace :shopify do
+  desc "Rotate shopify tokens for all active shops"
+  task :rotate_shopify_tokens, [:refresh_token] => :environment do |_t, args|
+    all_active_shops.find_each do |shop|
+      Shopify::RotateShopifyTokenJob.perform_later(
+        shop_domain: shop.shopify_domain,
+        refresh_token: args[:refresh_token]
+      )
+    end
+  end
+  # Its implementation will depend on the app configuration. Change accordingly.
+  def all_active_shops
+    Shop.all
+  end
+end

data/lib/generators/shopify_app/rotate_shopify_token_job/templates/rotate_shopify_token_job.rb ADDED Viewed

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module Shopify
+  class RotateShopifyTokenJob < ActiveJob::Base
+    def perform(params)
+      @shop = Shop.find_by(shopify_domain: params[:shop_domain])
+      return unless @shop
+      config = ShopifyApp.configuration
+      uri = URI("https://#{@shop.shopify_domain}/admin/oauth/access_token")
+      post_data = {
+        client_id: config.api_key,
+        client_secret: config.secret,
+        refresh_token: params[:refresh_token],
+        access_token: @shop.shopify_token,
+      }
+      @response = Net::HTTP.post_form(uri, post_data)
+      return log_error(response_exception_error_message) unless @response.is_a?(Net::HTTPSuccess)
+      access_token = JSON.parse(@response.body)['access_token']
+      return log_error(no_access_token_error_message) unless access_token
+      @shop.update(shopify_token: access_token)
+    end
+    private
+    def log_error(message)
+      Rails.logger.error(message)
+    end
+    def no_access_token_error_message
+      "RotateShopifyTokenJob response returned no access token for shop: #{@shop.shopify_domain}"
+    end
+    def response_exception_error_message
+      "RotateShopifyTokenJob failed for shop: #{@shop.shopify_domain}." \
+        "Response returned status: #{@response.code}. Error message: #{@response.message}. "
+    end
+  end
+end

data/lib/generators/shopify_app/routes/routes_generator.rb ADDED Viewed

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+module ShopifyApp
+  module Generators
+    class RoutesGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      def inject_shopify_app_routes_into_application_routes
+        route(session_routes)
+      end
+      def disable_engine_routes
+        gsub_file(
+          'config/routes.rb',
+          "mount ShopifyApp::Engine, at: '/'",
+          ''
+        )
+      end
+      private
+      def session_routes
+        File.read(routes_file_path)
+      end
+      def routes_file_path
+        File.expand_path(find_in_source_paths('routes.rb'))
+      end
+    end
+  end
+end

data/lib/generators/shopify_app/routes/templates/routes.rb ADDED Viewed

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+controller :sessions do
+  get 'login' => :new, :as => :login
+  post 'login' => :create, :as => :authenticate
+  get 'auth/shopify/callback' => :callback
+  get 'logout' => :destroy, :as => :logout
+end
+namespace :webhooks do
+  post ':type' => :receive
+end

data/lib/generators/shopify_app/shop_model/shop_model_generator.rb ADDED Viewed

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+require 'rails/generators/active_record'
+module ShopifyApp
+  module Generators
+    class ShopModelGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      class_option :new_shopify_cli_app, type: :boolean, default: false
+      def create_shop_model
+        copy_file('shop.rb', 'app/models/shop.rb')
+      end
+      def create_shop_migration
+        migration_template('db/migrate/create_shops.erb', 'db/migrate/create_shops.rb')
+      end
+      def create_shop_with_access_scopes_migration
+        scopes_column_prompt = <<~PROMPT
+          It is highly recommended that apps record the access scopes granted by \
+          merchants during app installation. See app/models/shop.rb to modify how \
+          access scopes are stored and retrieved.
+          [WARNING] You will need to update the access_scopes accessors in the Shop model \
+          to allow shopify_app to store and retrieve scopes when going through OAuth.
+          The following migration will add an `access_scopes` column to the Shop model. \
+          Do you want to include this migration? [y/n]
+        PROMPT
+        if new_shopify_cli_app? || Rails.env.test? || yes?(scopes_column_prompt)
+          migration_template(
+            'db/migrate/add_shop_access_scopes_column.erb',
+            'db/migrate/add_shop_access_scopes_column.rb'
+          )
+        end
+      end
+      def update_shopify_app_initializer
+        gsub_file('config/initializers/shopify_app.rb', 'ShopifyApp::InMemoryShopSessionStore', 'Shop')
+      end
+      def create_shop_fixtures
+        copy_file('shops.yml', 'test/fixtures/shops.yml')
+      end
+      private
+      def new_shopify_cli_app?
+        options['new_shopify_cli_app']
+      end
+      def rails_migration_version
+        Rails.version.match(/\d\.\d/)[0]
+      end
+      class << self
+        private :next_migration_number
+        # for generating a timestamp when using `create_migration`
+        def next_migration_number(dir)
+          ActiveRecord::Generators::Base.next_migration_number(dir)
+        end
+      end
+    end
+  end
+end

data/lib/generators/shopify_app/shop_model/templates/db/migrate/add_shop_access_scopes_column.erb ADDED Viewed

@@ -0,0 +1,5 @@
+class AddShopAccessScopesColumn < ActiveRecord::Migration[<%= rails_migration_version %>]
+  def change
+    add_column :shops, :access_scopes, :string
+  end
+end

data/lib/generators/shopify_app/shop_model/templates/db/migrate/create_shops.erb ADDED Viewed

@@ -0,0 +1,15 @@
+class CreateShops < ActiveRecord::Migration[<%= rails_migration_version %>]
+  def self.up
+    create_table :shops  do |t|
+      t.string :shopify_domain, null: false
+      t.string :shopify_token, null: false
+      t.timestamps
+    end
+    add_index :shops, :shopify_domain, unique: true
+  end
+  def self.down
+    drop_table :shops
+  end
+end

data/lib/generators/shopify_app/shop_model/templates/shop.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+class Shop < ActiveRecord::Base
+  include ShopifyApp::ShopSessionStorageWithScopes
+  def api_version
+    ShopifyApp.configuration.api_version
+  end
+end

data/lib/generators/shopify_app/shop_model/templates/shops.yml ADDED Viewed

@@ -0,0 +1,3 @@
+regular_shop:
+  shopify_domain: 'regular-shop.myshopify.com'
+  shopify_token: 'token'