Group Attributes of Class and Object elements of Google Wallet, to make it more maintainable.

src/edutap/wallet_google/api.py

@@ -1,9 +1,9 @@
-from .modelbase import GoogleWalletModel
-from .modelbase import GoogleWalletObjectReference
+from .modelbase import GoogleWalletObjectWithClassReferenceMixin
+from .modelcore import GoogleWalletModel
 from .models.primitives import Pagination
 from .models.primitives.enums import State
-from .models.primitives.notification import AddMessageRequest
-from .models.primitives.notification import Message
+from .models.primitives.message import AddMessageRequest
+from .models.primitives.message import Message
 from .registry import lookup_metadata
 from .registry import lookup_model
 from .registry import lookup_model_by_plural_name
@@ -170,6 +170,8 @@ def update(
             url=session_manager.url(name, f"/{resource_id}"),
             data=verified_json.encode("utf-8"),
         )
+    logger.debug(verified_json.encode("utf-8"))
+    # print(verified_json.encode("utf-8"))
     if response.status_code == 404:
         raise LookupError(
             f"Error 404, {name} {getattr(data, 'id', 'No ID')} not found: - {response.text}"
@@ -374,15 +376,31 @@ def save_link(
         for obj in objs:
             # first look if this is an object reference as dict
             if isinstance(obj, dict) and "id" in obj and len(obj.keys()) <= 2:
-                obj = GoogleWalletObjectReference.model_validate(obj)
-            if isinstance(obj, GoogleWalletObjectReference):
-                payload[name].append(obj.model_dump(exclude_none=True, mode="json"))
+                obj = GoogleWalletObjectWithClassReferenceMixin.model_validate(obj)
+            if isinstance(obj, GoogleWalletObjectWithClassReferenceMixin):
+                payload[name].append(
+                    obj.model_dump(
+                        # explicitly set to model_dump(mode="json") instead of model_dump_json due to problems
+                        # reported by jensens
+                        mode="json",
+                        exclude_none=True,
+                        exclude_unset=True,
+                        exclude_defaults=True,
+                    )
+                )
                 continue
 
             # otherwise it must be a registered model
             model = lookup_model_by_plural_name(name)
             obj = _validate_data(model, obj)
-            obj_json = obj.model_dump(exclude_none=True, mode="json")
+            obj_json = obj.model_dump(
+                # explicitly set to model_dump(mode="json") instead of model_dump_json due to problems
+                # reported by jensens
+                mode="json",
+                exclude_none=True,
+                exclude_unset=True,
+                exclude_defaults=True,
+            )
             payload[name].append(obj_json)
     claims = {
         "iat": "",
@@ -394,9 +412,9 @@ def save_link(
     }
     signer = crypt.RSASigner.from_service_account_file(session_manager.credentials_file)
     jwt_string = jwt.encode(signer, claims).decode("utf-8")
-    logger.debug(
-        "JWT-Length: %d, is less than recommenden 1800: %s",
+    logger.warning(
+        "JWT-Length: %d, is larger than recommenden 1800: %s",
         len(jwt_string),
-        len(jwt_string) <= 1800,
+        len(jwt_string) >= 1800,
     )
     return f"{session_manager.save_url}/{jwt_string}"

src/edutap/wallet_google/modelbase.py

@@ -1,43 +1,151 @@
-from pydantic import BaseModel
-from pydantic import ConfigDict
+from .modelcore import GoogleWalletModel
+from .modelcore import GoogleWalletWithIdModel
+from .models.primitives import CallbackOptions
+from .models.primitives import GroupingInfo
+from .models.primitives import Image
+from .models.primitives import PassConstraints
+from .models.primitives import SecurityAnimation
+from .models.primitives.barcode import Barcode
+from .models.primitives.barcode import RotatingBarcode
+from .models.primitives.class_template_info import ClassTemplateInfo
+from .models.primitives.data import ImageModuleData
+from .models.primitives.data import InfoModuleData
+from .models.primitives.data import LinksModuleData
+from .models.primitives.data import TextModuleData
+from .models.primitives.enums import MultipleDevicesAndHoldersAllowedStatus
+from .models.primitives.enums import ViewUnlockRequirement
+from .models.primitives.message import Message
+from pydantic import Field
 
 
-class GoogleWalletModel(BaseModel):
+class GoogleWalletClassModel(GoogleWalletWithIdModel):
     """
-    Base model for all Google Wallet models.
+    BaseModel for all Google Wallet Class Models.
     """
 
-    model_config = ConfigDict(
-        extra="forbid",
-        use_enum_values=True,
+    # Templating and Visual Data
+    classTemplateInfo: ClassTemplateInfo | None = None
+    imageModulesData: list[ImageModuleData] | None = None
+    textModulesData: list[TextModuleData] | None = None
+    linksModuleData: LinksModuleData | None = None
+    infoModuleData: InfoModuleData | None = Field(
+        description="deprecated",
+        deprecated=True,
+        exclude=True,
+        default=None,
+    )
+
+    # Callback Options
+    callbackOptions: CallbackOptions | None = None
+
+    # Smarttap Options
+    enableSmartTap: bool | None = None
+    redemptionIssuers: list[str] | None = None  # string (int64 format)
+
+    # Barcode Options
+    securityAnimation: SecurityAnimation | None = None
+
+    # Security Options
+    viewUnlockRequirement: ViewUnlockRequirement = (
+        ViewUnlockRequirement.VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED
+    )
+    allowMultipleUsersPerObject: bool | None = Field(
+        description="deprecated",
+        deprecated=True,
+        exclude=True,
+        default=None,
+    )
+    multipleDevicesAndHoldersAllowedStatus: MultipleDevicesAndHoldersAllowedStatus = (
+        MultipleDevicesAndHoldersAllowedStatus.STATUS_UNSPECIFIED
+    )
+
+    # Design Options
+    # hexBackgroundColor: str | None = None
+    # logo: Image | None = None
+    # wideLogo: Image | None = None
+    # heroImage: Image | None = None
+    wordMark: Image | None = Field(
+        description="deprecated",
+        deprecated=True,
+        exclude=True,
+        default=None,
     )
 
 
-class GoogleWalletWithIdModel(GoogleWalletModel):
+class GoogleWalletObjectModel(GoogleWalletWithIdModel):
     """
-    Base model for Google Wallet models with an identifier.
+    Base model for all Google Wallet Object models.
     """
 
-    id: str
+    classId: str
+    version: str | None = Field(
+        description="deprecated", deprecated=True, exclude=True, default=None
+    )
 
+    groupingInfo: GroupingInfo | None = None
 
-class GoogleWalletClassModel(GoogleWalletWithIdModel):
+    # Templating and Visual Data
+    imageModulesData: list[ImageModuleData] | None = None
+    textModulesData: list[TextModuleData] | None = None
+    linksModuleData: LinksModuleData | None = None
+    infoModuleData: InfoModuleData | None = Field(
+        description="deprecated",
+        deprecated=True,
+        exclude=True,
+        default=None,
+    )
+
+    # Security Options
+    passConstraints: PassConstraints | None = None
+
+    # Smart Tap Option
+    smartTapRedemptionValue: str | None = None
+
+    # Barcode Options
+    barcode: Barcode | None = None
+    rotatingBarcode: RotatingBarcode | None = None
+
+
+class GoogleWalletObjectWithClassReferenceMixin(
+    GoogleWalletModel, GoogleWalletWithIdModel
+):
     """
-    Base model for all Google Wallet Class models.
+    Mixin for all Google Wallet Object with a classReferences attribute, that reflects the whole class data.
     """
 
+    classReference: GoogleWalletClassModel | None = None
 
-class GoogleWalletObjectModel(GoogleWalletWithIdModel):
+
+class GoogleWalletMessageableMixin:
     """
-    Base model for all Google Wallet Object models.
+    Mixin for Google Wallet Classes or Objects that can retrieve Messages
     """
 
-    classId: str
+    messages: list[Message] | None = None
 
 
-class GoogleWalletObjectReference(GoogleWalletWithIdModel):
+class GoogleWalletStyleableClassMixin:
+    """
+    Mixin for Google Wallet Classes that can be styled.
     """
-    Model for all Google Wallet Object references.
+
+    # Design Options
+    hexBackgroundColor: str | None = None
+    logo: Image | None = None
+    wideLogo: Image | None = None
+    heroImage: Image | None = None
+
+
+class GoogleWalletStyleableObjectMixin:
+    """
+    Mixin for Google Wallet Objects that can be styled.
+
+    TODO: Check if really all Objects that can be styled have all four attributes and also with this name.
+          Potential Override necessary for programLogo, ...
     """
 
-    classId: str | None = None
+    # Design Options
+    hexBackgroundColor: str | None = None
+    logo: Image | None = None
+    wideLogo: Image | None = None
+    heroImage: Image | None = None

src/edutap/wallet_google/modelcore.py

@@ -0,0 +1,40 @@
+from pydantic import BaseModel
+from pydantic import ConfigDict
+from pydantic import Field
+
+
+class GoogleWalletModel(BaseModel):
+    """
+    Base Model for all Google Wallet Models.
+
+    Sets a model_config for all Google Wallet Models that enforce that all attributes must be explicitly modeled, and trying to set an unknown attribute would raise an Exception.
+    This Follows the Zen of Python (PEP 20) --> Explicit is better than implicit.
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+        # extra="ignore",
+        # use_enum_values=True,
+    )
+
+
+class GoogleWalletWithKindMixin(BaseModel):
+    """
+    Mixin Class for Google Wallet Models with an deprecated kind identifier.
+    Explicit kind value should be provided by the inheriting concret class.
+    """
+
+    kind: str | None = Field(
+        description="deprecated",
+        deprecated=True,
+        exclude=True,
+        default=None,
+    )
+
+
+class GoogleWalletWithIdModel(BaseModel):
+    """
+    Model for Google Wallet models with an identifier.
+    """
+
+    id: str

src/edutap/wallet_google/models/generic.py

@@ -1,54 +1,62 @@
 from ..modelbase import GoogleWalletClassModel
+from ..modelbase import GoogleWalletMessageableMixin
 from ..modelbase import GoogleWalletObjectModel
+from ..modelbase import GoogleWalletStyleableClassMixin
+from ..modelbase import GoogleWalletStyleableObjectMixin
+from ..modelcore import GoogleWalletModel
 from ..registry import register_model
-from .primitives import CallbackOptions
-from .primitives import GroupingInfo
-from .primitives import Image
-from .primitives import PassConstraints
-from .primitives import SecurityAnimation
-from .primitives.barcode import Barcode
-from .primitives.barcode import RotatingBarcode
-from .primitives.class_template_info import ClassTemplateInfo
 from .primitives.data import AppLinkData
-from .primitives.data import ImageModuleData
-from .primitives.data import LinksModuleData
-from .primitives.data import TextModuleData
 from .primitives.datetime import TimeInterval
 from .primitives.enums import GenericType
-from .primitives.enums import MultipleDevicesAndHoldersAllowedStatus
 from .primitives.enums import State
-from .primitives.enums import ViewUnlockRequirement
 from .primitives.localized_string import LocalizedString
-from .primitives.notification import Notifications
 from pydantic import Field
 
 
+class ExpiryNotification(GoogleWalletModel):
+    """
+    see: https://developers.google.com/wallet/generic/rest/v1/genericobject#expirynotification
+    """
+
+    enableNotification: bool = False
+
+
+class UpcomingNotification(GoogleWalletModel):
+    """
+    see: https://developers.google.com/wallet/generic/rest/v1/genericobject#upcomingnotification
+    """
+
+    enableNotification: bool = False
+
+
+class Notifications(GoogleWalletModel):
+    """
+    see: https://developers.google.com/wallet/generic/rest/v1/genericobject#notifications
+    """
+
+    expiryNotification: ExpiryNotification | None = None
+    upcomingNotification: UpcomingNotification | None = None
+
+
 @register_model(
     "GenericClass", url_part="genericClass", plural="genericClasses", can_disable=False
 )
-class GenericClass(GoogleWalletClassModel):
+class GenericClass(
+    GoogleWalletClassModel,
+    GoogleWalletStyleableClassMixin,
+    GoogleWalletMessageableMixin,
+):
     """
     see: https://developers.google.com/wallet/generic/rest/v1/genericclass
     """
 
-    classTemplateInfo: ClassTemplateInfo | None = None
-    imageModulesData: list[ImageModuleData] | None = None
-    textModulesData: list[TextModuleData] | None = None
-    linksModuleData: LinksModuleData | None = None
-    enableSmartTap: bool = False
-    redemptionIssuers: list[str] | None = None
-    securityAnimation: SecurityAnimation | None = None
-    multipleDevicesAndHoldersAllowedStatus: MultipleDevicesAndHoldersAllowedStatus = (
-        Field(default=MultipleDevicesAndHoldersAllowedStatus.STATUS_UNSPECIFIED)
-    )
-    callbackOptions: CallbackOptions | None = None
-    viewUnlockRequirement: ViewUnlockRequirement = Field(
-        default=ViewUnlockRequirement.VIEW_UNLOCK_REQUIREMENT_UNSPECIFIED
-    )
-
 
 @register_model("GenericObject", url_part="genericObject")
-class GenericObject(GoogleWalletObjectModel):
+class GenericObject(
+    GoogleWalletObjectModel,
+    GoogleWalletStyleableObjectMixin,
+    GoogleWalletMessageableMixin,
+):
     """
     see: https://developers.google.com/wallet/generic/rest/v1/genericobject
     """
@@ -57,20 +65,8 @@ class GenericObject(GoogleWalletObjectModel):
     cardTitle: LocalizedString | None = None
     subheader: LocalizedString | None = None
     header: LocalizedString | None = None
-    logo: Image | None = None
-    wideLogo: Image | None = None
-    hexBackgroundColor: str | None = None
     notifications: Notifications | None = None
-    barcode: Barcode | None = None
-    heroImage: Image | None = None
     validTimeInterval: TimeInterval | None = None
-    imageModulesData: list[ImageModuleData] | None = None
-    textModulesData: list[TextModuleData] | None = None
-    linksModuleData: LinksModuleData | None = None
     appLinkData: AppLinkData | None = None
-    groupingInfo: GroupingInfo | None = None
-    smartTapRedemptionValue: str | None = None
-    rotatingBarcode: RotatingBarcode | None = None
     state: State = Field(default=State.STATE_UNSPECIFIED)
     hasUsers: bool | None = None
-    passConstraints: PassConstraints | None = None