Added fetch_channel_emotes & fetch_global_emotes methods (#331)

* Added fetch_channel_emotes & fetch_global_emotes methods

* These changes are in response to PR comments

* some fix update

* fix an problem

* Update models to reflect the rest of the libraries patters

Co-authored-by: Tom <[email protected]>

Author: ZebcoWeb

docs/changelog.rst

@@ -1,9 +1,12 @@
-:orphan:
+:orphan:     
+
 
 Master
 ======
 - TwitchIO
     - Additions
+        - Added :func:`~twitchio.PartialUser.fetch_channel_emotes` to :class:`~twitchio.PartialUser`
+        - Added :func:`~twitchio.Client.fetch_global_emotes` to :class:`~twitchio.Client`
         - Added :func:`~twitchio.Client.event_channel_join_failure` event:
             - This is dispatched when the bot fails to join a channel
             - This also makes the channel join error message in logs optional

docs/reference.rst

@@ -66,6 +66,14 @@ Channel
     :members:
     :inherited-members:
 
+ChannelEmote
+------------
+.. attributetable:: ChannelEmote
+
+.. autoclass:: ChannelEmote
+    :members:
+    :inherited-members:
+
 ChannelInfo
 ------------
 .. attributetable:: ChannelInfo
@@ -183,6 +191,14 @@ Game
     :members:
     :inherited-members:
 
+GlobalEmote
+------------
+.. attributetable:: GlobalEmote
+
+.. autoclass:: GlobalEmote
+    :members:
+    :inherited-members:
+
 Goal
 ------
 .. attributetable:: Goal

twitchio/client.py

@@ -572,6 +572,20 @@ async def fetch_cheermotes(self, user_id: int = None):
         """
         data = await self._http.get_cheermotes(str(user_id) if user_id else None)
         return [models.CheerEmote(self._http, x) for x in data]
+        
+    async def fetch_global_emotes(self):
+        """|coro|
+
+        Fetches global emotes from the twitch API
+
+        Returns
+        --------
+            List[:class:`twitchio.GlobalEmote`]
+        """
+        from .models import GlobalEmote
+
+        data = await self._http.get_global_emotes()
+        return [GlobalEmote(self._http, x) for x in data]
 
     async def fetch_top_games(self) -> List[models.Game]:
         """|coro|
@@ -1019,4 +1033,4 @@ async def event_channel_join_failure(self, channel: str):
         channel: `str`
             The channel name that was attempted to be joined.
         """
-        logger.error(f'The channel "{channel}" was unable to be joined. Check the channel is valid.')
+        logger.error(f'The channel "{channel}" was unable to be joined. Check the channel is valid.')

twitchio/http.py

@@ -334,6 +334,12 @@ async def get_bits_board(
     async def get_cheermotes(self, broadcaster_id: str):
         return await self.request(Route("GET", "bits/cheermotes", "", query=[("broadcaster_id", broadcaster_id)]))
 
+    async def get_channel_emotes(self, broadcaster_id: str):
+        return await self.request(Route("GET", "chat/emotes", "", query=[("broadcaster_id", broadcaster_id)]))
+
+    async def get_global_emotes(self):
+        return await self.request(Route("GET", "chat/emotes/global", ""))
+
     async def get_extension_transactions(self, extension_id: str, ids: List[Any] = None):
         q = [("extension_id", extension_id)]
         if ids:

twitchio/models.py

@@ -37,6 +37,8 @@
     "Clip",
     "CheerEmote",
     "CheerEmoteTier",
+    "GlobalEmote",
+    "ChannelEmote",
     "HypeTrainContribution",
     "HypeTrainEvent",
     "BanEvent",
@@ -174,6 +176,90 @@ def __repr__(self):
         return f"<CheerEmote prefix={self.prefix} type={self.type} order={self.order}>"
 
 
+class GlobalEmote:
+    """
+    Represents a Global Emote
+
+    Attributes
+    -----------
+    id: :class:`str`
+        The ID of the emote.
+    name: :class:`str`
+        The name of the emote.
+    images: :class:`dict`
+        Contains the image URLs for the emote. These image URLs will always provide a static (i.e., non-animated) emote image with a light background.
+    format: List[:class:`str`]
+        The formats that the emote is available in.
+    scale: List[:class:`str`]
+        The sizes that the emote is available in.
+    theme_mode: List[:class:`str`]
+        The background themes that the emote is available in.
+    """
+
+    __slots__ = (
+        "id", 
+        "name", 
+        "images", 
+        "format", 
+        "scale", 
+        "theme_mode", 
+        "template"
+    )
+
+    def __init__(self, http: "TwitchHTTP", data: dict):
+        self.id: str = data["id"]
+        self.name: str = data["name"]
+        self.images: dict = data["images"]
+        self.format: List[str] = data["format"]
+        self.scale: List[str] = data["scale"]
+        self.theme_mode: List[str] = data["theme_mode"]
+
+    def __repr__(self):
+        return f"<GlobalEmote id={self.id} name={self.name}"
+
+
+class ChannelEmote(GlobalEmote):
+    """
+    Represents a Channel Emote
+
+    Attributes
+    -----------
+    id: :class:`str`
+        The ID of the emote.
+    name: :class:`str`
+        The name of the emote.
+    images: :class:`dict`
+        Contains the image URLs for the emote. These image URLs will always provide a static (i.e., non-animated) emote image with a light background.
+    tier: :class:`str`
+        The subscriber tier at which the emote is unlocked.
+    type: :class:`str`
+        The type of emote.
+    set_id: :class:`str`
+        An ID that identifies the emote set that the emote belongs to.
+    format: List[:class:`str`]
+        The formats that the emote is available in.
+    scale: List[:class:`str`]
+        The sizes that the emote is available in.
+    theme_mode: List[:class:`str`]
+        The background themes that the emote is available in.
+    """
+
+    __slots__ = (
+        "tier",
+        "type",
+        "set_id"
+    )
+
+    def __init__(self, http: "TwitchHTTP", data: dict):
+        super().__init__(http, data)
+        self.tier: str = data["tier"]
+        self.type: str = data["emote_type"]
+        self.set_id: str = data["emote_set_id"]
+
+    def __repr__(self):
+        return f"<ChannelEmote id={self.id} name={self.name} type={self.type}>"
+
+
 class Clip:
     """
     Represents a Twitch Clip

twitchio/user.py

@@ -568,6 +568,20 @@ async def fetch_following_count(self, token: Optional[str] = None) -> int:
         """
         data = await self._http.get_follow_count(token=token, from_id=str(self.id))
         return data["total"]
+    
+    async def fetch_channel_emotes(self):
+        """|coro|
+
+        Fetches channel emotes from the user
+
+        Returns
+        --------
+            List[:class:`twitchio.ChannelEmote`]
+        """
+        from .models import ChannelEmote
+
+        data = await self._http.get_channel_emotes(str(self.id))
+        return [ChannelEmote(self._http, x) for x in data]
 
     async def follow(self, userid: int, token: str, *, notifications=False):
         """|coro|