shopify_app 13.5.0

data/config/locales/pt-PT.yml

@@ -0,0 +1,22 @@
+---
+pt-PT:
+  logged_out: Terminou a sessão com sucesso
+  could_not_log_in: Não foi possível iniciar sessão na loja da Shopify
+  invalid_shop_url: Domínio de loja inválido
+  enable_cookies_heading: Ativar cookies de %{app}
+  enable_cookies_body: Tem de ativar manualmente os cookies neste navegador para utilizar
+    %{app} dentro da Shopify.
+  enable_cookies_footer: Os cookies permitem que a aplicação o autentique armazenando
+    temporariamente as suas preferências e informações pessoais. Expiram ao fim de
+    30 dias.
+  enable_cookies_action: Ativar cookies
+  top_level_interaction_heading: O seu navegador tem de autenticar %{app}
+  top_level_interaction_body: O seu navegador exige que aplicações como %{app} lhe
+    solicitem o acesso de cookies, antes que a Shopify as possa abrir.
+  top_level_interaction_action: Continuar
+  request_storage_access_heading: "%{app} tem de aceder a cookies"
+  request_storage_access_body: Isto permite que a aplicação o autentique armazenando
+    temporariamente as suas informações pessoais. Clique em continuar e permita os
+    cookies para utilizar a aplicação.
+  request_storage_access_footer: Os cookies expiram ao fim de 30 dias.
+  request_storage_access_action: Continuar

data/config/locales/sv.yml

@@ -0,0 +1,21 @@
+---
+sv:
+  logged_out: Har loggats ut
+  could_not_log_in: Det gick inte att logga in i Shopify-butiken
+  invalid_shop_url: Ogiltig butiksdomän
+  enable_cookies_heading: Aktivera cookies från %{app}
+  enable_cookies_body: Du måste aktivera cookies manuellt i den här webbläsaren för
+    att kunna använda %{app} inom Shopify.
+  enable_cookies_footer: Cookies låter appen autentisera dig genom att tillfälligt
+    lagra dina inställningar och personuppgifter. De upphör efter 30 dagar.
+  enable_cookies_action: Aktivera cookies
+  top_level_interaction_heading: Din webbläsare måste verifiera %{app}
+  top_level_interaction_body: Din webbläsare kräver att appar som %{app} frågar dig
+    om tillgång till cookies innan Shopify kan öppna den för dig.
+  top_level_interaction_action: Fortsätt
+  request_storage_access_heading: "%{app} behöver tillgång till cookies"
+  request_storage_access_body: Detta gör det möjligt för appen att autentisera dig
+    genom att tillfälligt lagra din personliga information. Klicka på fortsätt och
+    tillåta cookies att använda appen.
+  request_storage_access_footer: Cookies upphör efter 30 dagar.
+  request_storage_access_action: Fortsätt

data/config/locales/th.yml

@@ -0,0 +1,20 @@
+---
+th:
+  logged_out: ออกจากระบบสำเร็จ
+  could_not_log_in: ไม่สามารถเข้าสู่ระบบร้านค้า Shopify ได้
+  invalid_shop_url: โดเมนร้านค้าไม่ถูกต้อง
+  enable_cookies_heading: เปิดใช้งานคุกกี้จาก %{app}
+  enable_cookies_body: คุณต้องเปิดใช้งานคุกกี้ด้วยตนเองในเบราว์เซอร์นี้เพื่อใช้งาน
+    %{app} ภายใน Shopify
+  enable_cookies_footer: คุกกี้ช่วยให้แอปตรวจสอบความถูกต้องของคุณด้วยการจัดเก็บความชื่นชอบและข้อมูลส่วนตัวของคุณชั่วคราว
+    คุกกี้จะหมดอายุหลังจาก 30 วัน
+  enable_cookies_action: เปิดใช้งานคุกกี้
+  top_level_interaction_heading: เบราว์เซอร์ของคุณต้องรับรองความถูกต้องของ %{app}
+  top_level_interaction_body: เบราว์เซอร์ของคุณต้องการแอปอย่าง %{app} เพื่อขอให้คุณเข้าถึงคุกกี้ก่อนที่
+    Shopify จะสามารถเปิดมันให้คุณได้
+  top_level_interaction_action: ดำเนินการต่อ
+  request_storage_access_heading: "%{app} ต้องการสิทธิ์การเข้าถึงคุกกี้"
+  request_storage_access_body: สิ่งนี้ช่วยให้แอปตรวจสอบความถูกต้องของคุณด้วยการจัดเก็บข้อมูลส่วนตัวของคุณชั่วคราว
+    คลิกดำเนินการต่อและอนุญาตให้คุกกี้ใช้แอป
+  request_storage_access_footer: คุกกี้จะหมดอายุหลังจาก 30 วัน
+  request_storage_access_action: ดำเนินการต่อ

data/config/locales/tr.yml

@@ -0,0 +1,22 @@
+---
+tr:
+  logged_out: Oturum başarıyla kapatıldı
+  could_not_log_in: Shopify mağazasında oturum açılamadı
+  invalid_shop_url: Geçersiz mağaza alan adı
+  enable_cookies_heading: "%{app} uygulamasından çerezleri etkinleştir"
+  enable_cookies_body: "%{app} uygulamasını Shopify içinde kullanabilmek için bu tarayıcıda
+    çerezleri manuel olarak etkinleştirmelisiniz."
+  enable_cookies_footer: Çerezler, tercihlerinizi ve kişisel bilgilerinizi geçici
+    olarak saklayıp uygulamanın kimliğinizi doğrulamasına imkan tanır. Çerezlerin
+    süresi 30 gün sonra sonra sona erer.
+  enable_cookies_action: Çerezleri etkinleştir
+  top_level_interaction_heading: Tarayıcınızın %{app} kimliğini doğrulaması gerekiyor
+  top_level_interaction_body: Tarayıcınız, Shopify tarafından açılmadan önce %{app}
+    gibi uygulamaların sizden çerezlere erişim izni istemesini zorunlu tutuyor.
+  top_level_interaction_action: Devam
+  request_storage_access_heading: "%{app} uygulamasının çerezlere erişmesi gerekiyor"
+  request_storage_access_body: Böylece uygulama, kişisel bilgilerinizi geçici olarak
+    saklayıp kimliğinizi doğrulayabilir. Devam et'e tıklayın ve çerezlerin uygulamayı
+    kullanmasına izin verin.
+  request_storage_access_footer: Çerezlerin süresi 30 gün sonra sonra sona erer.
+  request_storage_access_action: Devam

data/config/locales/zh-CN.yml

@@ -0,0 +1,16 @@
+---
+zh-CN:
+  logged_out: 已成功退出
+  could_not_log_in: 无法登录到 Shopify 商店
+  invalid_shop_url: 商店域名无效
+  enable_cookies_heading: 从 %{app} 启用 Cookie
+  enable_cookies_body: 您必须在此浏览器中手动启用 Cookie 才能在 Shopify 中使用 %{app}。
+  enable_cookies_footer: Cookie 使此应用能够通过暂时存储您的偏好设置和个人信息来验证您的身份。这些信息将在 30 天后过期。
+  enable_cookies_action: 启用 Cookie
+  top_level_interaction_heading: 您的浏览器需要对 %{app} 进行验证
+  top_level_interaction_body: 您的浏览器要求类似 %{app} 的应用向您请求访问 Cookie，之后 Shopify 才能为您打开它。
+  top_level_interaction_action: 继续
+  request_storage_access_heading: "%{app} 需要访问 Cookie"
+  request_storage_access_body: 这使此应用能够通过暂时存储您的个人信息来验证您的身份。单击继续并启用 Cookie 以使用此应用。
+  request_storage_access_footer: Cookie 将在 30 天后过期。
+  request_storage_access_action: 继续

data/config/locales/zh-TW.yml

@@ -0,0 +1,16 @@
+---
+zh-TW:
+  logged_out: 登出成功
+  could_not_log_in: 無法登入 Shopify 商店
+  invalid_shop_url: 商店網域無效
+  enable_cookies_heading: 啟用 %{app} 的 Cookie
+  enable_cookies_body: 您必須在此瀏覽器中手動啟用 Cookie，才能夠在 Shopify 使用 %{app}。
+  enable_cookies_footer: Cookie 可讓應用程式暫時儲存您的偏好設定和個人資訊，藉此驗證您的身分，這些資料會在 30 天後失效。
+  enable_cookies_action: 啟用 Cookie
+  top_level_interaction_heading: 您的瀏覽器需要驗證 %{app}
+  top_level_interaction_body: 您的瀏覽器要求 %{app} 等應用程式向您請求 Cookie 的存取權限，才能讓 Shopify 為您開啟該應用程式。
+  top_level_interaction_action: 繼續
+  request_storage_access_heading: "%{app} 需要 Cookie 存取權限"
+  request_storage_access_body: Cookie 可讓應用程式暫時儲存您的個人資訊，藉此驗證您的身分。按一下繼續並允許 Cookie 使用此應用程式。
+  request_storage_access_footer: Cookie 將於 30 天後失效。
+  request_storage_access_action: 繼續

data/config/routes.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+ShopifyApp::Engine.routes.draw do
+  controller :sessions do
+    get 'login' => :new, :as => :login
+    post 'login' => :create, :as => :authenticate
+    get 'enable_cookies' => :enable_cookies, :as => :enable_cookies
+    get 'top_level_interaction' =>
+      :top_level_interaction,
+        :as => :top_level_interaction
+    get 'granted_storage_access' =>
+      :granted_storage_access,
+        :as => :granted_storage_access
+    get 'logout' => :destroy, :as => :logout
+  end
+
+  controller :callback do
+    get 'auth/shopify/callback' => :callback
+  end
+
+  namespace :webhooks do
+    post ':type' => :receive
+  end
+end

data/docs/Quickstart.md

@@ -0,0 +1,93 @@
+Quickstart
+==========
+
+Get started building and deploying a new Shopify App to Heroku in just a few minutes.
+This guide assumes you have Ruby, Rails and PostgreSQL installed on your computer already; if you haven't done that already start with [this guide.](https://guides.rubyonrails.org/v5.0/getting_started.html#installing-rails)
+
+1. New Rails App (with postgres)
+--------------------------------
+
+To create a new Rails app and use this generator, open your terminal and run the following commands:
+
+```sh
+$ rails new test-app --database=postgresql
+$ cd test-app
+$ git init
+$ git add .
+$ git commit -m 'new rails app'
+```
+
+2. Create a new Heroku app
+--------------------------
+
+The next step is to create a new Heroku app to host your application. If you haven't got a Heroku account yet, create a free account [here](https://www.heroku.com/). 
+
+Head to the Heroku dashboard and create a new app, or run the following commands with the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli#download-and-install) installed, substituting `name` for the name of your own app:
+
+CLI:
+```sh
+$ heroku create name
+```
+
+3. Create a new App in the Shopify Partner dashboard
+-----------------------------------------
+* Create a Shopify app in the [Partners dashboard](https://partner.shopify.com). For this tutorial, you can choose either a public or custom app, but you can [learn about App Types here.](https://help.shopify.com/en/manual/apps/app-types)
+[https://app.shopify.com/services/partners/api_clients](https://app.shopify.com/services/partners/api_clients)
+* Set the callback url to `https://<appname>.herokuapp.com/`
+* Choose an embedded app
+* Set the app's `redirect_uri` to `https://<appname>.herokuapp.com/auth/shopify/callback`
+
+4. Add ShopifyApp to Gemfile
+----------------------------
+
+Run this command to add the `shopify_app` Gem to your app:
+
+```sh
+$ bundle add shopify_app
+```
+
+**Note:** we recommend using the latest version of Shopify Gem. Check the [Git tags](https://github.com/Shopify/shopify_app/tags) to see the latest release version and then add it to your Gemfile e.g `gem 'shopify_app', '~> 7.0.0'`
+
+5. Run the ShopifyApp generator
+-------------------------------
+
+Generate the code for your app by running these commands: 
+
+```sh
+# Use the keys from your app you created in the partners area
+$ rails generate shopify_app
+$ git add .
+$ git commit -m 'generated shopify app'
+```
+
+Your API key and secret are read from environment variables. Refer to the main
+README for further details on how to set this up.
+
+6. Deploy your app
+---------
+
+Once you've generated your app, push it into your Heroku environment to see it up and running:
+```sh
+$ git push heroku
+$ heroku run rake db:migrate
+```
+
+7. Install the App!
+-------------------
+
+Ensure you have created a [development store](https://help.shopify.com/en/api/getting-started/making-your-first-request#create-a-development-store) using the Shopify Partner Dashboard. If you don't already have one, [create one by following these instructions](https://help.shopify.com/en/api/getting-started/making-your-first-request#create-a-development-store).
+
+##### Note: The following step will cause your store to become `transfer-disabled.` Read more about store transfer and why it's important [here](https://help.shopify.com/en/api/guides/store-transfers#transfer-disabled-stores). This is an irreversible change, so be sure you don't plan to transfer this store to a merchant.
+
+Install the app onto your new development store using the Partner Dashboard. Log in to your account, visit the apps page, click the app you created earlier, and looking for the `Test your app` instructions where you can select a store to install your app on.
+
+![Installing an app on the partners dashboard dropdown](/docs/install-on-dev-shop.png)
+
+### OR
+
+![Installing an app on the partners dashboard card](/docs/test-your-app.png)
+
+8. Great work! 
+-------------------
+
+You're done creating your first app on Shopify. Keep going and learn more by [diving into our full documentation](https://help.shopify.com/en/api/getting-started), or join our [community of developers.](https://community.shopify.com/c/Shopify-Apps/bd-p/shopify-apps)

data/docs/Releasing.md

@@ -0,0 +1,18 @@
+Releasing ShopifyApp
+
+1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org
+2. Create a pull request with the following changes:
+  * Update the version of ShopifyApp in lib/shopify_app/version.rb
+  * Update the version of shopify_app in package.json
+  * Add a CHANGELOG entry for the new release with the date
+  * Change the title of the PR to something like: "Packaging for release X.Y.Z"
+3. Merge your pull request
+4. Pull from master so you have the latest version of the shopify_app
+5. Tag the HEAD with the version (Leave REV blank for HEAD or provide a SHA)
+  $ git tag vX.Y.Z
+6. Push out your tags
+  $ git push --tags
+7. Use Shipit to build and push the gem
+
+If you see an error like 'You need to create the vX.Y.X tag first', clear GIT
+cache in Shipit settings

data/docs/Troubleshooting.md

@@ -0,0 +1,16 @@
+Troubleshooting Shopify App
+===========
+
+### Generator shopify_app:install hangs
+
+Rails uses spring by default to speed up development. To run the generator, spring has to be stopped:
+
+```sh
+$ bundle exec spring stop
+```
+
+Run shopify_app generator again.
+
+### App installation fails with 'The page you’re looking for could not be found' if the app was installed before
+
+This issue can occur when the session (the model you set as `ShopifyApp::SessionRepository.storage`) isn't deleted when the user uninstalls your app. A possible fix for this is listening to the `app/uninstalled` webhook and deleting the corresponding session in the webhook handler.

data/karma.conf.js

@@ -0,0 +1,44 @@
+const karmaReporters = ['mocha-clean'];
+
+function isDebug(argument) {
+  return argument === '--debug';
+}
+
+module.exports = function(config) {
+  config.set({
+    mode: 'development',
+    basePath: '',
+    frameworks: ['mocha-debug', 'mocha', 'chai-sinon'],
+    files: [
+      'app/assets/javascripts/**/*.js',
+      'test/javascripts/**/*test.js',
+    ],
+    exclude: [
+      // Exclude JS files that create 'DOMContentLoaded' event listeners
+      'app/assets/javascripts/**/redirect.js',
+      'app/assets/javascripts/**/storage_access_redirect.js',
+      'app/assets/javascripts/**/top_level_interaction.js',
+      'app/assets/javascripts/**/partition_cookies.js',
+    ],
+    mochaReporter: {
+      output: 'autowatch',
+    },
+    preprocessors: {
+      'test/javascripts/**/*test.js': ['webpack'],
+    },
+    webpack: {},
+    reporters: karmaReporters,
+    port: 9876,
+    colors: true,
+    logLevel: config.LOG_WARN,
+    autoWatch: false,
+    browsers: ['ChromeHeadless'],
+    singleRun: true,
+    client: {
+      mocha: {
+        ui: 'tdd',
+        grep: config.grep,
+      },
+    },
+  });
+};

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+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_authenticate_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,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