Code quality improvements (v0.2.0-pre-alpha) (#5)

* Bumped version to 0.2.0
* Implemented Github Actions for HACS, Hassfest, Linting
* Improved code quality (compliant with the linter now)
* Added link to the finish page to automatically login on the same device/browser

custom_components/auth_oidc/endpoints/callback.py

@@ -1,12 +1,13 @@
-from aiohttp import web
+"""Callback route to return the user to after external OIDC interaction."""
+
 from homeassistant.components.http import HomeAssistantView
-import logging
+from aiohttp import web
 from ..oidc_client import OIDCClient
 from ..provider import OpenIDAuthProvider
+from ..helpers import get_url
 
 PATH = "/auth/oidc/callback"
 
-_LOGGER = logging.getLogger(__name__)
 
 class OIDCCallbackView(HomeAssistantView):
     """OIDC Plugin Callback View."""
@@ -24,12 +25,9 @@ class OIDCCallbackView(HomeAssistantView):
     async def get(self, request: web.Request) -> web.Response:
         """Receive response."""
 
-        _LOGGER.debug("Callback view accessed")
-
         params = request.rel_url.query
         code = params.get("code")
         state = params.get("state")
-        base_uri = str(request.url).split('/auth', 2)[0]
 
         if not (code and state):
             return web.Response(
@@ -37,13 +35,16 @@ class OIDCCallbackView(HomeAssistantView):
                 text="<h1>Error</h1><p>Missing code or state parameter</p>",
             )
 
-        user_details = await self.oidc_client.complete_token_flow(base_uri, code, state)
+        redirect_uri = get_url("/auth/oidc/callback")
+        user_details = await self.oidc_client.async_complete_token_flow(
+            redirect_uri, code, state
+        )
         if user_details is None:
             return web.Response(
                 headers={"content-type": "text/html"},
                 text="<h1>Error</h1><p>Failed to get user details, see console.</p>",
             )
 
-        code = await self.oidc_provider.save_user_info(user_details)
+        code = await self.oidc_provider.async_save_user_info(user_details)
 
-        return web.HTTPFound(base_uri + "/auth/oidc/finish?code=" + code)
+        return web.HTTPFound(get_url("/auth/oidc/finish?code=" + code))

custom_components/auth_oidc/endpoints/finish.py

@@ -1,10 +1,12 @@
-from aiohttp import web
+"""Finish route to allow the user to view their code."""
+
 from homeassistant.components.http import HomeAssistantView
-import logging
+from aiohttp import web
+
+from ..helpers import get_url
 
 PATH = "/auth/oidc/finish"
 
-_LOGGER = logging.getLogger(__name__)
 
 class OIDCFinishView(HomeAssistantView):
     """OIDC Plugin Finish View."""
@@ -17,8 +19,20 @@ class OIDCFinishView(HomeAssistantView):
         """Receive response."""
 
         code = request.query.get("code", "FAIL")
+        link = get_url("/")
 
         return web.Response(
-            headers={"content-type": "text/html"},
-            text=f"<h1>Done!</h1><p>Your code is: <b>{code}</b></p><p>Please return to the Home Assistant login screen (or your mobile app) and fill in this code into the single login field. It should be visible if you select 'Login with OpenID Connect (SSO)'.</p>",
-        )
+            headers={
+                "content-type": "text/html",
+                "set-cookie": "auth_oidc_code="
+                + code
+                + "; Path=/auth/login_flow; SameSite=Strict; HttpOnly; Max-Age=300",
+            },
+            text=f"<h1>Done!</h1><p>Your code is: <b>{code}</b></p>"
+            + "<p>Please return to the Home Assistant login "
+            + "screen (or your mobile app) and fill in this code into the single login field. "
+            + "It should be visible if you "
+            + "select 'Login with OpenID Connect (SSO)'.</p><p><a href='"
+            + link
+            + "'>Click here to login automatically (on desktop).</a></p>",
+        )

custom_components/auth_oidc/endpoints/redirect.py

@@ -1,12 +1,14 @@
+"""Redirect route to redirect the user to the external OIDC server,
+can either be linked to directly or accessed through the welcome page."""
+
 from aiohttp import web
 from homeassistant.components.http import HomeAssistantView
-import logging
 
 from ..oidc_client import OIDCClient
+from ..helpers import get_url
 
 PATH = "/auth/oidc/redirect"
 
-_LOGGER = logging.getLogger(__name__)
 
 class OIDCRedirectView(HomeAssistantView):
     """OIDC Plugin Redirect View."""
@@ -15,32 +17,23 @@ class OIDCRedirectView(HomeAssistantView):
     url = PATH
     name = "auth:oidc:redirect"
 
-    def __init__(
-        self, oidc_client: OIDCClient
-    ) -> None:
+    def __init__(self, oidc_client: OIDCClient) -> None:
         self.oidc_client = oidc_client
 
-    async def get(self, request: web.Request) -> web.Response:
+    async def get(self, _: web.Request) -> web.Response:
         """Receive response."""
 
-        _LOGGER.debug("Redirect view accessed")
-
-        base_uri = str(request.url).split('/auth', 2)[0]
-        _LOGGER.debug("Base URI: %s", base_uri)
-
-        auth_url = await self.oidc_client.get_authorization_url(base_uri)
-        _LOGGER.debug("Auth URL: %s", auth_url)
+        redirect_uri = get_url("/auth/oidc/callback")
+        auth_url = await self.oidc_client.async_get_authorization_url(redirect_uri)
 
         if auth_url:
             return web.HTTPFound(auth_url)
-        else:
-            return web.Response(
+
+        return web.Response(
             headers={"content-type": "text/html"},
             text="<h1>Plugin is misconfigured, discovery could not be obtained</h1>",
         )
 
     async def post(self, request: web.Request) -> web.Response:
         """POST"""
-
-        _LOGGER.debug("Redirect POST view accessed")
-        return await self.get(request)
+        return await self.get(request)

custom_components/auth_oidc/endpoints/welcome.py

@@ -1,10 +1,10 @@
+"""Welcome route to show the user the OIDC login button and give instructions."""
+
 from aiohttp import web
 from homeassistant.components.http import HomeAssistantView
-import logging
 
 PATH = "/auth/oidc/welcome"
 
-_LOGGER = logging.getLogger(__name__)
 
 class OIDCWelcomeView(HomeAssistantView):
     """OIDC Plugin Welcome View."""
@@ -13,12 +13,10 @@ class OIDCWelcomeView(HomeAssistantView):
     url = PATH
     name = "auth:oidc:welcome"
 
-    async def get(self, request: web.Request) -> web.Response:
+    async def get(self, _: web.Request) -> web.Response:
         """Receive response."""
 
-        _LOGGER.debug("Welcome view accessed")
-
         return web.Response(
             headers={"content-type": "text/html"},
-            text="<h1>OIDC Login (beta)</h1><p><a href='/auth/oidc/redirect'>Login with OIDC</a></p>",
-        )
+            text="<h1>OIDC Login</h1><p><a href='/auth/oidc/redirect'>Login with OIDC</a></p>",
+        )