shopify_app 12.0.5 → 13.1.0

data/app/controllers/shopify_app/authenticated_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ShopifyApp
   class AuthenticatedController < ActionController::Base
     include ShopifyApp::Authenticated

data/app/controllers/shopify_app/callback_controller.rb

@@ -8,11 +8,16 @@ module ShopifyApp
     def callback
       if auth_hash
         login_shop
+
+        if ShopifyApp::SessionRepository.user_storage.present? && user_session.blank?
+          return redirect_to(login_url_with_optional_shop)
+        end
+
         install_webhooks
         install_scripttags
         perform_after_authenticate_job
 
-        redirect_to return_address
+        redirect_to(return_address)
       else
         flash[:error] = I18n.t('could_not_log_in')
         redirect_to(login_url_with_optional_shop)
@@ -55,16 +60,15 @@ module ShopifyApp
         token: token,
         api_version: ShopifyApp.configuration.api_version
       )
-      session[:shopify] = ShopifyApp::SessionRepository.store(session_store, user: associated_user)
-      session[:shopify_domain] = shop_name
-      session[:shopify_user] = associated_user
 
-      if ShopifyApp.configuration.per_user_tokens?
-        # Adds the user_session to the session to determine if the logged in user has changed
-        user_session = auth_hash&.extra&.session
-        raise IndexError, "Missing user session signature" if user_session.nil?
-        session[:user_session] = user_session
+      session[:shopify_user] = associated_user
+      if session[:shopify_user].present?
+        session[:user_id] = ShopifyApp::SessionRepository.store_user_session(session_store, associated_user)
+      else
+        session[:shop_id] = ShopifyApp::SessionRepository.store_shop_session(session_store)
       end
+      session[:shopify_domain] = shop_name
+      session[:user_session] = auth_hash&.extra&.session
     end
 
     def install_webhooks
@@ -72,7 +76,7 @@ module ShopifyApp
 
       WebhooksManager.queue(
         shop_name,
-        token,
+        shop_session&.token || user_session.token,
         ShopifyApp.configuration.webhooks
       )
     end
@@ -82,7 +86,7 @@ module ShopifyApp
 
       ScripttagsManager.queue(
         shop_name,
-        token,
+        shop_session&.token || user_session.token,
         ShopifyApp.configuration.scripttags
       )
     end

data/app/controllers/shopify_app/sessions_controller.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 module ShopifyApp
-  class SessionsController < ActionController::Base # rubocop:disable Metrics/ClassLength
+  class SessionsController < ActionController::Base
     include ShopifyApp::LoginProtection
 
     layout false, only: :new
+
     after_action only: [:new, :create] do |controller|
       controller.response.headers.except!('X-Frame-Options')
     end
@@ -16,7 +18,7 @@ module ShopifyApp
     end
 
     def enable_cookies
-      return unless validate_shop
+      return unless validate_shop_presence
 
       render(:enable_cookies, layout: false, locals: {
         does_not_have_storage_access_url: top_level_interaction_path(
@@ -28,17 +30,17 @@ module ShopifyApp
           shop: sanitized_shop_name,
           return_to: params[:return_to]
         ),
-        current_shopify_domain: current_shopify_domain
+        current_shopify_domain: current_shopify_domain,
       })
     end
 
     def top_level_interaction
       @url = login_url_with_optional_shop(top_level: true)
-      validate_shop
+      validate_shop_presence
     end
 
     def granted_storage_access
-      return unless validate_shop
+      return unless validate_shop_presence
 
       session['shopify.granted_storage_access'] = true
 
@@ -61,6 +63,8 @@ module ShopifyApp
 
       copy_return_to_param_to_session
 
+      set_user_tokens_option
+
       if user_agent_can_partition_cookies
         authenticate_with_partitioning
       else
@@ -88,7 +92,29 @@ module ShopifyApp
       end
     end
 
-    def validate_shop
+    # rubocop:disable Lint/SuppressedException
+    def set_user_tokens_option
+      if shop_session.blank?
+        session[:user_tokens] = false
+        return
+      end
+
+      session[:user_tokens] = ShopifyApp::SessionRepository.user_storage.present?
+
+      ShopifyAPI::Session.temp(
+        domain: shop_session.domain,
+        token: shop_session.token,
+        api_version: shop_session.api_version
+      ) do
+        ShopifyAPI::Metafield.find(:token_validity_bogus_check)
+      end
+    rescue ActiveResource::UnauthorizedAccess
+      session[:user_tokens] = false
+    rescue StandardError
+    end
+    # rubocop:enable Lint/SuppressedException
+
+    def validate_shop_presence
       @shop = sanitized_shop_name
       unless @shop
         render_invalid_shop_error
@@ -104,7 +130,7 @@ module ShopifyApp
 
     def render_invalid_shop_error
       flash[:error] = I18n.t('invalid_shop_url')
-      redirect_to return_address
+      redirect_to(return_address)
     end
 
     def enable_cookie_access
@@ -115,7 +141,7 @@ module ShopifyApp
     end
 
     def authenticate_in_context
-      redirect_to "#{main_app.root_path}auth/shopify"
+      redirect_to("#{main_app.root_path}auth/shopify")
     end
 
     def authenticate_at_top_level
@@ -150,7 +176,7 @@ module ShopifyApp
             shop: sanitized_shop_name,
             return_to: session[:return_to]
           ),
-          current_shopify_domain: current_shopify_domain
+          current_shopify_domain: current_shopify_domain,
         }
       )
     end

data/app/controllers/shopify_app/webhooks_controller.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
 module ShopifyApp
+  class MissingWebhookJobError < StandardError; end
+
   class WebhooksController < ActionController::Base
     include ShopifyApp::WebhookVerification
 
-    class ShopifyApp::MissingWebhookJobError < StandardError; end
-
     def receive
       params.permit!
-      job_args = {shop_domain: shop_domain, webhook: webhook_params.to_h}
+      job_args = { shop_domain: shop_domain, webhook: webhook_params.to_h }
       webhook_job_klass.perform_later(job_args)
-      head :no_content
+      head(:no_content)
     end
 
     private
@@ -18,7 +19,7 @@ module ShopifyApp
     end
 
     def webhook_job_klass
-      webhook_job_klass_name.safe_constantize or raise ShopifyApp::MissingWebhookJobError
+      webhook_job_klass_name.safe_constantize || raise(ShopifyApp::MissingWebhookJobError)
     end
 
     def webhook_job_klass_name(type = webhook_type)

data/config/locales/fi.yml

@@ -15,6 +15,6 @@ fi:
   top_level_interaction_action: Jatka
   request_storage_access_heading: "%{app} edellyttää evästeiden käyttöä"
   request_storage_access_body: Näin sovellus voi todentaa sinut tallentamalla henkilötietosi
-    tilapäisesti. Napsauta Jatka ja salli evästeet sovelluksen käyttämiseksi.
+    tilapäisesti. Klikkaa Jatka ja salli evästeet sovelluksen käyttämiseksi.
   request_storage_access_footer: Evästeet vanhenevat 30 päivän kuluttua.
   request_storage_access_action: Jatka

data/config/locales/nl.yml

@@ -1,20 +1,20 @@
 ---
 nl:
-  logged_out: u bent afgemeld
+  logged_out: je bentafgemeld
   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: U moet cookies in deze browser handmatig inschakelen om %{app}
+  enable_cookies_body: Je moet cookies in deze browser handmatig inschakelen om %{app}
     binnen Shopify te gebruiken.
-  enable_cookies_footer: Met cookies kan de app u verifiëren door uw voorkeuren en
+  enable_cookies_footer: Met cookies kan de app je verifiëren door je voorkeuren en
     persoonlijke informatie tijdelijk op te slaan. Ze vervallen na 30 dagen.
   enable_cookies_action: Schakel cookies in
-  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_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_action: Doorgaan
   request_storage_access_heading: "%{app} heeft toegang tot cookies nodig"
-  request_storage_access_body: Hiermee kan de app u verifiëren door uw persoonlijke
+  request_storage_access_body: Hiermee kan de app je verifiëren door je 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/routes.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ShopifyApp::Engine.routes.draw do
   controller :sessions do
     get 'login' => :new, :as => :login

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators/base'
 
 module ShopifyApp
@@ -6,7 +7,7 @@ module ShopifyApp
       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) ]
+        instance.invoke(generator, [instance.send(:job_file_name)])
       end
 
       def init_after_authenticate_config
@@ -23,12 +24,13 @@ module ShopifyApp
         )
 
         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)
+          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"
+        template('after_authenticate_job.rb', "app/jobs/#{job_file_name}_job.rb")
       end
 
       private

data/lib/generators/shopify_app/add_after_authenticate_job/templates/after_authenticate_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shopify
   class AfterAuthenticateJob < ActiveJob::Base
     def perform(shop_domain:)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators/base'
 
 module ShopifyApp
@@ -6,7 +7,7 @@ module ShopifyApp
       source_root File.expand_path('../templates', __FILE__)
 
       def generate_app_extension
-        template "marketing_activities_controller.rb", "app/controllers/marketing_activities_controller.rb"
+        template("marketing_activities_controller.rb", "app/controllers/marketing_activities_controller.rb")
         generate_routes
       end
 

data/lib/generators/shopify_app/add_marketing_activity_extension/templates/marketing_activities_controller.rb

@@ -3,7 +3,7 @@
 class MarketingActivitiesController < ShopifyApp::ExtensionVerificationController
   def preload_form_data
     preload_data = {
-      "form_data": {}
+      "form_data": {},
     }
     render(json: preload_data, status: :ok)
   end
@@ -31,14 +31,14 @@ class MarketingActivitiesController < ShopifyApp::ExtensionVerificationControlle
         "preview_url": placeholder_img,
         "content_type": "text/html",
         "width": 360,
-        "height": 200
+        "height": 200,
       },
       "mobile": {
         "preview_url": placeholder_img,
         "content_type": "text/html",
         "width": 360,
-        "height": 200
-      }
+        "height": 200,
+      },
     }
     render(json: preview_response, status: :ok)
   end

data/lib/generators/shopify_app/add_webhook/add_webhook_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators/base'
 
 module ShopifyApp
@@ -8,7 +9,7 @@ module ShopifyApp
       class_option :address, type: :string, aliases: "-a", required: true
 
       hook_for :test_framework, as: :job, in: :rails do |instance, generator|
-        instance.invoke generator, [ instance.send(:job_file_name) ]
+        instance.invoke(generator, [instance.send(:job_file_name)])
       end
 
       def init_webhook_config
@@ -32,14 +33,14 @@ module ShopifyApp
         initializer = load_initializer
 
         unless initializer.include?(webhook_config)
-          shell.say "Error adding webhook to config. Add this line manually: #{webhook_config}", :red
+          shell.say("Error adding webhook to config. Add this line manually: #{webhook_config}", :red)
         end
       end
 
       def add_webhook_job
         @job_file_name = job_file_name + '_job'
-        @job_class_name  = @job_file_name.classify
-        template 'webhook_job.rb', "app/jobs/#{@job_file_name}.rb"
+        @job_class_name = @job_file_name.classify
+        template('webhook_job.rb', "app/jobs/#{@job_file_name}.rb")
       end
 
       private

data/lib/generators/shopify_app/add_webhook/templates/{webhook_job.rb → webhook_job.rb.tt}

@@ -2,6 +2,11 @@ class <%= @job_class_name %> < ActiveJob::Base
   def perform(shop_domain:, webhook:)
     shop = Shop.find_by(shopify_domain: shop_domain)
 
+    if shop.nil?
+      logger.error("#{self.class} failed: cannot find shop with domain '#{shop_domain}'")
+      return
+    end
+
     shop.with_shopify_session do
     end
   end

data/lib/generators/shopify_app/app_proxy_controller/app_proxy_controller_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators/base'
 
 module ShopifyApp
@@ -6,11 +7,11 @@ module ShopifyApp
       source_root File.expand_path('../templates', __FILE__)
 
       def create_app_proxy_controller
-        template 'app_proxy_controller.rb', 'app/controllers/app_proxy_controller.rb'
+        template('app_proxy_controller.rb', 'app/controllers/app_proxy_controller.rb')
       end
 
       def create_app_proxy_index_view
-        copy_file 'index.html.erb', 'app/views/app_proxy/index.html.erb'
+        copy_file('index.html.erb', 'app/views/app_proxy/index.html.erb')
       end
 
       def add_app_proxy_route
@@ -18,7 +19,7 @@ module ShopifyApp
           'config/routes.rb',
           File.read(File.expand_path(find_in_source_paths('app_proxy_route.rb'))),
           after: "mount ShopifyApp::Engine, at: '/'\n"
-        )  			 
+        )
       end
     end
   end

data/lib/generators/shopify_app/app_proxy_controller/templates/app_proxy_controller.rb

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
 class AppProxyController < ApplicationController
-   include ShopifyApp::AppProxyVerification
+  include ShopifyApp::AppProxyVerification
 
   def index
-    render layout: false, content_type: 'application/liquid'
+    render(layout: false, content_type: 'application/liquid')
   end
-
 end

data/lib/generators/shopify_app/app_proxy_controller/templates/app_proxy_route.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 
-  namespace :app_proxy do
-    root action: 'index'
-    # simple routes without a specified controller will go to AppProxyController
-    
-    # more complex routes will go to controllers in the AppProxy namespace
-    # 	resources :reviews
-    # GET /app_proxy/reviews will now be routed to
-    # AppProxy::ReviewsController#index, for example
-  end
+namespace :app_proxy do
+  root action: 'index'
+  # simple routes without a specified controller will go to AppProxyController
+
+  # more complex routes will go to controllers in the AppProxy namespace
+  #   resources :reviews
+  # GET /app_proxy/reviews will now be routed to
+  # AppProxy::ReviewsController#index, for example
+end

data/lib/generators/shopify_app/controllers/controllers_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators/base'
 
 module ShopifyApp

data/lib/generators/shopify_app/home_controller/home_controller_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators/base'
 
 module ShopifyApp
@@ -6,15 +7,15 @@ module ShopifyApp
       source_root File.expand_path('../templates', __FILE__)
 
       def create_home_controller
-        template 'home_controller.rb', 'app/controllers/home_controller.rb'
+        template('home_controller.rb', 'app/controllers/home_controller.rb')
       end
 
       def create_home_index_view
-        copy_file 'index.html.erb', 'app/views/home/index.html.erb'
+        copy_file('index.html.erb', 'app/views/home/index.html.erb')
       end
 
       def add_home_index_route
-        route "root :to => 'home#index'"
+        route("root :to => 'home#index'")
       end
 
       def embedded_app?