Module supertokens_python.recipe.thirdparty.utils
Expand source code
# Copyright (c) 2021, VRAI Labs and/or its affiliates. All rights reserved.
#
# This software is licensed under the Apache License, Version 2.0 (the
# "License") as published by the Apache Software Foundation.
#
# You may not use this file except in compliance with the License. You may
# obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from __future__ import annotations
from typing import List, Callable, TYPE_CHECKING, Union
from .interfaces import RecipeInterface, APIInterface
from .types import INPUT_SCHEMA
from .constants import DEV_OAUTH_CLIENT_IDS
from supertokens_python.exceptions import raise_bad_input_exception
if TYPE_CHECKING:
from .recipe import ThirdPartyRecipe
from .provider import Provider
from supertokens_python.utils import validate_the_structure_of_user_input
class SignInAndUpFeature:
def __init__(self, providers: List[Provider]):
self.providers = providers
def validate_and_normalise_sign_in_and_up_config(
config=None) -> SignInAndUpFeature:
if config is None:
config = {}
providers = config['providers']
if providers is None or len(providers) == 0:
raise_bad_input_exception('thirdparty recipe requires atleast 1 provider to be passed in '
'sign_in_and_up_feature.providers config')
return SignInAndUpFeature(providers)
def email_verification_create_and_send_custom_email(
recipe: ThirdPartyRecipe, create_and_send_custom_email):
async def func(user, link):
user_info = await recipe.recipe_implementation.get_user_by_id(user.id)
if user_info is None:
raise Exception('Unknown User ID provided')
return await create_and_send_custom_email(user_info, link)
return func
def email_verification_get_email_verification_url(
recipe: ThirdPartyRecipe, get_email_verification_url):
async def func(user):
user_info = await recipe.recipe_implementation.get_user_by_id(user.id)
if user_info is None:
raise Exception(recipe, 'Unknown User ID provided')
return await get_email_verification_url(user_info)
return func
def validate_and_normalise_email_verification_config(
recipe: ThirdPartyRecipe, config=None, override=None):
create_and_send_custom_email = None
get_email_verification_url = None
if config is None:
config = {}
if override is None:
override = {}
if 'create_and_send_custom_email' in config:
create_and_send_custom_email = email_verification_create_and_send_custom_email(recipe, config[
'create_and_send_custom_email'])
if 'get_email_verification_url' in config:
get_email_verification_url = email_verification_get_email_verification_url(recipe,
config['get_email_verification_url'])
return {
'get_email_for_user_id': recipe.get_email_for_user_id,
'create_and_send_custom_email': create_and_send_custom_email,
'get_email_verification_url': get_email_verification_url,
'override': override
}
class OverrideConfig:
def __init__(self, functions: Union[Callable[[RecipeInterface], RecipeInterface], None],
apis: Union[Callable[[APIInterface], APIInterface], None]):
self.functions = functions
self.apis = apis
class ThirdPartyConfig:
def __init__(self,
sign_in_and_up_feature: SignInAndUpFeature,
email_verification_feature: any,
override: OverrideConfig):
self.sign_in_and_up_feature = sign_in_and_up_feature
self.email_verification_feature = email_verification_feature
self.override = override
def validate_and_normalise_user_input(
recipe: ThirdPartyRecipe, config) -> ThirdPartyConfig:
validate_the_structure_of_user_input(
config, INPUT_SCHEMA, 'thirdparty recipe', recipe)
sign_in_and_up_feature = validate_and_normalise_sign_in_and_up_config(
config['sign_in_and_up_feature'] if 'sign_in_and_up_feature' in config else None)
email_verification_feature = validate_and_normalise_email_verification_config(
recipe,
config['email_verification_feature'] if 'email_verification_feature' in config else None,
config['override']['email_verification_feature'] if 'override' in config and 'email_verification_feature' in
config['override'] else None)
override_functions = config['override']['functions'] if 'override' in config and 'functions' in config[
'override'] else None
override_apis = config['override']['apis'] if 'override' in config and 'apis' in config[
'override'] else None
override = OverrideConfig(override_functions, override_apis)
return ThirdPartyConfig(sign_in_and_up_feature,
email_verification_feature, override)
def is_using_oauth_development_keys(client_id: str):
return client_id in DEV_OAUTH_CLIENT_IDS
Functions
def email_verification_create_and_send_custom_email(recipe: ThirdPartyRecipe, create_and_send_custom_email)
-
Expand source code
def email_verification_create_and_send_custom_email( recipe: ThirdPartyRecipe, create_and_send_custom_email): async def func(user, link): user_info = await recipe.recipe_implementation.get_user_by_id(user.id) if user_info is None: raise Exception('Unknown User ID provided') return await create_and_send_custom_email(user_info, link) return func
def email_verification_get_email_verification_url(recipe: ThirdPartyRecipe, get_email_verification_url)
-
Expand source code
def email_verification_get_email_verification_url( recipe: ThirdPartyRecipe, get_email_verification_url): async def func(user): user_info = await recipe.recipe_implementation.get_user_by_id(user.id) if user_info is None: raise Exception(recipe, 'Unknown User ID provided') return await get_email_verification_url(user_info) return func
def is_using_oauth_development_keys(client_id: str)
-
Expand source code
def is_using_oauth_development_keys(client_id: str): return client_id in DEV_OAUTH_CLIENT_IDS
def validate_and_normalise_email_verification_config(recipe: ThirdPartyRecipe, config=None, override=None)
-
Expand source code
def validate_and_normalise_email_verification_config( recipe: ThirdPartyRecipe, config=None, override=None): create_and_send_custom_email = None get_email_verification_url = None if config is None: config = {} if override is None: override = {} if 'create_and_send_custom_email' in config: create_and_send_custom_email = email_verification_create_and_send_custom_email(recipe, config[ 'create_and_send_custom_email']) if 'get_email_verification_url' in config: get_email_verification_url = email_verification_get_email_verification_url(recipe, config['get_email_verification_url']) return { 'get_email_for_user_id': recipe.get_email_for_user_id, 'create_and_send_custom_email': create_and_send_custom_email, 'get_email_verification_url': get_email_verification_url, 'override': override }
def validate_and_normalise_sign_in_and_up_config(config=None) ‑> SignInAndUpFeature
-
Expand source code
def validate_and_normalise_sign_in_and_up_config( config=None) -> SignInAndUpFeature: if config is None: config = {} providers = config['providers'] if providers is None or len(providers) == 0: raise_bad_input_exception('thirdparty recipe requires atleast 1 provider to be passed in ' 'sign_in_and_up_feature.providers config') return SignInAndUpFeature(providers)
def validate_and_normalise_user_input(recipe: ThirdPartyRecipe, config) ‑> ThirdPartyConfig
-
Expand source code
def validate_and_normalise_user_input( recipe: ThirdPartyRecipe, config) -> ThirdPartyConfig: validate_the_structure_of_user_input( config, INPUT_SCHEMA, 'thirdparty recipe', recipe) sign_in_and_up_feature = validate_and_normalise_sign_in_and_up_config( config['sign_in_and_up_feature'] if 'sign_in_and_up_feature' in config else None) email_verification_feature = validate_and_normalise_email_verification_config( recipe, config['email_verification_feature'] if 'email_verification_feature' in config else None, config['override']['email_verification_feature'] if 'override' in config and 'email_verification_feature' in config['override'] else None) override_functions = config['override']['functions'] if 'override' in config and 'functions' in config[ 'override'] else None override_apis = config['override']['apis'] if 'override' in config and 'apis' in config[ 'override'] else None override = OverrideConfig(override_functions, override_apis) return ThirdPartyConfig(sign_in_and_up_feature, email_verification_feature, override)
Classes
class OverrideConfig (functions: Union[Callable[[RecipeInterface], RecipeInterface], None], apis: Union[Callable[[APIInterface], APIInterface], None])
-
Expand source code
class OverrideConfig: def __init__(self, functions: Union[Callable[[RecipeInterface], RecipeInterface], None], apis: Union[Callable[[APIInterface], APIInterface], None]): self.functions = functions self.apis = apis
class SignInAndUpFeature (providers: List[Provider])
-
Expand source code
class SignInAndUpFeature: def __init__(self, providers: List[Provider]): self.providers = providers
class ThirdPartyConfig (sign_in_and_up_feature: SignInAndUpFeature, email_verification_feature: any, override: OverrideConfig)
-
Expand source code
class ThirdPartyConfig: def __init__(self, sign_in_and_up_feature: SignInAndUpFeature, email_verification_feature: any, override: OverrideConfig): self.sign_in_and_up_feature = sign_in_and_up_feature self.email_verification_feature = email_verification_feature self.override = override