Habiticalib 0.1.0a3__tar.gz → 0.2.0a1__tar.gz

{habiticalib-0.1.0a3 → habiticalib-0.2.0a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: Habiticalib
-Version: 0.1.0a3
+Version: 0.2.0a1
 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

{habiticalib-0.1.0a3 → habiticalib-0.2.0a1}/src/habiticalib/__init__.py

@@ -16,9 +16,11 @@ from .types import (
     HabiticaClass,
     HabiticaClassSystemResponse,
     HabiticaErrorResponse,
+    HabiticaGroupMembersResponse,
     HabiticaLoginResponse,
     HabiticaResponse,
     HabiticaScoreResponse,
+    HabiticaSleepResponse,
     HabiticaStatsResponse,
     HabiticaTagResponse,
     HabiticaTagsResponse,
@@ -48,9 +50,11 @@ __all__ = [
     "HabiticaClassSystemResponse",
     "HabiticaErrorResponse",
     "HabiticaException",
+    "HabiticaGroupMembersResponse",
     "HabiticaLoginResponse",
     "HabiticaResponse",
     "HabiticaScoreResponse",
+    "HabiticaSleepResponse",
     "HabiticaStatsResponse",
     "HabiticaTagResponse",
     "HabiticaTagsResponse",

{habiticalib-0.1.0a3 → habiticalib-0.2.0a1}/src/habiticalib/const.py

@@ -1,6 +1,6 @@
 """Constants for Habiticalib."""
 
-__version__ = "0.1.0a3"
+__version__ = "0.2.0a1"
 
 DEFAULT_URL = "https://habitica.com/"
 ASSETS_URL = "https://habitica-assets.s3.amazonaws.com/mobileApp/images/"
@@ -14,3 +14,5 @@ BACKER_ONLY_GEAR = {
     "shield_special_ks2019": "BackerOnly-Equip-MythicGryphonShield.gif",
     "weapon_special_ks2019": "BackerOnly-Equip-MythicGryphonGlaive.gif",
 }
+
+PAGE_LIMIT = 60

{habiticalib-0.1.0a3 → habiticalib-0.2.0a1}/src/habiticalib/lib.py

@@ -12,7 +12,7 @@ from aiohttp import ClientError, ClientResponseError, ClientSession
 from PIL import Image
 from yarl import URL
 
-from .const import ASSETS_URL, BACKER_ONLY_GEAR, DEFAULT_URL
+from .const import ASSETS_URL, BACKER_ONLY_GEAR, DEFAULT_URL, PAGE_LIMIT
 from .exceptions import (
     BadRequestError,
     NotAuthorizedError,
@@ -32,9 +32,12 @@ from .types import (
     HabiticaClass,
     HabiticaClassSystemResponse,
     HabiticaErrorResponse,
+    HabiticaGroupMembersResponse,
     HabiticaLoginResponse,
+    HabiticaQuestResponse,
     HabiticaResponse,
     HabiticaScoreResponse,
+    HabiticaSleepResponse,
     HabiticaStatsResponse,
     HabiticaTagResponse,
     HabiticaTagsResponse,
@@ -848,17 +851,17 @@ class Habitica:
         if target_id:
             params.update({"targetId": str(target_id)})
         return HabiticaUserResponse.from_json(
-            await self._request("post", url=url, json=params),
+            await self._request("post", url=url, params=params),
         )
 
     async def toggle_sleep(
         self,
-    ) -> HabiticaResponse:
+    ) -> HabiticaSleepResponse:
         """Toggles the user's sleep mode in Habitica.
 
         Returns
         -------
-        HabiticaResponse
+        HabiticaSleepResponse
             A response object containing the result of the sleep mode toggle,
             and the new sleep state (True if sleeping, False if not).
 
@@ -875,7 +878,7 @@ class Habitica:
         """
         url = self.url / "api/v3/user/sleep"
 
-        return HabiticaResponse.from_json(await self._request("post", url=url))
+        return HabiticaSleepResponse.from_json(await self._request("post", url=url))
 
     async def revive(
         self,
@@ -1280,6 +1283,443 @@ class Habitica:
             await self._request("post", url=url, json=json),
         )
 
+    async def get_group_members(
+        self,
+        group_id: UUID | None = None,
+        *,
+        limit: int | None = None,
+        tasks: bool = False,
+        public_fields: bool = False,
+        last_id: UUID | None = None,
+    ) -> HabiticaGroupMembersResponse:
+        """Get members of the party or a specific group.
+
+        This method retrieves a list of members for a party or a specified group
+        from the Habitica API. Additional options allow including tasks or public
+        through results if necessary to collect all members. If the API rate limit is
+        exceeded, the method will pause for the duration specified in the `retry-after`
+        header and retry the request.
+
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the group. Defaults to the user's party if not specified.
+        limit : int, optional
+            Maximum number of members per request (default: 30, max: 60).
+        tasks : bool, optional
+            Whether to include tasks associated with the group.
+        public_fields : bool, optional
+            Whether to include all public fields for group members.
+        last_id : UUID, optional
+            For paginated requests, the UUID of the last member retrieved.
+
+        Returns
+        -------
+        HabiticaGroupMembersResponse
+            A response object containing the group member data.
+
+        Raises
+        ------
+        aiohttp.ClientResponseError
+            For HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            For any other exceptions raised by aiohttp during the request.
+        TimeoutError
+            If the connection times out.
+
+        Examples
+        --------
+        >>> members_response = await habitica.get_group_members()
+        >>> for member in members_response.data:
+        ...     print(member.profile.name)
+        """
+
+        if limit is not None and (limit < 1 or limit > PAGE_LIMIT):
+            msg = f"The 'limit' parameter must be between 1 and {PAGE_LIMIT}."
+            raise ValueError(msg)
+
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "members"
+
+        params: dict[str, str | int] = {}
+
+        if tasks:
+            params["includeTasks"] = "true"
+        if public_fields:
+            params["includeAllPublicFields"] = "true"
+        if last_id:
+            params["lastId"] = str(last_id)
+        if limit:
+            params["limit"] = limit
+
+        while True:
+            try:
+                response = HabiticaGroupMembersResponse.from_json(
+                    await self._request("get", url=url, params=params),
+                )
+                break
+            except TooManyRequestsError as e:
+                await asyncio.sleep(e.retry_after)
+
+        if len(response.data) == limit:
+            next_page = await self.get_group_members(
+                group_id=group_id,
+                limit=limit,
+                tasks=tasks,
+                public_fields=public_fields,
+                last_id=response.data[-1].id,
+            )
+            response.data.extend(next_page.data)
+
+        return response
+
+    async def abort_quest(self, group_id: UUID | None = None) -> HabiticaQuestResponse:
+        """Abort an active quest for the party or a specific group.
+
+        Prematurely terminates an ongoing quest, causing all progress to be lost.
+        The quest scroll will be returned to the owner's inventory.
+        Only the quest leader or group leader is allowed to perform this action.
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the specific group whose quest should be aborted.
+            Defaults to the user's party if not specified.
+
+        Returns
+        -------
+        HabiticaQuestResponse
+            A response object containing updated quest data of the group or party.
+
+        Raises
+        ------
+        NotFoundError
+            If the specified group or quest could not be found.
+        NotAuthorizedError
+            If the user does not have permission to abort the quest.
+        aiohttp.ClientResponseError
+            For HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            For any other exceptions raised by aiohttp during the request.
+        TimeoutError
+            If the connection times out.
+
+        Examples
+        --------
+        Abort the party's current quest:
+        >>> response = await habitica.abort_quest()
+        >>> print(response.success)  # True if the quest was successfully aborted.
+
+        Abort a quest for a specific group:
+        >>> group_id = UUID("12345678-1234-5678-1234-567812345678")
+        >>> response = await habitica.abort_quest(group_id)
+        >>> print(response.success)  # True if the quest was successfully aborted.
+        """
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "quests/abort"
+
+        return HabiticaQuestResponse.from_json(
+            await self._request("post", url=url),
+        )
+
+    async def accept_quest(self, group_id: UUID | None = None) -> HabiticaQuestResponse:
+        """Accept a pending invitation to a quest from the party or a specific group.
+
+        Allows a user to accept an invitation to participate in a quest within a
+        specified group.
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the group for which the quest invitation is being accepted.
+            Defaults to the user's party if not specified.
+
+
+        Returns
+        -------
+        HabiticaQuestResponse
+            A response object containing updated quest data of the group or party.
+
+        Raises
+        ------
+        NotFoundError
+            If the specified group or quest could not be found.
+        aiohttp.ClientResponseError
+            Raised for HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            Raised for any other exceptions encountered by `aiohttp` during the request.
+        TimeoutError
+            If the connection to the API times out.
+
+        Examples
+        --------
+        Accept a pending quest invitation from the party:
+        >>> response = await habitica.accept_quest()
+        >>> print(response.success)  # True if the quest invitation was successfully accepted.
+        """
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "quests/accept"
+
+        return HabiticaQuestResponse.from_json(
+            await self._request("post", url=url),
+        )
+
+    async def reject_quest(self, group_id: UUID | None = None) -> HabiticaQuestResponse:
+        """Reject a pending quest invitation from the party or a specific group.
+
+        Allows a user to reject an invitation to participate in a quest within a
+        specified group. The user will not join the quest and will be excluded from
+        its progress and rewards.
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the group for which the quest invitation is being rejected.
+            Defaults to the user's party if not specified.
+
+
+        Returns
+        -------
+        HabiticaQuestResponse
+            A response object containing updated quest data of the group or party.
+
+        Raises
+        ------
+        NotFoundError
+            If the specified group or quest could not be found.
+        aiohttp.ClientResponseError
+            Raised for HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            Raised for any other exceptions encountered by `aiohttp` during the request.
+        TimeoutError
+            If the connection to the API times out.
+
+        Examples
+        --------
+        Reject a pending quest invitation from the party:
+        >>> response = await habitica.reject_quest()
+        >>> print(response.success)  # True if the quest invitation was successfully rejected.
+
+        Reject a pending quest invitation from a specific group:
+        >>> group_id = UUID("12345678-1234-5678-1234-567812345678")
+        >>> response = await habitica.reject_quest(group_id)
+        >>> print(response.success)  # True if the quest invitation was successfully rejected.
+        """
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "quests/reject"
+
+        return HabiticaQuestResponse.from_json(
+            await self._request("post", url=url),
+        )
+
+    async def cancel_quest(self, group_id: UUID | None = None) -> HabiticaQuestResponse:
+        """Cancel a pending quest for the party or a specific group.
+
+        Cancel a quest that has not yet startet. All accepted and pending invitations
+        will be canceled and the quest roll returned to the owner's inventory.
+        Only quest leader or group leader can perform this action.
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the group for which the quest is being canceled.
+            Defaults to the user's party if not specified.
+
+        Returns
+        -------
+        HabiticaQuestResponse
+            A response object containing details about the canceled quest.
+
+        Raises
+        ------
+        NotFoundError
+            If the specified group or quest could not be found.
+        NotAuthorizedError
+            If the user does not have permission to cancel the quest.
+        aiohttp.ClientResponseError
+            Raised for HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            Raised for any other exceptions encountered by `aiohttp` during the request.
+        TimeoutError
+            If the connection to the API times out.
+
+        Examples
+        --------
+        Cancel a pending quest for the party:
+        >>> response = await habitica.cancel_quest()
+        >>> print(response.success)  # True if the quest was successfully canceled.
+        """
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "quests/cancel"
+
+        return HabiticaQuestResponse.from_json(
+            await self._request("post", url=url),
+        )
+
+    async def start_quest(self, group_id: UUID | None = None) -> HabiticaQuestResponse:
+        """Force-start a quest for the party or a specific group.
+
+        Begins a quest immediately, bypassing any pending invitations that haven't been
+        accepted or rejected.
+        Only quest leader or group leader can perform this action.
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the group for which the quest should be started.
+            Defaults to the user's party if not specified.
+
+
+        Returns
+        -------
+        HabiticaQuestResponse
+            A response object containing updated quest data of the group or party.
+
+        Raises
+        ------
+        NotFoundError
+            If the specified group or quest could not be found.
+        NotAuthorizedError
+            If the user does not have permission to start the quest.
+        aiohttp.ClientResponseError
+            Raised for HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            Raised for any other exceptions encountered by `aiohttp` during the request.
+        TimeoutError
+            If the connection to the API times out.
+
+        Examples
+        --------
+        Cancel a pending quest for the party:
+        >>> response = await habitica.cancel_quest()
+        >>> print(response.success)  # True if the quest was successfully canceled.
+        """
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "quests/force-start"
+
+        return HabiticaQuestResponse.from_json(
+            await self._request("post", url=url),
+        )
+
+    async def invite_quest(
+        self,
+        group_id: UUID | None = None,
+        *,
+        quest_key: str,
+    ) -> HabiticaQuestResponse:
+        """Invite members of the party or a specific group to participate in a quest.
+
+        Sends invitations for a quest to all eligible members of the specified group.
+        The quest is started when all members accept or reject the invitation.
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the group for which the quest invitations should be sent.
+            Defaults to the user's party if not specified.
+        quest_key : str
+            The unique key identifying the quest to invite members to.
+
+        Returns
+        -------
+        HabiticaQuestResponse
+            A response object containing updated quest data of the group or party.
+
+        Raises
+        ------
+        NotFoundError
+            If the specified group or quest could not be found.
+        aiohttp.ClientResponseError
+            Raised for HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            Raised for any other exceptions encountered by `aiohttp` during the request.
+        TimeoutError
+            If the connection to the API times out.
+
+        Examples
+        --------
+        Send a quest invitation to the party:
+        >>> response = await habitica.invite_quest(quest_key="dilatory_derby")
+        >>> print(response.success)  # True if invitations were successfully sent.
+
+        Send a quest invitation to a specific group:
+        >>> group_id = UUID("12345678-1234-5678-1234-567812345678")
+        >>> response = await habitica.invite_quest(group_id, quest_key="golden_knight")
+        >>> print(response.success)  # True if invitations were successfully sent.
+        """
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "quests/invite" / quest_key
+
+        return HabiticaQuestResponse.from_json(
+            await self._request("post", url=url),
+        )
+
+    async def leave_quest(self, group_id: UUID | None = None) -> HabiticaQuestResponse:
+        """Leave the current quest from the party or a specific group.
+
+        Allows a user to exit an ongoing quest they are part of. This action removes
+        them from the quest but does not affect its progress for other participants.
+        Users who leave a quest will not contribute to its completion or receive rewards.
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the group associated with the quest the user is leaving.
+            Defaults to the user's party if not specified.
+        quest_key : str
+            The unique key identifying the quest to invite members to.
+
+        Returns
+        -------
+        HabiticaQuestResponse
+            A response object containing updated quest data of the group or party.
+
+        Raises
+        ------
+        NotFoundError
+            If the specified group or quest could not be found.
+        aiohttp.ClientResponseError
+            Raised for HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            Raised for any other exceptions encountered by `aiohttp` during the request.
+        TimeoutError
+            If the connection to the API times out.
+
+        Examples
+        --------
+        Leave the current quest in the user's party:
+        >>> response = await habitica.leave_quest()
+        >>> print(response.success)  # True if the user successfully left the quest.
+
+        Leave the current quest in a specific group:
+        >>> group_id = UUID("12345678-1234-5678-1234-567812345678")
+        >>> response = await habitica.leave_quest(group_id)
+        >>> print(response.success)  # True if the user successfully left the quest.
+        """
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "quests/leave"
+
+        return HabiticaQuestResponse.from_json(
+            await self._request("post", url=url),
+        )
+
     def _cache_asset(self, asset: str, asset_data: IO[bytes]) -> None:
         """Cache an asset and maintain the cache size limit by removing older entries.
 

{habiticalib-0.1.0a3 → habiticalib-0.2.0a1}/src/habiticalib/types.py

@@ -777,6 +777,13 @@ class HabiticaUserResponse(HabiticaResponse):
     data: UserData
 
 
+@dataclass(kw_only=True)
+class HabiticaGroupMembersResponse(HabiticaResponse):
+    """Representation of a group members data response."""
+
+    data: list[UserData]
+
+
 @dataclass(kw_only=True)
 class CompletedBy:
     """Task group completedby data."""
@@ -1107,6 +1114,25 @@ class HabiticaTagResponse(HabiticaResponse, DataClassORJSONMixin):
     data: TagsUser
 
 
+@dataclass(kw_only=True)
+class QuestData:
+    """Quest data."""
+
+    progress: ProgressQuest = field(default_factory=ProgressQuest)
+    active: bool = False
+    members: dict[str, bool | None]
+    extra: dict | None = None
+    key: str
+    leader: UUID | None = None
+
+
+@dataclass(kw_only=True)
+class HabiticaQuestResponse(HabiticaResponse, DataClassORJSONMixin):
+    """Representation of a quest response."""
+
+    data: QuestData
+
+
 @dataclass
 class ChangeClassData:
     """Change class data."""
@@ -1131,6 +1157,13 @@ class HabiticaTaskOrderResponse(HabiticaResponse):
     data: list[UUID] = field(default_factory=list)
 
 
+@dataclass
+class HabiticaSleepResponse(HabiticaResponse):
+    """Representation of a sleep response."""
+
+    data: bool
+
+
 class TaskFilter(StrEnum):
     """Enum representing the valid types of tasks for requests."""
 
@@ -1187,7 +1220,7 @@ class Skill(StrEnum):
     VALOROUS_PRESENCE = "valorousPresence"
     INTIMIDATING_GAZE = "intimidate"
     # Rogue skills
-    PICKPOCKET = "Pickpocket"
+    PICKPOCKET = "pickPocket"
     BACKSTAB = "backStab"
     TOOLS_OF_THE_TRADE = "toolsOfTrade"
     STEALTH = "stealth"

habiticalib-0.1.0a3/tests/__snapshots__/test_user.ambr → habiticalib-0.2.0a1/tests/__snapshots__/test_lib.ambr

@@ -1,4 +1,7 @@
 # serializer version: 1
+# name: test_login
+  HabiticaLoginResponse(data=LoginData(id=UUID('a380546a-94be-4b8e-8a0b-23e0d5c03303'), apiToken='cd0e5985-17de-4b4f-849e-5d506c5e4382', newUser=False, username='test-username', passwordResetCode=None), success=True, notifications=[], userV=None, appVersion='5.30.0')
+# ---
 # name: test_user
   HabiticaUserResponse(data=UserData(id=UUID('c18e1853-bded-47a9-82e2-adfdad08894d'), preferences=PreferencesUser(hair=HairPreferences(color='red', base=3, bangs=1, beard=0, mustache=0, flower=1), emailNotifications=EmailNotificationsPreferences(unsubscribeFromAll=False, newPM=True, kickedGroup=True, wonChallenge=True, giftedGems=True, giftedSubscription=True, invitedParty=True, invitedGuild=True, questStarted=True, invitedQuest=True, importantAnnouncements=True, weeklyRecaps=True, onboarding=True, majorUpdates=True, subscriptionReminders=True, contentRelease=True), pushNotifications=PushNotificationsPreferences(unsubscribeFromAll=False, newPM=True, wonChallenge=True, giftedGems=True, giftedSubscription=True, invitedParty=True, invitedGuild=True, questStarted=True, invitedQuest=True, majorUpdates=True, mentionParty=True, mentionJoinedGuild=True, mentionUnjoinedGuild=True, partyActivity=True, contentRelease=True), suppressModals=SuppressModalsPreferences(levelUp=False, hatchPet=False, raisePet=False, streak=False), tasks=TasksPreferences(activeFilter=ActiveFilterTask(habit='all', daily='all', todo='remaining', reward='all'), groupByChallenge=False, confirmScoreNotes=False, mirrorGroupTasks=[]), dayStart=0, size='slim', hideHeader=False, skin='915533', shirt='blue', timezoneOffset=-120, sound='rosstavoTheme', chair='none', allocationMode='flat', autoEquip=True, costume=False, dateFormat='MM/dd/yyyy', sleep=False, stickyHeader=True, disableClasses=False, newTaskEdit=False, dailyDueDefaultView=False, advancedCollapsed=False, toolbarCollapsed=False, reverseChatOrder=False, developerMode=False, displayInviteToPartyWhenPartyIs1=True, background='violet', automaticAllocation=None, webhooks={}, improvementCategories=[], timezoneOffsetAtLastCron=None, language='de'), flags=FlagsUser(customizationsNotification=False, tour=TourFlags(intro=-1, classes=-1, stats=-1, tavern=-1, party=-1, guilds=-1, challenges=-1, market=-1, pets=-1, mounts=-1, hall=-1, equipment=-1, groupPlans=-1), showTour=True, tutorial=TutorialFlags(common=CommonTutorial(habits=True, dailies=True, todos=True, rewards=True, party=True, pets=True, gems=True, skills=True, classes=True, tavern=True, equipment=True, items=True, mounts=True, inbox=True, stats=True), ios=IosTutorial(addTask=False, editTask=False, deleteTask=False, filterTask=False, groupPets=False, inviteParty=False, reorderTask=False)), dropsEnabled=False, itemsEnabled=False, lastNewStuffRead='', rewrite=True, classSelected=False, rebirthEnabled=False, levelDrops={}, recaptureEmailsPhase=0, weeklyRecapEmailsPhase=0, lastWeeklyRecap=datetime.datetime(2024, 10, 19, 18, 43, 39, 782000, tzinfo=datetime.timezone.utc), communityGuidelinesAccepted=False, cronCount=0, welcomed=True, armoireEnabled=True, armoireOpened=False, armoireEmpty=False, cardReceived=False, warnedLowHealth=False, verifiedUsername=True, newStuff=False, thirdPartyTools=None, mathUpdates=None, lastFreeRebirth=None, chatRevoked=None, chatShadowMuted=None, lastWeeklyRecapDiscriminator=None, onboardingEmailsPhase=None), auth=AuthUser(local=LocalAuth(email='test@example.com', username='test', lowerCaseUsername='test', has_password=True), timestamps=LocalTimestamps(created=datetime.datetime(2024, 10, 19, 18, 43, 39, 782000, tzinfo=datetime.timezone.utc), loggedin=datetime.datetime(2024, 10, 19, 18, 43, 39, 782000, tzinfo=datetime.timezone.utc), updated=datetime.datetime(2024, 10, 19, 18, 44, 51, 37000, tzinfo=datetime.timezone.utc)), facebook={}, google={}, apple={}), achievements=AchievementsUser(ultimateGearSets=UltimateGearSetsAchievments(healer=False, wizard=False, rogue=False, warrior=False), streak=0, challenges=[], perfect=0, quests=QuestsAchievments(bewilder=None, burnout=None, stressbeast=None, harpy=None, atom3=None, vice3=None, vice1=None, gryphon=None, evilsanta2=None, evilsanta=None, dilatory_derby=None, dilatory=None, atom2=None, atom1=None, dysheartener=None), backToBasics=None, dustDevil=None, primedForPainting=None, completedTask=None, createdTask=None, fedPet=None, hatchedPet=None, purchasedEquipment=None, tickledPink=None, goodAsGold=None, boneCollector=None, seeingRed=None, violetsAreBlue=None, shadyCustomer=None, joinedGuild=None, joinedChallenge=None, partyUp=None), backer=BackerUser(tier=None, npc=None, tokensApplied=None), contributor=ContributorUser(contributions=None, level=None, text=None), permissions=PermissionsUser(fullAccess=None, news=None, userSupport=None, challengeAdmin=None, moderator=None, coupons=None), purchased=PurchasedUser(plan=PlanPurchased(consecutive=ConsecutivePlan(trinkets=0, gemCapExtra=0, offset=0, count=0), mysteryItems=[], gemsBought=0, extraMonths=0, dateUpdated=None, perkMonthCount=-1, quantity=1), txnCount=0, background={'violet': True}, shirt={}, hair={}, skin={}, ads=False, mobileChat=None), history=HistoryUser(todos=[], exp=[]), items=ItemsUser(gear=GearItems(equipped=EquippedGear(weapon='weapon_special_fall2024Warrior', armor='armor_special_fall2024Warrior', head='head_special_fall2024Warrior', shield='shield_special_fall2024Warrior', back='back_mystery_201402', headAccessory='headAccessory_special_pinkHeadband', eyewear='eyewear_special_pinkHalfMoon', body='body_mystery_202003'), costume=EquippedGear(weapon=None, armor='armor_base_0', head='head_base_0', shield='shield_base_0', back=None, headAccessory=None, eyewear=None, body=None), owned={'headAccessory_special_blackHeadband': True, 'headAccessory_special_blueHeadband': True, 'headAccessory_special_greenHeadband': True, 'headAccessory_special_pinkHeadband': True, 'headAccessory_special_redHeadband': True, 'headAccessory_special_whiteHeadband': True, 'headAccessory_special_yellowHeadband': True, 'eyewear_special_blackTopFrame': True, 'eyewear_special_blueTopFrame': True, 'eyewear_special_greenTopFrame': True, 'eyewear_special_pinkTopFrame': True, 'eyewear_special_redTopFrame': True, 'eyewear_special_whiteTopFrame': True, 'eyewear_special_yellowTopFrame': True, 'eyewear_special_blackHalfMoon': True, 'eyewear_special_blueHalfMoon': True, 'eyewear_special_greenHalfMoon': True, 'eyewear_special_pinkHalfMoon': True, 'eyewear_special_redHalfMoon': True, 'eyewear_special_whiteHalfMoon': True, 'eyewear_special_yellowHalfMoon': True}), special=SpecialItems(birthdayReceived=[], birthday=0, thankyouReceived=[], thankyou=0, greetingReceived=[], greeting=0, nyeReceived=[], nye=0, valentineReceived=[], valentine=0, seafoam=0, shinySeed=0, spookySparkles=0, snowball=0, congrats=0, congratsReceived=[], getwell=0, getwellReceived=[], goodluck=0, goodluckReceived=[]), lastDrop=LastDropItems(count=0, date=datetime.datetime(2024, 10, 19, 18, 43, 39, 784000, tzinfo=datetime.timezone.utc)), currentMount='Velociraptor-Base', currentPet='Rat-Shade', quests={'dustbunnies': 1}, mounts={}, food={}, hatchingPotions={}, eggs={}, pets={}), invitations=InvitationsUser(party={}, guilds=[], parties=[]), party=PartyUser(quest=QuestParty(progress=ProgressQuest(up=0.0, down=0.0, collect={}, collectedItems=0), RSVPNeeded=False, key=None, completed=None), order='level', orderAscending='ascending', _id=None), profile=ProfileUser(blurb=None, imageUrl=None, name='test'), stats=StatsUser(buffs=BuffsStats(Str=0, per=0, con=0, stealth=0, streaks=False, seafoam=False, shinySeed=False, snowball=False, spookySparkles=False, Int=0), training=TrainingStats(Str=0.0, per=0, con=0, Int=0), hp=50.0, mp=10.0, exp=0, gp=0.0, lvl=1, Class=<HabiticaClass.WARRIOR: 'warrior'>, points=0, Str=0, con=0, per=0, toNextLevel=25, maxHealth=50, maxMP=30, Int=0), notifications=[], tags=[TagsUser(id=UUID('5358c71f-fe0f-4583-84a3-109b70c699fd'), name='Arbeit', challenge=None, group=None), TagsUser(id=UUID('45870b8b-3e1e-4e13-a722-6afcacdf689f'), name='Training', challenge=None, group=None), TagsUser(id=UUID('3e49b9db-0cc5-4070-b860-e16f1e4806a4'), name='Gesundheit + Wohlbefinden', challenge=None, group=None), TagsUser(id=UUID('0d85319e-7b9c-43e2-81ed-2a706521d5e3'), name='Schule', challenge=None, group=None), TagsUser(id=UUID('b7cf86bf-97ac-42d3-b5d0-5ffe998b62b4'), name='Teams', challenge=None, group=None), TagsUser(id=UUID('c584d792-0a9b-4646-a6ca-a67bb6ef3c36'), name='Hausarbeiten', challenge=None, group=None), TagsUser(id=UUID('0602fd13-edf2-46a7-99c0-c5084046efbb'), name='Kreativität', challenge=None, group=None)], inbox=InboxUser(newMessages=0, optOut=False, blocks=[], messages={}), tasksOrder=TasksOrderUser(habits=[UUID('21b10675-e238-4462-be11-1a4f8012fc9c'), UUID('69909140-a920-4b83-b018-b9156760aca3'), UUID('7e0679cf-e9cd-4604-b429-d061ea16ce72'), UUID('270df162-d47d-488b-9c1d-4fc4f0e2b2d2'), UUID('80ad00b5-622e-4d1a-af4d-6a6c199f3571'), UUID('0712669d-8374-4211-84ea-715cbcbae9c1'), UUID('56dee98d-038a-43f3-a514-59b1ed9a52ee'), UUID('25df4765-754c-47b1-a011-83b31f70c4fb')], dailys=[UUID('e22e9ef0-15be-478a-81c7-f9fdbb4fac10'), UUID('2a74baa2-3acd-426c-bce4-6b4bb145a8d5'), UUID('e18d0899-7c59-41c0-affd-318b8850c3e5'), UUID('3d0cecac-73c1-462b-ab39-a39cea107e6b'), UUID('1ed21cd0-e6f5-4707-b1b4-fb376d462387'), UUID('9117ad5e-2cda-43e0-a07c-0b175d32c0eb')], todos=[UUID('ac13c62c-9375-4809-a357-0e42b01a1b43'), UUID('2388ccad-0387-4ea6-9968-2d10d994e903'), UUID('5c6efb91-6ae3-4cad-8b19-2dd2fc52a965'), UUID('80afe0b9-e367-4473-8117-b8bc7115f54a'), UUID('4cc21c36-886c-4a43-b580-877e958a37fd'), UUID('10a45996-7133-4ca1-84d8-abf1093d9dcc'), UUID('fb867459-ae50-4cee-9017-c13206c6dfa2')], rewards=[UUID('4b18ccf6-3934-43a5-a153-31af8b2a36d9')]), extra={}, pushDevices=[], webhooks=[], loginIncentives=0, invitesSent=0, pinnedItems=[PinnedItemsUser(path='gear.flat.weapon_warrior_0', Type='marketGear'), PinnedItemsUser(path='gear.flat.armor_warrior_1', Type='marketGear'), PinnedItemsUser(path='gear.flat.shield_warrior_1', Type='marketGear'), PinnedItemsUser(path='gear.flat.head_warrior_1', Type='marketGear'), PinnedItemsUser(path='potion', Type='potion'), PinnedItemsUser(path='armoire', Type='armoire')], pinnedItemsOrder=[], unpinnedItems=[], secret=None, balance=0.0, lastCron=datetime.datetime(2024, 10, 19, 18, 43, 39, 784000, tzinfo=datetime.timezone.utc), needsCron=False, challenges=[], guilds=[], newMessages={}), success=True, notifications=[], userV=5, appVersion='5.28.8')
 # ---

habiticalib-0.2.0a1/tests/fixtures/login.json

@@ -0,0 +1,10 @@
+{
+    "success": true,
+    "data": {
+      "id": "a380546a-94be-4b8e-8a0b-23e0d5c03303",
+      "apiToken": "cd0e5985-17de-4b4f-849e-5d506c5e4382",
+      "newUser": false,
+      "username": "test-username"
+    },
+    "appVersion": "5.30.0"
+  }

habiticalib-0.1.0a3/tests/test_user.py → habiticalib-0.2.0a1/tests/test_lib.py

@@ -9,6 +9,18 @@ from habiticalib import Habitica
 from .conftest import load_fixture
 
 
+async def test_login(mock_aiohttp: aioresponses, snapshot: SnapshotAssertion) -> None:
+    """Test login."""
+    mock_aiohttp.post(
+        "https://habitica.com/api/v3/user/auth/local/login",
+        body=load_fixture("login.json"),
+    )
+    async with ClientSession() as session:
+        habitica = Habitica(session, "test", "test")
+        response = await habitica.login("test-username", "test-password")
+        assert response == snapshot
+
+
 async def test_user(mock_aiohttp: aioresponses, snapshot: SnapshotAssertion) -> None:
     """Test default user agent is set."""
     mock_aiohttp.get("https://habitica.com/api/v3/user", body=load_fixture("user.json"))