Merge pull request #52 from OpenBuilders/feat/sticker-character-logo

feat: Add logo_url to the StickerCharacter

Author: danoctua

backend/api/pos/sticker.py

@@ -1,8 +1,32 @@
+from typing import Self
+
 from api.pos.base import BaseFDO
-from core.dtos.sticker import MinimalStickerCollectionWithCharactersDTO
+from core.dtos.sticker import (
+    MinimalStickerCollectionWithCharactersDTO,
+    MinimalStickerCharacterDTO,
+)
+
+
+class MinimalStickerCharacterFDO(BaseFDO, MinimalStickerCharacterDTO):
+    @classmethod
+    def from_dto(cls, dto: MinimalStickerCharacterDTO) -> Self:
+        return cls(
+            id=dto.id,
+            name=dto.name,
+            logo_url=dto.logo_url,
+        )
 
 
 class MinimalStickerCollectionWithCharactersFDO(
     BaseFDO, MinimalStickerCollectionWithCharactersDTO
 ):
-    ...
+    characters: list[MinimalStickerCharacterFDO]
+
+    @classmethod
+    def from_dto(cls, dto: MinimalStickerCollectionWithCharactersDTO) -> Self:
+        return cls(
+            id=dto.id,
+            title=dto.title,
+            logo_url=dto.logo_url,
+            characters=[MinimalStickerCharacterFDO.from_dto(c) for c in dto.characters],
+        )

backend/api/routes/admin/resource.py

@@ -89,9 +89,7 @@ async def get_stickers_collections(
     collections = await action.get_all_grouped()
 
     return [
-        MinimalStickerCollectionWithCharactersFDO.model_validate(
-            collection.model_dump()
-        )
+        MinimalStickerCollectionWithCharactersFDO.from_dto(collection)
         for collection in collections
     ]
 

backend/core/actions/sticker.py

@@ -93,6 +93,7 @@ def create(self, dto: StickerCharacterDTO) -> StickerCharacterDTO:
             name=dto.name,
             description=dto.description,
             supply=dto.supply,
+            logo_url=dto.logo_url,
         )
         return StickerCharacterDTO.from_orm(sticker_character)
 

backend/core/dtos/sticker.py

@@ -23,12 +23,14 @@ def from_orm(cls, obj: StickerCollection) -> Self:
 class MinimalStickerCharacterDTO(BaseModel):
     id: int
     name: str
+    logo_url: str | None
 
     @classmethod
     def from_orm(cls, obj: Any) -> Self:
         return cls(
             id=obj.id,
             name=obj.name,
+            logo_url=obj.logo_url,
         )
 
 
@@ -50,7 +52,6 @@ def from_orm(cls, obj: StickerCollection) -> Self:
 
 class StickerCollectionDTO(MinimalStickerCollectionDTO):
     description: str | None
-    logo_url: str | None
 
     @classmethod
     def from_orm(cls, obj: StickerCollection) -> Self:
@@ -75,6 +76,7 @@ def from_orm(cls, obj: Any) -> Self:
             collection_id=obj.collection_id,
             description=obj.description,
             supply=obj.supply,
+            logo_url=obj.logo_url,
         )
 
 
@@ -151,6 +153,7 @@ def from_json(cls, collection_json: dict[str, Any]) -> Self:
                     collection_id=collection_json["id"],
                     description=character["description"],
                     supply=character["supply"],
+                    logo_url=character.get("logo_url"),
                 )
                 for character in collection_json["characters"]
             ],

backend/core/migrations/versions/1745924061-02d2e4791b2c-sticker_character_logo.py

@@ -0,0 +1,28 @@
+"""sticker character logo
+
+Revision ID: 02d2e4791b2c
+Revises: ae8e0ea77cf0
+Create Date: 2025-04-29 10:54:21.198049
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision: str = "02d2e4791b2c"
+down_revision: Union[str, None] = "ae8e0ea77cf0"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    op.add_column(
+        "sticker_character", sa.Column("logo_url", sa.String(length=255), nullable=True)
+    )
+
+
+def downgrade() -> None:
+    op.drop_column("sticker_character", "logo_url")

backend/core/models/sticker.py

@@ -25,6 +25,7 @@ class StickerCharacter(Base):
     name = mapped_column(String(255), nullable=False)
     description = mapped_column(String(255), nullable=True)
     supply = mapped_column(Integer, nullable=False)
+    logo_url = mapped_column(String(255), nullable=True)
 
     collection = relationship(
         "StickerCollection",

backend/core/services/sticker/character.py

@@ -24,13 +24,15 @@ def create(
         name: str,
         description: str,
         supply: int,
+        logo_url: str | None,
     ) -> StickerCharacter:
         new_character = StickerCharacter(
             external_id=character_id,
             collection_id=collection_id,
             name=name,
             description=description,
             supply=supply,
+            logo_url=logo_url,
         )
         self.db_session.add(new_character)
         self.db_session.commit()
@@ -42,12 +44,14 @@ def is_update_required(
         name: str,
         description: str,
         supply: int,
+        logo_url: str | None,
     ) -> bool:
         return any(
             [
                 character.name != name,
                 character.description != description,
                 character.supply != supply,
+                character.logo_url != logo_url,
             ]
         )
 
@@ -57,9 +61,11 @@ def update(
         name: str,
         description: str,
         supply: int,
+        logo_url: str | None,
     ) -> StickerCharacter:
         character.name = name
         character.description = description
         character.supply = supply
+        character.logo_url = logo_url
         self.db_session.commit()
         return character

backend/indexer/actions/sticker.py

@@ -159,13 +159,15 @@ async def refresh_collections(self) -> None:
                         name=character.name,
                         description=character.description,
                         supply=character.supply,
+                        logo_url=character.logo_url,
                     )
                 else:
                     if self.sticker_character_service.is_update_required(
                         character=current_character,
                         name=character.name,
                         description=character.description,
                         supply=character.supply,
+                        logo_url=character.logo_url,
                     ):
                         logger.info(
                             f"Character {character.id=} for collection {collection.id=} has changed. Updating..."
@@ -175,6 +177,7 @@ async def refresh_collections(self) -> None:
                             name=character.name,
                             description=character.description,
                             supply=character.supply,
+                            logo_url=character.logo_url,
                         )
 
         # Set cache only on successful processing