all: prefix all UI related methods with ui_, switch to property and return dataclass

passbook/sources/oauth/models.py

@@ -4,7 +4,8 @@ from django.db import models
 from django.urls import reverse, reverse_lazy
 from django.utils.translation import gettext_lazy as _
 
-from passbook.core.models import Source, UserSettings, UserSourceConnection
+from passbook.core.types import UILoginButton, UIUserSettings
+from passbook.core.models import Source, UserSourceConnection
 from passbook.sources.oauth.clients import get_client
 
 
@@ -28,30 +29,35 @@ class OAuthSource(Source):
     form = "passbook.sources.oauth.forms.OAuthSourceForm"
 
     @property
-    def login_button(self):
-        url = reverse_lazy(
-            "passbook_sources_oauth:oauth-client-login",
-            kwargs={"source_slug": self.slug},
+    def ui_login_button(self) -> UILoginButton:
+        return UILoginButton(
+            url=reverse_lazy(
+                "passbook_sources_oauth:oauth-client-login",
+                kwargs={"source_slug": self.slug},
+            ),
+            icon_path=f"{self.provider_type}.svg",
+            name=self.name,
         )
-        return url, self.provider_type, self.name
 
     @property
-    def additional_info(self):
-        return "Callback URL: <pre>%s</pre>" % reverse_lazy(
+    def ui_additional_info(self) -> str:
+        url = reverse_lazy(
             "passbook_sources_oauth:oauth-client-callback",
             kwargs={"source_slug": self.slug},
         )
+        return f"Callback URL: <pre>{url}</pre>"
 
-    def user_settings(self) -> UserSettings:
+    @property
+    def ui_user_settings(self) -> UIUserSettings:
         icon_type = self.provider_type
         if icon_type == "azure ad":
             icon_type = "windows"
-        icon_class = "fa fa-%s" % icon_type
+        icon_class = f"fa fa-{icon_type}"
         view_name = "passbook_sources_oauth:oauth-client-user"
-        return UserSettings(
-            self.name,
-            icon_class,
-            reverse((view_name), kwargs={"source_slug": self.slug}),
+        return UIUserSettings(
+            name=self.name,
+            icon=icon_class,
+            view_name=reverse((view_name), kwargs={"source_slug": self.slug}),
         )
 
     class Meta:

passbook/sources/saml/models.py

@@ -3,11 +3,12 @@ from django.db import models
 from django.urls import reverse_lazy
 from django.utils.translation import gettext_lazy as _
 
+from passbook.core.types import UILoginButton
 from passbook.core.models import Source
 
 
 class SAMLSource(Source):
-    """SAML2 Source"""
+    """SAML Source"""
 
     entity_id = models.TextField(blank=True, default=None, verbose_name=_("Entity ID"))
     idp_url = models.URLField(verbose_name=_("IDP URL"))
@@ -20,14 +21,17 @@ class SAMLSource(Source):
     form = "passbook.sources.saml.forms.SAMLSourceForm"
 
     @property
-    def login_button(self):
-        url = reverse_lazy(
-            "passbook_sources_saml:login", kwargs={"source_slug": self.slug}
+    def ui_login_button(self) -> UILoginButton:
+        return UILoginButton(
+            name=self.name,
+            url=reverse_lazy(
+                "passbook_sources_saml:login", kwargs={"source_slug": self.slug}
+            ),
+            icon_path="",
         )
-        return url, "", self.name
 
     @property
-    def additional_info(self):
+    def ui_additional_info(self) -> str:
         metadata_url = reverse_lazy(
             "passbook_sources_saml:metadata", kwargs={"source_slug": self}
         )