shopify_app 8.5.1 → 8.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10bd3e8ad3e372f9c95cdb7b95d981855e3ead97e3b2f94f889a7d5107da5260
-  data.tar.gz: e18e84e540c1d46545890603a1d11e8122bb2f35686bfa11b25d4a5147288686
+  metadata.gz: ccf30619a3a247b248063c35a3708ca551a36c8901ec5800219d7100b8088afa
+  data.tar.gz: 50ff0b3d5aec483eeb963863609bad5fb81c932a433a02caa60b8690f9b6b0f4
 SHA512:
-  metadata.gz: 7a248d2992f0695e431dfcab931afa20e6bce0799404f6ec00eb9b33a76bc56003ae5a050f86f850a8bb040cfe281c285bc2744fb8dee7c67f1e87a80941dfed
-  data.tar.gz: 950832e92bbac19934906f3321a3aad7d19e65855158c7eb26a66bfac9a27ce3c2cc920b6969bc8806fabd05c97f334a19df2e4dc5582ee876a4420396244da1
+  metadata.gz: 97bc3975160f1a81492175c673ef0b8c136816c2152ac15ea3a706f4f91e763e8fe54d9c4775c16e1b89f8681b30e9aaa3bb10169a568f170feda7acdf5d2664
+  data.tar.gz: 9068a793e673209770f29185510695abb001b3aa0fcb1e1b4f519c9db348b8e36067b1e275e189fc169c614871f0080bea7e87b3d462f3ca89bf9907c0100818

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+8.6.0
+-----
+
+* Added an `Authenticated` concern to allow gem users to inherit from a custom `AuthenticatedController` instead of
+  `ShopifyApp::AuthenticatedController`
+
 8.5.1
 -----
 

data/README.md

@@ -31,7 +31,7 @@ Table of Contents
 * [**ScripttagsManager**](#scripttagsmanager)
 * [**AfterAuthenticate Job**](#afterauthenticate-job)
 * [**ShopifyApp::SessionRepository**](#shopifyappsessionrepository)
-* [**AuthenticatedController**](#authenticatedcontroller)
+* [**Authenticated**](#authenticated)
 * [**AppProxyVerification**](#appproxyverification)
  * [Recommended Usage](#recommended-usage)
 * [**Troubleshooting**](#troubleshooting)
@@ -397,10 +397,12 @@ ShopifyApp::SessionRepository
 
 If you only run the install generator then by default you will have an in memory store but it **won't work** on multi-server environments including Heroku. If you ran all the generators including the shop_model generator then the `Shop` model itself will be the `SessionRepository`. If you look at the implementation of the generated shop model you'll see that this gem provides a concern for the `SessionRepository`. You can use this concern on any model that responds to `shopify_domain` and `shopify_token`.
 
-AuthenticatedController
------------------------
+Authenticated
+-------------
+
+The engine provides a `ShopifyApp::Authenticated` concern which should be included in any controller that is intended to be behind Shopify OAuth. It adds `before_action`s to ensure that the user is authenticated and will redirect to the Shopify login page if not. It is best practice to include this concern in a base controller inheriting from your `ApplicationController`, from which all controllers that require Shopify authentication inherit.
 
-The engine includes a controller called `ShopifyApp::AuthenticatedController` which inherits from `ActionController::Base`. It adds some before_filters which ensure the user is authenticated and will redirect to the login page if not. It is best practice to have all controllers that belong to the Shopify part of your app inherit from this controller. The HomeController that is generated already inherits from AuthenticatedController.
+For backwards compatibility, the engine still provides a controller called `ShopifyApp::AuthenticatedController` which includes the `ShopifyApp::Authenticated` concern. Note that it inherits directly from `ActionController::Base`, so you will not be able to share functionality between it and your application's `ApplicationController`.
 
 AppProxyVerification
 --------------------

data/app/assets/javascripts/shopify_app/partition_cookies.js

@@ -1,7 +1,8 @@
 (function() {
   document.addEventListener("DOMContentLoaded", function() {
-    var storageAccessHelper = new StorageAccessHelper();
+    var redirectTargetElement = document.getElementById("redirection-target");
+    var targetInfo = JSON.parse(redirectTargetElement.dataset.target)
+    var storageAccessHelper = new StorageAccessHelper(targetInfo);
     storageAccessHelper.execute();
   });
 })();
-

data/app/assets/javascripts/shopify_app/storage_access.js

@@ -36,6 +36,9 @@
     try {
       sessionStorage.setItem('shopify.granted_storage_access', true);
       document.cookie = 'shopify.granted_storage_access=true';
+      if (!document.cookie) {
+        throw 'Cannot set third-party cookie.'
+      }
       this.redirectToAppHome();
     } catch (error) {
       console.warn('Third party cookies may be blocked.', error);

data/app/controllers/concerns/shopify_app/authenticated.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ShopifyApp
+  module Authenticated
+    extend ActiveSupport::Concern
+
+    included do
+      include ShopifyApp::Localization
+      include ShopifyApp::LoginProtection
+      include ShopifyApp::EmbeddedApp
+      before_action :login_again_if_different_shop
+      around_action :shopify_session
+    end
+  end
+end

data/app/controllers/shopify_app/authenticated_controller.rb

@@ -1,11 +1,7 @@
 module ShopifyApp
   class AuthenticatedController < ActionController::Base
-    include ShopifyApp::Localization
-    include ShopifyApp::LoginProtection
-    include ShopifyApp::EmbeddedApp
+    include ShopifyApp::Authenticated
 
     protect_from_forgery with: :exception
-    before_action :login_again_if_different_shop
-    around_action :shopify_session
   end
 end

data/app/controllers/shopify_app/sessions_controller.rb

@@ -1,5 +1,5 @@
 module ShopifyApp
-  class SessionsController < ActionController::Base
+  class SessionsController < ActionController::Base # rubocop:disable Metrics/ClassLength
     include ShopifyApp::LoginProtection
 
     layout false, only: :new
@@ -16,7 +16,16 @@ module ShopifyApp
     end
 
     def enable_cookies
-      validate_shop
+      return unless validate_shop
+
+      render(:enable_cookies, layout: false, locals: {
+        does_not_have_storage_access_url: top_level_interaction_path(
+          shop: sanitized_shop_name
+        ),
+        has_storage_access_url: login_url(top_level: true),
+        app_home_url: granted_storage_access_path(shop: sanitized_shop_name),
+        current_shopify_domain: current_shopify_domain,
+      })
     end
 
     def top_level_interaction

data/app/views/shopify_app/sessions/enable_cookies.html.erb

@@ -21,6 +21,20 @@
   <%= javascript_include_tag('shopify_app/enable_cookies', crossorigin: 'anonymous', integrity: true) %>
 </head>
 <body>
+  <%=
+    content_tag(
+      :div, nil,
+      id: 'redirection-target',
+      data: {
+        target: {
+          myshopifyUrl: "https://#{current_shopify_domain}",
+          hasStorageAccessUrl: "#{has_storage_access_url}",
+          doesNotHaveStorageAccessUrl: "#{does_not_have_storage_access_url}",
+          appHomeUrl: "#{app_home_url}"
+        },
+      },
+    )
+  %>
   <main id="CookiePartitionPrompt">
     <div class="Polaris-Page">
       <div class="Polaris-Page__Content">

data/config/locales/zh-CN.yml

@@ -1,11 +1,11 @@
 ---
 zh-CN:
   logged_out: 已成功注销
-  could_not_log_in: 无法登录到 Shopify 店铺
+  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_footer: Cookie 使此应用能够通过暂时存储您的偏好设置和个人信息来验证您的身份。这些信息将在 30 天后过期。
   enable_cookies_action: 启用 Cookie
   top_level_interaction_heading: 您的浏览器需要对 %{app} 进行验证
   top_level_interaction_body: 您的浏览器要求类似 %{app} 的第三方应用向您请求访问 Cookie，之后 Shopify 才能为您打开它。

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/home_controller/templates/home_controller.rb

@@ -1,4 +1,6 @@
-class HomeController < ShopifyApp::AuthenticatedController
+# frozen_string_literal: true
+
+class HomeController < AuthenticatedController
   def index
     @products = ShopifyAPI::Product.find(:all, params: { limit: 10 })
     @webhooks = ShopifyAPI::Webhook.find(:all)

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

@@ -23,6 +23,10 @@ module ShopifyApp
         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'

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/shopify_app_generator.rb

@@ -9,6 +9,7 @@ module ShopifyApp
       def run_all_generators
         generate "shopify_app:install #{@opts.join(' ')}"
         generate "shopify_app:shop_model"
+        generate("shopify_app:authenticated_controller")
         generate "shopify_app:home_controller"
       end
     end

data/lib/shopify_app/version.rb

@@ -1,3 +1,3 @@
 module ShopifyApp
-  VERSION = '8.5.1'.freeze
+  VERSION = '8.6.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_app
 version: !ruby/object:Gem::Version
-  version: 8.5.1
+  version: 8.6.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-27 00:00:00.000000000 Z
+date: 2019-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: browser_sniffer
@@ -166,6 +166,7 @@ files:
 - app/assets/javascripts/shopify_app/storage_access_redirect.js
 - app/assets/javascripts/shopify_app/top_level.js
 - app/assets/javascripts/shopify_app/top_level_interaction.js
+- app/controllers/concerns/shopify_app/authenticated.rb
 - app/controllers/shopify_app/authenticated_controller.rb
 - app/controllers/shopify_app/callback_controller.rb
 - app/controllers/shopify_app/sessions_controller.rb
@@ -204,6 +205,8 @@ files:
 - lib/generators/shopify_app/app_proxy_controller/templates/app_proxy_controller.rb
 - lib/generators/shopify_app/app_proxy_controller/templates/app_proxy_route.rb
 - lib/generators/shopify_app/app_proxy_controller/templates/index.html.erb
+- lib/generators/shopify_app/authenticated_controller/authenticated_controller_generator.rb
+- lib/generators/shopify_app/authenticated_controller/templates/authenticated_controller.rb
 - lib/generators/shopify_app/controllers/controllers_generator.rb
 - lib/generators/shopify_app/home_controller/home_controller_generator.rb
 - lib/generators/shopify_app/home_controller/templates/home_controller.rb
@@ -213,6 +216,7 @@ files:
 - lib/generators/shopify_app/install/templates/_flash_messages.html.erb
 - lib/generators/shopify_app/install/templates/embedded_app.html.erb
 - lib/generators/shopify_app/install/templates/omniauth.rb
+- lib/generators/shopify_app/install/templates/session_store.rb
 - lib/generators/shopify_app/install/templates/shopify_app.rb
 - lib/generators/shopify_app/install/templates/shopify_provider.rb
 - lib/generators/shopify_app/rotate_shopify_token_job/rotate_shopify_token_job_generator.rb