shopify_app 11.1.0 → 11.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5efea1849894001dd33e89e8beaab22dc7630f383a263b1638b2e316478c4927
-  data.tar.gz: f6b8fb40731e82c83ebb57548814a9ea6aa5691691606c50fa986191b00f092f
+  metadata.gz: '097ed8c5a4e2712571c38ab110dba580e6c80dd6af95d04414d489e16366653f'
+  data.tar.gz: 7f95f2cd5100b9952cef6a40b68cb778bfa4be6753f9693f7c6ff6df18615014
 SHA512:
-  metadata.gz: 7d278a7a7dc385940cbfdaa832d7e05f69f31c5bb57ce007f0a776ed1d926682fb36f88de490b63d9208ccca50b39e30057c3c14d3056d80301fed95468484c4
-  data.tar.gz: ec1ebf4b962a4cfde1abf6d771caa0e7910ef04cbaade77961f97234799b3db4a21d799434bf20d12b3d00653b59f923871fe03d6132efa880d092d7f2ebb9be
+  metadata.gz: '08c2495dac07fc430e8583c196e06af804905b3de7d6e7d7eed4bcc29a131d635caacc82f4a0619b7f7170be77d2069df6602379d413eb1f273a64dd9c79486d'
+  data.tar.gz: 3a559f4426151c91fd16eb1125a8b910a68ac4abe1b6601a5234a1e3c91969d4227eca31acae7a27171c0c0004cd8af1e17f6e9aebac60957119f4f211d895b4

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+11.4.0
+-----
+* Remove `dotenv-rails` dependency. [#835](https://github.com/Shopify/shopify_app/pull/835)
+
+11.3.2
+-----
+* Fix hosts generator in Rails 5 [#823](https://github.com/Shopify/shopify_app/pull/823)
+
+11.3.1
+-----
+* Bump browser_sniffer version to 1.1.3 [#824](https://github.com/Shopify/shopify_app/pull/824)
+
+11.3.0
+-----
+* Update assets to be compatible with Rails 6 [#808](https://github.com/Shopify/shopify_app/pull/808)
+
+11.2.1
+-----
+* Adds ngrok whitelist in development [#802](https://github.com/Shopify/shopify_app/pull/802)
+
+11.2.0
+-----
+
+* Bump omniauth-shopify-oauth2 gem to v2.2.0
+
 11.1.0
 -----
 

data/README.md

@@ -457,6 +457,23 @@ Questions or problems?
 - [Ask questions!](https://ecommerce.shopify.com/c/shopify-apis-and-technology)
 - [Read the docs!](https://help.shopify.com/api/guides)
 
+Rails 6 Compatibility
+---------------------------
+
+### Disable Webpacker
+If you are using sprockets in rails 6 or want to generate a shopify_app without webpacker run the install task by running
+
+```
+SHOPIFY_APP_DISABLE_WEBPACKER=1 rails generate shopify_app
+```
+
+and then in your ShopifyApp configuration block, add
+
+```
+ShopifyApp.configure do |config|
+  config.disable_webpacker = true
+end
+```
 
 Upgrading from 8.6 to 9.0.0
 ---------------------------

data/config/locales/cs.yml

@@ -4,20 +4,20 @@ cs:
   could_not_log_in: Nelze se přihlásit do obchodu Shopify
   invalid_shop_url: Neplatná doména obchodu
   enable_cookies_heading: Zapnout soubory cookie z aplikace %{app}
-  enable_cookies_body: Pokud chceš v Shopify používat aplikaci %{app}, musíš soubory
+  enable_cookies_body: Pokud chcete v Shopify používat aplikaci %{app}, musíte soubory
     cookie v tomto prohlížeči povolit ručně.
-  enable_cookies_footer: Soubory cookie umožňují, aby tě aplikace ověřila pomocí dočasného
-    uchování preferencí a osobních údajů. Jejich platnost vyprší po 30 dnech.
+  enable_cookies_footer: Soubory cookie umožňují, aby vás aplikace ověřila pomocí
+    dočasného uchování preferencí a osobních údajů. Jejich platnost vyprší po 30 dnech.
   enable_cookies_action: Povolit soubory cookie
-  top_level_interaction_heading: Tvůj prohlížeč potřebuje ověřit aplikaci %{app}
-  top_level_interaction_body: Tvůj prohlížeč vyžaduje, aby si od tebe aplikace, jako
-    je %{app}, nejdřív vyžádaly přístup k souborům cookie, než je pro tebe Shopify
+  top_level_interaction_heading: Váš prohlížeč potřebuje ověřit aplikaci %{app}
+  top_level_interaction_body: Váš prohlížeč vyžaduje, aby si od vás aplikace, jako
+    je %{app}, nejdřív vyžádaly přístup k souborům cookie, než je pro vás Shopify
     otevře.
   top_level_interaction_action: Pokračovat
   request_storage_access_heading: Aplikace %{app} potřebuje získat přístup k souborům
     cookie
-  request_storage_access_body: Tato aplikace ti umožní ověření prostřednictvím dočasného
-    uchování tvých osobních údajů. Pokud chceš používat tuto aplikaci, klikni na tlačítko
-    Pokračovat a povol soubory cookie.
+  request_storage_access_body: Tato aplikace vám umožní ověření prostřednictvím dočasného
+    uchování vašich osobních údajů. Pokud chcete používat tuto aplikaci, klikněte
+    na tlačítko Pokračovat a povolte soubory cookie.
   request_storage_access_footer: Platnost souborů cookie vyprší po 30 dnech.
   request_storage_access_action: Pokračovat

data/config/locales/de.yml

@@ -7,7 +7,7 @@ de:
   enable_cookies_body: Sie müssen Cookies in diesem Browser manuell aktivieren, um
     %{app} in Shopify verwenden zu können.
   enable_cookies_footer: Mithilfe von Cookies kann die App Sie authentifizieren, indem
-    Ihre Einstellungen und persönlichen Informationen vorübergehend gespeichert werden.
+    Ihre Einstellungen und personenbezogenen Daten vorübergehend gespeichert werden.
     Sie laufen nach 30 Tagen ab.
   enable_cookies_action: Cookies aktivieren
   top_level_interaction_heading: Ihr Browser muss %{app} authentifizieren
@@ -16,7 +16,7 @@ de:
   top_level_interaction_action: Weiter
   request_storage_access_heading: "%{app} braucht Zugriff auf Cookies"
   request_storage_access_body: Damit kann die App Sie authentifizieren, indem Ihre
-    Einstellungen und persönlichen Informationen vorübergehend gespeichert werden.
-    Klicken Sie auf "Weiter" und erlauben Sie den Cookies, die App zu verwenden.
+    Einstellungen und personenbezogenen Daten vorübergehend gespeichert werden. Klicken
+    Sie auf "Weiter" und erlauben Sie den Cookies, die App zu verwenden.
   request_storage_access_footer: Cookies laufen nach 30 Tagen ab.
   request_storage_access_action: Weiter

data/config/locales/es.yml

@@ -1,7 +1,7 @@
 ---
 es:
   logged_out: Cerrar sesión
-  could_not_log_in: No se pudo iniciar sesión en tu tienda de Shopify
+  could_not_log_in: No se pudo iniciar sesión en tu tienda Shopify
   invalid_shop_url: Dominio de tienda inválido
   enable_cookies_heading: Habilitar cookies de %{app}
   enable_cookies_body: Debes habilitar manualmente las cookies en este navegador para

data/config/locales/nl.yml

@@ -4,17 +4,17 @@ nl:
   could_not_log_in: Kon niet aanmelden bij Shopify-winkel
   invalid_shop_url: Ongeldig winkeldomein
   enable_cookies_heading: Schakel cookies in van %{app}
-  enable_cookies_body: Je moet cookies in deze browser handmatig inschakelen om %{app}
+  enable_cookies_body: U moet cookies in deze browser handmatig inschakelen om %{app}
     binnen Shopify te gebruiken.
-  enable_cookies_footer: Met cookies kan de app je verifiëren door je voorkeuren en
+  enable_cookies_footer: Met cookies kan de app u verifiëren door uw voorkeuren en
     persoonlijke informatie tijdelijk op te slaan. Ze vervallen na 30 dagen.
   enable_cookies_action: Schakel cookies in
-  top_level_interaction_heading: Je browser moet %{app} verifiëren
-  top_level_interaction_body: Je browser heeft apps nodig zoals %{app} om je toegang
-    te vragen tot cookies voordat Shopify het voor je kan openen.
+  top_level_interaction_heading: Uw browser moet %{app} verifiëren
+  top_level_interaction_body: Uw browser heeft apps nodig zoals %{app} om u toegang
+    te vragen tot cookies voordat Shopify het voor u kan openen.
   top_level_interaction_action: Doorgaan
   request_storage_access_heading: "%{app} heeft toegang tot cookies nodig"
-  request_storage_access_body: Hiermee kan de app je verifiëren door je persoonlijke
+  request_storage_access_body: Hiermee kan de app u verifiëren door uw persoonlijke
     gegevens tijdelijk op te slaan. Klik op Doorgaan en sta cookies toe om de app
     te gebruiken.
   request_storage_access_footer: Cookies verlopen na 30 dagen.

data/config/locales/pt-BR.yml

@@ -1,15 +1,14 @@
 ---
 pt-BR:
-  logged_out: Você saiu com sucesso
+  logged_out: Você saiu.
   could_not_log_in: Não foi possível fazer login na Shopify store
   invalid_shop_url: Domínio de loja inválido
-  enable_cookies_heading: Ativar cookies de %{app}
-  enable_cookies_body: Você deve ativar manualmente os cookies neste navegador para
-    usar %{app} dentro da Shopify.
-  enable_cookies_footer: Os cookies permitem que o aplicativo o autentique armazenando
-    temporariamente suas preferências e informações pessoais. Eles expiram depois
-    de 30 dias.
-  enable_cookies_action: Ativar cookies
+  enable_cookies_heading: Habilitar cookies de %{app}
+  enable_cookies_body: Você deve habilitar manualmente os cookies neste navegador
+    para usar %{app} dentro da Shopify.
+  enable_cookies_footer: Os cookies permitem que o app o autentique armazenando temporariamente
+    suas preferências e dados pessoais. Eles expiram depois de 30 dias.
+  enable_cookies_action: Habilitar cookies
   top_level_interaction_heading: Seu navegador precisa autenticar %{app}
   top_level_interaction_body: Seu navegador exige que apps como o %{app} consultem
     você sobre o acesso a cookies antes que a Shopify os abra.

data/config/locales/zh-CN.yml

@@ -1,6 +1,6 @@
 ---
 zh-CN:
-  logged_out: 已成功注销
+  logged_out: 已成功退出
   could_not_log_in: 无法登录到 Shopify 商店
   invalid_shop_url: 商店域名无效
   enable_cookies_heading: 从 %{app} 启用 Cookie

data/karma.conf.js

@@ -26,6 +26,7 @@ module.exports = function(config) {
     preprocessors: {
       'test/javascripts/**/*test.js': ['webpack'],
     },
+    webpack: {},
     reporters: karmaReporters,
     port: 9876,
     colors: true,

data/lib/generators/shopify_app/add_marketing_activity_extension/add_marketing_activity_extension_generator.rb

@@ -0,0 +1,39 @@
+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,66 @@
+# frozen_string_literal: true
+
+class MarketingActivitiesController < ExtensionVerificationController
+  def preload_form_data
+    preload_data = {
+      "form_data": {
+        "budget": {
+          "currency": "USD",
+        }
+      }
+    }
+    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/install/install_generator.rb

@@ -40,12 +40,19 @@ module ShopifyApp
       end
 
       def create_embedded_app_layout
-        if embedded_app?
-          copy_file 'embedded_app.html.erb', 'app/views/layouts/embedded_app.html.erb'
+        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")')
+        else
           copy_file('shopify_app.js', 'app/assets/javascripts/shopify_app.js')
-          copy_file '_flash_messages.html.erb', 'app/views/layouts/_flash_messages.html.erb'
-          copy_file('flash_messages.js',
-            'app/assets/javascripts/flash_messages.js')
+          copy_file('flash_messages.js', 'app/assets/javascripts/flash_messages.js')
         end
       end
 
@@ -57,6 +64,14 @@ module ShopifyApp
         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?

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

@@ -5,7 +5,11 @@
     <% application_name = ShopifyApp.configuration.application_name %>
     <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>
 

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

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

data/lib/shopify_app.rb

@@ -4,32 +4,47 @@ require 'shopify_app/version'
 require 'shopify_api'
 require 'omniauth-shopify-oauth2'
 
-# config
-require 'shopify_app/configuration'
-
-# engine
-require 'shopify_app/engine'
-
-# utils
-require 'shopify_app/utils'
-
-# controller concerns
-require 'shopify_app/controller_concerns/localization'
-require 'shopify_app/controller_concerns/itp'
-require 'shopify_app/controller_concerns/login_protection'
-require 'shopify_app/controller_concerns/embedded_app'
-require 'shopify_app/controller_concerns/webhook_verification'
-require 'shopify_app/controller_concerns/app_proxy_verification'
-
-# jobs
-require 'shopify_app/jobs/webhooks_manager_job'
-require 'shopify_app/jobs/scripttags_manager_job'
-
-# managers
-require 'shopify_app/managers/webhooks_manager'
-require 'shopify_app/managers/scripttags_manager'
-
-# session
-require 'shopify_app/session/session_storage'
-require 'shopify_app/session/session_repository'
-require 'shopify_app/session/in_memory_session_store'
+module ShopifyApp
+  def self.rails6?
+    Rails::VERSION::MAJOR >= 6
+  end
+
+  def self.use_webpacker?
+    rails6? &&
+      defined?(Webpacker) == 'constant' &&
+      !configuration.disable_webpacker
+  end
+
+  # config
+  require 'shopify_app/configuration'
+
+  # engine
+  require 'shopify_app/engine'
+
+  # utils
+  require 'shopify_app/utils'
+
+  # controllers
+  require 'shopify_app/controllers/extension_verification_controller'
+
+  # controller concerns
+  require 'shopify_app/controller_concerns/localization'
+  require 'shopify_app/controller_concerns/itp'
+  require 'shopify_app/controller_concerns/login_protection'
+  require 'shopify_app/controller_concerns/embedded_app'
+  require 'shopify_app/controller_concerns/webhook_verification'
+  require 'shopify_app/controller_concerns/app_proxy_verification'
+
+  # jobs
+  require 'shopify_app/jobs/webhooks_manager_job'
+  require 'shopify_app/jobs/scripttags_manager_job'
+
+  # managers
+  require 'shopify_app/managers/webhooks_manager'
+  require 'shopify_app/managers/scripttags_manager'
+
+  # session
+  require 'shopify_app/session/session_storage'
+  require 'shopify_app/session/session_repository'
+  require 'shopify_app/session/in_memory_session_store'
+end

data/lib/shopify_app/configuration.rb

@@ -28,6 +28,9 @@ module ShopifyApp
     # configure myshopify domain for local shopify development
     attr_accessor :myshopify_domain
 
+    # ability to have webpacker installed but not used in this gem and the generators
+    attr_accessor :disable_webpacker
+
     # allow namespacing webhook jobs
     attr_accessor :webhook_jobs_namespace
 
@@ -36,6 +39,7 @@ module ShopifyApp
       @myshopify_domain = 'myshopify.com'
       @scripttags_manager_queue_name = Rails.application.config.active_job.queue_name
       @webhooks_manager_queue_name = Rails.application.config.active_job.queue_name
+      @disable_webpacker = ENV['SHOPIFY_APP_DISABLE_WEBPACKER'].present?
     end
 
     def login_url