Revamp authentication routes structure (#201)

* Fix #68: use makefun to generate dynamic dependencies

* Remove every Starlette imports

* Split every routers and remove event handlers

* Make users router optional

* Pass after_update handler to get_users_router

* Update documentation

* Remove test file

* Write migration doc for splitted routers

docs/src/full_mongodb.py

@@ -1,9 +1,8 @@
 import motor.motor_asyncio
-from fastapi import FastAPI
+from fastapi import FastAPI, Request
 from fastapi_users import FastAPIUsers, models
 from fastapi_users.authentication import JWTAuthentication
 from fastapi_users.db import MongoDBUserDatabase
-from starlette.requests import Request
 
 DATABASE_URL = "mongodb://localhost:27017"
 SECRET = "SECRET"
@@ -32,22 +31,32 @@ db = client["database_name"]
 collection = db["users"]
 user_db = MongoDBUserDatabase(UserDB, collection)
 
-auth_backends = [
-    JWTAuthentication(secret=SECRET, lifetime_seconds=3600),
-]
 
-app = FastAPI()
-fastapi_users = FastAPIUsers(
-    user_db, auth_backends, User, UserCreate, UserUpdate, UserDB, SECRET,
-)
-app.include_router(fastapi_users.router, prefix="/users", tags=["users"])
-
-
-@fastapi_users.on_after_register()
-def on_after_register(user: User, request: Request):
+def on_after_register(user: UserDB, request: Request):
     print(f"User {user.id} has registered.")
 
 
-@fastapi_users.on_after_forgot_password()
-def on_after_forgot_password(user: User, token: str, request: Request):
+def on_after_forgot_password(user: UserDB, token: str, request: Request):
     print(f"User {user.id} has forgot their password. Reset token: {token}")
+
+
+jwt_authentication = JWTAuthentication(secret=SECRET, lifetime_seconds=3600)
+
+app = FastAPI()
+fastapi_users = FastAPIUsers(
+    user_db, [jwt_authentication], User, UserCreate, UserUpdate, UserDB,
+)
+app.include_router(
+    fastapi_users.get_auth_router(jwt_authentication), prefix="/auth/jwt", tags=["auth"]
+)
+app.include_router(
+    fastapi_users.get_register_router(on_after_register), prefix="/auth", tags=["auth"]
+)
+app.include_router(
+    fastapi_users.get_reset_password_router(
+        SECRET, after_forgot_password=on_after_forgot_password
+    ),
+    prefix="/auth",
+    tags=["auth"],
+)
+app.include_router(fastapi_users.get_users_router(), prefix="/users", tags=["users"])

docs/src/full_sqlalchemy.py

@@ -1,11 +1,10 @@
 import databases
 import sqlalchemy
-from fastapi import FastAPI
+from fastapi import FastAPI, Request
 from fastapi_users import FastAPIUsers, models
 from fastapi_users.authentication import JWTAuthentication
 from fastapi_users.db import SQLAlchemyBaseUserTable, SQLAlchemyUserDatabase
 from sqlalchemy.ext.declarative import DeclarativeMeta, declarative_base
-from starlette.requests import Request
 
 DATABASE_URL = "sqlite:///./test.db"
 SECRET = "SECRET"
@@ -44,27 +43,36 @@ users = UserTable.__table__
 user_db = SQLAlchemyUserDatabase(UserDB, database, users)
 
 
-auth_backends = [
-    JWTAuthentication(secret=SECRET, lifetime_seconds=3600),
-]
-
-app = FastAPI()
-fastapi_users = FastAPIUsers(
-    user_db, auth_backends, User, UserCreate, UserUpdate, UserDB, SECRET,
-)
-app.include_router(fastapi_users.router, prefix="/users", tags=["users"])
-
-
-@fastapi_users.on_after_register()
-def on_after_register(user: User, request: Request):
+def on_after_register(user: UserDB, request: Request):
     print(f"User {user.id} has registered.")
 
 
-@fastapi_users.on_after_forgot_password()
-def on_after_forgot_password(user: User, token: str, request: Request):
+def on_after_forgot_password(user: UserDB, token: str, request: Request):
     print(f"User {user.id} has forgot their password. Reset token: {token}")
 
 
+jwt_authentication = JWTAuthentication(secret=SECRET, lifetime_seconds=3600)
+
+app = FastAPI()
+fastapi_users = FastAPIUsers(
+    user_db, [jwt_authentication], User, UserCreate, UserUpdate, UserDB,
+)
+app.include_router(
+    fastapi_users.get_auth_router(jwt_authentication), prefix="/auth/jwt", tags=["auth"]
+)
+app.include_router(
+    fastapi_users.get_register_router(on_after_register), prefix="/auth", tags=["auth"]
+)
+app.include_router(
+    fastapi_users.get_reset_password_router(
+        SECRET, after_forgot_password=on_after_forgot_password
+    ),
+    prefix="/auth",
+    tags=["auth"],
+)
+app.include_router(fastapi_users.get_users_router(), prefix="/users", tags=["users"])
+
+
 @app.on_event("startup")
 async def startup():
     await database.connect()

docs/src/full_tortoise.py

@@ -1,8 +1,7 @@
-from fastapi import FastAPI
+from fastapi import FastAPI, Request
 from fastapi_users import FastAPIUsers, models
 from fastapi_users.authentication import JWTAuthentication
 from fastapi_users.db import TortoiseBaseUserModel, TortoiseUserDatabase
-from starlette.requests import Request
 from tortoise.contrib.starlette import register_tortoise
 
 DATABASE_URL = "sqlite://./test.db"
@@ -33,21 +32,31 @@ user_db = TortoiseUserDatabase(UserDB, UserModel)
 app = FastAPI()
 register_tortoise(app, db_url=DATABASE_URL, modules={"models": ["test"]})
 
-auth_backends = [
-    JWTAuthentication(secret=SECRET, lifetime_seconds=3600),
-]
 
-fastapi_users = FastAPIUsers(
-    user_db, auth_backends, User, UserCreate, UserUpdate, UserDB, SECRET,
-)
-app.include_router(fastapi_users.router, prefix="/users", tags=["users"])
-
-
-@fastapi_users.on_after_register()
-def on_after_register(user: User, request: Request):
+def on_after_register(user: UserDB, request: Request):
     print(f"User {user.id} has registered.")
 
 
-@fastapi_users.on_after_forgot_password()
-def on_after_forgot_password(user: User, token: str, request: Request):
+def on_after_forgot_password(user: UserDB, token: str, request: Request):
     print(f"User {user.id} has forgot their password. Reset token: {token}")
+
+
+jwt_authentication = JWTAuthentication(secret=SECRET, lifetime_seconds=3600)
+
+fastapi_users = FastAPIUsers(
+    user_db, [jwt_authentication], User, UserCreate, UserUpdate, UserDB,
+)
+app.include_router(
+    fastapi_users.get_auth_router(jwt_authentication), prefix="/auth/jwt", tags=["auth"]
+)
+app.include_router(
+    fastapi_users.get_register_router(on_after_register), prefix="/auth", tags=["auth"]
+)
+app.include_router(
+    fastapi_users.get_reset_password_router(
+        SECRET, after_forgot_password=on_after_forgot_password
+    ),
+    prefix="/auth",
+    tags=["auth"],
+)
+app.include_router(fastapi_users.get_users_router(), prefix="/users", tags=["users"])

docs/src/oauth_full_mongodb.py

@@ -1,10 +1,9 @@
 import motor.motor_asyncio
-from fastapi import FastAPI
+from fastapi import FastAPI, Request
 from fastapi_users import FastAPIUsers, models
 from fastapi_users.authentication import JWTAuthentication
 from fastapi_users.db import MongoDBUserDatabase
 from httpx_oauth.clients.google import GoogleOAuth2
-from starlette.requests import Request
 
 DATABASE_URL = "mongodb://localhost:27017"
 SECRET = "SECRET"
@@ -36,25 +35,37 @@ db = client["database_name"]
 collection = db["users"]
 user_db = MongoDBUserDatabase(UserDB, collection)
 
-auth_backends = [
-    JWTAuthentication(secret=SECRET, lifetime_seconds=3600),
-]
 
-app = FastAPI()
-fastapi_users = FastAPIUsers(
-    user_db, auth_backends, User, UserCreate, UserUpdate, UserDB, SECRET,
-)
-app.include_router(fastapi_users.router, prefix="/users", tags=["users"])
-
-google_oauth_router = fastapi_users.get_oauth_router(google_oauth_client, SECRET)
-app.include_router(google_oauth_router, prefix="/google-oauth", tags=["users"])
-
-
-@fastapi_users.on_after_register()
-def on_after_register(user: User, request: Request):
+def on_after_register(user: UserDB, request: Request):
     print(f"User {user.id} has registered.")
 
 
-@fastapi_users.on_after_forgot_password()
-def on_after_forgot_password(user: User, token: str, request: Request):
+def on_after_forgot_password(user: UserDB, token: str, request: Request):
     print(f"User {user.id} has forgot their password. Reset token: {token}")
+
+
+jwt_authentication = JWTAuthentication(secret=SECRET, lifetime_seconds=3600)
+
+app = FastAPI()
+fastapi_users = FastAPIUsers(
+    user_db, [jwt_authentication], User, UserCreate, UserUpdate, UserDB,
+)
+app.include_router(
+    fastapi_users.get_auth_router(jwt_authentication), prefix="/auth/jwt", tags=["auth"]
+)
+app.include_router(
+    fastapi_users.get_register_router(on_after_register), prefix="/auth", tags=["auth"]
+)
+app.include_router(
+    fastapi_users.get_reset_password_router(
+        SECRET, after_forgot_password=on_after_forgot_password
+    ),
+    prefix="/auth",
+    tags=["auth"],
+)
+app.include_router(fastapi_users.get_users_router(), prefix="/users", tags=["users"])
+
+google_oauth_router = fastapi_users.get_oauth_router(
+    google_oauth_client, SECRET, after_register=on_after_register
+)
+app.include_router(google_oauth_router, prefix="/auth/google", tags=["auth"])

docs/src/oauth_full_sqlalchemy.py

@@ -1,6 +1,6 @@
 import databases
 import sqlalchemy
-from fastapi import FastAPI
+from fastapi import FastAPI, Request
 from fastapi_users import FastAPIUsers, models
 from fastapi_users.authentication import JWTAuthentication
 from fastapi_users.db import (
@@ -10,7 +10,6 @@ from fastapi_users.db import (
 )
 from httpx_oauth.clients.google import GoogleOAuth2
 from sqlalchemy.ext.declarative import DeclarativeMeta, declarative_base
-from starlette.requests import Request
 
 DATABASE_URL = "sqlite:///./test.db"
 SECRET = "SECRET"
@@ -57,30 +56,41 @@ oauth_accounts = OAuthAccount.__table__
 user_db = SQLAlchemyUserDatabase(UserDB, database, users, oauth_accounts)
 
 
-auth_backends = [
-    JWTAuthentication(secret=SECRET, lifetime_seconds=3600),
-]
-
-app = FastAPI()
-fastapi_users = FastAPIUsers(
-    user_db, auth_backends, User, UserCreate, UserUpdate, UserDB, SECRET,
-)
-app.include_router(fastapi_users.router, prefix="/users", tags=["users"])
-
-google_oauth_router = fastapi_users.get_oauth_router(google_oauth_client, SECRET)
-app.include_router(google_oauth_router, prefix="/google-oauth", tags=["users"])
-
-
-@fastapi_users.on_after_register()
-def on_after_register(user: User, request: Request):
+def on_after_register(user: UserDB, request: Request):
     print(f"User {user.id} has registered.")
 
 
-@fastapi_users.on_after_forgot_password()
-def on_after_forgot_password(user: User, token: str, request: Request):
+def on_after_forgot_password(user: UserDB, token: str, request: Request):
     print(f"User {user.id} has forgot their password. Reset token: {token}")
 
 
+jwt_authentication = JWTAuthentication(secret=SECRET, lifetime_seconds=3600)
+
+app = FastAPI()
+fastapi_users = FastAPIUsers(
+    user_db, [jwt_authentication], User, UserCreate, UserUpdate, UserDB,
+)
+app.include_router(
+    fastapi_users.get_auth_router(jwt_authentication), prefix="/auth/jwt", tags=["auth"]
+)
+app.include_router(
+    fastapi_users.get_register_router(on_after_register), prefix="/auth", tags=["auth"]
+)
+app.include_router(
+    fastapi_users.get_reset_password_router(
+        SECRET, after_forgot_password=on_after_forgot_password
+    ),
+    prefix="/auth",
+    tags=["auth"],
+)
+app.include_router(fastapi_users.get_users_router(), prefix="/users", tags=["users"])
+
+google_oauth_router = fastapi_users.get_oauth_router(
+    google_oauth_client, SECRET, after_register=on_after_register
+)
+app.include_router(google_oauth_router, prefix="/auth/google", tags=["auth"])
+
+
 @app.on_event("startup")
 async def startup():
     await database.connect()

docs/src/oauth_full_tortoise.py

@@ -1,4 +1,4 @@
-from fastapi import FastAPI
+from fastapi import FastAPI, Request
 from fastapi_users import FastAPIUsers, models
 from fastapi_users.authentication import JWTAuthentication
 from fastapi_users.db import (
@@ -7,7 +7,6 @@ from fastapi_users.db import (
     TortoiseUserDatabase,
 )
 from httpx_oauth.clients.google import GoogleOAuth2
-from starlette.requests import Request
 from tortoise import fields
 from tortoise.contrib.starlette import register_tortoise
 
@@ -46,24 +45,36 @@ user_db = TortoiseUserDatabase(UserDB, UserModel, OAuthAccountModel)
 app = FastAPI()
 register_tortoise(app, db_url=DATABASE_URL, modules={"models": ["test"]})
 
-auth_backends = [
-    JWTAuthentication(secret=SECRET, lifetime_seconds=3600),
-]
 
-fastapi_users = FastAPIUsers(
-    user_db, auth_backends, User, UserCreate, UserUpdate, UserDB, SECRET,
-)
-app.include_router(fastapi_users.router, prefix="/users", tags=["users"])
-
-google_oauth_router = fastapi_users.get_oauth_router(google_oauth_client, SECRET)
-app.include_router(google_oauth_router, prefix="/google-oauth", tags=["users"])
-
-
-@fastapi_users.on_after_register()
-def on_after_register(user: User, request: Request):
+def on_after_register(user: UserDB, request: Request):
     print(f"User {user.id} has registered.")
 
 
-@fastapi_users.on_after_forgot_password()
-def on_after_forgot_password(user: User, token: str, request: Request):
+def on_after_forgot_password(user: UserDB, token: str, request: Request):
     print(f"User {user.id} has forgot their password. Reset token: {token}")
+
+
+jwt_authentication = JWTAuthentication(secret=SECRET, lifetime_seconds=3600)
+
+fastapi_users = FastAPIUsers(
+    user_db, [jwt_authentication], User, UserCreate, UserUpdate, UserDB,
+)
+app.include_router(
+    fastapi_users.get_auth_router(jwt_authentication), prefix="/auth/jwt", tags=["auth"]
+)
+app.include_router(
+    fastapi_users.get_register_router(on_after_register), prefix="/auth", tags=["auth"]
+)
+app.include_router(
+    fastapi_users.get_reset_password_router(
+        SECRET, after_forgot_password=on_after_forgot_password
+    ),
+    prefix="/auth",
+    tags=["auth"],
+)
+app.include_router(fastapi_users.get_users_router(), prefix="/users", tags=["users"])
+
+google_oauth_router = fastapi_users.get_oauth_router(
+    google_oauth_client, SECRET, after_register=on_after_register
+)
+app.include_router(google_oauth_router, prefix="/auth/google", tags=["auth"])