http-misc 1.0.2__tar.gz → 1.0.4__tar.gz

{http_misc-1.0.2 → http_misc-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: http-misc
-Version: 1.0.2
+Version: 1.0.4
 Summary: Утилитарный пакет межсервисного взаимодействия по протоколу HTTP
 Author: Anton Gorinenko
 Author-email: anton.gorinenko@gmail.com
@@ -20,6 +20,7 @@ Requires-Dist: envparse; extra == "test"
 Requires-Dist: pytest-asyncio; extra == "test"
 Requires-Dist: pytest-mock; extra == "test"
 Requires-Dist: pytest-env; extra == "test"
+Requires-Dist: freezegun; extra == "test"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

http_misc-1.0.4/http_misc/cache.py

@@ -0,0 +1,43 @@
+import datetime
+from abc import abstractmethod, ABC
+
+
+class TokenCache(ABC):
+    @abstractmethod
+    def set_token(self, cache_key: str, access_token: str, expires_in: datetime.datetime):
+        pass
+
+    @abstractmethod
+    def get_token(self, cache_key: str):
+        pass
+
+    @abstractmethod
+    def remove(self, cache_key: str):
+        pass
+
+
+class MemoryTokenCache(TokenCache):
+    """ Класс, реализующий хранение access_token в памяти.
+    Обратите внимание, что если ключом является client_id, то memory_cache не может быть одним на все запросы,
+    тк у разных запросов могут быть разные разрешения scopes
+    """
+
+    # memory_cache = {}
+    def __init__(self):
+        self.memory_cache = {}
+
+    def set_token(self, cache_key: str, access_token: str, expires_in: datetime.datetime):
+        """ Установка токенов """
+        cache_value = {'access_token': access_token, 'expires_in': expires_in}
+
+        self.memory_cache[cache_key] = cache_value
+
+    def get_token(self, cache_key: str):
+        """ Получение access_token """
+
+        result = self.memory_cache.get(cache_key, {})
+        return result.get('access_token'), result.get('expires_in')
+
+    def remove(self, cache_key: str):
+        if cache_key in self.memory_cache:
+            self.memory_cache.pop(cache_key)

http_misc-1.0.4/http_misc/transformers.py

@@ -0,0 +1,115 @@
+import base64
+from abc import ABC, abstractmethod
+from datetime import datetime, timedelta, timezone
+
+import aiohttp
+
+from http_misc import services, http_utils, retry_policy
+from http_misc.cache import TokenCache
+from http_misc.services import Transformer
+
+
+class TokenTransformer(Transformer, ABC):
+
+    @abstractmethod
+    async def get_token(self, *args, **kwargs):
+        pass
+
+    @abstractmethod
+    async def get_token_name(self, *args, **kwargs):
+        pass
+
+    async def modify(self, *args, **kwargs):
+        headers = kwargs.setdefault('cfg', {}).setdefault('headers', {})
+        token = await self.get_token(*args, **kwargs)
+        token_name = await self.get_token_name(*args, **kwargs)
+        headers['Authorization'] = f'{token_name} {token}'
+
+        return args, kwargs
+
+
+class SetBasicAuthorization(TokenTransformer):
+    """ Указывает Basic token """
+
+    async def get_token_name(self, *args, **kwargs):
+        return 'Basic'
+
+    async def get_token(self, *args, **kwargs):
+        return base64.b64encode(self.client_id + b':' + self.client_secret).decode('utf-8')
+
+    def __init__(self, client_id: str, client_secret: str):
+        self.client_id = client_id.encode('utf-8')
+        self.client_secret = client_secret.encode('utf-8')
+
+
+class SetSystemOAuthToken(TokenTransformer):
+    """ Указывает Bearer token учетных записей для автоматизации """
+
+    async def get_token_name(self, *args, **kwargs):
+        return 'Bearer'
+
+    def __init__(self, client_id: str, client_secret: str, scope: str,
+                 token_url: str, token_cache: TokenCache | None = None, use_utc: bool | None = True):
+        self.token_cache = token_cache
+        self.client_id = client_id
+        self.client_secret = client_secret
+        self.token_url = token_url
+        self.scope = scope
+        self._service = services.HttpService()
+        self._policy = retry_policy.AsyncRetryPolicy()
+        self.use_utc = use_utc
+
+    def _init_token_request(self):
+        form = aiohttp.FormData(quote_fields=True)
+        form.add_field('grant_type', 'client_credentials')
+        form.add_field('client_id', self.client_id)
+        form.add_field('client_secret', self.client_secret)
+        form.add_field('scope', self.scope)
+        request = {
+            'method': 'POST',
+            'url': self.token_url,
+            'cfg': {
+                'data': form
+            }
+        }
+        return request
+
+    def _parse_token_response(self, response: dict):
+        access_token = response.get('access_token')
+        expires_in = response.get('expires_in')
+        if not access_token or not expires_in:
+            raise ValueError('Invalid response - access_token or expires_in is none.')
+
+        return access_token, expires_in
+
+    def _now(self):
+        return datetime.now(tz=timezone.utc if self.use_utc else None)
+
+    async def _init_token(self) -> str:
+        request = self._init_token_request()
+        response_data = await http_utils.send_and_validate(self._service, request, policy=self._policy)
+        access_token, expires_in = self._parse_token_response(response_data)
+        if self.token_cache:
+            expires_in = self._now() + timedelta(seconds=expires_in)
+            self.token_cache.set_token(self.client_id, access_token, expires_in)
+        return access_token
+
+    async def _get_token(self) -> tuple[str | None, datetime | None]:
+        if self.token_cache:
+            return self.token_cache.get_token(self.client_id)
+
+        return None, None
+
+    async def get_token(self, *args, **kwargs):
+        access_token, expires_in = await self._get_token()
+        # если токен найден
+        if access_token:
+            # проверяем срок жизни токена и если он истек получаем новый.
+            if self._now() < expires_in:
+                return access_token
+
+            # время жизни истекло, инициализируем токен
+            return await self._init_token()
+        else:
+            # если токен не найден, то инициализируем токены
+            return await self._init_token()

{http_misc-1.0.2 → http_misc-1.0.4}/http_misc.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: http-misc
-Version: 1.0.2
+Version: 1.0.4
 Summary: Утилитарный пакет межсервисного взаимодействия по протоколу HTTP
 Author: Anton Gorinenko
 Author-email: anton.gorinenko@gmail.com
@@ -20,6 +20,7 @@ Requires-Dist: envparse; extra == "test"
 Requires-Dist: pytest-asyncio; extra == "test"
 Requires-Dist: pytest-mock; extra == "test"
 Requires-Dist: pytest-env; extra == "test"
+Requires-Dist: freezegun; extra == "test"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{http_misc-1.0.2 → http_misc-1.0.4}/http_misc.egg-info/SOURCES.txt

@@ -1,15 +1,18 @@
 README.md
 setup.py
 http_misc/__init__.py
+http_misc/cache.py
 http_misc/errors.py
 http_misc/http_utils.py
 http_misc/logger.py
 http_misc/retry_policy.py
 http_misc/services.py
+http_misc/transformers.py
 http_misc.egg-info/PKG-INFO
 http_misc.egg-info/SOURCES.txt
 http_misc.egg-info/dependency_links.txt
 http_misc.egg-info/requires.txt
 http_misc.egg-info/top_level.txt
 tests/test_retry_policy.py
-tests/test_services.py
+tests/test_services.py
+tests/test_transformers.py

{http_misc-1.0.2 → http_misc-1.0.4}/http_misc.egg-info/requires.txt

@@ -7,3 +7,4 @@ envparse
 pytest-asyncio
 pytest-mock
 pytest-env
+freezegun

{http_misc-1.0.2 → http_misc-1.0.4}/setup.py

@@ -4,7 +4,7 @@ import setuptools
 
 setuptools.setup(
     name='http-misc',
-    version='1.0.2',
+    version='1.0.4',
     author='Anton Gorinenko',
     author_email='anton.gorinenko@gmail.com',
     description='Утилитарный пакет межсервисного взаимодействия по протоколу HTTP',
@@ -30,7 +30,8 @@ setuptools.setup(
             'envparse',
             'pytest-asyncio',
             'pytest-mock',
-            'pytest-env'
+            'pytest-env',
+            'freezegun'
         ]
     },
     python_requires='>=3.10',

http_misc-1.0.4/tests/test_transformers.py

@@ -0,0 +1,49 @@
+from freezegun import freeze_time
+
+from http_misc import transformers, cache
+
+
+async def test_set_system_oauth_token(mocker):
+    send_and_validate_mocker = mocker.patch('http_misc.http_utils.send_and_validate')
+    send_and_validate_mocker.side_effect = [
+        {
+            "access_token": "nb0G0HyVooN5XbSBaN2uYUr6pW75wh",
+            "expires_in": 36000,
+            "token_type": "Bearer",
+            "scope": "read write"
+        },
+        {
+            "access_token": "YYPfV0LG1jdTRl6D1qx9Hq0UxJvBKf",
+            "expires_in": 36000,
+            "token_type": "Bearer",
+            "scope": "read write"
+        }
+    ]
+    transformer = transformers.SetSystemOAuthToken(
+        client_id='6x7ujMdws6tDLbpePzQZvkYd0yFADYNJ11putMRw',
+        client_secret='RgCUfgtFHxqZ2amnqS4eTFL6cRsdfc3YYN0lTBrAIarLrt0Icewv6QzC1nFZXusEjqpG0aFmC14f8Jme4z3Q4TpxI9UQM5aU5LQkvuKpOoZ3oF2wDlyC7J41zPGTYuhO',
+        scope='read write',
+        token_url='http://localhost/api/v1/oauth/token/',
+        token_cache=cache.MemoryTokenCache())
+
+    request = {
+        'method': 'POST',
+        'url': 'https://localhost',
+        'cfg': {
+            'json': {}
+        }
+    }
+    with freeze_time('2025-01-14 12:00:01'):
+        await transformer.modify(**request)
+        await transformer.modify(**request)
+
+    assert 'headers' in request['cfg']
+    assert 'Authorization' in request['cfg']['headers']
+    token_1 = request['cfg']['headers']['Authorization']
+    assert token_1 == 'Bearer nb0G0HyVooN5XbSBaN2uYUr6pW75wh'
+    # Протух
+    with freeze_time('2025-01-16 12:00:01'):
+        await transformer.modify(**request)
+        token_2 = request['cfg']['headers']['Authorization']
+        assert token_2 == 'Bearer YYPfV0LG1jdTRl6D1qx9Hq0UxJvBKf'
+        assert token_1 != token_2