split up leaderboard functions

Author: SharpBit

CHANGELOG.md

@@ -1,13 +1,15 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [3.0.3] - TBD
+## [3.0.3] - 2/17/20
 ### Added
 - `invalid_chars` attribute for `NotFoundError` when applicable
 - `url` attribute for all errors that have requested a URL
 - `str(error)` will return the message attribute of the error.
 ### Changed
 - The `error` attribute for all errors have been renamed to `message`
+- For BrawlAPI: `get_leaderboard` split up into `get_player_leaderboard`, `get_club_leaderboard`, and `get_brawler_leaderboard`
+- For the official API: `get_rankings` split up into `get_player_rankings`, `get_club_rankings`, and `get_brawler_rankings`
 
 ## [3.0.2] - 12/22/19
 ### Fixed

brawlstats/brawlapi/core.py

@@ -258,41 +258,73 @@ def get_club(self, tag: bstag):
         url = '{}?tag={}'.format(self.api.CLUB, tag)
         return self._get_model(url, model=Club)
 
-    def get_leaderboard(self, lb_type: str, limit: int=200, region='global', brawler=None):
+    def get_player_leaderboard(self, limit=200, region='global'):
         """
-        Get the top count players/clubs/brawlers.
+        Get the top players.
 
         Parameters
         ----------
-        lb_type: str
-            The type of leaderboard. Must be "players", "clubs", "brawlers".
-            Anything else will return a ValueError.
         limit: Optional[int] = 200
-            The number of top players or clubs to fetch.
-            If count > 200, it will return a ValueError.
+            The number of top players to fetch.
+            If limit > 200, it will set the limit to 200.
+        region: Optional[str] = "global"
+            The region to retrieve from. Must be a 2 letter country code or "global"
+
+        Returns Leaderboard
+        """
+        if not 0 < limit <= 200:
+            limit = 200
+
+        url = '{}/players?count={}&region={}'.format(self.api.LEADERBOARD, limit, region)
+        return self._get_model(url, model=Leaderboard)
+
+    def get_club_leaderboard(self, limit=200, region='global'):
+        """
+        Get the top clubs.
+
+        Parameters
+        ----------
+        limit: Optional[int] = 200
+            The number of top clubs to fetch.
+            If limit > 200, it will set the limit to 200.
         region: Optional[str] = "global"
             The region to retrieve from. Must be a 2 letter country code or "global"
-        brawler: Optional[Union[str, int]] = None
-            The brawler name or ID.
 
         Returns Leaderboard
         """
-        if brawler:
-            brawler = brawler.lower()
-            if brawler not in self.api.BRAWLERS.keys():
-                raise ValueError('Invalid brawler.')
 
         # Check for invalid parameters
-        if lb_type not in ('players', 'clubs', 'brawlers'):
-            raise ValueError("'lb_type' must be 'players', 'clubs' or 'brawlers'.")
         if not 0 < limit <= 200:
-            raise ValueError('Make sure limit is between 1 and 200.')
+            limit = 200
 
         # Construct URL
-        url = '{}/{}?count={}&region={}'.format(self.api.LEADERBOARD, lb_type, limit, region)
-        if lb_type == 'brawlers':
-            url = '{}/players?count={}&brawlers={}&region={}'.format(self.api.LEADERBOARD, limit, brawler, region)
+        url = '{}/clubs?count={}&region={}'.format(self.api.LEADERBOARD, limit, region)
+        return self._get_model(url, model=Leaderboard)
+
+    def get_brawler_leaderboard(self, brawler, limit=200, region='global'):
+        """
+        Get the leaderboard for a certain brawler.
+
+        Parameters
+        ----------
+        brawler: str
+            The brawler name to get the leaderboard for.
+        limit: Optional[int] = 200
+            The number of top clubs to fetch.
+            If limit > 200, it will set the limit to 200.
+        region: Optional[str] = "global"
+            The region to retrieve from. Must be a 2 letter country code or "global"
+
+        Returns Leaderboard
+        """
+        brawler = brawler.lower()
+        if brawler not in self.api.BRAWLERS.keys():
+            raise ValueError('Invalid brawler.')
+
+        if not 0 < limit <= 200:
+            limit = 200
 
+        url = '{}/players?brawlers={}&count={}&region={}'.format(self.api.LEADERBOARD, brawler, limit, region)
         return self._get_model(url, model=Leaderboard)
 
     def get_events(self):

brawlstats/brawlapi/utils.py

@@ -43,9 +43,7 @@ def __init__(self, base_url, version=1):
 def bstag(tag):
     tag = tag.strip('#').upper().replace('O', '0')
     allowed = '0289PYLQGRJCUV'
-    print(tag)
     if len(tag) < 3:
-        print(f'Less than 3 {tag}')
         raise NotFoundError('Tag less than 3 characters.', 404)
     invalid = [c for c in tag if c not in allowed]
     if invalid:

brawlstats/errors.py

@@ -33,8 +33,10 @@ class NotFoundError(RequestError):
 
     def __init__(self, code, invalid_chars=[]):
         self.code = code
-        self.message = 'An incorrect tag has been passed.\nInvalid Characters: ' + ', '.join(invalid_chars)
         self.invalid_chars = invalid_chars
+        self.message = 'An incorrect tag has been passed.'
+        if invalid_chars:
+            self.message += '\nInvalid Characters: ' + ', '.join(invalid_chars)
         super().__init__(self.code, self.message)
 
 

brawlstats/officialapi/core.py

@@ -196,7 +196,7 @@ def _get_model(self, url, model, key=None):
             # Calls the async function
             return self._aget_model(url, model=model, key=key)
 
-        data, resp = self._request(url)
+        data = self._request(url)
         if self.prevent_ratelimit:
             time.sleep(1 / self.ratelimit[0])
 
@@ -259,45 +259,74 @@ def get_club_members(self, tag: bstag):
         url = '{}/{}/members'.format(self.api.CLUB, tag)
         return self._get_model(url, model=Members)
 
-    def get_rankings(self, ranking_type: str, limit: int=200, region='global', brawler=None):
+    def get_player_rankings(self, limit=200, region='global'):
         """
-        Get the top count players/clubs/brawlers.
+        Get the top players.
 
         Parameters
         ----------
-        ranking_type: str
-            The type of ranking. Must be "players", "clubs", "brawlers".
-            Anything else will return a ValueError.
         limit: Optional[int] = 200
             The number of top players or clubs to fetch.
-            If count > 200, it will return a ValueError.
+            If count > 200, it will set the limit to 200.
         region: Optional[str] = "global"
             The region to retrieve from. Must be a 2 letter country code or "global".
-        brawler: Optional[Union[str, int]] = None
-            The brawler name or ID.
 
         Returns Ranking
         """
-        if brawler:
-            brawler = brawler.lower()
-            if brawler not in self.api.BRAWLERS:
-                raise ValueError('Invalid brawler.')
-
-        # Check for invalid parameters
-        if ranking_type not in ('players', 'clubs', 'brawlers'):
-            raise ValueError("'lb_type' must be 'players', 'clubs' or 'brawlers'.")
         if not 0 < limit <= 200:
-            raise ValueError('Make sure limit is between 1 and 200.')
+            limit = 200
+
+        url = '{}/{}/players?limit={}'.format(self.api.RANKINGS, region, limit)
+        return self._get_model(url, model=Ranking)
+
+    def get_club_rankings(self, limit=200, region='global'):
+        """
+        Get the top clubs.
+
+        Parameters
+        ----------
+        limit: Optional[int] = 200
+            The number of top players or clubs to fetch.
+            If count > 200, it will set the limit to 200.
+        region: Optional[str] = "global"
+            The region to retrieve from. Must be a 2 letter country code or "global".
+
+        Returns Ranking
+        """
+        if not 0 < limit <= 200:
+            limit = 200
+
+        url = '{}/{}/clubs?limit={}'.format(self.api.RANKINGS, region, limit)
+        return self._get_model(url, model=Ranking)
+
+    def get_brawler_rankings(self, brawler, limit=200, region='global'):
+        """
+        Get the leaderboard for a certain brawler.
+
+        Parameters
+        ----------
+        brawler: Union[str, int]
+            The brawler name or ID
+        limit: Optional[int] = 200
+            The number of top players or clubs to fetch.
+            If count > 200, it will set the limit to 200.
+        region: Optional[str] = "global"
+            The region to retrieve from. Must be a 2 letter country code or "global".
+
+        Returns Ranking
+        """
+        brawler = brawler.lower()
+        if brawler not in self.api.BRAWLERS:
+            raise ValueError('Invalid brawler.')
+
+        if not 0 < limit <= 200:
+            limit = 200
 
         # Replace brawler name with ID
         if brawler in self.api.BRAWLERS.keys():
             brawler = self.api.BRAWLERS[brawler]
 
-        # Construct URL
-        url = '{}/{}/{}?limit={}'.format(self.api.RANKINGS, region, ranking_type, limit)
-        if ranking_type == 'brawlers':
-            url = '{}/{}/{}/{}?limit={}'.format(self.api.RANKINGS, region, ranking_type, brawler, limit)
-
+        url = '{}/{}/brawlers/{}?limit={}'.format(self.api.RANKINGS, region, brawler, limit)
         return self._get_model(url, model=Ranking)
 
     @typecasted

examples/brawlapi/async.py

@@ -16,7 +16,7 @@ async def main():
     for player in best_players:
         print(player.name, player.trophies)
 
-    leaderboard = await client.get_leaderboard('players', limit=5)  # gets top 5 players
+    leaderboard = await client.get_player_leaderboard(limit=5)  # gets top 5 players
     for player in leaderboard:
         print(player.name, player.position)
 

examples/brawlapi/sync.py

@@ -13,7 +13,7 @@
 for player in best_players:
     print(player.name, player.trophies)  # prints name and trophies
 
-leaderboard = client.get_leaderboard('players', limit=5)  # gets top 5 players
+leaderboard = client.get_player_leaderboard(limit=5)  # gets top 5 players
 for player in leaderboard:
     print(player.name, player.position)
 

tests/brawlapi/test_async.py

@@ -46,19 +46,21 @@ async def test_get_club(self):
         self.assertEqual(club.tag, self.club_tag)
 
     async def test_get_leaderboard_player(self):
-        lb = await self.client.get_leaderboard('players')
+        lb = await self.client.get_player_leaderboard(limit=200)
         self.assertIsInstance(lb, Leaderboard)
-        lb = await self.client.get_leaderboard('players', region='us')
+        lb = await self.client.get_player_leaderboard(limit=5, region='us')
         self.assertIsInstance(lb, Leaderboard)
-        lb = await self.client.get_leaderboard('players', region='us', limit=5)
-        self.assertTrue(len(lb) == 5)
 
     async def test_get_leaderboard_club(self):
-        lb = await self.client.get_leaderboard('clubs')
+        lb = await self.client.get_club_leaderboard(limit=200)
+        self.assertIsInstance(lb, Leaderboard)
+        lb = await self.client.get_club_leaderboard(limit=5, region='us')
         self.assertIsInstance(lb, Leaderboard)
 
     async def test_get_leaderboard_brawler(self):
-        lb = await self.client.get_leaderboard('brawlers', brawler='shelly')
+        lb = await self.client.get_club_leaderboard('shelly', limit=200)
+        self.assertIsInstance(lb, Leaderboard)
+        lb = await self.client.get_club_leaderboard('mortis', limit=5, region='us')
         self.assertIsInstance(lb, Leaderboard)
 
     async def test_get_events(self):
@@ -93,24 +95,11 @@ async def test_invalid_tag(self):
         async def request():
             await self.client.get_player(invalid_tag)
         invalid_tag = 'P'
-        self.assertRaises(brawlstats.NotFoundError, request)
+        self.assertAsyncRaises(brawlstats.NotFoundError, request)
         invalid_tag = 'AAA'
-        self.assertRaises(brawlstats.NotFoundError, request)
+        self.assertAsyncRaises(brawlstats.NotFoundError, request)
         invalid_tag = '2PPPPPPP'
-        self.assertRaises(brawlstats.ServerError, request)
-
-    async def test_invalid_lb(self):
-        async def request():
-            await self.client.get_leaderboard(invalid_type, invalid_limit)
-        invalid_type = 'test'
-        invalid_limit = 200
-        self.assertRaises(ValueError, request)
-        invalid_type = 'players'
-        invalid_limit = 201
-        self.assertRaises(ValueError, request)
-        invalid_type = 'players'
-        invalid_limit = -5
-        self.assertRaises(ValueError, request)
+        self.assertAsyncRaises(brawlstats.ServerError, request)
 
 
 if __name__ == '__main__':

tests/brawlapi/test_blocking.py

@@ -46,17 +46,21 @@ def test_get_club(self):
         self.assertEqual(club.tag, self.club_tag)
 
     def test_get_leaderboard_player(self):
-        lb = self.client.get_leaderboard('players')
+        lb = self.client.get_player_leaderboard(limit=200)
+        self.assertIsInstance(lb, Leaderboard)
+        lb = self.client.get_player_leaderboard(limit=5, region='us')
         self.assertIsInstance(lb, Leaderboard)
-        region = self.client.get_leaderboard('players', region='us')
-        self.assertIsInstance(region, Leaderboard)
 
     def test_get_leaderboard_club(self):
-        lb = self.client.get_leaderboard('clubs')
+        lb = self.client.get_club_leaderboard(limit=200)
+        self.assertIsInstance(lb, Leaderboard)
+        lb = self.client.get_club_leaderboard(limit=5, region='us')
         self.assertIsInstance(lb, Leaderboard)
 
     def test_get_leaderboard_brawler(self):
-        lb = self.client.get_leaderboard('brawlers', brawler='shelly')
+        lb = self.client.get_club_leaderboard('shelly', limit=200)
+        self.assertIsInstance(lb, Leaderboard)
+        lb = self.client.get_club_leaderboard('mortis', limit=5, region='us')
         self.assertIsInstance(lb, Leaderboard)
 
     def test_get_events(self):
@@ -95,18 +99,6 @@ def test_invalid_tag(self):
         invalid_tag = '2PPPPPPP'
         self.assertRaises(brawlstats.ServerError, get_player, invalid_tag)
 
-    def test_invalid_lb(self):
-        get_lb = self.client.get_leaderboard
-        invalid_type = 'test'
-        invalid_limit = 200
-        self.assertRaises(ValueError, get_lb, invalid_type, invalid_limit)
-        invalid_type = 'players'
-        invalid_limit = 201
-        self.assertRaises(ValueError, get_lb, invalid_type, invalid_limit)
-        invalid_type = 'players'
-        invalid_limit = -5
-        self.assertRaises(ValueError, get_lb, invalid_type, invalid_limit)
-
 
 if __name__ == '__main__':
     unittest.main()