shopify_app 18.0.2 → 19.1.0

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

@@ -1,116 +1,71 @@
 # frozen_string_literal: true
-require 'rails/generators/base'
+
+require "rails/generators/base"
 
 module ShopifyApp
   module Generators
     class InstallGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path("../templates", __FILE__)
 
-      class_option :application_name, type: :array, default: ['My', 'Shopify', 'App']
-      class_option :scope, type: :array, default: ['read_products']
-      class_option :embedded, type: :string, default: 'true'
+      class_option :application_name, type: :array, default: ["My", "Shopify", "App"]
+      class_option :scope, type: :array, default: ["read_products"]
+      class_option :embedded, type: :string, default: "true"
       class_option :api_version, type: :string, default: nil
-      class_option :with_cookie_authentication, type: :boolean, default: false
 
       def create_shopify_app_initializer
-        @application_name = format_array_argument(options['application_name'])
-        @scope = format_array_argument(options['scope'])
-        @api_version = options['api_version'] || ShopifyAPI::Meta.admin_versions.find(&:latest_supported).handle
+        @application_name = format_array_argument(options["application_name"])
+        @scope = format_array_argument(options["scope"])
+        @api_version = options["api_version"] || ShopifyAPI::LATEST_SUPPORTED_ADMIN_VERSION
 
-        template('shopify_app.rb', 'config/initializers/shopify_app.rb')
+        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')
-        end
-
-        return if !Rails.env.test? && shopify_provider_exists?
-
-        inject_into_file(
-          'config/initializers/omniauth.rb',
-          shopify_provider_template,
-          after: "Rails.application.config.middleware.use(OmniAuth::Builder) do\n"
-        )
+        copy_file("session_store.rb", "config/initializers/session_store.rb")
       end
 
       def create_embedded_app_layout
         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')
+        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\")\n")
+          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\")\n")
+        elsif ShopifyApp.use_importmap?
+          copy_file("shopify_app_importmap.js", "app/javascript/lib/shopify_app.js")
+          copy_file("flash_messages.js", "app/javascript/lib/flash_messages.js")
+          append_to_file("config/importmap.rb", "pin_all_from \"app/javascript/lib\", under: \"lib\"\n")
         else
-          copy_file('shopify_app.js', 'app/assets/javascripts/shopify_app.js')
-          copy_file('flash_messages.js', 'app/assets/javascripts/flash_messages.js')
+          copy_file("shopify_app.js", "app/assets/javascripts/shopify_app.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 = (config.hosts rescue []) << /\\w+\\.ngrok\\.io/\n",
+          "config/environments/development.rb",
+          "  config.hosts = (config.hosts rescue []) << /\[-\\w]+\\.ngrok\\.io/\n",
           after: "Rails.application.configure do\n"
         )
       end
 
       private
 
-      def shopify_provider_exists?
-        File.open("config/initializers/omniauth.rb") do |file|
-          file.each_line do |line|
-            if line =~ /provider :shopify/
-              puts "\e[33m#{omniauth_warning}\e[0m"
-              return true
-            end
-          end
-        end
-        false
-      end
-
-      def omniauth_warning
-        <<~OMNIAUTH
-          \n[WARNING] The Shopify App generator attempted to add the following Shopify Omniauth \
-          provider 'config/initializers/omniauth.rb':
-
-          \e[0m#{shopify_provider_template}\e[33m
-
-          Consider updating 'config/initializers/omniauth.rb' to match the configuration above.
-        OMNIAUTH
-      end
-
-      def shopify_provider_template
-        File.read(File.expand_path(find_in_source_paths('shopify_provider.rb.tt')))
-      end
-
       def embedded_app?
-        options['embedded'] == 'true'
+        options["embedded"] == "true"
       end
 
       def format_array_argument(array)
-        array.join(' ').tr('"', '')
-      end
-
-      def with_cookie_authentication?
-        options['with_cookie_authentication'] || !embedded_app?
+        array.join(" ").tr('"', "")
       end
     end
   end

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

@@ -7,6 +7,8 @@
     <%= stylesheet_link_tag 'application' %>
     <% if ShopifyApp.use_webpacker? %>
       <%= javascript_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
+    <% elsif ShopifyApp.use_importmap? %>
+      <%= javascript_importmap_tags %>
     <% else %>
       <%= javascript_include_tag 'application', "data-turbolinks-track" => true %>
     <% end %>
@@ -28,7 +30,7 @@
 
     <%= content_tag(:div, nil, id: 'shopify-app-init', data: {
       api_key: ShopifyApp.configuration.api_key,
-      shop_origin: @shop_origin || (@current_shopify_session.domain if @current_shopify_session),
+      shop_origin: @shop_origin || (@current_shopify_session.shop if @current_shopify_session),
       host: @host,
       debug: Rails.env.development?
     } ) %>

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

@@ -1,4 +1,5 @@
 # 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)
+Rails.application.config.session_store(:cookie_store, key: "_example_session", expire_after: 14.days)

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

@@ -10,16 +10,44 @@ ShopifyApp.configure do |config|
 
   config.reauth_on_access_scope_changes = true
 
-  config.allow_jwt_authentication = <%= !with_cookie_authentication? %>
-  config.allow_cookie_authentication = <%= with_cookie_authentication? %>
-
   config.api_key = ENV.fetch('SHOPIFY_API_KEY', '').presence
   config.secret = ENV.fetch('SHOPIFY_API_SECRET', '').presence
+
+  # You may want to charge merchants for using your app. Setting the billing configuration will cause the Authenticated
+  # controller concern to check that the session is for a merchant that has an active one-time payment or subscription.
+  # If no payment is found, it starts off the process and sends the merchant to a confirmation URL so that they can
+  # approve the purchase.
+  #
+  # Learn more about billing in our documentation: https://shopify.dev/apps/billing
+  # config.billing = ShopifyApp::BillingConfiguration.new(
+  #   charge_name: "My app billing charge",
+  #   amount: 5,
+  #   interval: ShopifyApp::BillingConfiguration::INTERVAL_EVERY_30_DAYS,
+  #   currency_code: "USD", # Only supports USD for now
+  # )
+
   if defined? Rails::Server
     raise('Missing SHOPIFY_API_KEY. See https://github.com/Shopify/shopify_app#requirements') unless config.api_key
     raise('Missing SHOPIFY_API_SECRET. See https://github.com/Shopify/shopify_app#requirements') unless config.secret
   end
 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
+Rails.application.config.after_initialize do
+  if ShopifyApp.configuration.api_key.present? && ShopifyApp.configuration.secret.present?
+    ShopifyAPI::Context.setup(
+      api_key: ShopifyApp.configuration.api_key,
+      api_secret_key: ShopifyApp.configuration.secret,
+      api_version: ShopifyApp.configuration.api_version,
+      host_name: URI(ENV.fetch('HOST', '')).host || '',
+      scope: ShopifyApp.configuration.scope,
+      is_private: !ENV.fetch('SHOPIFY_APP_PRIVATE_SHOP', '').empty?,
+      is_embedded: ShopifyApp.configuration.embedded_app,
+      session_storage: ShopifyApp::SessionRepository,
+      logger: Rails.logger,
+      private_shop: ENV.fetch('SHOPIFY_APP_PRIVATE_SHOP', nil),
+      user_agent_prefix: "ShopifyApp/#{ShopifyApp::VERSION}"
+    )
+
+    ShopifyApp::WebhooksManager.add_registrations
+  end
+end

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

@@ -0,0 +1,13 @@
+var data = document.getElementById('shopify-app-init').dataset;
+var AppBridge = window['app-bridge'];
+var createApp = AppBridge.default;
+window.app = createApp({
+  apiKey: data.apiKey,
+  host: data.host,
+});
+
+var actions = AppBridge.actions;
+var TitleBar = actions.TitleBar;
+TitleBar.create(app, {
+  title: data.page,
+});

data/lib/generators/shopify_app/products_controller/products_controller_generator.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require 'rails/generators/base'
+require "rails/generators/base"
 
 module ShopifyApp
   module Generators
     class ProductsControllerGenerator < Rails::Generators::Base
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path("../templates", __FILE__)
 
       def create_products_controller
-        template('products_controller.rb', 'app/controllers/products_controller.rb')
+        template("products_controller.rb", "app/controllers/products_controller.rb")
       end
 
       def add_products_route

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

@@ -2,7 +2,7 @@
 
 class ProductsController < AuthenticatedController
   def index
-    @products = ShopifyAPI::Product.find(:all, params: { limit: 10 })
+    @products = ShopifyAPI::Product.all(limit: 10)
     render(json: { products: @products })
   end
 end

data/lib/generators/shopify_app/rotate_shopify_token_job/rotate_shopify_token_job_generator.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'rails/generators/base'
+require "rails/generators/base"
 
 module ShopifyApp
   module Generators
     class RotateShopifyTokenJobGenerator < Rails::Generators::Base
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path("../templates", __FILE__)
 
       def add_rotate_shopify_token_job
-        copy_file('rotate_shopify_token_job.rb', "app/jobs/shopify/rotate_shopify_token_job.rb")
-        copy_file('rotate_shopify_token.rake', "lib/tasks/shopify/rotate_shopify_token.rake")
+        copy_file("rotate_shopify_token_job.rb", "app/jobs/shopify/rotate_shopify_token_job.rb")
+        copy_file("rotate_shopify_token.rake", "lib/tasks/shopify/rotate_shopify_token.rake")
       end
     end
   end

data/lib/generators/shopify_app/rotate_shopify_token_job/templates/rotate_shopify_token.rake

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 namespace :shopify do
   desc "Rotate shopify tokens for all active shops"
   task :rotate_shopify_tokens, [:refresh_token] => :environment do |_t, args|

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

@@ -18,7 +18,7 @@ module Shopify
       @response = Net::HTTP.post_form(uri, post_data)
       return log_error(response_exception_error_message) unless @response.is_a?(Net::HTTPSuccess)
 
-      access_token = JSON.parse(@response.body)['access_token']
+      access_token = JSON.parse(@response.body)["access_token"]
       return log_error(no_access_token_error_message) unless access_token
 
       @shop.update(shopify_token: access_token)

data/lib/generators/shopify_app/routes/routes_generator.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
-require 'rails/generators/base'
+
+require "rails/generators/base"
 
 module ShopifyApp
   module Generators
     class RoutesGenerator < Rails::Generators::Base
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path("../templates", __FILE__)
 
       def inject_shopify_app_routes_into_application_routes
         route(session_routes)
@@ -12,9 +13,9 @@ module ShopifyApp
 
       def disable_engine_routes
         gsub_file(
-          'config/routes.rb',
+          "config/routes.rb",
           "mount ShopifyApp::Engine, at: '/'",
-          ''
+          ""
         )
       end
 
@@ -25,7 +26,7 @@ module ShopifyApp
       end
 
       def routes_file_path
-        File.expand_path(find_in_source_paths('routes.rb'))
+        File.expand_path(find_in_source_paths("routes.rb"))
       end
     end
   end

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

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 controller :sessions do
-  get 'login' => :new, :as => :login
-  post 'login' => :create, :as => :authenticate
-  get 'auth/shopify/callback' => :callback
-  get 'logout' => :destroy, :as => :logout
+  get "login" => :new, :as => :login
+  post "login" => :create, :as => :authenticate
+  get "auth/shopify/callback" => :callback
+  get "logout" => :destroy, :as => :logout
 end
 
 namespace :webhooks do
-  post ':type' => :receive
+  post ":type" => :receive
 end

data/lib/generators/shopify_app/shop_model/shop_model_generator.rb

@@ -1,21 +1,22 @@
 # frozen_string_literal: true
-require 'rails/generators/base'
-require 'rails/generators/active_record'
+
+require "rails/generators/base"
+require "rails/generators/active_record"
 
 module ShopifyApp
   module Generators
     class ShopModelGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path("../templates", __FILE__)
 
       class_option :new_shopify_cli_app, type: :boolean, default: false
 
       def create_shop_model
-        copy_file('shop.rb', 'app/models/shop.rb')
+        copy_file("shop.rb", "app/models/shop.rb")
       end
 
       def create_shop_migration
-        migration_template('db/migrate/create_shops.erb', 'db/migrate/create_shops.rb')
+        migration_template("db/migrate/create_shops.erb", "db/migrate/create_shops.rb")
       end
 
       def create_shop_with_access_scopes_migration
@@ -33,24 +34,24 @@ module ShopifyApp
 
         if new_shopify_cli_app? || Rails.env.test? || yes?(scopes_column_prompt)
           migration_template(
-            'db/migrate/add_shop_access_scopes_column.erb',
-            'db/migrate/add_shop_access_scopes_column.rb'
+            "db/migrate/add_shop_access_scopes_column.erb",
+            "db/migrate/add_shop_access_scopes_column.rb"
           )
         end
       end
 
       def update_shopify_app_initializer
-        gsub_file('config/initializers/shopify_app.rb', 'ShopifyApp::InMemoryShopSessionStore', 'Shop')
+        gsub_file("config/initializers/shopify_app.rb", "ShopifyApp::InMemoryShopSessionStore", "Shop")
       end
 
       def create_shop_fixtures
-        copy_file('shops.yml', 'test/fixtures/shops.yml')
+        copy_file("shops.yml", "test/fixtures/shops.yml")
       end
 
       private
 
       def new_shopify_cli_app?
-        options['new_shopify_cli_app']
+        options["new_shopify_cli_app"]
       end
 
       def rails_migration_version

data/lib/generators/shopify_app/shop_model/templates/shop.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Shop < ActiveRecord::Base
   include ShopifyApp::ShopSessionStorageWithScopes
 

data/lib/generators/shopify_app/shopify_app_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ShopifyApp
   module Generators
     class ShopifyAppGenerator < Rails::Generators::Base
@@ -8,10 +9,10 @@ module ShopifyApp
       end
 
       def run_all_generators
-        generate("shopify_app:install #{@opts.join(' ')}")
-        generate("shopify_app:shop_model #{@opts.join(' ')}")
+        generate("shopify_app:install #{@opts.join(" ")}")
+        generate("shopify_app:shop_model #{@opts.join(" ")}")
         generate("shopify_app:authenticated_controller")
-        generate("shopify_app:home_controller #{@opts.join(' ')}")
+        generate("shopify_app:home_controller #{@opts.join(" ")}")
       end
     end
   end

data/lib/generators/shopify_app/user_model/templates/user.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class User < ActiveRecord::Base
   include ShopifyApp::UserSessionStorageWithScopes
 

data/lib/generators/shopify_app/user_model/user_model_generator.rb

@@ -1,21 +1,22 @@
 # frozen_string_literal: true
-require 'rails/generators/base'
-require 'rails/generators/active_record'
+
+require "rails/generators/base"
+require "rails/generators/active_record"
 
 module ShopifyApp
   module Generators
     class UserModelGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path("../templates", __FILE__)
 
       class_option :new_shopify_cli_app, type: :boolean, default: false
 
       def create_user_model
-        copy_file('user.rb', 'app/models/user.rb')
+        copy_file("user.rb", "app/models/user.rb")
       end
 
       def create_user_migration
-        migration_template('db/migrate/create_users.erb', 'db/migrate/create_users.rb')
+        migration_template("db/migrate/create_users.erb", "db/migrate/create_users.rb")
       end
 
       def create_scopes_storage_in_user_model
@@ -33,24 +34,24 @@ module ShopifyApp
 
         if new_shopify_cli_app? || Rails.env.test? || yes?(scopes_column_prompt)
           migration_template(
-            'db/migrate/add_user_access_scopes_column.erb',
-            'db/migrate/add_user_access_scopes_column.rb'
+            "db/migrate/add_user_access_scopes_column.erb",
+            "db/migrate/add_user_access_scopes_column.rb"
           )
         end
       end
 
       def update_shopify_app_initializer
-        gsub_file('config/initializers/shopify_app.rb', 'ShopifyApp::InMemoryUserSessionStore', 'User')
+        gsub_file("config/initializers/shopify_app.rb", "ShopifyApp::InMemoryUserSessionStore", "User")
       end
 
       def create_user_fixtures
-        copy_file('users.yml', 'test/fixtures/users.yml')
+        copy_file("users.yml", "test/fixtures/users.yml")
       end
 
       private
 
       def new_shopify_cli_app?
-        options['new_shopify_cli_app']
+        options["new_shopify_cli_app"]
       end
 
       def rails_migration_version

data/lib/generators/shopify_app/views/views_generator.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'rails/generators/base'
+
+require "rails/generators/base"
 
 module ShopifyApp
   module Generators
@@ -15,14 +16,14 @@ module ShopifyApp
       private
 
       def views
-        files_within_root('.', 'app/views/**/*.*')
+        files_within_root(".", "app/views/**/*.*")
       end
 
       def files_within_root(prefix, glob)
         root = "#{self.class.source_root}/#{prefix}"
 
         Dir["#{root}/#{glob}"].sort.map do |full_path|
-          full_path.sub(root, '.').gsub('/./', '/')
+          full_path.sub(root, ".").gsub("/./", "/")
         end
       end
     end

data/lib/shopify_app/access_scopes/shop_strategy.rb

@@ -12,11 +12,11 @@ module ShopifyApp
         private
 
         def shop_access_scopes(shop_domain)
-          ShopifyApp::SessionRepository.retrieve_shop_session_by_shopify_domain(shop_domain)&.access_scopes
+          ShopifyApp::SessionRepository.retrieve_shop_session_by_shopify_domain(shop_domain)&.scope
         end
 
         def configuration_access_scopes
-          ShopifyAPI::ApiAccess.new(ShopifyApp.configuration.shop_access_scopes)
+          ShopifyAPI::Auth::AuthScopes.new(ShopifyApp.configuration.shop_access_scopes)
         end
       end
     end

data/lib/shopify_app/access_scopes/user_strategy.rb

@@ -9,7 +9,7 @@ module ShopifyApp
         def update_access_scopes?(user_id: nil, shopify_user_id: nil)
           return update_access_scopes_for_user_id?(user_id) if user_id
           return update_access_scopes_for_shopify_user_id?(shopify_user_id) if shopify_user_id
-          raise(InvalidInput, '#update_access_scopes? requires user_id or shopify_user_id parameter inputs')
+          raise(InvalidInput, "#update_access_scopes? requires user_id or shopify_user_id parameter inputs")
         end
 
         private
@@ -25,15 +25,15 @@ module ShopifyApp
         end
 
         def user_access_scopes_by_user_id(user_id)
-          ShopifyApp::SessionRepository.retrieve_user_session(user_id)&.access_scopes
+          ShopifyApp::SessionRepository.retrieve_user_session(user_id)&.scope
         end
 
         def user_access_scopes_by_shopify_user_id(shopify_user_id)
-          ShopifyApp::SessionRepository.retrieve_user_session_by_shopify_user_id(shopify_user_id)&.access_scopes
+          ShopifyApp::SessionRepository.retrieve_user_session_by_shopify_user_id(shopify_user_id)&.scope
         end
 
         def configuration_access_scopes
-          ShopifyAPI::ApiAccess.new(ShopifyApp.configuration.user_access_scopes)
+          ShopifyAPI::Auth::AuthScopes.new(ShopifyApp.configuration.user_access_scopes)
         end
       end
     end