arpakitlib 1.6.34__py3-none-any.whl → 1.6.37__py3-none-any.whl

arpakitlib/ar_fastapi_util.py

@@ -13,11 +13,13 @@ from typing import Any, Callable
 
 import fastapi.exceptions
 import fastapi.responses
+import fastapi.security
 import starlette.exceptions
 import starlette.requests
 import starlette.status
-from fastapi import FastAPI, APIRouter, Query
+from fastapi import FastAPI, APIRouter, Query, Security
 from fastapi.openapi.docs import get_swagger_ui_html, get_redoc_html
+from fastapi.security import APIKeyHeader
 from jaraco.context import suppress
 from pydantic import BaseModel, ConfigDict
 from starlette.middleware.cors import CORSMiddleware
@@ -430,6 +432,100 @@ def get_transmitted_api_data(request: starlette.requests.Request) -> BaseTransmi
     return request.app.state.transmitted_api_data
 
 
+class BaseNeedAPIAuthData(BaseModel):
+    model_config = ConfigDict(extra="forbid", arbitrary_types_allowed=True, from_attributes=True)
+
+    token_string: str | None = None
+    apikey_string: str | None = None
+
+
+def need_api_auth(
+        *,
+        require_apikey_string: bool = False,
+        require_token_string: bool = False,
+) -> Callable:
+    async def func(
+            *,
+            ac: fastapi.security.HTTPAuthorizationCredentials | None = fastapi.Security(
+                fastapi.security.HTTPBearer(auto_error=False)
+            ),
+            apikey_string: str | None = Security(APIKeyHeader(name="apikey", auto_error=False)),
+            request: fastapi.Request
+    ) -> BaseNeedAPIAuthData:
+
+        _error_data = {
+            "require_apikey_string": require_apikey_string,
+            "require_token_string": require_token_string
+        }
+
+        res = BaseNeedAPIAuthData()
+
+        # apikey
+
+        res.apikey_string = apikey_string
+
+        if not res.apikey_string and "api_key" in request.headers.keys():
+            res.apikey_string = request.headers["api_key"]
+        if not res.apikey_string and "apikey" in request.headers.keys():
+            res.apikey_string = request.headers["apikey"]
+
+        if not res.apikey_string and "apikey" in request.query_params.keys():
+            res.apikey_string = request.query_params["apikey"]
+        if not res.apikey_string and "api_key" in request.query_params.keys():
+            res.apikey_string = request.query_params["api_key"]
+
+        _error_data["res.apikey_string"] = res.apikey_string
+
+        # token
+
+        res.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 res.token_string and "token" in request.query_params.keys():
+            res.token_string = request.query_params["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 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.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 res.token_string and "user-token" in request.query_params.keys():
+            res.token_string = request.query_params["user-token"]
+
+        if res.token_string:
+            res.token_string = res.token_string.strip()
+        if not res.token_string:
+            res.token_string = None
+
+        _error_data["res.token_string"] = res.token_string
+
+        if require_apikey_string and not res.apikey_string:
+            raise APIException(
+                status_code=starlette.status.HTTP_401_UNAUTHORIZED,
+                error_code=ErrorSO.APIErrorCodes.cannot_authorize,
+                error_data=_error_data
+            )
+
+        if require_token_string and not res.token_string:
+            raise APIException(
+                status_code=starlette.status.HTTP_401_UNAUTHORIZED,
+                error_code=ErrorSO.APIErrorCodes.cannot_authorize,
+                error_data=_error_data
+            )
+
+        return res
+
+    return func
+
+
 def simple_api_router_for_testing():
     router = APIRouter(tags=["Testing"])
 
@@ -468,6 +564,12 @@ def simple_api_router_for_testing():
     return router
 
 
+_DEFAULT_CONTACT = {
+    "name": "arpakit",
+    "email": "support@arpakit.com"
+}
+
+
 def create_fastapi_app(
         *,
         title: str = "arpakitlib FastAPI",
@@ -477,8 +579,12 @@ def create_fastapi_app(
         startup_api_events: list[BaseStartupAPIEvent] | None = None,
         shutdown_api_events: list[BaseStartupAPIEvent] | None = None,
         transmitted_api_data: BaseTransmittedAPIData = BaseTransmittedAPIData(),
-        main_api_router: APIRouter = simple_api_router_for_testing()
+        main_api_router: APIRouter = simple_api_router_for_testing(),
+        contact: dict[str, Any] | None = None
 ):
+    if contact is None:
+        contact = _DEFAULT_CONTACT
+
     setup_normal_logging(log_filepath=log_filepath)
 
     if not startup_api_events:
@@ -494,7 +600,8 @@ def create_fastapi_app(
         redoc_url=None,
         openapi_url="/openapi",
         on_startup=[api_startup_event.async_on_startup for api_startup_event in startup_api_events],
-        on_shutdown=[api_shutdown_event.async_on_shutdown for api_shutdown_event in shutdown_api_events]
+        on_shutdown=[api_shutdown_event.async_on_shutdown for api_shutdown_event in shutdown_api_events],
+        contact=contact
     )
 
     app.state.transmitted_api_data = transmitted_api_data

arpakitlib/ar_schedule_uust_api_client_util.py

@@ -52,23 +52,26 @@ class ScheduleUUSTAPIClient:
         elif self.api_password_first_part:
             return {
                 "login": self.api_login,
-                "pass": self.generate_v2_token(password_first_part=self.api_password_first_part)
+                "pass": self.generate_v2_token()
             }
         else:
             return {}
 
     @classmethod
-    def hash_token(cls, token: str) -> str:
+    def hash_new_token(cls, token: str) -> str:
         sha256 = hashlib.sha256()
         sha256.update(token.encode('utf-8'))
         return sha256.hexdigest()
 
     @classmethod
-    def generate_v2_token(cls, password_first_part: str) -> str:
-        return cls.hash_token(
+    def generate_new_v2_token(cls, password_first_part: str) -> str:
+        return cls.hash_new_token(
             password_first_part + datetime.now(tz=pytz.timezone("Asia/Yekaterinburg")).strftime("%Y-%m-%d")
         )
 
+    def generate_v2_token(self) -> str:
+        return self.generate_new_v2_token(password_first_part=self.api_password_first_part)
+
     async def _async_make_http_get_request(
             self,
             *,

{arpakitlib-1.6.34.dist-info → arpakitlib-1.6.37.dist-info}/METADATA

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

{arpakitlib-1.6.34.dist-info → arpakitlib-1.6.37.dist-info}/RECORD

@@ -6,7 +6,7 @@ arpakitlib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arpakitlib/ar_additional_model_util.py,sha256=t95M4Ggl7EBRj7qOJHmuo5p2YmE7LlJdEAMNzse3vhE,309
 arpakitlib/ar_aiogram_util.py,sha256=zQ5txWe359U8LCSD-jvSz1Ol8N40bEg3DdTRbdRD8fU,11974
 arpakitlib/ar_arpakit_lib_module_util.py,sha256=V_mc3Ml73Tzz3arxmwEfIxruKMyrwbe8XZ9FfVDtUXY,5446
-arpakitlib/ar_arpakit_schedule_uust_api_client.py,sha256=SYWWQDohPnw0qpBIu2hEvGZRVdaI4NUUQdEjnMnseo4,18237
+arpakitlib/ar_arpakit_schedule_uust_api_client_util.py,sha256=SYWWQDohPnw0qpBIu2hEvGZRVdaI4NUUQdEjnMnseo4,18237
 arpakitlib/ar_arpakitlib_info.py,sha256=cvgrLnEznmYkCAg1adbY46ATjD6GJd-Yk8PTgOPjpKM,248
 arpakitlib/ar_base64_util.py,sha256=aZkg2cZTuAaP2IWeG_LXJ6RO7qhyskVwec-Lks0iM-k,676
 arpakitlib/ar_base_worker_util.py,sha256=8ruBoF9pARf3yc5duAajUOBi7Cce5KFAkp66lShRf7U,2796
@@ -35,7 +35,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=6QZLbAs_OHSDSype-Beb93op4Y403Elk5kTvyIng7RQ,16771
+arpakitlib/ar_fastapi_util.py,sha256=VoWJDJnBKcoej5OOgz0C_vqmOe5xz8e_5tW8zMw0VCI,20687
 arpakitlib/ar_file_storage_in_dir_util.py,sha256=D3e3rGuHoI6xqAA5mVvEpVVpOWY1jyjNsjj2UhyHRbE,3674
 arpakitlib/ar_generate_env_example.py,sha256=R_pdbFZe-mIZxEps2dm-K9m8rAg1pAaMzFOBPTGe4s4,370
 arpakitlib/ar_hash_util.py,sha256=Iqy6KBAOLBQMFLWv676boI5sV7atT2B-fb7aCdHOmIQ,340
@@ -54,7 +54,7 @@ arpakitlib/ar_operation_execution_util.py,sha256=w_dz4XYEM4WbTxpBoYVkknG3U3_391c
 arpakitlib/ar_parse_command.py,sha256=qpr2OwG3Bf7DFiL9S3iWgtbvtE80RSC35E5zFJvjG1I,2714
 arpakitlib/ar_postgresql_util.py,sha256=1AuLjEaa1Lg4pzn-ukCVnDi35Eg1k91APRTqZhIJAdo,945
 arpakitlib/ar_run_cmd_util.py,sha256=D_rPavKMmWkQtwvZFz-Io5Ak8eSODHkcFeLPzNVC68g,1072
-arpakitlib/ar_schedule_uust_api_client_util.py,sha256=NpCN8GT96aPvE3Lc-IRn653abjI95CmOqNc4pbHIWxo,5780
+arpakitlib/ar_schedule_uust_api_client_util.py,sha256=Z5BNiHdKWqHmmycinwCbX5_pSNBB59Qn9urvUXU0RDk,5877
 arpakitlib/ar_sleep_util.py,sha256=9ZN4Qo4eZ_q3hjM7vNBQjFRcH-9-sqv3QLSjnxVJE90,1405
 arpakitlib/ar_sqlalchemy_model_util.py,sha256=ttdgOwQfoHTKqgivBtXoSbJoBCASHDjLEFK5tJ9kNNE,4779
 arpakitlib/ar_sqlalchemy_util.py,sha256=3jKHu5aUFPUQ492dWaisN0Y_-r2Pif16SfNawrQ_6xY,4012
@@ -63,8 +63,8 @@ arpakitlib/ar_str_util.py,sha256=xSEzmsDvRiZVaxyqFFjcgzpphktCbXg2FHcvsd1DYpA,188
 arpakitlib/ar_type_util.py,sha256=I6jbTz7_dxR1lkhz1JfUb5ZyLLdXVhG_-hzjdgT6N6s,1932
 arpakitlib/ar_yookassa_api_client_util.py,sha256=5GMvu8paByni8buhc1vpHB7n6oXe0gPfj1LSvnyZCrQ,5307
 arpakitlib/ar_zabbix_util.py,sha256=Q-VR4MvoZ9aHwZeYZr9G3LwN-ANx1T5KFmF6pvPM-9M,6402
-arpakitlib-1.6.34.dist-info/LICENSE,sha256=1jqWIkbnMxDfs_i0SXP5qbV6PHjBr1g8506oW7uPjfg,11347
-arpakitlib-1.6.34.dist-info/METADATA,sha256=DfmaBofPUVfMk32Eq2-74DG6CFqlwpdN2kG9KJtmw3M,2320
-arpakitlib-1.6.34.dist-info/NOTICE,sha256=wHwmiq3wExfFfgMsE5U5TOBP9_l72ocIG82KurEels0,43
-arpakitlib-1.6.34.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-arpakitlib-1.6.34.dist-info/RECORD,,
+arpakitlib-1.6.37.dist-info/LICENSE,sha256=1jqWIkbnMxDfs_i0SXP5qbV6PHjBr1g8506oW7uPjfg,11347
+arpakitlib-1.6.37.dist-info/METADATA,sha256=dQxSVu2TKCD_JZibRrI4f98gpFjmgRJNywUEFJoP_yY,2320
+arpakitlib-1.6.37.dist-info/NOTICE,sha256=wHwmiq3wExfFfgMsE5U5TOBP9_l72ocIG82KurEels0,43
+arpakitlib-1.6.37.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+arpakitlib-1.6.37.dist-info/RECORD,,