local lb, battle logs tests+docs

Author: SharpBit

.gitignore

@@ -8,6 +8,7 @@
 __pycache__/
 *.py[cod]
 *$py.class
+*.pyc
 
 # C extensions
 *.so
@@ -110,5 +111,3 @@ ENV/
 
 # mypy
 .mypy_cache/
-
-*/__pycache__/

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [2.3.12] - 7/18/19
+### Added
+- Player battle logs
+- Local leaderboards
+
 ## [2.3.11] - 7/3/19
 ### Fixed
 - Fixed the sync version of the wrapper to not raise a RuntimeWarning due to using `asyncio.sleep()` instead of `time.sleep()`

README.rst

@@ -20,9 +20,9 @@ Brawl Stats
     :target: https://github.com/SharpBit/brawlstats/blob/master/LICENSE
     :alt: MIT License
 
-| This library is a sync and async wrapper the unofficial `Brawl Stars API`_.
-| Python 3.5.3 or later is required.
-| To keep up with API changes, discussions, and status, I recommend you join the API's `discord server`_.
+- This library is a sync and async wrapper the unofficial `Brawl Stars API`_.
+- Python 3.5.3 or later is required.
+- To keep up with API changes, discussions, and status, I recommend you join the API's `discord server`_.
 
 Features
 ~~~~~~~~

brawlstats/__init__.py

@@ -8,7 +8,7 @@
 ############
 
 
-__version__ = 'v2.3.11'
+__version__ = 'v2.3.12'
 __title__ = 'brawlstats'
 __license__ = 'MIT'
 __author__ = 'SharpBit'

brawlstats/core.py

@@ -218,7 +218,7 @@ def get_club(self, tag: bstag):
 
         return self._get_model(url, model=Club)
 
-    def get_leaderboard(self, lb_type: str, count: int=200):
+    def get_leaderboard(self, lb_type: str, count: int=200, region='global'):
         """Get the top count players/clubs/brawlers.
 
         Parameters
@@ -237,9 +237,9 @@ def get_leaderboard(self, lb_type: str, count: int=200):
             raise ValueError("Make sure 'count' is an int")
         if lb_type not in self.api.BRAWLERS + ['players', 'clubs'] or not 0 < count <= 200:
             raise ValueError("Please enter 'players', 'clubs' or a brawler or make sure 'count' is between 1 and 200.")
-        url = '{}/{}?count={}'.format(self.api.LEADERBOARD, lb_type, count)
+        url = '{}/{}?count={}&region={}'.format(self.api.LEADERBOARD, lb_type, count, region)
         if lb_type in self.api.BRAWLERS:
-            url = '{}/players?count={}&brawlers={}'.format(self.api.LEADERBOARD, count, lb_type)
+            url = '{}/players?count={}&brawlers={}&region={}'.format(self.api.LEADERBOARD, count, lb_type, region)
 
         return self._get_model(url, model=Leaderboard)
 

brawlstats/utils.py

@@ -12,8 +12,8 @@ def __init__(self, base_url):
         self.LEADERBOARD = self.BASE + '/leaderboards'
         self.EVENTS = self.BASE + '/events'
         self.MISC = self.BASE + '/misc'
-        self.BATTLELOG = self.BASE + '/player/battlelog'
-        self.CLUB_SEARCH = self.BASE + '/club/search'
+        self.BATTLELOG = self.PROFILE + '/battlelog'
+        self.CLUB_SEARCH = self.CLUB + '/search'
         self.CONSTANTS = 'https://fourjr.herokuapp.com/bs/constants/'
         self.BRAWLERS = [
             'shelly', 'nita', 'colt', 'bull', 'jessie',  # league reward 0-500

docs/api.rst

@@ -28,6 +28,9 @@ Data Models
 .. autoclass: brawlstats.models.MiscData
     :members:
 
+.. autoclass: brawlstats.models.BattleLog
+    :members:
+
 Player
 -------
 
@@ -264,7 +267,95 @@ Name                                  Type
 ``server_date_day_of_year``           int
 ===================================== ====
 
+Battle Logs
+-----------
+
+Returns a list of `BattleLog` that has the following attributes:
+
+Attributes:
 
+::
+
+    {
+        "battleTime":"20190706T151526.000Z",
+        "event":{
+            "id":15000126,
+            "mode":"duoShowdown",
+            "map":"Royal Runway"
+        },
+        "battle":{
+            "mode":"duoShowdown",
+            "type":"ranked",
+            "rank":1,
+            "trophyChange":9,
+            "teams":[
+                [
+                    {
+                        "tag":"#Y2QPGG",
+                        "name":"Lex_YouTube",
+                        "brawler":{
+                            "id":16000005,
+                            "name":"SPIKE",
+                            "power":10,
+                            "trophies":495
+                        }
+                    },
+                    {
+                        "tag":"#8Q229LJY",
+                        "name":"Brandon",
+                        "brawler":{
+                            "id":16000003,
+                            "name":"BROCK",
+                            "power":10,
+                            "trophies":495
+                        }
+                    },
+                        {
+                        "tag":"#29RGL0QJ0",
+                        "name":"smallwhitepeen1",
+                        "brawler":{
+                            "id":16000007,
+                            "name":"JESSIE",
+                            "power":7,
+                            "trophies":486
+                        }
+                    }
+                ],
+                [
+                    {
+                        "tag":"#CYLVL8LY",
+                        "name":"TST|ROYER™",
+                        "brawler":{
+                            "id":16000019,
+                            "name":"PENNY",
+                            "power":8,
+                            "trophies":541
+                        }
+                    },
+                    {
+                        "tag":"#8P2URCR0",
+                        "name":"ANOTHER",
+                        "brawler":{
+                            "id":16000023,
+                            "name":"LEON",
+                            "power":8,
+                            "trophies":559
+                        }
+                    },
+                    {
+                        "tag":"#8LRY92QP",
+                        "name":"Marshmello",
+                        "brawler":{
+                            "id":16000021,
+                            "name":"GENE",
+                            "power":7,
+                            "trophies":448
+                        }
+                    }
+                ]
+            ]
+        }
+    }
 
 .. _Club: https://brawlstats.readthedocs.io/en/latest/api.html#id1
 .. _PartialClub: https://brawlstats.readthedocs.io/en/latest/api.html#id2

tests/test_async.py

@@ -42,6 +42,8 @@ async def test_get_club(self):
     async def test_get_leaderboard_player(self):
         lb = await self.client.get_leaderboard('players')
         self.assertTrue(isinstance(lb, brawlstats.Leaderboard))
+        region = await self.client.get_leaderboard('players', region='us')
+        self.assertTrue(isinstance(region, brawlstats.Leaderboard))
 
     async def test_get_leaderboard_club(self):
         lb = await self.client.get_leaderboard('clubs')
@@ -74,6 +76,10 @@ async def test_club_search(self):
         search = await self.client.search_club('Penguin Raft')
         self.assertTrue(isinstance(search, list))
 
+    async def test_battle_logs(self):
+        logs = await self.client.get_battle_logs(self.player_tag)
+        self.assertTrue(isinstance(logs, list))
+
     # Other
     async def test_invalid_tag(self):
         async def request():

tests/test_blocking.py

@@ -24,7 +24,6 @@ def setUp(self):
             TOKEN,
             is_async=False,
             timeout=30,
-            prevent_ratelimit=True,
             debug=True
         )
         logging.basicConfig(level=logging.DEBUG)
@@ -44,6 +43,8 @@ def test_get_club(self):
     def test_get_leaderboard_player(self):
         lb = self.client.get_leaderboard('players')
         self.assertTrue(isinstance(lb, brawlstats.Leaderboard))
+        region = self.client.get_leaderboard('players', region='us')
+        self.assertTrue(isinstance(region, brawlstats.Leaderboard))
 
     def test_get_leaderboard_club(self):
         lb = self.client.get_leaderboard('clubs')
@@ -72,9 +73,12 @@ def test_get_misc(self):
 
     def test_club_search(self):
         search = self.client.search_club('Penguin Raft')
-        print(search)
         self.assertTrue(isinstance(search, list))
 
+    def test_battle_logs(self):
+        logs = self.client.get_battle_logs(self.player_tag)
+        self.assertTrue(isinstance(logs, list))
+
     # Other
     def test_invalid_tag(self):
         get_profile = self.client.get_profile