shopify_app 21.6.0 → 22.5.0

data/docs/shopify_app/session-repository.md

@@ -1,79 +0,0 @@
-# Session repository
-
-#### Table of contents
-
-[`ShopifyApp::SessionRepository`](#shopifyappsessionrepository)
-  * [Shop-based token storage](#shop-based-token-storage)
-  * [User-based token storage](#user-based-token-storage)
-
-[Access scopes](#access-scopes)
-  * [`ShopifyApp::ShopSessionStorageWithScopes`](#shopifyappshopsessionstoragewithscopes)
-  * [``ShopifyApp::UserSessionStorageWithScopes``](#shopifyappusersessionstoragewithscopes)
-
-[Migrating from shop-based to user-based token strategy](#migrating-from-shop-based-to-user-based-token-strategy)
-
-## ShopifyApp::SessionRepository
-
-`ShopifyApp::SessionRepository` allows you as a developer to define how your sessions are stored and retrieved for shops. The `SessionRepository` is configured in the `config/initializers/shopify_app.rb` file and can be set to any object that implements `self.store(auth_session, *args)` which stores the session and returns a unique identifier and `self.retrieve(id)` which returns a `ShopifyAPI::Session` for the passed id. These methods are already implemented as part of the `ShopifyApp::SessionStorage` concern but can be overridden for custom implementation.
-
-### Shop-based token storage
-
-Storing tokens on the store model means that any user login associated with the store will have equal access levels to whatever the original user granted the app.
-```sh
-rails generate shopify_app:shop_model
-```
-This will generate a shop model which will be the storage for the tokens necessary for authentication.
-
-### User-based token storage
-
-A more granular control over the level of access per user on an app might be necessary, to which the shop-based token strategy is not sufficient. Shopify supports a user-based token storage strategy where a unique token to each user can be managed. Shop tokens must still be maintained if you are running background jobs so that you can make use of them when necessary.
-```sh
-rails generate shopify_app:shop_model
-rails generate shopify_app:user_model
-```
-This will generate a shop model and user model, which will be the storage for the tokens necessary for authentication.
-
-The current Shopify user will be stored in the rails session at `session[:shopify_user]`
-
-Read more about Online vs. Offline access [here](https://shopify.dev/apps/auth/oauth/access-modes).
-
-## Access scopes
-
-If you want to customize how access scopes are stored for shops and users, you can implement the `access_scopes` getters and setters in the models that include `ShopifyApp::ShopSessionStorageWithScopes` and `ShopifyApp::UserSessionStorageWithScopes` as shown:
-
-### `ShopifyApp::ShopSessionStorageWithScopes`
-```ruby
-class Shop < ActiveRecord::Base
-  include ShopifyApp::ShopSessionStorageWithScopes
-
-  def access_scopes=(scopes)
-    # Store access scopes
-  end
-  def access_scopes
-    # Find access scopes
-  end
-end
-```
-
-### `ShopifyApp::UserSessionStorageWithScopes`
-```ruby
-class User < ActiveRecord::Base
-  include ShopifyApp::UserSessionStorageWithScopes
-
-  def access_scopes=(scopes)
-    # Store access scopes
-  end
-  def access_scopes
-    # Find access scopes
-  end
-end
-```
-## Migrating from shop-based to user-based token strategy
-
-1. Run the `user_model` generator as mentioned above.
-2. Ensure that both your `Shop` model and `User` model includes the necessary concerns `ShopifyApp::ShopSessionStorage` and `ShopifyApp::UserSessionStorage`.
-3. Make changes to the `shopify_app.rb` initializer file as shown below:
-```ruby
-config.shop_session_repository = {YOUR_SHOP_MODEL_CLASS}
-config.user_session_repository = {YOUR_USER_MODEL_CLASS}
-```

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

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/base"
-
-module ShopifyApp
-  module Generators
-    class AddMarketingActivityExtensionGenerator < Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
-
-      def generate_app_extension
-        ShopifyApp::Logger.deprecated("MarketingActivitiesController will be removed in an upcoming version", "22.0.0")
-        template("marketing_activities_controller.rb", "app/controllers/marketing_activities_controller.rb")
-        generate_routes
-      end
-
-      private
-
-      def generate_routes
-        inject_into_file(
-          "config/routes.rb",
-          optimize_indentation(routes, 2),
-          after: "root :to => 'home#index'\n",
-        )
-      end
-
-      def routes
-        <<~EOS
-
-          resource :marketing_activities, only: [:create, :update] do
-            patch :resume
-            patch :pause
-            patch :delete
-            post :republish
-            post :preload_form_data
-            post :preview
-            post :errors
-          end
-        EOS
-      end
-    end
-  end
-end

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

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-class MarketingActivitiesController < ShopifyApp::ExtensionVerificationController
-  def preload_form_data
-    preload_data = {
-      "form_data": {},
-    }
-    render(json: preload_data, status: :ok)
-  end
-
-  def update
-    render(json: {}, status: :accepted)
-  end
-
-  def pause
-    render(json: {}, status: :accepted)
-  end
-
-  def resume
-    render(json: {}, status: :accepted)
-  end
-
-  def delete
-    render(json: {}, status: :accepted)
-  end
-
-  def preview
-    placeholder_img = "https://cdn.shopify.com/s/files/1/0533/2089/files/placeholder-images-image_small.png"
-    preview_response = {
-      "desktop": {
-        "preview_url": placeholder_img,
-        "content_type": "text/html",
-        "width": 360,
-        "height": 200,
-      },
-      "mobile": {
-        "preview_url": placeholder_img,
-        "content_type": "text/html",
-        "width": 360,
-        "height": 200,
-      },
-    }
-    render(json: preview_response, status: :ok)
-  end
-
-  def create
-    render(json: {}, status: :ok)
-  end
-
-  def republish
-    render(json: {}, status: :accepted)
-  end
-
-  def errors
-    request_id = params[:request_id]
-    message = params[:message]
-
-    ShopifyApp::Logger.info("[Marketing Activity App Error Feedback]"\
-      "Request id: #{request_id}, message: #{message}")
-
-    render(json: {}, status: :ok)
-  end
-end

data/lib/shopify_app/controller_concerns/itp.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyApp
-  # Cookie management helpers required for ITP implementation
-  module Itp
-    extend ActiveSupport::Concern
-    included do
-      ShopifyApp::Logger.deprecated("Itp will be removed in an upcoming version", "22.0.0")
-    end
-
-    private
-
-    def set_test_cookie
-      return unless ShopifyApp.configuration.embedded_app?
-      return unless user_agent_can_partition_cookies
-
-      session["shopify.cookies_persist"] = true
-    end
-
-    def set_top_level_oauth_cookie
-      session["shopify.top_level_oauth"] = true
-    end
-
-    def clear_top_level_oauth_cookie
-      session.delete("shopify.top_level_oauth")
-    end
-
-    def user_agent_is_mobile
-      user_agent = BrowserSniffer.new(request.user_agent).browser_info
-
-      user_agent[:name].to_s.match(/Shopify\sMobile/)
-    end
-
-    def user_agent_is_pos
-      user_agent = BrowserSniffer.new(request.user_agent).browser_info
-
-      user_agent[:name].to_s.match(/Shopify\sPOS/)
-    end
-
-    def user_agent_can_partition_cookies
-      user_agent = BrowserSniffer.new(request.user_agent).browser_info
-
-      is_safari = user_agent[:name].to_s.match(/Safari/)
-
-      return false unless is_safari
-
-      user_agent[:version].to_s.match(/12\.0/)
-    end
-  end
-end

data/lib/shopify_app/jobs/scripttags_manager_job.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyApp
-  class ScripttagsManagerJob < ActiveJob::Base
-    queue_as do
-      ShopifyApp.configuration.scripttags_manager_queue_name
-    end
-
-    def perform(shop_domain:, shop_token:, scripttags:)
-      ShopifyAPI::Auth::Session.temp(shop: shop_domain, access_token: shop_token) do
-        manager = ScripttagsManager.new(scripttags, shop_domain)
-        manager.create_scripttags
-      end
-    end
-  end
-end

data/lib/shopify_app/managers/scripttags_manager.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-module ShopifyApp
-  class ScripttagsManager
-    def self.queue(shop_domain, shop_token, scripttags)
-      ShopifyApp::ScripttagsManagerJob.perform_later(
-        shop_domain: shop_domain,
-        shop_token: shop_token,
-        # Procs cannot be serialized so we interpolate now, if necessary
-        scripttags: build_src(scripttags, shop_domain),
-      )
-    end
-
-    def self.build_src(scripttags, domain)
-      scripttags.map do |tag|
-        next tag unless tag[:src].respond_to?(:call)
-
-        tag = tag.dup
-        tag[:src] = tag[:src].call(domain)
-        tag
-      end
-    end
-
-    attr_reader :required_scripttags, :shop_domain
-
-    def initialize(scripttags, shop_domain)
-      ShopifyApp::Logger.deprecated("The ScripttagsManager will become deprecated in an upcoming version", "22.0.0")
-      @required_scripttags = scripttags
-      @shop_domain = shop_domain
-    end
-
-    def recreate_scripttags!
-      destroy_scripttags
-      create_scripttags
-    end
-
-    def create_scripttags
-      return unless required_scripttags.present?
-
-      expanded_scripttags.each do |scripttag|
-        create_scripttag(scripttag) unless scripttag_exists?(scripttag[:src])
-      end
-    end
-
-    def destroy_scripttags
-      scripttags = expanded_scripttags
-      ShopifyAPI::ScriptTag.all.each do |tag|
-        tag.delete if required_scripttag?(scripttags, tag)
-      end
-
-      @current_scripttags = nil
-    end
-
-    private
-
-    def expanded_scripttags
-      self.class.build_src(required_scripttags, shop_domain)
-    end
-
-    def required_scripttag?(scripttags, tag)
-      scripttags.map { |w| w[:src] }.include?(tag.src)
-    end
-
-    def create_scripttag(attributes)
-      scripttag = ShopifyAPI::ScriptTag.new
-      attributes.each { |key, value| scripttag.public_send("#{key}=", value) }
-
-      begin
-        scripttag.save!
-      rescue ShopifyAPI::Errors::HttpResponseError => e
-        raise ::ShopifyApp::CreationFailed, e.message
-      end
-
-      scripttag
-    end
-
-    def scripttag_exists?(src)
-      current_scripttags[src]
-    end
-
-    def current_scripttags
-      @current_scripttags ||= ShopifyAPI::ScriptTag.all.index_by(&:src)
-    end
-  end
-end