shopify_app 13.0.0 → 13.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4e2d37f9112725500d1a9f36fe76b743e8981920eea4838024cafd6a71cb5eb
-  data.tar.gz: 3c52a0ee9a7f40433ad01b82bda3a0c6d30dd9bb45c319f1d457a0bd13c30fc0
+  metadata.gz: c32f23c198e7bfcc44d3557857c11194ce71f2dc8a1a42ff0d220569c4eb4599
+  data.tar.gz: cf430f7fb26c01592d68d5110a5690f290452ab18c5853dcc4602c5f1d5c0521
 SHA512:
-  metadata.gz: 19a445a22b25b01f860a84128551234313bc44e7acd1583ec90bc96f59d65a8fac208feb1d5a6899453935dd19458196c5253605d85e3ac346be2fa405a50b4c
-  data.tar.gz: 526354098526753ade6d30a346ffa75b2280707638b66dba61c89b34a771e72dd4c23cfae8bda319de58a7a373e7c05d233a13a4f2f8325c7754cda1ed58d835
+  metadata.gz: 4af6eb8ff59c68d9bc1089c577d90d40cfa2997550331314e90f620580da62898000e2b7568616b077fa15080878d0e8ddc9a09160490dea3a4ce719f4e814cd
+  data.tar.gz: b3cf9731363e7df4b3cc78f057bd96204f25f9ab2832662e2cc7e98a3e52ad98ef68d142bcca6d9c96d232eac2cc1dbc2518a41d364f1470247100c2eddd92fc

data/.rubocop.yml

@@ -1,10 +1,17 @@
-inherit_from:
-  - https://shopify.github.io/ruby-style-guide/rubocop.yml
+inherit_gem:
+    rubocop-shopify: rubocop.yml
 
-LineLength:
+AllCops:
+  TargetRubyVersion: 2.4
   Exclude:
-    - test/**/*
+    - 'lib/generators/**/*'
+    - 'test/tmp/**/*'
 
-Metrics/ClassLength:
+Style/MethodCallWithArgsParentheses:
   Exclude:
-    - test/**/*
+    - '**/Gemfile'
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'test/**/*'
+

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+13.0.1
+------
+* Small addition to WebhookJob to return if the shop is nil #952
+* Added Rubocop to the Repo #948
+* Added a WebhookVerification test helper #950
+
+13.0.1
+------
+* fix for deprecation warning while loading session storage at startup
+
 13.0.0
 ------
 + #887 Added concurrent user and shop session support (online/offline)

data/Gemfile

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in shopify_app.gemspec
 gemspec
 
 gem 'rails-controller-testing', group: :test
+
+gem 'rubocop-shopify', require: false

data/README.md

@@ -25,7 +25,7 @@ Table of Contents
 - [AppProxyVerification](#appproxyverification)
 - [Troubleshooting](#troubleshooting)
 - [Testing an embedded app outside the Shopify admin](#testing-an-embedded-app-outside-the-shopify-admin)
-- [Migration to 13.0.0](#migrating-to-13)
+- [Migration to 13.0.0](#migrating-to-1300)
 - [Questions or problems?](#questions-or-problems-)
 - [Rails 6 Compatibility](#rails-6-compatibility)
 - [Upgrading from 8.6 to 9.0.0](#upgrading-from-86-to-900)
@@ -472,6 +472,31 @@ Troubleshooting
 
 see [TROUBLESHOOTING.md](https://github.com/Shopify/shopify_app/blob/master/docs/Troubleshooting.md)
 
+Using Test Helpers inside your Application
+-----------------------------------------
+
+A test helper that will allow you to test `ShopifyApp::WebhookVerification` in the controller from your app, to use this test, you need to `require` it directly in side you app `test/controllers/webhook_verification_test.rb`.
+
+```ruby
+    require 'test_helper'
+    require 'action_controller'
+    require 'action_controller/base'
+    require 'shopify_app/test_helpers/webhook_verification_helper'
+```
+
+or you can require in your `test/test_helper.rb`
+
+```ruby
+  ENV['RAILS_ENV'] ||= 'test'
+  require_relative '../config/environment'
+  require 'rails/test_help'
+  require 'byebug'
+  require 'shopify_app/test_helpers/all'
+```
+
+With `lib/shopify_app/test_helpers/all'` more tests can be added and will only need to be required in once in your library.
+
+
 Testing an embedded app outside the Shopify admin
 -------------------------------------------------
 
@@ -495,6 +520,12 @@ change to how session stores work. Here are the steps to migrate to 13.x
 ### Shop Model Changes (normally `app/models/shop.rb`)
 -  *CHANGE* `include ShopifyApp::SessionStorage` to `include ShopifyApp::ShopSessionStorage`
 
+### Changes to the @shop_session instance variable (normally in `app/controllers/*.rb`)
+- *CHANGE* if you are using shop sessions, `@shop_session` will need to be changed to `@current_shopify_session`
+
+### Changes to Rails `session`
+- *CHANGE* `session[:shopify]` is no longer set. Use `session[:user_id]` if your app uses user based tokens, or `session[:shop_id]` if your app uses shop based tokens.
+
 ### Changes to `ShopifyApp::LoginProtection`
 `ShopifyApp::LoginProtection`
 

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 

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

@@ -17,7 +17,7 @@ module ShopifyApp
         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)

data/app/controllers/shopify_app/sessions_controller.rb

@@ -1,5 +1,6 @@
+# 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
@@ -29,7 +30,7 @@ module ShopifyApp
           shop: sanitized_shop_name,
           return_to: params[:return_to]
         ),
-        current_shopify_domain: current_shopify_domain
+        current_shopify_domain: current_shopify_domain,
       })
     end
 
@@ -91,6 +92,7 @@ module ShopifyApp
       end
     end
 
+    # rubocop:disable Lint/SuppressedException
     def set_user_tokens_option
       if shop_session.blank?
         session[:user_tokens] = false
@@ -110,6 +112,7 @@ module ShopifyApp
       session[:user_tokens] = false
     rescue StandardError
     end
+    # rubocop:enable Lint/SuppressedException
 
     def validate_shop_presence
       @shop = sanitized_shop_name
@@ -127,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
@@ -138,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
@@ -173,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/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

@@ -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?