aiohttp-msal 0.6.8__py3-none-any.whl → 0.7.1__py3-none-any.whl

aiohttp_msal/__init__.py

@@ -14,7 +14,7 @@ from aiohttp_msal.settings import ENV
 
 _LOGGER = logging.getLogger(__name__)
 
-VERSION = "0.6.8"
+VERSION = "0.7.1"
 
 
 def msal_session(
@@ -32,10 +32,17 @@ def msal_session(
             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:
+
+                if at_least_one:
+                    if _ok:
+                        return await func(request=request, ses=ses)
+                    continue
+
+                if not _ok:
                     raise web.HTTPForbidden
+
+            if at_least_one:
+                raise web.HTTPForbidden
             return await func(request=request, ses=ses)
 
         assert iscoroutinefunction(func), f"Function needs to be a coroutine: {func}"
@@ -46,11 +53,31 @@ def msal_session(
     return _session
 
 
-def authenticated(ses: AsyncMSAL) -> bool:
+def auth_ok(ses: AsyncMSAL) -> bool:
     """Test if session was authenticated."""
     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/routes.py

@@ -8,7 +8,7 @@ from urllib.parse import urljoin
 from aiohttp import web
 from aiohttp_session import get_session, new_session
 
-from aiohttp_msal import _LOGGER, ENV, authenticated, msal_session
+from aiohttp_msal import _LOGGER, ENV, auth_ok, msal_session
 from aiohttp_msal.msal_async import FLOW_CACHE, AsyncMSAL
 from aiohttp_msal.user_info import get_manager_info, get_user_info
 
@@ -145,14 +145,14 @@ async def user_debug(request: web.Request) -> web.Response:
     return web.json_response(debug)
 
 
-ENV.info["authenticated"] = authenticated
+ENV.info["authenticated"] = auth_ok
 
 
 @ROUTES.get("/user/info")
 @msal_session()
 async def user_info(request: web.Request, ses: AsyncMSAL) -> web.Response:
     """User info handler."""
-    if not authenticated(ses):
+    if not auth_ok(ses):
         return web.json_response({"authenticated": False})
 
     debug = request.query.get("debug", False)
@@ -182,7 +182,7 @@ async def user_info(request: web.Request, ses: AsyncMSAL) -> web.Response:
 
 @ROUTES.get("/user/logout")
 @ROUTES.get("/user/logout/{to:.+$}")
-@msal_session(authenticated)
+@msal_session(auth_ok)
 async def user_logout(request: web.Request, ses: AsyncMSAL) -> web.Response:
     """Redirect to MS graph login page."""
     ses.session.clear()
@@ -202,7 +202,7 @@ async def user_logout(request: web.Request, ses: AsyncMSAL) -> web.Response:
 
 
 @ROUTES.get("/user/photo")
-@msal_session(authenticated)
+@msal_session(auth_ok)
 async def user_photo(request: web.Request, ses: AsyncMSAL) -> web.StreamResponse:
     """Photo."""
     async with ses.get("https://graph.microsoft.com/v1.0/me/photo/$value") as res:

aiohttp_msal/settings.py

@@ -37,7 +37,7 @@ class MSALSettings(SettingsBase):
 
     REDIS = "redis://redis1:6379"
     """OPTIONAL: Redis database connection used by app_init_redis_session()."""
-    database: Redis
+    database: Redis = None  # type: ignore
     """Store the Redis connection when using app_init_redis_session()."""
 
 

{aiohttp_msal-0.6.8.dist-info → aiohttp_msal-0.7.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aiohttp_msal
-Version: 0.6.8
+Version: 0.7.1
 Summary: Helper Library to use the Microsoft Authentication Library (MSAL) with aiohttp
 Home-page: https://github.com/kellerza/aiohttp_msal
 Author: Johann Kellerman

{aiohttp_msal-0.6.8.dist-info → aiohttp_msal-0.7.1.dist-info}/RECORD

@@ -1,18 +1,18 @@
-aiohttp_msal/__init__.py,sha256=vvc6_F-5jkV_Fy2il81x-kFCrwhZvBMfZ9rNPhkx4ts,3103
+aiohttp_msal/__init__.py,sha256=-8b6kR9wbqLoWmAVw4MsU5GYv5EK8IWoPFJJLr_UsHk,3850
 aiohttp_msal/msal_async.py,sha256=afvfh7gZrXk5KO7Umb9jAnQu4jdg_iVlgaTnxS3JgNM,8899
 aiohttp_msal/redis_tools.py,sha256=zgRACVxm2wPkbEHtA6VmArsd-QQlKn-crlq1XlFbjEY,5919
-aiohttp_msal/routes.py,sha256=JNz0tn-avHUiUmI-YeprY7XyVQNnHRdb2kQFynCTBy0,8228
-aiohttp_msal/settings.py,sha256=AriMUJnTzNkxbwtg8tjxAuM4uPxtJFx26RA3-YvYp1U,1318
+aiohttp_msal/routes.py,sha256=gUkNJknrR0_9ohdgMejWCQXfcobPltuAl_3C4wthZAM,8198
+aiohttp_msal/settings.py,sha256=hWVJdtqcdAkqqN5I4GINJIZSFGhEuoBImM26NrhqY_M,1341
 aiohttp_msal/settings_base.py,sha256=m4tmurnq8xipVNAa-Dh4ii9Rsu6gg39F4aDJNHPLwiI,2919
 aiohttp_msal/user_info.py,sha256=fijBUbl5g1AVgrpOl-2ZY-eQCCWcu4YqcA0QaMQrcWw,1766
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/test_init.py,sha256=olI80lEHoG9Bf2owq3lyfJHp6OPYdsoN_jzlrNY0GYk,76
+tests/test_init.py,sha256=EXq56_E2FUePXVFilAauHXoqItXe5Lvlpz8hBSUh6cU,1832
 tests/test_msal_async.py,sha256=7-G6dO3_qWb8zxqC6_SqMMubCBbEERZy513P7UM4vmw,365
 tests/test_redis_tools.py,sha256=uFpPSe6atbDVAuh1_OUtFgeZwyuLDspp42_EECJDSPg,1869
 tests/test_settings.py,sha256=z-qtUs1zl5Q9NEux051eebyPnArLZ_OfZu65FKz0N4Y,333
-aiohttp_msal-0.6.8.dist-info/LICENSE,sha256=BwqFEcF0Ij49hDZx4A_5CzsKnfU_twRjrm87JFwydFc,1080
-aiohttp_msal-0.6.8.dist-info/METADATA,sha256=brsm0akO5VVzEW7FDe-GxKCw8Bl1WiQadjxq5cVpYXA,4724
-aiohttp_msal-0.6.8.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
-aiohttp_msal-0.6.8.dist-info/top_level.txt,sha256=QPWOi5JtacVEdbaU5bJExc9o-cCT2Lufx0QhUpsv5_E,19
-aiohttp_msal-0.6.8.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-aiohttp_msal-0.6.8.dist-info/RECORD,,
+aiohttp_msal-0.7.1.dist-info/LICENSE,sha256=BwqFEcF0Ij49hDZx4A_5CzsKnfU_twRjrm87JFwydFc,1080
+aiohttp_msal-0.7.1.dist-info/METADATA,sha256=mxa80vNNCVI7s7I5htk1OHqVBdfgy1TuPCm8_ydV8x4,4724
+aiohttp_msal-0.7.1.dist-info/WHEEL,sha256=HiCZjzuy6Dw0hdX5R3LCFPDmFS4BWl8H-8W39XfmgX4,91
+aiohttp_msal-0.7.1.dist-info/top_level.txt,sha256=QPWOi5JtacVEdbaU5bJExc9o-cCT2Lufx0QhUpsv5_E,19
+aiohttp_msal-0.7.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+aiohttp_msal-0.7.1.dist-info/RECORD,,

{aiohttp_msal-0.6.8.dist-info → aiohttp_msal-0.7.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (72.1.0)
+Generator: setuptools (72.2.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

tests/test_init.py

@@ -1,4 +1,79 @@
 """Init."""
 
-import aiohttp_msal  # noqa
+from unittest.mock import MagicMock, patch
+
+import pytest
+
 import aiohttp_msal.routes  # noqa
+from aiohttp_msal import auth_ok, msal_session
+
+
+def a_yes(ses):
+    return True
+
+
+def a_no(ses):
+    return False
+
+
+@msal_session(a_yes, a_yes)
+async def t_2yes(request, ses):
+    return True
+
+
+@msal_session(a_no, a_yes, at_least_one=True)
+async def t_1no1yes_one(request, ses):
+    return True
+
+
+@msal_session(a_no, a_no, at_least_one=True)
+async def t_2no_one(request, ses):
+    return True
+
+
+@patch("aiohttp_msal.get_session")
+async def test_include_any(get_session: MagicMock):
+    get_session.return_value = {}
+
+    assert await t_2yes({})
+
+    with pytest.raises(Exception):
+        await t_1no1yes_one
+
+    with pytest.raises(Exception):
+        await t_2no_one
+
+
+async def func(request, ses):
+    return True
+
+
+@patch("aiohttp_msal.get_session")
+async def test_msal_session_auth(get_session: MagicMock):
+    get_session.return_value = {}
+
+    assert await msal_session(a_yes, a_yes)(func)({})
+    assert await msal_session(a_yes, a_no, at_least_one=True)(func)({})
+    assert await msal_session(a_no, a_yes, at_least_one=True)(func)({})
+    assert await msal_session(a_no, a_no, a_no, a_yes, at_least_one=True)(func)({})
+
+    with pytest.raises(Exception):
+        await msal_session(a_yes, a_no)(func)({})
+
+    with pytest.raises(Exception):
+        await msal_session(a_yes, a_yes, a_no)(func)({})
+
+    with pytest.raises(Exception):
+        await msal_session(a_no, a_no, at_least_one=True)(func)({})
+
+
+@patch("aiohttp_msal.get_session")
+async def test_auth_ok(get_session: MagicMock):
+    get_session.return_value = {"mail": "yes!"}
+
+    assert await msal_session(a_yes)(func)({})
+
+    get_session.return_value = {}
+
+    with pytest.raises(Exception):
+        assert await msal_session(a_yes, auth_ok)(func)({})