2.0.7: events support

brawlstats/__init__.py

@@ -7,7 +7,7 @@
 ############
 
 
-__version__ = 'v2.0.6'
+__version__ = 'v2.0.7'
 __title__ = 'brawlstats'
 __license__ = 'MIT'
 __author__ = 'SharpBit'

brawlstats/core.py

@@ -1,7 +1,7 @@
 import aiohttp
 import asyncio
 
-from box import Box
+from box import Box, BoxKeyError
 
 from .errors import BadRequest, InvalidTag, NotFoundError, Unauthorized, UnexpectedError, ServerError
 from .utils import API
@@ -60,7 +60,7 @@ async def _aget(self, url):
                     raw_data = await resp.json()
                 elif resp.status == 400:
                     raise BadRequest(url, resp.status)
-                elif resp.status == 403:
+                elif resp.status == 401:
                     raise Unauthorized(url, resp.status)
                 elif resp.status == 404:
                     raise InvalidTag(url, resp.status)
@@ -130,6 +130,13 @@ async def get_leaderboard(self, player_or_band: str, count: int=200):
 
         return Leaderboard(response)
 
+    async def get_events(self):
+        """Get current and upcoming events.
+
+        Returns Events"""
+        response = await self._aget(API.EVENTS)
+
+        return Events(response)
 
 class Profile(BaseBox):
     """
@@ -201,7 +208,24 @@ class Leaderboard(BaseBox):
     """
 
     def __repr__(self):
-        return '<Leaderboard object count={}'.format(len(self))
+        try:
+            return "<Leaderboard object type='players' count={}>".format(len(self.players))
+        except BoxKeyError:
+            return "<Leaderboard object type='bands' count={}>".format(len(self.bands))
+
+    def __str__(self):
+        try:
+            return 'Player Leaderboard containing {} items'.format(len(self.players))
+        except BoxKeyError:
+            return 'Band Leaderboard containing {} items'.format(len(self.bands))
+
+class Events(BaseBox):
+    """
+    Returns current and upcoming events.
+    """
+
+    def __repr__(self):
+        return '<Events object>'
 
     def __str__(self):
-        return '{} Leaderboard containing {} items'.format(len(self))
+        return 'Events object'

brawlstats/utils.py

@@ -3,3 +3,4 @@ class API:
     PROFILE = BASE + '/players'
     BAND = BASE + '/bands'
     LEADERBOARD = BASE + '/leaderboards'
+    EVENTS = BASE + '/events'

docs/api.rst

@@ -19,6 +19,9 @@ Data Models
 .. autoclass:: brawlstats.core.Leaderboard
     :members:
 
+.. autoclass:: brawlstats.core.Events
+    :members:
+
 Profile
 -------
 
@@ -198,6 +201,33 @@ Name                 Type
 ``level``            int
 ==================== =============================
 
+Events
+------
+
+Returns a result of current and upcoming events.
+
+Attributes:
+
+============ ===================
+Name         Type
+============ ===================
+``current``  List[\Event, Event]
+``upcoming`` List[\Event, Event]
+============ ===================
+
+Event Attributes:
+
+================= ====
+Name              Type
+================= ====
+``slot``          int
+``timeInSeconds`` int
+``mapId``         int
+================= ====
+
+
+
+
 .. _Band: https://brawlstats.readthedocs.io/en/latest/api.html#id1
 .. _SimpleBand: https://brawlstats.readthedocs.io/en/latest/api.html#id2
 .. _Brawler: https://brawlstats.readthedocs.io/en/latest/api.html#id6

docs/conf.py

@@ -26,7 +26,7 @@
 # The short X.Y version
 version = '2.0'
 # The full version, including alpha/beta/rc tags
-release = '2.0.5'
+release = '2.0.7'
 
 
 # -- General configuration ---------------------------------------------------

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name='brawlstats',
-    version='2.0.6',
+    version='2.0.7',
     description='An async Python API wrapper for the unofficial Brawl Stars API',
     long_description=long_description,
     long_description_content_type='text/x-rst',

tests/test.py

@@ -39,6 +39,10 @@ async def test_get_leaderboard_band(self):
         lb = await self.client.get_leaderboard('bands')
         self.assertTrue(isinstance(lb.bands, list))
 
+    async def test_get_events(self):
+        events = await self.client.get_events()
+        self.assertTrue(isinstance(events.current, list))
+
     # Other
     async def test_invalid_tag(self):
         async def request():