shopify_app 13.5.0

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

@@ -0,0 +1,15 @@
+ShopifyApp.configure do |config|
+  config.application_name = "<%= @application_name %>"
+  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
+  config.embedded_app = <%= embedded_app? %>
+  config.after_authenticate_job = false
+  config.api_version = "<%= @api_version %>"
+  config.shop_session_repository = 'Shop'
+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/shopify_provider.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+provider :shopify,
+  ShopifyApp.configuration.api_key,
+  ShopifyApp.configuration.secret,
+  scope: ShopifyApp.configuration.scope,
+  setup: lambda { |env|
+    strategy = env['omniauth.strategy']
+
+    shopify_auth_params = strategy.session['shopify.omniauth_params']&.with_indifferent_access
+    shop = if shopify_auth_params.present?
+      "https://#{shopify_auth_params[:shop]}"
+    else
+      ''
+    end
+
+    strategy.options[:client_options][:site] = shop
+    strategy.options[:old_client_secret] = ShopifyApp.configuration.old_secret
+    strategy.options[:per_user_permissions] = strategy.session[:user_tokens]
+  }

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

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

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module ShopifyApp
+  module Generators
+    class RotateShopifyTokenJobGenerator < Rails::Generators::Base
+      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")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# 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|
+    all_active_shops.find_each do |shop|
+      Shopify::RotateShopifyTokenJob.perform_later(
+        shop_domain: shop.shopify_domain,
+        refresh_token: args[:refresh_token]
+      )
+    end
+  end
+
+  # Its implementation will depend on the app configuration. Change accordingly.
+  def all_active_shops
+    Shop.all
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Shopify
+  class RotateShopifyTokenJob < ActiveJob::Base
+    def perform(params)
+      @shop = Shop.find_by(shopify_domain: params[:shop_domain])
+      return unless @shop
+
+      config = ShopifyApp.configuration
+      uri = URI("https://#{@shop.shopify_domain}/admin/oauth/access_token")
+      post_data = {
+        client_id: config.api_key,
+        client_secret: config.secret,
+        refresh_token: params[:refresh_token],
+        access_token: @shop.shopify_token,
+      }
+
+      @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']
+      return log_error(no_access_token_error_message) unless access_token
+
+      @shop.update(shopify_token: access_token)
+    end
+
+    private
+
+    def log_error(message)
+      Rails.logger.error(message)
+    end
+
+    def no_access_token_error_message
+      "RotateShopifyTokenJob response returned no access token for shop: #{@shop.shopify_domain}"
+    end
+
+    def response_exception_error_message
+      "RotateShopifyTokenJob failed for shop: #{@shop.shopify_domain}." \
+        "Response returned status: #{@response.code}. Error message: #{@response.message}. "
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+
+module ShopifyApp
+  module Generators
+    class RoutesGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def inject_shopify_app_routes_into_application_routes
+        route(session_routes)
+      end
+
+      def disable_engine_routes
+        gsub_file(
+          'config/routes.rb',
+          "mount ShopifyApp::Engine, at: '/'",
+          ''
+        )
+      end
+
+      private
+
+      def session_routes
+        File.read(routes_file_path)
+      end
+
+      def routes_file_path
+        File.expand_path(find_in_source_paths('routes.rb'))
+      end
+    end
+  end
+end

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

@@ -0,0 +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
+end
+
+namespace :webhooks do
+  post ':type' => :receive
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+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__)
+
+      def create_shop_model
+        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')
+      end
+
+      def update_shopify_app_initializer
+        gsub_file('config/initializers/shopify_app.rb', 'ShopifyApp::InMemoryShopSessionStore', 'Shop')
+      end
+
+      def create_shop_fixtures
+        copy_file('shops.yml', 'test/fixtures/shops.yml')
+      end
+
+      private
+
+      def rails_migration_version
+        Rails.version.match(/\d\.\d/)[0]
+      end
+
+      class << self
+        private :next_migration_number
+
+        # for generating a timestamp when using `create_migration`
+        def next_migration_number(dir)
+          ActiveRecord::Generators::Base.next_migration_number(dir)
+        end
+      end
+    end
+  end
+end

data/lib/generators/shopify_app/shop_model/templates/db/migrate/create_shops.erb

@@ -0,0 +1,15 @@
+class CreateShops < ActiveRecord::Migration[<%= rails_migration_version %>]
+  def self.up
+    create_table :shops  do |t|
+      t.string :shopify_domain, null: false
+      t.string :shopify_token, null: false
+      t.timestamps
+    end
+
+    add_index :shops, :shopify_domain, unique: true
+  end
+
+  def self.down
+    drop_table :shops
+  end
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+class Shop < ActiveRecord::Base
+  include ShopifyApp::ShopSessionStorage
+
+  def api_version
+    ShopifyApp.configuration.api_version
+  end
+end

data/lib/generators/shopify_app/shop_model/templates/shops.yml

@@ -0,0 +1,3 @@
+regular_shop:
+  shopify_domain: 'regular-shop.myshopify.com'
+  shopify_token: 'token'

data/lib/generators/shopify_app/shopify_app_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module ShopifyApp
+  module Generators
+    class ShopifyAppGenerator < Rails::Generators::Base
+      def initialize(args, *options)
+        @opts = options.first
+        super(args, *options)
+      end
+
+      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
+  end
+end

data/lib/generators/shopify_app/user_model/templates/db/migrate/create_users.erb

@@ -0,0 +1,16 @@
+class CreateUsers < ActiveRecord::Migration[<%= rails_migration_version %>]
+  def self.up
+    create_table :users do |t|
+      t.bigint :shopify_user_id, null: false
+      t.string :shopify_domain, null: false
+      t.string :shopify_token, null: false
+      t.timestamps
+    end
+
+    add_index :users, :shopify_user_id, unique: true
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+class User < ActiveRecord::Base
+  include ShopifyApp::UserSessionStorage
+
+  def api_version
+    ShopifyApp.configuration.api_version
+  end
+end

data/lib/generators/shopify_app/user_model/templates/users.yml

@@ -0,0 +1,4 @@
+regular_user:
+  shopify_domain: 'regular-shop.myshopify.com'
+  shopify_token: 'token'
+  shopify_user_id: 1

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+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__)
+
+      def create_user_model
+        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')
+      end
+
+      def update_shopify_app_initializer
+        gsub_file('config/initializers/shopify_app.rb', 'ShopifyApp::InMemoryUserSessionStore', 'User')
+      end
+
+      def create_user_fixtures
+        copy_file('users.yml', 'test/fixtures/users.yml')
+      end
+
+      private
+
+      def rails_migration_version
+        Rails.version.match(/\d\.\d/)[0]
+      end
+
+      class << self
+        private :next_migration_number
+
+        # for generating a timestamp when using `create_migration`
+        def next_migration_number(dir)
+          ActiveRecord::Generators::Base.next_migration_number(dir)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require 'rails/generators/base'
+
+module ShopifyApp
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../..", __FILE__)
+
+      def create_views
+        views.each do |view|
+          copy_file view
+        end
+      end
+
+      private
+
+      def 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('/./', '/')
+        end
+      end
+    end
+  end
+end

data/lib/shopify_app.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+require 'shopify_app/version'
+
+# deps
+require 'shopify_api'
+require 'omniauth-shopify-oauth2'
+require 'redirect_safely'
+
+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/csrf_protection'
+  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/payload_verification'
+  require 'shopify_app/controller_concerns/app_proxy_verification'
+  require 'shopify_app/controller_concerns/webhook_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'
+
+  # middleware
+  require 'shopify_app/middleware/jwt_middleware'
+  require 'shopify_app/middleware/same_site_cookie_middleware'
+
+  # session
+  require 'shopify_app/session/in_memory_session_store'
+  require 'shopify_app/session/in_memory_shop_session_store'
+  require 'shopify_app/session/in_memory_user_session_store'
+  require 'shopify_app/session/jwt'
+  require 'shopify_app/session/null_user_session_store'
+  require 'shopify_app/session/session_repository'
+  require 'shopify_app/session/session_storage'
+  require 'shopify_app/session/shop_session_storage'
+  require 'shopify_app/session/user_session_storage'
+end

data/lib/shopify_app/configuration.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+module ShopifyApp
+  class Configuration
+    # Shopify App settings. These values should match the configuration
+    # for the app in your Shopify Partners page. Change your settings in
+    # `config/initializers/shopify_app.rb`
+    attr_accessor :application_name
+    attr_accessor :api_key
+    attr_accessor :secret
+    attr_accessor :old_secret
+    attr_accessor :scope
+    attr_accessor :embedded_app
+    alias_method  :embedded_app?, :embedded_app
+    attr_accessor :webhooks
+    attr_accessor :scripttags
+    attr_accessor :after_authenticate_job
+    attr_accessor :api_version
+
+    # customise urls
+    attr_accessor :root_url
+    attr_writer :login_url
+
+    # customise ActiveJob queue names
+    attr_accessor :scripttags_manager_queue_name
+    attr_accessor :webhooks_manager_queue_name
+
+    # configure myshopify domain for local shopify development
+    attr_accessor :myshopify_domain
+
+    # ability to have webpacker installed but not used in this gem and the generators
+    attr_accessor :disable_webpacker
+
+    # allow namespacing webhook jobs
+    attr_accessor :webhook_jobs_namespace
+
+    # allow enabling of same site none on cookies
+    attr_writer :enable_same_site_none
+
+    # allow enabling jwt headers for authentication
+    attr_accessor :allow_jwt_authentication
+
+    def initialize
+      @root_url = '/'
+      @myshopify_domain = 'myshopify.com'
+      @scripttags_manager_queue_name = Rails.application.config.active_job.queue_name
+      @webhooks_manager_queue_name = Rails.application.config.active_job.queue_name
+      @disable_webpacker = ENV['SHOPIFY_APP_DISABLE_WEBPACKER'].present?
+    end
+
+    def login_url
+      @login_url || File.join(@root_url, 'login')
+    end
+
+    def user_session_repository=(klass)
+      ShopifyApp::SessionRepository.user_storage = klass
+    end
+
+    def user_session_repository
+      ShopifyApp::SessionRepository.user_storage
+    end
+
+    def shop_session_repository=(klass)
+      ShopifyApp::SessionRepository.shop_storage = klass
+    end
+
+    def shop_session_repository
+      ShopifyApp::SessionRepository.shop_storage
+    end
+
+    def has_webhooks?
+      webhooks.present?
+    end
+
+    def has_scripttags?
+      scripttags.present?
+    end
+
+    def enable_same_site_none
+      !Rails.env.test? && (@enable_same_site_none.nil? ? embedded_app? : @enable_same_site_none)
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  def self.configure
+    yield configuration
+  end
+end