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

.github/workflows/ci.yaml

@@ -10,16 +10,15 @@ jobs:
     strategy:
       matrix:
         python-version: ['3.10', '3.11', '3.12']
-
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         python -m pip install tox tox-gh-actions
     - name: Test with tox
-      run: tox
+      run: tox

pyproject.toml

@@ -23,6 +23,8 @@ classifiers = [
 ]
 dependencies = [
     "pydantic[email,dotenv]>=2.0",
+    "pydantic-settings",
+    # "email-validator",
     "python-dotenv",
     "google-auth",
     "google-cloud-storage",

src/edutap/wallet_google/api.py

@@ -1,9 +1,12 @@
-from .modelbase import GoogleWalletModel
-from .modelbase import GoogleWalletObjectReference
+from .modelbase import GoogleWalletClassModel
+from .modelbase import GoogleWalletObjectModel
+from .modelbase import GoogleWalletObjectWithClassReferenceMixin
+from .modelbase import GoogleWalletWithIdModel
+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
@@ -33,7 +36,7 @@ def _validate_data(
                        or a Pydantic model instance.
     :return:           data as an instance of the given model
     """
-    if not isinstance(data, GoogleWalletModel):
+    if not isinstance(data, (GoogleWalletModel, GoogleWalletWithIdModel)):
         return model.model_validate(data)
     if not isinstance(data, model):
         raise ValueError(
@@ -88,15 +91,20 @@ def create(
     resource_id, verified_json = _validate_data_and_convert_to_json(model, data)
     session = session_manager.session
     url = session_manager.url(name)
-    response = session.post(url=url, data=verified_json.encode("utf-8"))
+    headers = {"Content-Type": "application/json"}
+    response = session.post(
+        url=url,
+        data=verified_json.encode("utf-8"),
+        headers=headers,
+    )
     if response.status_code == 409:
         raise Exception(
             f"Wallet Object {name} {getattr(data, 'id', 'No ID')} already exists\n{response.text}"
         )
     elif response.status_code != 200:
         raise Exception(f"Error at {url}: {response.status_code} - {response.text}")
 
-    logger.debug(f"RAW-Response: {response.content}")
+    logger.debug(f"RAW-Response: {response.content!r}")
     return model.model_validate_json(response.content)
 
 
@@ -123,7 +131,7 @@ def read(
 
     if response.status_code == 200:
         model = lookup_model(name)
-        logger.debug(f"RAW-Response: {response.content}")
+        logger.debug(f"RAW-Response: {response.content!r}")
         # print(f"RAW-Response: {response.content}")
         return model.model_validate_json(response.content)
 
@@ -151,7 +159,18 @@ def update(
     raise_when_operation_not_allowed(name, "update")
     model_metadata = lookup_metadata(name)
     model = model_metadata["model"]
-    if not isinstance(data, GoogleWalletModel) and partial:
+    if (
+        not isinstance(
+            data,
+            (
+                GoogleWalletModel,
+                GoogleWalletWithIdModel,
+                GoogleWalletClassModel,
+                GoogleWalletObjectModel,
+            ),
+        )
+        and partial
+    ):
         resource_id = data[model_metadata["resource_id"]]
         # we can not validate partial data for patch yet
         verified_json = json.dumps(data)
@@ -170,6 +189,7 @@ def update(
             url=session_manager.url(name, f"/{resource_id}"),
             data=verified_json.encode("utf-8"),
         )
+    logger.debug(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}"
@@ -178,7 +198,7 @@ def update(
     if response.status_code != 200:
         raise Exception(f"Error: {response.status_code} - {response.text}")
 
-    logger.debug(f"RAW-Response: {response.content}")
+    logger.debug(f"RAW-Response: {response.content!r}")
     return model.model_validate_json(response.content)
 
 
@@ -243,7 +263,7 @@ def message(
 
     if response.status_code != 200:
         raise Exception(f"Error: {response.status_code} - {response.text}")
-    logger.debug(f"RAW-Response: {response.content}")
+    logger.debug(f"RAW-Response: {response.content!r}")
     response_data = json.loads(response.content)
     return model.model_validate(response_data.get("resource"))
 
@@ -374,15 +394,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 +430,10 @@ 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",
-        len(jwt_string),
-        len(jwt_string) <= 1800,
-    )
+    if len(jwt_string) >= 1800:
+        logger.debug(
+            "JWT-Length: %d, is larger than recommended 1800 bytes: %s",
+            len(jwt_string),
+            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(GoogleWalletModel, 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
 
-class GoogleWalletWithIdModel(GoogleWalletModel):
+    # 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 GoogleWalletObjectModel(GoogleWalletModel, 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
 
+    # 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,
+    )
 
-class GoogleWalletClassModel(GoogleWalletWithIdModel):
+    # 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:
     """
-    Model for all Google Wallet Object references.
+    Mixin for Google Wallet Classes that can be styled.
+    """
+
+    # 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