Merge branch 'master' into feature/ws-eventsub

Author: IAmTomahawkx

docs/changelog.rst

@@ -1,6 +1,20 @@
 :orphan:
 
 
+Master
+======
+- TwitchIO
+    - Additions
+        - Added optional ``started_at`` and ``ended_at`` arguments to :func:`~twitchio.PartialUser.fetch_clips`
+        - Updated docstring regarding new  HypeTrain contribution  method ``OTHER`` for :attr:`~twitchio.HypeTrainContribution.type`
+
+    - Bug fixes
+        - Fix :func:`~twitchio.PartialUser.fetch_bits_leaderboard` not handling ``started_at`` and :class:`~twitchio.BitsLeaderboard` not correctly parsing
+
+- ext.eventsub
+    - Additions
+        - Updated docs regarding new HypeTrain contribution method ``other`` for :attr:`~twitchio.ext.eventsub.HypeTrainContributor.type`
+
 2.5.0
 ======
 - TwitchIO

twitchio/ext/eventsub/models.py

@@ -760,7 +760,7 @@ class HypeTrainContributor:
     user: :class:`twitchio.PartialUser`
         The user
     type: :class:`str`
-        One of "bits" or "subscription". The way they contributed to the hype train
+        One of "bits, "subscription" or "other". The way they contributed to the hype train
     total: :class:`int`
         How many points they've contributed to the Hype Train
     """
@@ -769,7 +769,7 @@ class HypeTrainContributor:
 
     def __init__(self, client: EventSubClient, data: dict):
         self.user = _transform_user(client, data, "user")
-        self.type: Literal["bits", "subscription"] = data["type"]  # one of bits, subscription
+        self.type: Literal["bits", "subscription", "other"] = data["type"]  # one of bits, subscription
         self.total: int = data["total"]
 
 

twitchio/http.py

@@ -315,18 +315,24 @@ async def get_game_analytics(
         raise NotImplementedError  # TODO
 
     async def get_bits_board(
-        self, token: str, period: str = "all", user_id: str = None, started_at: datetime.datetime = None
+        self,
+        token: str,
+        period: str = "all",
+        user_id: Optional[str] = None,
+        started_at: Optional[datetime.datetime] = None,
     ):
         assert period in {"all", "day", "week", "month", "year"}
+        query = [
+            ("period", period),
+            ("started_at", started_at.isoformat() if started_at else None),
+            ("user_id", user_id),
+        ]
+
         route = Route(
             "GET",
             "bits/leaderboard",
             "",
-            query=[
-                ("period", period),
-                ("started_at", started_at.isoformat() if started_at else None),
-                ("user_id", user_id),
-            ],
+            query=[q for q in query if q[1] is not None],
             token=token,
         )
         return await self.request(route, full_body=True, paginate=False)
@@ -551,6 +557,11 @@ async def get_clips(
         ended_at: Optional[datetime.datetime] = None,
         token: Optional[str] = None,
     ):
+        if started_at and started_at.tzinfo is None:
+            started_at = started_at.replace(tzinfo=datetime.timezone.utc)
+        if ended_at and ended_at.tzinfo is None:
+            ended_at = ended_at.replace(tzinfo=datetime.timezone.utc)
+
         q = [
             ("broadcaster_id", broadcaster_id),
             ("game_id", game_id),

twitchio/models.py

@@ -85,9 +85,9 @@ class BitsLeaderboard:
 
     Attributes
     ------------
-    started_at: :class:`datetime.datetime`
+    started_at: Optional[:class:`datetime.datetime`]
         The time the leaderboard started.
-    ended_at: :class`datetime.datetime`
+    ended_at: Optional[:class:`datetime.datetime`]
         The time the leaderboard ended.
     leaders: List[:class:`BitLeaderboardUser`]
         The current leaders of the Leaderboard.
@@ -97,8 +97,10 @@ class BitsLeaderboard:
 
     def __init__(self, http: "TwitchHTTP", data: dict):
         self._http = http
-        self.started_at = datetime.datetime.fromisoformat(data["date_range"]["started_at"])
-        self.ended_at = datetime.datetime.fromisoformat(data["date_range"]["ended_at"])
+        self.started_at = (
+            parse_timestamp(data["date_range"]["started_at"]) if data["date_range"]["started_at"] else None
+        )
+        self.ended_at = parse_timestamp(data["date_range"]["ended_at"]) if data["date_range"]["ended_at"] else None
         self.leaders = [BitLeaderboardUser(http, x) for x in data["data"]]
 
     def __repr__(self):
@@ -333,7 +335,7 @@ class HypeTrainContribution:
         If type is ``SUBS``, aggregate total where 500, 1000, or 2500 represent tier 1, 2, or 3 subscriptions respectively.
         For example, if top contributor has gifted a tier 1, 2, and 3 subscription, total would be 4000.
     type: :class:`str`
-        Identifies the contribution method, either BITS or SUBS.
+        Identifies the contribution method, either BITS, SUBS or OTHER.
     user: :class:`~twitchio.PartialUser`
         The user making the contribution.
     """

twitchio/user.py

@@ -261,7 +261,11 @@ async def create_custom_reward(
             raise
 
     async def fetch_bits_leaderboard(
-        self, token: str, period: str = "all", user_id: int = None, started_at: datetime.datetime = None
+        self,
+        token: str,
+        period: str = "all",
+        user_id: Optional[int] = None,
+        started_at: Optional[datetime.datetime] = None,
     ) -> "BitsLeaderboard":
         """|coro|
 
@@ -280,7 +284,7 @@ async def fetch_bits_leaderboard(
         """
         from .models import BitsLeaderboard
 
-        data = await self._http.get_bits_board(token, period, user_id, started_at)
+        data = await self._http.get_bits_board(token, period, str(user_id), started_at)
         return BitsLeaderboard(self._http, data)
 
     async def start_commercial(self, token: str, length: int) -> dict:
@@ -322,19 +326,30 @@ async def create_clip(self, token: str, has_delay=False) -> dict:
         data = await self._http.post_create_clip(token, self.id, has_delay)
         return data[0]
 
-    async def fetch_clips(self) -> List["Clip"]:
+    async def fetch_clips(
+        self, started_at: Optional[datetime.datetime] = None, ended_at: Optional[datetime.datetime] = None
+    ) -> List["Clip"]:
         """|coro|
 
         Fetches clips from the api. This will only return clips from the specified user.
         Use :class:`Client.fetch_clips` to fetch clips by id
 
+        Parameters
+        -----------
+        started_at: Optional[:class:`datetime.datetime`]
+            Starting date/time for returned clips.
+            If this is specified, ended_at also should be specified; otherwise, the ended_at date/time will be 1 week after the started_at value.
+        ended_at: Optional[:class:`datetime.datetime`]
+            Ending date/time for returned clips.
+            If this is specified, started_at also must be specified; otherwise, the time period is ignored.
+
         Returns
         --------
         List[:class:`twitchio.Clip`]
         """
         from .models import Clip
 
-        data = await self._http.get_clips(self.id)
+        data = await self._http.get_clips(self.id, started_at=started_at, ended_at=ended_at)
 
         return [Clip(self._http, x) for x in data]