reyserver 1.1.48__py3-none-any.whl → 1.1.50__py3-none-any.whl

reyserver/rauth.py

@@ -9,3 +9,243 @@
 """
 
 
+from fastapi import APIRouter
+from reydb import rorm, DatabaseEngine, DatabaseEngineAsync
+from reykit.rdata import encode_jwt, decode_jwt, hash_bcrypt, is_hash_bcrypt
+from reykit.rtime import now
+
+from .rbase import ServerConfig, Bind, exit_api
+
+
+__all__ = (
+    'DatabaseORMTableUser',
+    'DatabaseORMTableRole',
+    'DatabaseORMTablePerm',
+    'DatabaseORMTableUserRole',
+    'DatabaseORMTableRolePerm',
+    'build_auth_db',
+    'auth_router'
+)
+
+
+class DatabaseORMTableUser(rorm.Model, table=True):
+    """
+    Database `user` table ORM model.
+    """
+
+    __name__ = 'user'
+    __comment__ = 'User information table.'
+    create_time: rorm.Datetime = rorm.Field(field_default=':create_time', not_null=True, index_n=True, comment='Record create time.')
+    update_time: rorm.Datetime = rorm.Field(field_default=':update_time', not_null=True, index_n=True, comment='Record update time.')
+    user_id: int = rorm.Field(rorm.types_mysql.MEDIUMINT(unsigned=True), key_auto=True, comment='User ID.')
+    name: str = rorm.Field(rorm.types.VARCHAR(50), not_null=True, index_u=True, comment='User name.')
+    password: str = rorm.Field(rorm.types.CHAR(60), not_null=True, comment='User password, encrypted with "bcrypt".')
+    email: rorm.Email = rorm.Field(rorm.types.VARCHAR(255), index_u=True, comment='User email.')
+    phone: str = rorm.Field(rorm.types.CHAR(11), index_u=True, comment='User phone.')
+    avatar: int = rorm.Field(rorm.types_mysql.MEDIUMINT(unsigned=True), comment='User avatar file ID.')
+    is_valid: bool = rorm.Field(rorm.types_mysql.TINYINT(unsigned=True), field_default='1', not_null=True, comment='Is the valid.')
+
+
+class DatabaseORMTableRole(rorm.Model, table=True):
+    """
+    Database `role` table ORM model.
+    """
+
+    __name__ = 'role'
+    __comment__ = 'Role information table.'
+    create_time: rorm.Datetime = rorm.Field(field_default=':create_time', not_null=True, index_n=True, comment='Record create time.')
+    update_time: rorm.Datetime = rorm.Field(field_default=':update_time', not_null=True, index_n=True, comment='Record update time.')
+    role_id: int = rorm.Field(rorm.types_mysql.SMALLINT(unsigned=True), key_auto=True, comment='Role ID.')
+    name: str = rorm.Field(rorm.types.VARCHAR(50), not_null=True, index_u=True, comment='Role name.')
+    desc: str = rorm.Field(rorm.types.VARCHAR(500), comment='Role description.')
+
+
+class DatabaseORMTablePerm(rorm.Model, table=True):
+    """
+    Database `perm` table ORM model.
+    """
+
+    __name__ = 'perm'
+    __comment__ = 'API permission information table.'
+    create_time: rorm.Datetime = rorm.Field(field_default=':create_time', not_null=True, index_n=True, comment='Record create time.')
+    update_time: rorm.Datetime = rorm.Field(field_default=':update_time', not_null=True, index_n=True, comment='Record update time.')
+    perm_id: int = rorm.Field(rorm.types_mysql.SMALLINT(unsigned=True), key_auto=True, comment='Permission ID.')
+    name: str = rorm.Field(rorm.types.VARCHAR(50), not_null=True, index_u=True, comment='Permission name.')
+    desc: str = rorm.Field(rorm.types.VARCHAR(500), comment='Permission description.')
+    method: str = rorm.Field(rorm.types.VARCHAR(7), comment='API request method regular expression "match" pattern.')
+    path: str = rorm.Field(rorm.types.VARCHAR(1000), comment='API resource path regular expression "match" pattern.')
+
+
+class DatabaseORMTableUserRole(rorm.Model, table=True):
+    """
+    Database `user_role` table ORM model.
+    """
+
+    __name__ = 'user_role'
+    __comment__ = 'User and role association table.'
+    create_time: rorm.Datetime = rorm.Field(field_default=':create_time', not_null=True, index_n=True, comment='Record create time.')
+    update_time: rorm.Datetime = rorm.Field(field_default=':update_time', not_null=True, index_n=True, comment='Record update time.')
+    user_id: int = rorm.Field(rorm.types_mysql.MEDIUMINT(unsigned=True), key=True, comment='User ID.')
+    role_id: int = rorm.Field(rorm.types_mysql.SMALLINT(unsigned=True), key=True, comment='Role ID.')
+
+
+class DatabaseORMTableRolePerm(rorm.Model, table=True):
+    """
+    Database `role_perm` table ORM model.
+    """
+
+    __name__ = 'role_perm'
+    __comment__ = 'role and permission association table.'
+    create_time: rorm.Datetime = rorm.Field(field_default=':create_time', not_null=True, index_n=True, comment='Record create time.')
+    update_time: rorm.Datetime = rorm.Field(field_default=':update_time', not_null=True, index_n=True, comment='Record update time.')
+    role_id: int = rorm.Field(rorm.types_mysql.SMALLINT(unsigned=True), key=True, comment='Role ID.')
+    perm_id: int = rorm.Field(rorm.types_mysql.SMALLINT(unsigned=True), key=True, comment='Permission ID.')
+
+
+def build_auth_db(engine: DatabaseEngine | DatabaseEngineAsync) -> None:
+    """
+    Check and build `auth` database tables.
+
+    Parameters
+    ----------
+    db : Database engine instance.
+    """
+
+    # Set parameter.
+    database = engine.database
+
+    ## Table.
+    tables = [
+        DatabaseORMTableUser,
+        DatabaseORMTableRole,
+        DatabaseORMTablePerm,
+        DatabaseORMTableUserRole,
+        DatabaseORMTableRolePerm
+    ]
+
+    ## View stats.
+    views_stats = [
+        {
+            'path': 'stats',
+            'items': [
+                {
+                    'name': 'user_count',
+                    'select': (
+                        'SELECT COUNT(1)\n'
+                        f'FROM `{database}`.`user`'
+                    ),
+                    'comment': 'User information count.'
+                },
+                {
+                    'name': 'role_count',
+                    'select': (
+                        'SELECT COUNT(1)\n'
+                        f'FROM `{database}`.`role`'
+                    ),
+                    'comment': 'Role information count.'
+                },
+                {
+                    'name': 'perm_count',
+                    'select': (
+                        'SELECT COUNT(1)\n'
+                        f'FROM `{database}`.`perm`'
+                    ),
+                    'comment': 'Permission information count.'
+                },
+                {
+                    'name': 'user_day_count',
+                    'select': (
+                        'SELECT COUNT(1)\n'
+                        f'FROM `{database}`.`user`\n'
+                        'WHERE TIMESTAMPDIFF(DAY, `create_time`, NOW()) = 0'
+                    ),
+                    'comment': 'User information count in the past day.'
+                },
+                {
+                    'name': 'user_week_count',
+                    'select': (
+                        'SELECT COUNT(1)\n'
+                        f'FROM `{database}`.`user`\n'
+                        'WHERE TIMESTAMPDIFF(DAY, `create_time`, NOW()) <= 6'
+                    ),
+                    'comment': 'User information count in the past week.'
+                },
+                {
+                    'name': 'user_month_count',
+                    'select': (
+                        'SELECT COUNT(1)\n'
+                        f'FROM `{database}`.`user`\n'
+                        'WHERE TIMESTAMPDIFF(DAY, `create_time`, NOW()) <= 29'
+                    ),
+                    'comment': 'User information count in the past month.'
+                },
+                {
+                    'name': 'user_last_time',
+                    'select': (
+                        'SELECT MAX(`create_time`)\n'
+                        f'FROM `{database}`.`user`'
+                    ),
+                    'comment': 'User last record create time.'
+                }
+            ]
+        }
+    ]
+
+    # Build.
+    engine.sync_engine.build.build(tables=tables, views_stats=views_stats, skip=True)
+
+
+auth_router = APIRouter()
+depend_auth_sess = Bind.create_depend_db('auth', 'sess')
+depend_auth_conn = Bind.create_depend_db('auth', 'conn')
+
+
+@auth_router.post('/sessions')
+async def create_sessions(
+    username: str = Bind.body,
+    password: str = Bind.body,
+    conn: Bind.Conn = depend_auth_conn
+) -> dict:
+    """
+    Create session.
+
+    Parameters
+    ----------
+    username : User name.
+    password : User password.
+
+    Returns
+    -------
+    JSON with `token`.
+    """
+
+    # Parameter.
+    key = ServerConfig.server.api_auth_key
+    password_hash = hash_bcrypt(password)
+
+    # Check.
+    sql = (
+        ''
+    )
+    result = await conn.execute(
+        sql,
+        username=username,
+        password_hash=password_hash
+    )
+
+    # Check.
+    if result.empty:
+        exit_api(401)
+
+    # Response.
+    json = {
+        'time': now('timestamp'),
+        'sub': username,
+        'iat': now('timestamp'),
+        'nbf': now('timestamp'),
+        'exp': now('timestamp') + 28800000
+    }
+    token = encode_jwt(json, key)
+    data = {'token': token}
+
+    return data

reyserver/rfile.py

@@ -11,7 +11,7 @@
 
 from fastapi import APIRouter
 from fastapi.responses import FileResponse
-from reydb import rorm
+from reydb import rorm, DatabaseEngine, DatabaseEngineAsync
 from reykit.ros import FileStore, get_md5
 
 from .rbase import ServerConfig, Bind, exit_api
@@ -33,7 +33,7 @@ class DatabaseORMTableInfo(rorm.Model, table=True):
     __name__ = 'info'
     __comment__ = 'File information table.'
     create_time: rorm.Datetime = rorm.Field(field_default=':create_time', not_null=True, index_n=True, comment='Record create time.')
-    file_id: int = rorm.Field(rorm.types_mysql.MEDIUMINT(unsigned=True), key_auto=True, comment='File self increase ID.')
+    file_id: int = rorm.Field(rorm.types_mysql.MEDIUMINT(unsigned=True), key_auto=True, comment='File ID.')
     md5: str = rorm.Field(rorm.types.CHAR(32), not_null=True, index_n=True, comment='File MD5.')
     name: str = rorm.Field(rorm.types.VARCHAR(260), index_n=True, comment='File name.')
     note: str = rorm.Field(rorm.types.VARCHAR(500), comment='File note.')
@@ -51,13 +51,16 @@ class DatabaseORMTableData(rorm.Model, table=True):
     path: str = rorm.Field(rorm.types.VARCHAR(4095), not_null=True, comment='File disk storage path.')
 
 
-def build_file_db() -> None:
+def build_file_db(engine: DatabaseEngine | DatabaseEngineAsync) -> None:
     """
     Check and build `file` database tables.
+
+    Parameters
+    ----------
+    db : Database engine instance.
     """
 
     # Set parameter.
-    engine = ServerConfig.server.db.file
     database = engine.database
 
     ## Table.
@@ -179,7 +182,34 @@ depend_file_sess = Bind.create_depend_db('file', 'sess')
 depend_file_conn = Bind.create_depend_db('file', 'conn')
 
 
-@file_router.post('/')
+@file_router.get('/files/{file_id}')
+async def get_file_info(
+    file_id: int = Bind.path,
+    sess: Bind.Sess = depend_file_sess
+) -> DatabaseORMTableInfo:
+    """
+    Get file information.
+
+    Parameters
+    ----------
+    file_id : File ID.
+
+    Returns
+    -------
+    File information.
+    """
+
+    # Get.
+    table_info = await sess.get(DatabaseORMTableInfo, file_id)
+
+    # Check.
+    if table_info is None:
+        exit_api(404)
+
+    return table_info
+
+
+@file_router.post('/files')
 async def upload_file(
     file: Bind.File = Bind.forms,
     name: str = Bind.forms_n,
@@ -233,7 +263,7 @@ async def upload_file(
     return table_info
 
 
-@file_router.get('/{file_id}/download')
+@file_router.get('/files/{file_id}/download')
 async def download_file(
     file_id: int = Bind.path,
     conn: Bind.Conn = depend_file_conn
@@ -273,30 +303,3 @@ async def download_file(
     response = FileResponse(file_path, filename=file_name)
 
     return response
-
-
-@file_router.get('/{file_id}')
-async def get_file_info(
-    file_id: int = Bind.path,
-    sess: Bind.Sess = depend_file_sess
-) -> DatabaseORMTableInfo:
-    """
-    Get file information.
-
-    Parameters
-    ----------
-    file_id : File ID.
-
-    Returns
-    -------
-    File information.
-    """
-
-    # Get.
-    table_info = await sess.get(DatabaseORMTableInfo, file_id)
-
-    # Check.
-    if table_info is None:
-        exit_api(404)
-
-    return table_info

reyserver/rserver.py

@@ -19,7 +19,8 @@ from fastapi.staticfiles import StaticFiles
 from fastapi.middleware.gzip import GZipMiddleware
 from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware
 from reydb import DatabaseAsync
-from reykit.rbase import CallableT, CoroutineFunctionSimple, Singleton, throw
+from reykit.rbase import CoroutineFunctionSimple, Singleton, throw
+from reykit.rrand import randchar
 
 from .rbase import ServerBase, ServerConfig, Bind
 
@@ -102,6 +103,8 @@ class Server(ServerBase, Singleton):
         self.__add_default_middleware()
 
         # API.
+        self.api_auth_key: str
+        'Authentication API JWT encryption key.'
         self.api_file_dir: str
         'File API store directory path.'
 
@@ -187,13 +190,30 @@ class Server(ServerBase, Singleton):
                 setattr(self.app, key, value)
 
 
-    def add_api_auth(self):
+    def add_api_auth(self, key: str | None = None) -> None:
         """
-        Add Authentication API.
+        Add authentication API.
         Note: must include database engine of `auth` name.
+
+        Parameters
+        ----------
+        key : JWT encryption key.
+            - `None`: Random 32 length string.
         """
 
-        ...
+        from .rauth import build_file_db, auth_router
+
+        # Parameter.
+        if key is None:
+            key = randchar(32)
+
+        # Build database.
+        engine = self.db.auth
+        build_file_db(engine)
+
+        # Add.
+        self.api_auth_key = key
+        self.app.include_router(auth_router, tags=['auth'])
 
 
     def add_api_file(self, file_dir: str = 'file') -> None:
@@ -207,11 +227,12 @@ class Server(ServerBase, Singleton):
         prefix : File API path prefix.
         """
 
-        from .rfile import file_router, build_file_db
+        from .rfile import build_file_db, file_router
 
         # Build database.
-        build_file_db()
+        engine = self.db.file
+        build_file_db(engine)
 
         # Add.
         self.api_file_dir = file_dir
-        self.app.include_router(file_router, prefix='/files', tags=['file'])
+        self.app.include_router(file_router, tags=['file'])

{reyserver-1.1.48.dist-info → reyserver-1.1.50.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reyserver
-Version: 1.1.48
+Version: 1.1.50
 Summary: Backend server method set.
 Project-URL: homepage, https://github.com/reyxbo/reyserver/
 Author-email: Rey <reyxbo@163.com>

reyserver-1.1.50.dist-info/RECORD

@@ -0,0 +1,11 @@
+reyserver/__init__.py,sha256=7GX64p7uI2eetJH9NJ-DTg-8iyQwOsGcviADFJCPxVA,373
+reyserver/rall.py,sha256=riyDRTUsigco_Bee1H4aZFb8IgvjnxdX9qcnVb9i9mE,270
+reyserver/rauth.py,sha256=xknFI0IEMJcDRTkmO8jb-4Pbl7QSnQOA8m87D7gU3MM,9228
+reyserver/rbase.py,sha256=IUVkkNsLmQh-QRLX6qtbCjPZAbQAsxoe0goPLCxG9KA,5283
+reyserver/rclient.py,sha256=pTJtn78jPKgFo5EoQwZRdM0cYHdCs7QUKqfl-jUBRgk,4220
+reyserver/rfile.py,sha256=RpMeq0vRStop4RnyjKv4wjdXgJjKPOAKpwPAKpLt0hk,9000
+reyserver/rserver.py,sha256=oOfAc0aM-C561k8mKhF8_gYDmF0Kn6hKyZ5ff6mzPCE,6498
+reyserver-1.1.50.dist-info/METADATA,sha256=iVbZ7pE_k0IlyYw1bsuw5lJIziRJ2CvsRyM4ivSQRi8,1689
+reyserver-1.1.50.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reyserver-1.1.50.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reyserver-1.1.50.dist-info/RECORD,,

reyserver-1.1.48.dist-info/RECORD

@@ -1,11 +0,0 @@
-reyserver/__init__.py,sha256=7GX64p7uI2eetJH9NJ-DTg-8iyQwOsGcviADFJCPxVA,373
-reyserver/rall.py,sha256=riyDRTUsigco_Bee1H4aZFb8IgvjnxdX9qcnVb9i9mE,270
-reyserver/rauth.py,sha256=QyY4gZ0ulpH9Kxvux_jnZBhzfWZZEuOWB1oYU9uzCnY,167
-reyserver/rbase.py,sha256=IUVkkNsLmQh-QRLX6qtbCjPZAbQAsxoe0goPLCxG9KA,5283
-reyserver/rclient.py,sha256=pTJtn78jPKgFo5EoQwZRdM0cYHdCs7QUKqfl-jUBRgk,4220
-reyserver/rfile.py,sha256=6Dwq8_X1kiY1n-9RhbLL3hvdhTAnsAUHyXivcviYcoA,8888
-reyserver/rserver.py,sha256=hqpemzJHO6xHy_7pO3cvvjnfy8Yfqy8HfyIq4sjk4Dc,5889
-reyserver-1.1.48.dist-info/METADATA,sha256=T6Q2BrTheAiAziG15T9seCxh_Yi9IRcplL35YTa-wGo,1689
-reyserver-1.1.48.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reyserver-1.1.48.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
-reyserver-1.1.48.dist-info/RECORD,,