aiohttp-msal 0.6.7__tar.gz → 0.7.0__tar.gz

{aiohttp_msal-0.6.7 → aiohttp_msal-0.7.0}/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022-2023 kellerza
+Copyright (c) 2022-2024 kellerza
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{aiohttp_msal-0.6.7 → aiohttp_msal-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aiohttp_msal
-Version: 0.6.7
+Version: 0.7.0
 Summary: Helper Library to use the Microsoft Authentication Library (MSAL) with aiohttp
 Home-page: https://github.com/kellerza/aiohttp_msal
 Author: Johann Kellerman
@@ -12,20 +12,20 @@ Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: msal>=1.24.1
+Requires-Dist: msal>=1.30.0
 Requires-Dist: aiohttp_session>=2.12
 Requires-Dist: aiohttp>=3.8
 Provides-Extra: redis
 Requires-Dist: aiohttp_session[aioredis]>=2.12; extra == "redis"
 Provides-Extra: tests
-Requires-Dist: black==23.9.1; extra == "tests"
-Requires-Dist: pylint; extra == "tests"
+Requires-Dist: black==24.8.0; extra == "tests"
+Requires-Dist: pylint==3.2.6; extra == "tests"
 Requires-Dist: flake8; extra == "tests"
 Requires-Dist: pytest-aiohttp; extra == "tests"
 Requires-Dist: pytest; extra == "tests"

{aiohttp_msal-0.6.7 → aiohttp_msal-0.7.0}/aiohttp_msal/__init__.py

@@ -1,8 +1,9 @@
 """aiohttp_msal."""
+
 import logging
+import typing
 from functools import wraps
 from inspect import getfullargspec, iscoroutinefunction
-from typing import Any, Awaitable, Callable, Union
 
 from aiohttp import ClientSession, web
 from aiohttp_session import get_session
@@ -13,26 +14,29 @@ from aiohttp_msal.settings import ENV
 
 _LOGGER = logging.getLogger(__name__)
 
-VERSION = "0.6.7"
+VERSION = "0.7.0"
 
 
-def msal_session(*args: Callable[[AsyncMSAL], Union[Any, Awaitable[Any]]]) -> Callable:
+def msal_session(
+    *callbacks: typing.Callable[[AsyncMSAL], bool | typing.Awaitable[bool]],
+    at_least_one: bool | None = False,
+) -> typing.Callable:
     """Session decorator.
 
     Arguments can include a list of function to perform login tests etc.
     """
 
-    def _session(func: Callable) -> Callable:
+    def _session(func: typing.Callable) -> typing.Callable:
         @wraps(func)
-        async def __session(request: web.Request) -> Callable:
-            _ses = AsyncMSAL(session=await get_session(request))
-            for arg in args:
-                if iscoroutinefunction(arg):
-                    if not await arg(_ses):
-                        raise web.HTTPForbidden
-                elif not arg(_ses):
+        async def __session(request: web.Request) -> typing.Callable:
+            ses = AsyncMSAL(session=await get_session(request))
+            for c_b in callbacks:
+                _ok = await c_b(ses) if iscoroutinefunction(c_b) else c_b(ses)
+                if at_least_one and _ok:
+                    break
+                if not at_least_one and not _ok:
                     raise web.HTTPForbidden
-            return await func(request=request, ses=_ses)
+            return await func(request=request, ses=ses)
 
         assert iscoroutinefunction(func), f"Function needs to be a coroutine: {func}"
         spec = getfullargspec(func)
@@ -47,6 +51,26 @@ def authenticated(ses: AsyncMSAL) -> bool:
     return bool(ses.mail)
 
 
+def auth_or(
+    *args: typing.Callable[[AsyncMSAL], bool | typing.Awaitable[bool]]
+) -> typing.Callable[[AsyncMSAL], typing.Awaitable[bool]]:
+    """Ensure either of the methods is valid. An alternative to at_least_one=True.
+
+    Arguments can include a list of function to perform login tests etc."""
+
+    async def or_auth(ses: AsyncMSAL) -> bool:
+        """Or."""
+        for arg in args:
+            if iscoroutinefunction(arg):
+                if await arg(ses):
+                    return True
+            elif arg(ses):
+                return True
+        raise web.HTTPForbidden
+
+    return or_auth
+
+
 async def app_init_redis_session(
     app: web.Application, max_age: int = 3600 * 24 * 90
 ) -> None:

{aiohttp_msal-0.6.7 → aiohttp_msal-0.7.0}/aiohttp_msal/msal_async.py

@@ -4,10 +4,11 @@ The AsyncMSAL class contains more info to perform OAuth & get the required token
 Once you have the OAuth tokens store in the session, you are free to make requests
 (typically from an aiohttp server's inside a request)
 """
+
 import asyncio
 import json
 from functools import partial, wraps
-from typing import Any, Callable, Literal, Optional, Union
+from typing import Any, Callable, Literal
 
 from aiohttp import web
 from aiohttp.client import ClientResponse, ClientSession, _RequestContextManager
@@ -32,7 +33,7 @@ def async_wrap(func: Callable) -> Callable:
     @wraps(func)
     async def run(
         *args: Any,
-        loop: Optional[asyncio.AbstractEventLoop] = None,
+        loop: asyncio.AbstractEventLoop | None = None,
         executor: Any = None,
         **kwargs: dict[str, Any],
     ) -> Callable:
@@ -67,8 +68,8 @@ class AsyncMSAL:
 
     def __init__(
         self,
-        session: Union[Session, dict[str, str]],
-        save_cache: Optional[Callable[[Union[Session, dict[str, str]]], None]] = None,
+        session: Session | dict[str, str],
+        save_cache: Callable[[Session | dict[str, str]], None] | None = None,
     ):
         """Init the class.
 
@@ -119,8 +120,8 @@ class AsyncMSAL:
     def build_auth_code_flow(
         self,
         redirect_uri: str,
-        scopes: Optional[list[str]] = None,
-        prompt: Optional[Literal["login", "consent", "select_account", "none"]] = None,
+        scopes: list[str] | None = None,
+        prompt: Literal["login", "consent", "select_account", "none"] | None = None,
         **kwargs: Any,
     ) -> str:
         """First step - Start the flow."""
@@ -131,7 +132,7 @@ class AsyncMSAL:
             redirect_uri=redirect_uri,
             response_mode="form_post",
             prompt=prompt,
-            **kwargs
+            **kwargs,
             # max_age=1209600,
             # max allowed 86400 - 1 day
         )
@@ -159,7 +160,7 @@ class AsyncMSAL:
             None, self.acquire_token_by_auth_code_flow, auth_response
         )
 
-    def get_token(self, scopes: Optional[list[str]] = None) -> Optional[dict[str, Any]]:
+    def get_token(self, scopes: list[str] | None = None) -> dict[str, Any] | None:
         """Acquire a token based on username."""
         accounts = self.app.get_accounts()
         if accounts:
@@ -170,7 +171,7 @@ class AsyncMSAL:
             return result
         return None
 
-    async def async_get_token(self) -> Optional[dict[str, Any]]:
+    async def async_get_token(self) -> dict[str, Any] | None:
         """Acquire a token based on username."""
         return await asyncio.get_event_loop().run_in_executor(None, self.get_token)
 

{aiohttp_msal-0.6.7 → aiohttp_msal-0.7.0}/aiohttp_msal/redis_tools.py

@@ -1,4 +1,5 @@
 """Redis tools for sessions."""
+
 import asyncio
 import json
 import logging
@@ -9,7 +10,7 @@ from typing import Any, AsyncGenerator, Optional
 from redis.asyncio import Redis, from_url
 
 from aiohttp_msal.msal_async import AsyncMSAL
-from aiohttp_msal.settings import ENV
+from aiohttp_msal.settings import ENV as MENV
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -19,15 +20,17 @@ SES_KEYS = ("mail", "name", "m_mail", "m_name")
 @asynccontextmanager
 async def get_redis() -> AsyncGenerator[Redis, None]:
     """Get a Redis connection."""
-    if ENV.database:
+    if MENV.database:
         _LOGGER.debug("Using redis from environment")
-        yield ENV.database
+        yield MENV.database
         return
-    _LOGGER.info("Connect to Redis %s", ENV.REDIS)
-    redis = from_url(ENV.REDIS)
+    _LOGGER.info("Connect to Redis %s", MENV.REDIS)
+    redis = from_url(MENV.REDIS)  # decode_responses=True not allowed aiohttp_session
+    MENV.database = redis
     try:
         yield redis
     finally:
+        MENV.database = None  # type:ignore
         await redis.close()
 
 
@@ -45,10 +48,11 @@ async def session_iter(
     if match and not all(isinstance(v, str) for v in match.values()):
         raise ValueError("match values must be strings")
     async for key in redis.scan_iter(
-        count=100, match=key_match or f"{ENV.COOKIE_NAME}*"
+        count=100, match=key_match or f"{MENV.COOKIE_NAME}*"
     ):
+        if not isinstance(key, str):
+            key = key.decode()
         sval = await redis.get(key)
-        _LOGGER.debug("Session: %s = %s", key, sval)
         created, ses = 0, {}
         try:
             val = json.loads(sval)  # type: ignore
@@ -110,11 +114,67 @@ def _session_factory(key: str, created: str, session: dict) -> AsyncMSAL:
     return AsyncMSAL(session, save_cache=save_cache)
 
 
-async def get_session(email: str, *, redis: Optional[Redis] = None) -> AsyncMSAL:
+async def get_session(
+    email: str, *, redis: Optional[Redis] = None, scope: str = ""
+) -> AsyncMSAL:
     """Get a session from Redis."""
+    cnt = 0
     async with AsyncExitStack() as stack:
         if redis is None:
             redis = await stack.enter_async_context(get_redis())
         async for key, created, session in session_iter(redis, match={"mail": email}):
+            cnt += 1
+            if scope and scope not in str(session.get("token_cache")).lower():
+                continue
             return _session_factory(key, str(created), session)
-    raise ValueError(f"Session for {email} not found")
+    msg = f"Session for {email}"
+    if not scope:
+        raise ValueError(f"{msg} not found")
+    raise ValueError(f"{msg} with scope {scope} not found ({cnt} checked)")
+
+
+async def redis_get_json(key: str) -> list | dict | None:
+    """Get a key from redis."""
+    res = await MENV.database.get(key)
+    if isinstance(res, (str, bytes, bytearray)):
+        return json.loads(res)
+    if res is not None:
+        _LOGGER.warning("Unexpected type for %s: %s", key, type(res))
+    return None
+
+
+async def redis_get(key: str) -> str | None:
+    """Get a key from redis."""
+    res = await MENV.database.get(key)
+    if isinstance(res, str):
+        return res
+    if isinstance(res, (bytes, bytearray)):
+        return res.decode()
+    if res is not None:
+        _LOGGER.warning("Unexpected type for %s: %s", key, type(res))
+    return None
+
+
+async def redis_set_set(key: str, new_set: set[str]) -> None:
+    """Set the value of a set in redis."""
+    cur_set = set(
+        s if isinstance(s, str) else s.decode()
+        for s in await MENV.database.smembers(key)
+    )
+    dif = list(cur_set - new_set)
+    if dif:
+        _LOGGER.warning("%s: removing %s", key, dif)
+        await MENV.database.srem(key, *dif)
+
+    dif = list(new_set - cur_set)
+    if dif:
+        _LOGGER.info("%s: adding %s", key, dif)
+        await MENV.database.sadd(key, *dif)
+
+
+async def redis_scan(match_str: str) -> list[str]:
+    """Return a list of matching keys."""
+    return [
+        s if isinstance(s, str) else s.decode()
+        async for s in MENV.database.scan_iter(match=match_str)
+    ]

{aiohttp_msal-0.6.7 → aiohttp_msal-0.7.0}/aiohttp_msal/routes.py

@@ -1,4 +1,5 @@
 """The user blueprint."""
+
 import time
 from inspect import iscoroutinefunction
 from typing import Any, Mapping, Sequence

{aiohttp_msal-0.6.7 → aiohttp_msal-0.7.0}/aiohttp_msal/settings.py

@@ -1,8 +1,14 @@
 """Settings."""
-from typing import Any, Awaitable, Callable, Union
+
+from typing import TYPE_CHECKING, Any, Awaitable, Callable
 
 from aiohttp_msal.settings_base import SettingsBase, Var
 
+if TYPE_CHECKING:
+    from redis.asyncio import Redis
+else:
+    Redis = Any
+
 
 class MSALSettings(SettingsBase):
     """Settings."""
@@ -26,12 +32,12 @@ class MSALSettings(SettingsBase):
 
     login_callback: list[Callable[[Any], Awaitable[Any]]] = []
     """A list of callbacks to execute on successful login."""
-    info: dict[str, Callable[[Any], Union[Any, Awaitable[Any]]]] = {}
+    info: dict[str, Callable[[Any], Any | Awaitable[Any]]] = {}
     """List of attributes to return in /user/info."""
 
     REDIS = "redis://redis1:6379"
     """OPTIONAL: Redis database connection used by app_init_redis_session()."""
-    database: Any = None
+    database: Redis = None  # type: ignore
     """Store the Redis connection when using app_init_redis_session()."""
 
 

{aiohttp_msal-0.6.7 → aiohttp_msal-0.7.0}/aiohttp_msal/settings_base.py

@@ -1,4 +1,6 @@
 """Settings Base."""
+
+from __future__ import annotations
 import logging
 import os
 from pathlib import Path
@@ -9,7 +11,7 @@ class Var:  # pylint: disable=too-few-public-methods
     """Variable settings."""
 
     @staticmethod
-    def from_value(val: Any):  # type: ignore
+    def from_value(val: Any) -> Var:
         """Ensure the return is an instance of Var."""
         return val if isinstance(val, Var) else Var(type(val))
 

{aiohttp_msal-0.6.7 → aiohttp_msal-0.7.0}/aiohttp_msal/user_info.py

@@ -1,4 +1,5 @@
 """Graph User Info."""
+
 import asyncio
 from functools import wraps
 from typing import Any, Callable

{aiohttp_msal-0.6.7 → aiohttp_msal-0.7.0}/aiohttp_msal.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: aiohttp-msal
-Version: 0.6.7
+Name: aiohttp_msal
+Version: 0.7.0
 Summary: Helper Library to use the Microsoft Authentication Library (MSAL) with aiohttp
 Home-page: https://github.com/kellerza/aiohttp_msal
 Author: Johann Kellerman
@@ -12,20 +12,20 @@ Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: msal>=1.24.1
+Requires-Dist: msal>=1.30.0
 Requires-Dist: aiohttp_session>=2.12
 Requires-Dist: aiohttp>=3.8
 Provides-Extra: redis
 Requires-Dist: aiohttp_session[aioredis]>=2.12; extra == "redis"
 Provides-Extra: tests
-Requires-Dist: black==23.9.1; extra == "tests"
-Requires-Dist: pylint; extra == "tests"
+Requires-Dist: black==24.8.0; extra == "tests"
+Requires-Dist: pylint==3.2.6; extra == "tests"
 Requires-Dist: flake8; extra == "tests"
 Requires-Dist: pytest-aiohttp; extra == "tests"
 Requires-Dist: pytest; extra == "tests"

{aiohttp_msal-0.6.7 → aiohttp_msal-0.7.0}/aiohttp_msal.egg-info/requires.txt

@@ -1,4 +1,4 @@
-msal>=1.24.1
+msal>=1.30.0
 aiohttp_session>=2.12
 aiohttp>=3.8
 
@@ -6,8 +6,8 @@ aiohttp>=3.8
 aiohttp_session[aioredis]>=2.12
 
 [tests]
-black==23.9.1
-pylint
+black==24.8.0
+pylint==3.2.6
 flake8
 pytest-aiohttp
 pytest

aiohttp_msal-0.7.0/pyproject.toml

@@ -0,0 +1,65 @@
+
+[tool.black]
+line-length = 88
+target-version = ['py36', 'py37', 'py38']
+include = '\.pyi?$'
+
+[tool.ruff]
+line-length = 121
+# pyflakes, pycodestyle, isort
+include = ["tests/*.py", "aiohttp_msal/**/*.py"]
+
+[tool.ruff.lint]
+select = ["F", "E", "W", "I001"]
+
+[tool.ruff.lint.flake8-import-conventions]
+# Declare the banned `from` imports.
+banned-from = ["typing"]
+
+[tool.ruff.lint.isort]
+no-lines-before = ["future", "standard-library"]
+
+[tool.mypy]
+disallow_untyped_defs = true
+ignore_missing_imports = true
+
+# https://stackoverflow.com/questions/64162504/settings-for-pylint-in-setup-cfg-are-not-getting-used
+[tool.pylint.'MESSAGES CONTROL']
+max-line-length = 120
+good-names = ["db", "fr", "cr", "k", "i"]
+disable = [
+    "line-too-long",
+    "unsubscriptable-object",
+    "unused-argument",
+    "too-many-branches",
+    "too-many-locals",
+    "too-many-statements",
+    "too-many-instance-attributes",
+    "too-few-public-methods",
+    "R0401",
+    "R0801",
+    "wrong-import-order",
+]
+
+[tool.pylint.design]
+# limiting the number of returns might discourage
+# the use of guard clauses. So we increase the
+# allowed number of returns from 6 to 8
+max-returns = 8
+
+[tool.pytest.ini_options]
+pythonpath = [".", "src"]
+filterwarnings = "ignore:.+@coroutine.+deprecated.+"
+testpaths = "tests"
+norecursedirs = [".git", "modules"]
+log_cli = true
+log_cli_level = "DEBUG"
+asyncio_mode = "auto"
+env = [
+    "X_SP_APP_PW=p1",
+    "X_SP_APP_ID=i1",
+    "X_SP_AUTHORITY=a1",
+    "SP_APP_PW=p2",
+    "SP_APP_ID=i2",
+    "SP_AUTHORITY=a2",
+]

{aiohttp_msal-0.6.7 → aiohttp_msal-0.7.0}/setup.cfg

@@ -15,18 +15,17 @@ classifiers =
 	Natural Language :: English
 	Programming Language :: Python :: 3
 	Programming Language :: Python :: 3 :: Only
-	Programming Language :: Python :: 3.9
 	Programming Language :: Python :: 3.10
 	Programming Language :: Python :: 3.11
+	Programming Language :: Python :: 3.12
 keywords = msal, oauth, aiohttp, asyncio
 
 [options]
 packages = find:
-python_requires = >=3.9
+python_requires = >=3.10
 include_package_data = True
-tests_requires = file: requirements_test.txt
 install_requires = 
-	msal>=1.24.1
+	msal>=1.30.0
 	aiohttp_session>=2.12
 	aiohttp>=3.8
 zip_safe = true
@@ -35,8 +34,8 @@ zip_safe = true
 redis = 
 	aiohttp_session[aioredis]>=2.12
 tests = 
-	black==23.9.1
-	pylint
+	black==24.8.0
+	pylint==3.2.6
 	flake8
 	pytest-aiohttp
 	pytest
@@ -50,20 +49,6 @@ disallow_untyped_defs = True
 [mypy-msal.*]
 ignore_missing_imports = True
 
-[tool:pytest]
-filterwarnings = 
-	ignore:.+@coroutine.+deprecated.+
-log_cli = True
-log_cli_level = DEBUG
-asyncio_mode = auto
-env = 
-	X_SP_APP_PW=p1
-	X_SP_APP_ID=i1
-	X_SP_AUTHORITY=a1
-	SP_APP_PW=p2
-	SP_APP_ID=i2
-	SP_AUTHORITY=a2
-
 [egg_info]
 tag_build = 
 tag_date = 0

{aiohttp_msal-0.6.7 → aiohttp_msal-0.7.0}/tests/test_init.py

@@ -1,3 +1,4 @@
 """Init."""
+
 import aiohttp_msal  # noqa
 import aiohttp_msal.routes  # noqa

{aiohttp_msal-0.6.7 → aiohttp_msal-0.7.0}/tests/test_msal_async.py

@@ -1,4 +1,5 @@
 """Test the AsyncMSAL class."""
+
 from aiohttp_msal.msal_async import AsyncMSAL, Session
 
 

{aiohttp_msal-0.6.7 → aiohttp_msal-0.7.0}/tests/test_redis_tools.py

@@ -1,4 +1,5 @@
 """Test redis tools."""
+
 from json import dumps
 from typing import AsyncGenerator
 from unittest.mock import AsyncMock, MagicMock, Mock, call

aiohttp_msal-0.6.7/pyproject.toml

@@ -1,4 +0,0 @@
-[tool.ruff]
-line-length = 121
-# pyflakes, pycodestyle, isort
-select = ["F", "E", "W", "I001"]