Add Friend Feed Reaction functionality (#8)

Author: Ethan Chrisp

callofduty/client.py

@@ -1,7 +1,7 @@
 import logging
 from typing import List, Optional, Union
 
-from .enums import GameType, Language, Mode, Platform, TimeFrame, Title
+from .enums import GameType, Language, Mode, Platform, Reaction, TimeFrame, Title
 from .feed import Blog, FeedItem, Video
 from .leaderboard import Leaderboard
 from .loadout import Loadout, LoadoutItem
@@ -15,6 +15,7 @@
     VerifyLanguage,
     VerifyMode,
     VerifyPlatform,
+    VerifyReaction,
     VerifyTimeFrame,
     VerifyTitle,
 )
@@ -144,6 +145,94 @@ async def GetFriendFeed(self, **kwargs) -> List[FeedItem]:
 
         return feed
 
+    async def SetFeedReaction(
+        self,
+        reaction: Reaction,
+        platform: Platform,
+        username: str,
+        title: Title,
+        date: int,
+        category: str,
+    ) -> None:
+        """
+        Set a Reaction to a Call of Duty Friend Feed item.
+
+        Parameters
+        ----------
+        reaction : callofduty.Reaction
+            Reaction to add to the feed item.
+        platform : callofduty.Platform
+            Platform to get the player from.
+        username : str
+            Player's username for the designated platform.
+        title : callofduty.Title
+            Title of the feed item.
+        date : int
+            Timstamp of the feed item.
+        category : str
+            Category of the feed item.
+
+        Returns
+        -------
+        None
+        """
+
+        VerifyReaction(reaction)
+        VerifyPlatform(platform)
+        VerifyTitle(title)
+
+        json: dict = {
+            "username": username,
+            "platform": platform.value,
+            "title": title.value,
+            "date": date,
+            "category": category,
+        }
+
+        return await self.http.SetFeedReaction(reaction.value, json)
+
+    async def RemoveFeedReaction(
+        self,
+        platform: Platform,
+        username: str,
+        title: Title,
+        date: int,
+        category: str,
+    ) -> None:
+        """
+        Unset the Reaction to a Call of Duty Friend Feed item.
+
+        Parameters
+        ----------
+        platform : callofduty.Platform
+            Platform to get the player from.
+        username : str
+            Player's username for the designated platform.
+        title : callofduty.Title
+            Title of the feed item.
+        date : int
+            Timstamp of the feed item.
+        category : str
+            Category of the feed item.
+
+        Returns
+        -------
+        None
+        """
+
+        VerifyPlatform(platform)
+        VerifyTitle(title)
+
+        json: dict = {
+            "username": username,
+            "platform": platform.value,
+            "title": title.value,
+            "date": date,
+            "category": category,
+        }
+
+        return await self.http.SetFeedReaction(Reaction.Remove.value, json)
+
     async def GetMyIdentities(self) -> list:
         """
         Get the Title Identities for the authenticated Call of Duty player.

callofduty/enums.py

@@ -41,3 +41,12 @@ class GameType(Enum):
     Core = "core"
     Hardcore = "hc"
     WorldLeague = "arena"
+
+
+class Reaction(Enum):
+    Fire = "love"
+    ThumbsUp = "thumbs_up"
+    Cool = "cool"
+    Shocked = "shock"
+    FistBump = "congrats"
+    Remove = "none"

callofduty/errors.py

@@ -76,6 +76,15 @@ class InvalidGameType(ClientException):
     pass
 
 
+class InvalidReaction(ClientException):
+    """
+    Exception which is thrown when an invalid reaction is passed to any
+    client function.
+    """
+
+    pass
+
+
 class HTTPException(CallofDutyException):
     """
     Exception which is thrown when an HTTP request operation fails.

callofduty/feed.py

@@ -2,7 +2,7 @@
 from datetime import datetime
 from typing import List, Optional
 
-from .enums import Title
+from .enums import Reaction, Title
 from .match import Match
 from .object import Object
 from .player import Player
@@ -57,6 +57,46 @@ def __init__(self, client, data: dict):
                 {"id": _matchId, "platform": self.player.platform, "title": self.title},
             )
 
+    async def react(self, reaction: Reaction) -> None:
+        """
+        Set a Reaction to the Call of Duty Friend Feed item.
+
+        Parameters
+        ----------
+        reaction : callofduty.Reaction
+            Reaction to add to the feed item.
+
+        Returns
+        -------
+        None
+        """
+
+        await self._client.SetFeedReaction(
+            reaction,
+            self.player.platform,
+            self.player.username,
+            self.title,
+            (self.date.timestamp() * 1000),
+            self.category,
+        )
+
+    async def unreact(self) -> None:
+        """
+        Unset the Reaction to the Call of Duty Friend Feed item.
+
+        Returns
+        -------
+        None
+        """
+
+        return await self._client.RemoveFeedReaction(
+            self.player.platform,
+            self.player.username,
+            self.title,
+            (self.date.timestamp() * 1000),
+            self.category,
+        )
+
 
 class Blog(Object):
     """

callofduty/http.py

@@ -43,10 +43,13 @@ class Request:
     baseUrl : str, optional
         Base URL to use for the request (default is https://callofduty.com/)
     headers : dict, optional
-        Headers to send along with the request (default is None.)
+        Headers to include in the request (default is None.)
+    json : dict, optional
+        JSON data to include in the body of the request (default is None.)
     """
 
     defaultBaseUrl: str = "https://callofduty.com/"
+    myBaseUrl: str = "https://my.callofduty.com/"
     squadsBaseUrl: str = "https://squads.callofduty.com/"
 
     accessToken: Optional[str] = None
@@ -55,6 +58,7 @@ class Request:
     def __init__(self, method: str, endpoint: Optional[str] = None, **kwargs):
         self.method: str = method
         self.headers: Dict[str, str] = {}
+        self.json: dict = kwargs.get("json", {})
 
         if endpoint is not None:
             baseUrl: str = kwargs.get("baseUrl", self.defaultBaseUrl)
@@ -95,7 +99,7 @@ async def Send(self, req: Request) -> Union[dict, str]:
 
         async with self.session as client:
             res: Response = await client.request(
-                req.method, req.url, headers=req.headers
+                req.method, req.url, headers=req.headers, json=req.json
             )
 
             data: Union[dict, str] = await JSONorText(res)
@@ -161,6 +165,16 @@ async def GetFriendFeed(self) -> Union[dict, str]:
             Request("GET", "api/papi-client/userfeed/v1/friendFeed/rendered/")
         )
 
+    async def SetFeedReaction(self, reaction: str, json: dict) -> Union[dict, str]:
+        return await self.Send(
+            Request(
+                "POST",
+                f"api/papi-client/userfeed/v1/reactions/set/{reaction}/en",
+                baseUrl=Request.myBaseUrl,
+                json=json,
+            )
+        )
+
     async def GetMyIdentities(self) -> Union[dict, str]:
         return await self.Send(Request("GET", "api/papi-client/crm/cod/v2/identities/"))
 

callofduty/utils.py

@@ -1,12 +1,13 @@
 import logging
 import re
 
-from .enums import GameType, Language, Mode, Platform, TimeFrame, Title
+from .enums import GameType, Language, Mode, Platform, Reaction, TimeFrame, Title
 from .errors import (
     InvalidGameType,
     InvalidLanguage,
     InvalidMode,
     InvalidPlatform,
+    InvalidReaction,
     InvalidTimeFrame,
     InvalidTitle,
 )
@@ -110,6 +111,21 @@ def VerifyGameType(value: GameType):
         raise InvalidGameType(f"{value.name} is not a valid game type")
 
 
+def VerifyReaction(value: Reaction):
+    """
+    Raise an InvalidReaction client exception if a value which is not
+    present in the Reaction enum is passed.
+
+    Parameters
+    ----------
+    value : callofduty.Reaction
+        Value to confirm is present in the Reaction enum.
+    """
+
+    if value not in Reaction:
+        raise InvalidReaction(f"{value.name} is not a valid reaction")
+
+
 def StripHTML(input: str) -> str:
     """
     Strip the HTML formatting from a string.

test.py

@@ -4,7 +4,7 @@
 from dotenv import load_dotenv
 
 import callofduty
-from callofduty import Mode, Platform, Title
+from callofduty import Mode, Platform, Reaction, Title
 
 
 async def main():
@@ -86,6 +86,16 @@ async def main():
     #                 if player.username != item.player.username:
     #                     print(f"                   {player.username} ({player.platform.name})")
 
+    # feed = await client.GetFriendFeed(limit=5)
+    # for item in feed:
+    #     print(item.text)
+    #     await item.react(Reaction.Fire)
+
+    # feed = await client.GetFriendFeed(limit=5)
+    # for item in feed:
+    #     print(item.text)
+    #     await item.unreact()
+
     # maps = await client.GetAvailableMaps(Title.ModernWarfare)
     # for mapName in maps:
     #     print(mapName)