shopify_app 11.0.0 → 11.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99e91b542c6d5f2fb530c9d259e6d32d463bb6e8d0720dd11faa009e845d2ced
-  data.tar.gz: '0214085b33d8ccbb7dfe929430f81b75296ac5cf201c6b9969ba0b5d78ea7351'
+  metadata.gz: 15eca48ef29e1c972ae2444aa0f87d0174a86fe429a5f006fb1dcad801040f89
+  data.tar.gz: f91ad649d3b251111a6b48ec0545e4716a18540e3efbe18c89bd8f36becd5d1c
 SHA512:
-  metadata.gz: f8fb32cc915ecfeba1ee7db40f1cd3ec4e0c9b8c8bae697370248a8f6225f70504da6a3a160cdfb960426899c2d0abcbbe8f623a0771cef81c7ddb1e58ac779d
-  data.tar.gz: 73c4b7f0f49130ea808fd7b4c24cef408025a5fcaf89a8b29ee2c0baa0e00d0837b11ec6ecd7f35d4c57269a39e357a9d3cb7d5b55b66a76ff25b0444f503405
+  metadata.gz: 16bebc85b8c03bc330c583d43310a33cb0dfa789087cc84a73722ffa02de045113ccdf69a25f1bb975ceae35ad60b6b938b80e57972bf654fc5d4d79299e4fde
+  data.tar.gz: 874b833abb3c157aecebecb62d2ecba4f886af24d476f6c55826cca1eec023f6109ec66b33ab2661c6dfab9a9db3da8b247d80beb39a4e8187066e0bae1c7acc

data/CHANGELOG.md

@@ -1,3 +1,35 @@
+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
+-----
+
+* Add Webmock and Pry as development dependencies
+* Update install generator to leverage updates to ShopifyAPI::ApiVersion add in v8.0.0 of the shopify_api gem [#790](https://github.com/Shopify/shopify_app/pull/790)
+
+
+11.0.2
+-----
+
+* Lock shopify_api gem dependency to `~> 7.0` from `>= 7.0.0`.
+* Remove flakey JS Tests
+* bump sqlite3 development dependency to `~>1.4` from `~> 1.3.6`. [#789](https://github.com/Shopify/shopify_app/pull/789)
+
+11.0.1
+-----
+
+* Add dotenv-rails gem to install generator, so apps fetch credentials from `.env` by default: [#776](https://github.com/Shopify/shopify_app/pull/776)
+
 11.0.0
 -----
 

data/README.md

@@ -26,7 +26,6 @@ Table of Contents
  * [App Proxy Controller Generator](#app-proxy-controller-generator)
  * [Controllers, Routes and Views](#controllers-routes-and-views)
 * [**Mounting the Engine**](#mounting-the-engine)
-* [**Managing Api Keys**](#managing-api-keys)
 * [**WebhooksManager**](#webhooksmanager)
 * [**ScripttagsManager**](#scripttagsmanager)
 * [**AfterAuthenticate Job**](#afterauthenticate-job)
@@ -104,11 +103,22 @@ Generators
 The default generator will run the `install`, `shop`, and `home_controller` generators. This is the recommended way to start your app.
 
 ```sh
-$ rails generate shopify_app --api_key <your_api_key> --secret <your_app_secret>
+$ rails generate shopify_app
 ```
 
 After running the generator, you will need to run `rake db:migrate` to add tables to your database. You can start your app with `bundle exec rails server` and install your app by visiting localhost.
 
+### API Keys
+
+The default and install generators have been updated to source Shopify API key and secret from a `.env` file, which you will need to create with the following format:
+
+```
+SHOPIFY_API_KEY=your api key
+SHOPIFY_API_SECRET=your api secret
+```
+
+These values can be found on the "App Setup" page in the [Shopify Partners Dashboard][dashboard].
+
 ### Install Generator
 
 ```sh
@@ -116,7 +126,7 @@ $ rails generate shopify_app:install
 
 # or optionally with arguments:
 
-$ rails generate shopify_app:install --api_key <your_api_key> --secret <your_app_secret>
+$ rails generate shopify_app:install
 ```
 
 Other options include:
@@ -244,21 +254,6 @@ The current Shopify user will be stored in the rails session at `session[:shopif
 
 This will change the type of token that Shopify returns and it will only be valid for a short time. Read more about `Online access` [here](https://help.shopify.com/api/getting-started/authentication/oauth). Note that this means you won't be able to use this token to respond to Webhooks.
 
-Managing Api Keys
------------------
-
-The `install` generator places your Api credentials directly into the shopify_app initializer which is convenient and fine for development but once your app goes into production **your api credentials should not be in source control**. When we develop apps we keep our keys in environment variables so a production shopify_app initializer would look like this:
-
-```ruby
-ShopifyApp.configure do |config|
-  config.application_name = 'Your app name' # Optional
-  config.api_key = ENV['SHOPIFY_CLIENT_API_KEY']
-  config.secret = ENV['SHOPIFY_CLIENT_API_SECRET']
-  config.scope = 'read_customers, write_products'
-  config.embedded_app = true
-end
-```
-
 
 WebhooksManager
 ---------------
@@ -439,7 +434,7 @@ class ReviewsController < ApplicationController
 end
 ```
 
-Create your app proxy url in the [Shopify Partners' Dashboard](https://app.shopify.com/services/partners/api_clients), making sure to point it to `https://your_app_website.com/app_proxy`.
+Create your app proxy url in the [Shopify Partners' Dashboard][dashboard], making sure to point it to `https://your_app_website.com/app_proxy`.
 ![Creating an App Proxy](/images/app-proxy-screenshot.png)
 
 Troubleshooting
@@ -462,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
 ---------------------------
@@ -476,7 +488,7 @@ config.api_version = '2019-04'
 
 ### Session storage change
 
-You will need to add an `api_version` method to you session storage object.  The default implmentation for this is.
+You will need to add an `api_version` method to you session storage object.  The default implementation for this is.
 ```ruby
 def api_version
   ShopifyApp.configuration.api_version
@@ -485,7 +497,7 @@ end
 
 ### Generated file change
 
-`embedded_app.html.erb` the useage of `shop_session.url` needs to be changed to `shop_session.domain`
+`embedded_app.html.erb` the usage of `shop_session.url` needs to be changed to `shop_session.domain`
 ```erb
 <script type="text/javascript">
   ShopifyApp.init({
@@ -515,3 +527,5 @@ is changed to
 ### ShopifyAPI changes
 
 You will need to also follow the ShopifyAPI [upgrade guide](https://github.com/Shopify/shopify_api/blob/master/README.md#-breaking-change-notice-for-version-700-) to ensure your app is ready to work with api versioning.
+
+[dashboard]:https://partners.shopify.com

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

@@ -1,6 +1,6 @@
 ---
 nl:
-  logged_out: u bent afgemeld
+  logged_out: je bent afgemeld
   could_not_log_in: Kon niet aanmelden bij Shopify-winkel
   invalid_shop_url: Ongeldig winkeldomein
   enable_cookies_heading: Schakel cookies in van %{app}

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/docs/Releasing.md

@@ -3,7 +3,6 @@ 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 in package.json, then run `npm install` to make sure the lock file gets updated
   * 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

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/install/install_generator.rb

@@ -7,20 +7,18 @@ module ShopifyApp
       source_root File.expand_path('../templates', __FILE__)
 
       class_option :application_name, type: :array, default: ['My', 'Shopify', 'App']
-      class_option :api_key, type: :string, default: '<api_key>'
-      class_option :secret, type: :string, default: '<secret>'
-      class_option :old_secret, type: :string, default: '<old_secret>'
       class_option :scope, type: :array, default: ['read_products']
       class_option :embedded, type: :string, default: 'true'
-      class_option :api_version, type: :string, default: ShopifyAPI::ApiVersion.latest_stable_version.to_s
+      class_option :api_version, type: :string, default: nil
+
+      def add_dotenv_gem
+        gem('dotenv-rails', group: [:test, :development])
+      end
 
       def create_shopify_app_initializer
         @application_name = format_array_argument(options['application_name'])
-        @api_key = options['api_key']
-        @secret = options['secret']
-        @old_secret = options['old_secret']
         @scope = format_array_argument(options['scope'])
-        @api_version = options['api_version']
+        @api_version = options['api_version'] || ShopifyAPI::Meta.admin_versions.find(&:latest_supported).handle
 
         template 'shopify_app.rb', 'config/initializers/shopify_app.rb'
       end
@@ -42,19 +40,38 @@ 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
 
+      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 << /\\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.rb

@@ -1,7 +1,7 @@
 ShopifyApp.configure do |config|
   config.application_name = "<%= @application_name %>"
-  config.api_key = "<%= @api_key %>"
-  config.secret = "<%= @secret %>"
+  config.api_key = ENV['SHOPIFY_API_KEY']
+  config.secret = ENV['SHOPIFY_API_SECRET']
   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
@@ -10,3 +10,6 @@ ShopifyApp.configure do |config|
   config.api_version = "<%= @api_version %>"
   config.session_repository = ShopifyApp::InMemorySessionStore
 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_index.js

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

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

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

data/lib/shopify_app.rb

@@ -4,32 +4,44 @@ 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'
+
+  # 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