mirror of
				https://github.com/fastapi-users/fastapi-users.git
				synced 2025-11-04 14:45:50 +08:00 
			
		
		
		
	* Add routes for user activation (#403) * Add routes for user activation Generate a token after creating the user in register route, passing to `activation_callback`, if `activation_callback` supplied Create new `/activate` route that will verify the token and activate the user Add new error codes to `fastapi_users/router/common.py` Update documentation Add tests Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk> * Rework routes for user activation * Separate verification logic and token generation into `/fastapi_users/router/verify.py`, with per-route callbacks for custom behaviour * Return register router to original state * Added `is_verified` property to user models * Added `requires_verification` argument to `get_users_router`and `get_auth_router` * Additional dependencies added for verification in `fastapi_users/authentication/__init__.py` * Update tests for new behaviour * Update `README.md` to describe a workaround for possible problems during testing, by exceeding ulimit file descriptor limit Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk> * Restored docs to original state. * All other modifications reqested added Kebab-case on request-verify-token SECRET now used as test string Other minor changes Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk> * Embed token in body in verify route * Reorganize checks in verify route and add unit test * Ignore coverage on Protocol classes * Tweak verify_user function to take full user in parameter * Improve unit tests structure regarding parametrized test client * Make after_verification_request optional to be more consistent with other routers * Tweak status codes on verify routes * Write documentation for verification feature * Add not released warning on verify docs Co-authored-by: Edd Salkield <edd@salkield.uk> Co-authored-by: Mark Todd <markpeter.todd@hotmail.co.uk>
		
			
				
	
	
		
			84 lines
		
	
	
		
			1.8 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
			
		
		
	
	
			84 lines
		
	
	
		
			1.8 KiB
		
	
	
	
		
			Python
		
	
	
	
	
	
import uuid
 | 
						|
from typing import List, Optional, TypeVar
 | 
						|
 | 
						|
from pydantic import UUID4, BaseModel, EmailStr, validator
 | 
						|
 | 
						|
 | 
						|
class CreateUpdateDictModel(BaseModel):
 | 
						|
    def create_update_dict(self):
 | 
						|
        return self.dict(
 | 
						|
            exclude_unset=True,
 | 
						|
            exclude={
 | 
						|
                "id",
 | 
						|
                "is_superuser",
 | 
						|
                "is_active",
 | 
						|
                "is_verified",
 | 
						|
                "oauth_accounts",
 | 
						|
            },
 | 
						|
        )
 | 
						|
 | 
						|
    def create_update_dict_superuser(self):
 | 
						|
        return self.dict(exclude_unset=True, exclude={"id"})
 | 
						|
 | 
						|
 | 
						|
class BaseUser(CreateUpdateDictModel):
 | 
						|
    """Base User model."""
 | 
						|
 | 
						|
    id: Optional[UUID4] = None
 | 
						|
    email: Optional[EmailStr] = None
 | 
						|
    is_active: Optional[bool] = True
 | 
						|
    is_superuser: Optional[bool] = False
 | 
						|
    is_verified: Optional[bool] = False
 | 
						|
 | 
						|
    @validator("id", pre=True, always=True)
 | 
						|
    def default_id(cls, v):
 | 
						|
        return v or uuid.uuid4()
 | 
						|
 | 
						|
 | 
						|
class BaseUserCreate(CreateUpdateDictModel):
 | 
						|
    email: EmailStr
 | 
						|
    password: str
 | 
						|
    is_active: Optional[bool] = True
 | 
						|
    is_superuser: Optional[bool] = False
 | 
						|
    is_verified: Optional[bool] = False
 | 
						|
 | 
						|
 | 
						|
class BaseUserUpdate(BaseUser):
 | 
						|
    password: Optional[str]
 | 
						|
 | 
						|
 | 
						|
class BaseUserDB(BaseUser):
 | 
						|
    id: UUID4
 | 
						|
    hashed_password: str
 | 
						|
 | 
						|
    class Config:
 | 
						|
        orm_mode = True
 | 
						|
 | 
						|
 | 
						|
UD = TypeVar("UD", bound=BaseUserDB)
 | 
						|
 | 
						|
 | 
						|
class BaseOAuthAccount(BaseModel):
 | 
						|
    """Base OAuth account model."""
 | 
						|
 | 
						|
    id: Optional[UUID4] = None
 | 
						|
    oauth_name: str
 | 
						|
    access_token: str
 | 
						|
    expires_at: Optional[int] = None
 | 
						|
    refresh_token: Optional[str] = None
 | 
						|
    account_id: str
 | 
						|
    account_email: str
 | 
						|
 | 
						|
    @validator("id", pre=True, always=True)
 | 
						|
    def default_id(cls, v):
 | 
						|
        return v or uuid.uuid4()
 | 
						|
 | 
						|
    class Config:
 | 
						|
        orm_mode = True
 | 
						|
 | 
						|
 | 
						|
class BaseOAuthAccountMixin(BaseModel):
 | 
						|
    """Adds OAuth accounts list to a User model."""
 | 
						|
 | 
						|
    oauth_accounts: List[BaseOAuthAccount] = []
 |