Habiticalib 0.4.0rc0__py3-none-any.whl → 0.4.0rc2__py3-none-any.whl

habiticalib/__init__.py

@@ -51,6 +51,7 @@ from .typedefs import (
     GroupChatReceived,
     GroupChatReceivedOptions,
     GroupChatReceivedWebhook,
+    GroupData,
     GroupTask,
     HabiticaCastSkillResponse,
     HabiticaClass,
@@ -59,7 +60,9 @@ from .typedefs import (
     HabiticaDeleteWebhookResponse,
     HabiticaErrorResponse,
     HabiticaGroupMembersResponse,
+    HabiticaGroupsResponse,
     HabiticaLoginResponse,
+    HabiticaMessageResponse,
     HabiticaQuestResponse,
     HabiticaResponse,
     HabiticaScoreResponse,
@@ -204,6 +207,7 @@ __all__ = [
     "GroupChatReceived",
     "GroupChatReceivedOptions",
     "GroupChatReceivedWebhook",
+    "GroupData",
     "GroupTask",
     "Habitica",
     "HabiticaCastSkillResponse",
@@ -219,8 +223,10 @@ __all__ = [
     "HabiticaException",
     "HabiticaGroupMembersResponse",
     "HabiticaGroupMembersResponse",
+    "HabiticaGroupsResponse",
     "HabiticaLoginResponse",
     "HabiticaLoginResponse",
+    "HabiticaMessageResponse",
     "HabiticaQuestResponse",
     "HabiticaQuestResponse",
     "HabiticaResponse",

habiticalib/const.py

@@ -1,6 +1,6 @@
 """Constants for Habiticalib."""
 
-__version__ = "0.4.0rc0"
+__version__ = "0.4.0rc2"
 
 DEFAULT_URL = "https://habitica.com/"
 ASSETS_URL = "https://habitica-assets.s3.amazonaws.com/mobileApp/images/"

habiticalib/lib.py

@@ -7,10 +7,9 @@ from http import HTTPStatus
 from io import BytesIO
 import logging
 from operator import add
-from typing import IO, TYPE_CHECKING, Any, Self
+from typing import IO, TYPE_CHECKING, Self
 
 from aiohttp import ClientError, ClientResponseError, ClientSession
-from habitipy.aio import HabitipyAsync  # type: ignore[import-untyped]
 from PIL import Image
 from yarl import URL
 
@@ -47,7 +46,9 @@ from .typedefs import (
     HabiticaDeleteWebhookResponse,
     HabiticaErrorResponse,
     HabiticaGroupMembersResponse,
+    HabiticaGroupsResponse,
     HabiticaLoginResponse,
+    HabiticaMessageResponse,
     HabiticaQuestResponse,
     HabiticaResponse,
     HabiticaScoreResponse,
@@ -2051,36 +2052,6 @@ class Habitica:
 
         return avatar
 
-    async def habitipy(self) -> HabitipyAsync:
-        """Create a Habitipy instance."""
-
-        _session = self._session
-        _headers = self._headers
-        loop = asyncio.get_running_loop()
-
-        class HAHabitipyAsync(HabitipyAsync):
-            """Closure API class to hold session."""
-
-            def __call__(self, **kwargs) -> Any:
-                """Pass session to habitipy."""
-                return super().__call__(_session, **kwargs)
-
-            def _make_headers(self) -> dict[str, str]:
-                """Inject headers."""
-                headers = super()._make_headers()
-                headers.update(_headers)
-                return headers
-
-        return await loop.run_in_executor(
-            None,
-            HAHabitipyAsync,
-            {
-                "url": str(self.url),
-                "login": self._headers.get("X-API-USER"),
-                "password": self._headers.get("X-API-KEY"),
-            },  # type: ignore[var-annotated]
-        )
-
     async def create_webhook(
         self,
         webhook: TaskActivity
@@ -2183,3 +2154,89 @@ class Habitica:
         return HabiticaWebhookResponse.from_json(
             await self._request("put", url, json=webhook.to_dict(omit_none=True))
         )
+
+    async def get_group(self, group_id: UUID | None = None) -> HabiticaGroupsResponse:
+        """
+        Retrieve a user's group or party information.
+
+        Parameters
+        ----------
+        group_id : UUID or None, optional
+            The unique identifier of the group to retrieve. If not provided,
+            the user's party information will be retrieved instead.
+
+        Returns
+        -------
+        HabiticaGroupsResponse
+            An object representing the response containing the group or party details.
+        """
+
+        url = self.url / "api/v3/groups" / (str(group_id) if group_id else "party")
+
+        return HabiticaGroupsResponse.from_json(await self._request("get", url))
+
+    async def send_group_message(
+        self, message: str, group_id: UUID | None = None
+    ) -> HabiticaMessageResponse:
+        """Send a message to a specific group.
+
+        Parameters
+        ----------
+        message : str
+            The content of the message to be sent.
+        group_id : UUID
+            The unique identifier of the group to send the message to.
+            If not provided, the user's party will be used.
+
+        Returns
+        -------
+        HabiticaMessageResponse
+            An object representing the response containing the sent message details.
+
+        Raises
+        ------
+        NotAuthorizedError
+            If the user is not authorized to send messages to the specified group
+            because the chat privileges have been revoked.
+        NotFoundError
+            If the specified group could not be found.
+        """
+        url = (
+            self.url
+            / "api/v3/groups"
+            / (str(group_id) if group_id else "party")
+            / "chat"
+        )
+        return HabiticaMessageResponse.from_json(
+            await self._request("post", url, json={"message": message})
+        )
+
+    async def send_private_message(
+        self, message: str, to_user_id: UUID
+    ) -> HabiticaMessageResponse:
+        """Send a private message to a specific user.
+
+        Parameters
+        ----------
+        message : str
+            The content of the private message to be sent.
+        to_user_id : UUID
+            The unique identifier of the user to send the message to.
+
+        Returns
+        -------
+        HabiticaMessageResponse
+            An object representing the response containing the sent message details.
+
+        Raises
+        ------
+        NotFoundError
+            If the specified user could not be found.
+        """
+        url = self.url / "api/v3/members/send-private-message"
+
+        return HabiticaMessageResponse.from_json(
+            await self._request(
+                "post", url, json={"message": message, "toUserId": str(to_user_id)}
+            )
+        )

habiticalib/typedefs.py

@@ -559,6 +559,9 @@ class QuestParty(BaseModel):
     RSVPNeeded: bool | None = None
     key: str | None = None
     completed: str | None = None
+    active: bool | None = None
+    leader: UUID | None = None
+    members: dict[UUID, bool] = field(default_factory=dict)
 
 
 @dataclass(kw_only=True)
@@ -1621,7 +1624,7 @@ class ItemListContent(BaseModel):
     bundles: ItemListEntry
 
 
-@dataclass
+@dataclass(kw_only=True)
 class GearEntry(BaseModel):
     """GearEntry content data."""
 
@@ -1767,7 +1770,7 @@ class PetEntry(BaseModel):
     text: str | None = None
 
 
-@dataclass
+@dataclass(kw_only=True)
 class InventoryItemEntry(BaseModel):
     """Inventory item content data."""
 
@@ -1779,6 +1782,36 @@ class InventoryItemEntry(BaseModel):
     key: str | None = None
     notes: str | None = None
     canDrop: bool | None = None
+    sellWarningNote: str | None = None
+
+
+@dataclass(kw_only=True)
+class Achievment(BaseModel):
+    """An achievment."""
+
+    icon: str
+    titleKey: str
+    textKey: str
+    key: str
+    text2Key: str | None = None
+    notificationText: str | None = None
+    singularTitleKey: str | None = None
+    singularTextKey: str | None = None
+    pluralTitleKey: str | None = None
+    pluralTextKey: str | None = None
+    modalTextKey: str | None = None
+
+
+@dataclass(kw_only=True)
+class Incentive(BaseModel):
+    """A login incentive."""
+
+    rewardKey: list[str] = field(default_factory=list)
+    nextRewardAt: int = 500
+    prevRewardKey: int = 0
+    reward: list[QuestsContent | GearEntry | InventoryItemEntry | Achievment] = field(
+        default_factory=list
+    )
 
 
 @dataclass
@@ -1836,7 +1869,7 @@ class ContentData(BaseModel):
     # tasksByCategory
     # userDefaultsMobile
     # faq
-    # loginIncentives
+    loginIncentives: dict[str, Incentive]
 
 
 @dataclass
@@ -1870,3 +1903,113 @@ class HabiticaCastSkillResponse(HabiticaResponse):
     """Representation of a cast skill response."""
 
     data: UserTasks
+
+
+class GroupPrivacy(StrEnum):
+    """Group privacy."""
+
+    PRIVATE = "private"
+    PUBLIC = "public"
+
+
+class GroupType(StrEnum):
+    """Group type."""
+
+    GUILD = "guild"
+    PARTY = "party"
+
+
+@dataclass(kw_only=True)
+class LeaderOnly(BaseModel):
+    """Group leaderOnly  data."""
+
+    challenges: bool
+    getGems: bool
+
+
+@dataclass(kw_only=True)
+class GroupLeader(BaseModel):
+    """Group leader data."""
+
+    id: UUID
+    auth: AuthUser
+    profile: ProfileUser
+
+
+@dataclass(kw_only=True)
+class ChatMsgInfo(BaseModel):
+    """Chat message info."""
+
+    type: str | None = None
+    user: str | None = None
+    quest: str | None = None
+    items: dict[str, int] | None = None
+
+
+@dataclass(kw_only=True)
+class ChatMsg(BaseModel):
+    """Chat message."""
+
+    id: UUID
+    flagCount: int
+    text: str
+    unformattedText: str
+    info: ChatMsgInfo
+    timestamp: datetime = field(
+        metadata=field_options(
+            deserialize=serialize_datetime,
+        )
+    )
+    likes: dict[UUID, bool]
+    client: str | None = None
+    uuid: UUID | str
+    groupId: UUID | None = None
+    user: str | None = None
+    username: str | None = None
+    userStyles: Avatar | None = None
+    sent: bool | None = None
+    ownerId: UUID | None = None
+    uniqueMessageId: UUID | None = None
+
+
+@dataclass(kw_only=True)
+class GroupData(BaseModel):
+    """Groups data."""
+
+    id: UUID
+    name: str
+    summary: str = ""
+    description: str = ""
+    leader: GroupLeader
+    type: GroupType
+    privacy: GroupPrivacy
+    chat: list[ChatMsg]
+    leaderOnly: LeaderOnly
+    memberCount: int = 1
+    ChallengeCount: int = 0
+    chatLimitCount: int | None = None
+    balance: float
+    logo: str | None = None
+    leaderMessage: str | None = None
+    quest: QuestParty
+
+
+@dataclass
+class HabiticaGroupsResponse(HabiticaResponse):
+    """Representation of a groups response."""
+
+    data: GroupData
+
+
+@dataclass(kw_only=True)
+class MessageData(BaseModel):
+    """Message data."""
+
+    message: ChatMsg
+
+
+@dataclass(kw_only=True)
+class HabiticaMessageResponse(HabiticaResponse):
+    """Representation of a group response."""
+
+    data: MessageData

{habiticalib-0.4.0rc0.dist-info → habiticalib-0.4.0rc2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Habiticalib
-Version: 0.4.0rc0
+Version: 0.4.0rc2
 Summary: Asynchronous Python client library for the Habitica API
 Project-URL: Documentation, https://tr4nt0r.github.io/habiticalib/
 Project-URL: Source, https://github.com/tr4nt0r/habiticalib
@@ -12,7 +12,6 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.12
 Requires-Dist: aiohttp~=3.9
-Requires-Dist: habitipy~=0.3.3
 Requires-Dist: mashumaro~=3.13
 Requires-Dist: orjson~=3.10
 Requires-Dist: pillow~=11.0

habiticalib-0.4.0rc2.dist-info/RECORD

@@ -0,0 +1,12 @@
+habiticalib/__init__.py,sha256=UxNKxNhjIi3v95VE3h-JWgitriNZytrGeX0GvKdevwU,7840
+habiticalib/const.py,sha256=-u5ybeRWgP6hzR18_JNU-oxFY1Bkdg4baOupXKXlr0Q,2311
+habiticalib/exceptions.py,sha256=i9hnCaMT5RbnTioFhwRYJkcC_bG9lMeUd2jJsWFVnVg,1342
+habiticalib/ha.py,sha256=rSzrs7ixLJH3ZtOFlcuKV2t1ZndT0VpuPhDsGqorkOs,20757
+habiticalib/helpers.py,sha256=lq2HBvqLsFo5_zckMnc7hzDsHLfyrcStpFUpet3ZuZY,4500
+habiticalib/lib.py,sha256=DUMdqia-w4AAPdf8bAX2g9PXq0HgPocYy-E1-cFXV7g,78503
+habiticalib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+habiticalib/typedefs.py,sha256=726lwaH_Zpk6YMVlFmlLsV0aicn-jrfQ7ESXHFeK5Nw,50900
+habiticalib-0.4.0rc2.dist-info/METADATA,sha256=vY9qMfEXj8y5BWzTSVQmzZSMVvqDMQgCDVHO0hVpS58,4179
+habiticalib-0.4.0rc2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+habiticalib-0.4.0rc2.dist-info/licenses/LICENSE,sha256=oIinIOSJ49l1iVIRI3XGXFWt6SF7a83kEFBAY8ORwNI,1084
+habiticalib-0.4.0rc2.dist-info/RECORD,,

habiticalib-0.4.0rc0.dist-info/RECORD

@@ -1,12 +0,0 @@
-habiticalib/__init__.py,sha256=2IM9mDegpFIANIdatGTePbT4r1cilUtwNYs4Bups7So,7690
-habiticalib/const.py,sha256=Yh3d46unPdB1n6EMENXrpV_komBj3b1eDWwc9pdEaws,2311
-habiticalib/exceptions.py,sha256=i9hnCaMT5RbnTioFhwRYJkcC_bG9lMeUd2jJsWFVnVg,1342
-habiticalib/ha.py,sha256=rSzrs7ixLJH3ZtOFlcuKV2t1ZndT0VpuPhDsGqorkOs,20757
-habiticalib/helpers.py,sha256=lq2HBvqLsFo5_zckMnc7hzDsHLfyrcStpFUpet3ZuZY,4500
-habiticalib/lib.py,sha256=9CqfAIGBx-MJB08UAB81kczB2kD1W1aPYHjDfAvBmFY,76729
-habiticalib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-habiticalib/typedefs.py,sha256=pU7jfWAKMSvJO8QjTEgm_B0c6GONy1SZH2lTMUPPhrE,47834
-habiticalib-0.4.0rc0.dist-info/METADATA,sha256=w920G81BFg4JxgAuIwi93JIC-jXZ3zhuwBNOwtu3GWg,4210
-habiticalib-0.4.0rc0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-habiticalib-0.4.0rc0.dist-info/licenses/LICENSE,sha256=oIinIOSJ49l1iVIRI3XGXFWt6SF7a83kEFBAY8ORwNI,1084
-habiticalib-0.4.0rc0.dist-info/RECORD,,