arpakitlib 1.6.88__py3-none-any.whl → 1.6.89__py3-none-any.whl

arpakitlib/ar_fastapi_util.py

@@ -421,14 +421,19 @@ def get_transmitted_api_data(request: starlette.requests.Request) -> BaseTransmi
 class BaseAPIAuthData(BaseModel):
     model_config = ConfigDict(extra="forbid", arbitrary_types_allowed=True, from_attributes=True)
 
+    require_api_key_string: bool = False
+    require_token_string: bool = None
+
     token_string: str | None = None
     api_key_string: str | None = None
 
 
-def base_api_auth(
+def api_auth(
         *,
         require_api_key_string: bool = False,
         require_token_string: bool = False,
+        api_key_string_validator: Callable | None = None,
+        token_string_validator: Callable | None = None,
 ) -> Callable:
     async def func(
             *,
@@ -439,79 +444,79 @@ def base_api_auth(
             request: fastapi.Request
     ) -> BaseAPIAuthData:
 
-        _error_data = {
-            "require_api_key_string": require_api_key_string,
-            "require_token_string": require_token_string
-        }
-
-        res = BaseAPIAuthData()
+        api_auth_data = BaseAPIAuthData(
+            require_api_key_string=require_api_key_string,
+            require_token_string=require_token_string
+        )
 
         # api_key
 
-        res.api_key_string = api_key_string
-
-        if not res.api_key_string and "api_key" in request.headers.keys():
-            res.api_key_string = request.headers["api_key"]
-        if not res.api_key_string and "api-key" in request.headers.keys():
-            res.api_key_string = request.headers["api-key"]
-        if not res.api_key_string and "apikey" in request.headers.keys():
-            res.api_key_string = request.headers["apikey"]
+        api_auth_data.api_key_string = api_key_string
 
-        if not res.api_key_string and "api_key" in request.query_params.keys():
-            res.api_key_string = request.query_params["api_key"]
-        if not res.api_key_string and "api-key" in request.query_params.keys():
-            res.api_key_string = request.query_params["api-key"]
-        if not res.api_key_string and "apikey" in request.query_params.keys():
-            res.api_key_string = request.query_params["apikey"]
+        if not api_auth_data.api_key_string and "api_key" in request.headers.keys():
+            api_auth_data.api_key_string = request.headers["api_key"]
+        if not api_auth_data.api_key_string and "api-key" in request.headers.keys():
+            api_auth_data.api_key_string = request.headers["api-key"]
+        if not api_auth_data.api_key_string and "apikey" in request.headers.keys():
+            api_auth_data.api_key_string = request.headers["apikey"]
 
-        _error_data["res.api_key_string"] = res.api_key_string
+        if not api_auth_data.api_key_string and "api_key" in request.query_params.keys():
+            api_auth_data.api_key_string = request.query_params["api_key"]
+        if not api_auth_data.api_key_string and "api-key" in request.query_params.keys():
+            api_auth_data.api_key_string = request.query_params["api-key"]
+        if not api_auth_data.api_key_string and "apikey" in request.query_params.keys():
+            api_auth_data.api_key_string = request.query_params["apikey"]
 
         # token
 
-        res.token_string = ac.credentials if ac and ac.credentials and ac.credentials.strip() else None
+        api_auth_data.token_string = ac.credentials if ac and ac.credentials and ac.credentials.strip() else None
 
-        if not res.token_string and "token" in request.headers.keys():
-            res.token_string = request.headers["token"]
+        if not api_auth_data.token_string and "token" in request.headers.keys():
+            api_auth_data.token_string = request.headers["token"]
 
-        if not res.token_string and "user_token" in request.headers.keys():
-            res.token_string = request.headers["user_token"]
-        if not res.token_string and "user-token" in request.headers.keys():
-            res.token_string = request.headers["user-token"]
-        if not res.token_string and "usertoken" in request.headers.keys():
-            res.token_string = request.headers["usertoken"]
+        if not api_auth_data.token_string and "user_token" in request.headers.keys():
+            api_auth_data.token_string = request.headers["user_token"]
+        if not api_auth_data.token_string and "user-token" in request.headers.keys():
+            api_auth_data.token_string = request.headers["user-token"]
+        if not api_auth_data.token_string and "usertoken" in request.headers.keys():
+            api_auth_data.token_string = request.headers["usertoken"]
 
-        if not res.token_string and "token" in request.query_params.keys():
-            res.token_string = request.query_params["token"]
+        if not api_auth_data.token_string and "token" in request.query_params.keys():
+            api_auth_data.token_string = request.query_params["token"]
 
-        if not res.token_string and "user_token" in request.query_params.keys():
-            res.token_string = request.query_params["user_token"]
-        if not res.token_string and "user-token" in request.query_params.keys():
-            res.token_string = request.query_params["user-token"]
-        if not res.token_string and "usertoken" in request.query_params.keys():
-            res.token_string = request.query_params["usertoken"]
+        if not api_auth_data.token_string and "user_token" in request.query_params.keys():
+            api_auth_data.token_string = request.query_params["user_token"]
+        if not api_auth_data.token_string and "user-token" in request.query_params.keys():
+            api_auth_data.token_string = request.query_params["user-token"]
+        if not api_auth_data.token_string and "usertoken" in request.query_params.keys():
+            api_auth_data.token_string = request.query_params["usertoken"]
 
-        if res.token_string:
-            res.token_string = res.token_string.strip()
-        if not res.token_string:
-            res.token_string = None
+        if api_auth_data.token_string:
+            api_auth_data.token_string = api_auth_data.token_string.strip()
+        if not api_auth_data.token_string:
+            api_auth_data.token_string = None
 
-        _error_data["res.token_string"] = res.token_string
-
-        if require_api_key_string and not res.api_key_string:
+        if require_api_key_string and not api_auth_data.api_key_string:
             raise APIException(
                 status_code=starlette.status.HTTP_401_UNAUTHORIZED,
                 error_code=ErrorSO.APIErrorCodes.cannot_authorize,
-                error_data=_error_data
+                error_data=safely_transfer_to_json_str_to_json_obj(api_auth_data.model_dump())
             )
 
-        if require_token_string and not res.token_string:
+        if require_token_string and not api_auth_data.token_string:
             raise APIException(
                 status_code=starlette.status.HTTP_401_UNAUTHORIZED,
                 error_code=ErrorSO.APIErrorCodes.cannot_authorize,
-                error_data=_error_data
+                error_data=safely_transfer_to_json_str_to_json_obj(api_auth_data.model_dump())
             )
 
-        return res
+        if api_key_string_validator is not None:
+            api_auth_data = api_key_string_validator(api_auth_data=api_auth_data)
+
+        if token_string_validator is not None:
+            api_auth_data = token_string_validator(api_auth_data=api_auth_data)
+
+        return api_auth_data
 
     return func
 

{arpakitlib-1.6.88.dist-info → arpakitlib-1.6.89.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: arpakitlib
-Version: 1.6.88
+Version: 1.6.89
 Summary: arpakitlib
 Home-page: https://github.com/ARPAKIT-Company/arpakitlib
 License: Apache-2.0

{arpakitlib-1.6.88.dist-info → arpakitlib-1.6.89.dist-info}/RECORD

@@ -95,7 +95,7 @@ arpakitlib/ar_fastapi_static/swagger-ui/swagger-ui.css,sha256=jzPZlgJTFwSdSphk9C
 arpakitlib/ar_fastapi_static/swagger-ui/swagger-ui.css.map,sha256=5wq8eXMLU6Zxb45orZPL1zAsBFJReFw6GjYqGpUX3hg,262650
 arpakitlib/ar_fastapi_static/swagger-ui/swagger-ui.js,sha256=ffrLZHHEQ_g84A-ul3yWa10Kk09waOAxHcQXPuZuavg,339292
 arpakitlib/ar_fastapi_static/swagger-ui/swagger-ui.js.map,sha256=9UhIW7MqCOZPAz1Sl1IKfZUuhWU0p-LJqrnjjJD9Xhc,1159454
-arpakitlib/ar_fastapi_util.py,sha256=KFSD2XS-NZvpz_Dk-IGfF35Yc9miUGOqR23EtfGdySI,20670
+arpakitlib/ar_fastapi_util.py,sha256=X72pf0JsPBLla6Q1WYBUrf2w_F7ukKwUYSRZCnw2Yi0,21465
 arpakitlib/ar_file_storage_in_dir_util.py,sha256=D3e3rGuHoI6xqAA5mVvEpVVpOWY1jyjNsjj2UhyHRbE,3674
 arpakitlib/ar_file_util.py,sha256=XiwmeycxoLqtYnGOu5q6IEaJJXilZvtLvsKDKtwqSLY,137
 arpakitlib/ar_hash_util.py,sha256=Iqy6KBAOLBQMFLWv676boI5sV7atT2B-fb7aCdHOmIQ,340
@@ -126,9 +126,9 @@ arpakitlib/ar_str_util.py,sha256=AhcdrEm-pXRilCaDWCdTfVkQSy0SnbE52ur43Ltr6cI,212
 arpakitlib/ar_type_util.py,sha256=5nDnXL5Oyozlg8XvxMrogsoYiG8_atItg46A0mtv-pk,2025
 arpakitlib/ar_yookassa_api_client_util.py,sha256=5GMvu8paByni8buhc1vpHB7n6oXe0gPfj1LSvnyZCrQ,5307
 arpakitlib/ar_zabbix_util.py,sha256=Q-VR4MvoZ9aHwZeYZr9G3LwN-ANx1T5KFmF6pvPM-9M,6402
-arpakitlib-1.6.88.dist-info/LICENSE,sha256=GPEDQMam2r7FSTYqM1mm7aKnxLaWcBotH7UvQtea-ec,11355
-arpakitlib-1.6.88.dist-info/METADATA,sha256=5jbKUXX0EJhzqOKqzHU9iK1u7JZ1rGAVs8zI1IMLJ5Q,2739
-arpakitlib-1.6.88.dist-info/NOTICE,sha256=95aUzaPJjVpDsGAsNzVnq7tHTxAl0s5UFznCTkVCau4,763
-arpakitlib-1.6.88.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-arpakitlib-1.6.88.dist-info/entry_points.txt,sha256=VHkTDXDOMrgcNzGfKhEhoOIIz6T8Kkt46hy95Zc1iL0,74
-arpakitlib-1.6.88.dist-info/RECORD,,
+arpakitlib-1.6.89.dist-info/LICENSE,sha256=GPEDQMam2r7FSTYqM1mm7aKnxLaWcBotH7UvQtea-ec,11355
+arpakitlib-1.6.89.dist-info/METADATA,sha256=Wg3XKaZEYazWZ6UtVettl0ZZEu3y3mvlwwFsE9vgpYM,2739
+arpakitlib-1.6.89.dist-info/NOTICE,sha256=95aUzaPJjVpDsGAsNzVnq7tHTxAl0s5UFznCTkVCau4,763
+arpakitlib-1.6.89.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+arpakitlib-1.6.89.dist-info/entry_points.txt,sha256=VHkTDXDOMrgcNzGfKhEhoOIIz6T8Kkt46hy95Zc1iL0,74
+arpakitlib-1.6.89.dist-info/RECORD,,