shopify_app 21.6.0 → 21.8.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}
-```