add rosa, prevent_ratelimit, update URLs

Author: SharpBit

CHANGELOG.md

@@ -1,6 +1,14 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [2.3.6] - 4/27/19
+### Added
+- Rosa to the brawler list
+- `prevent_ratelimit` option when initializing a client to wait when chaining requests
+### Changed
+- Base URL for requests to [the new API URL](https://api.brawlapi.cf/v1)
+- Ratelimit updated to API's 3 requests per second
+
 ## [2.3.5] - 4/15/19
 ### Fixed
 - Fixed the rate limit handler when error code 429 was returned by the API.

README.rst

@@ -21,7 +21,7 @@ Brawl Stats
     :alt: MIT License
 
 | This library is a sync and async wrapper the unofficial `Brawl Stars API`_.
-| To keep up with API changes, discussions, and status, I recommend you join the `discord server`_.
+| To keep up with API changes, discussions, and status, I recommend you join the API's `discord server`_.
 
 Features
 ~~~~~~~~
@@ -64,16 +64,17 @@ Misc
 
 | If you are currently using this wrapper, feel free to star this repository :)
 | If you come across an issue in the wrapper, please `create an issue`_. Do **not** PM me on Discord for help.
-| If you need an API Key, join the API’s `discord server`_.
+| If you need an API Key, create one using the `dashboard`_.
 
 Contributing
 ~~~~~~~~~~~~
 If you want to contribute, whether it be a bug fix or new feature, make sure to follow the `contributing guidelines`_.
 
-.. _Brawl Stars API: http://brawlapi.cf/api
+.. _Brawl Stars API: https://api.brawlapi.cf/v1
 .. _create an issue: https://github.com/SharpBit/brawlstats/issues
 .. _discord server: https://discord.me/BrawlAPI
 .. _Read the Docs: https://brawlstats.rtfd.io/
 .. _examples folder: https://github.com/SharpBit/brawlstats/tree/master/examples
 .. _discord.py rewrite: https://github.com/rapptz/discord.py/tree/rewrite
-.. _contributing guidelines: https://github.com/SharpBit/brawlstats/blob/master/CONTRIBUTING.md
+.. _contributing guidelines: https://github.com/SharpBit/brawlstats/blob/master/CONTRIBUTING.md
+.. _dashboard: https://brawlapi.cf/dashboard

brawlstats/__init__.py

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

brawlstats/constants.json

@@ -24,7 +24,7 @@ class Client:
     Parameters
     ------------
     token: str
-        The API Key that you can get from https://discord.me/BrawlAPI
+        The API Key that you can get from https://brawlapi.cf/dashboard
     session: Optional[Session] = None
         Use a current session or a make new one. Can be ``aiohttp.ClientSession()`` or ``requests.Session()``
     timeout: Optional[int] = 10
@@ -42,6 +42,9 @@ class Client:
         Whether or not to give you more info to debug easily.
     base_url: Optional[str] = None
         Sets a different base URL to make request to. Only use this if you know what you are doing.
+    prevent_ratelimit: Optional[bool] = False
+        Whether or not you want to wait for a small amount of time between requests to prevent being ratelimited.
+        Recommended if you are performing multiple requests in a short period of time.
     """
 
     REQUEST_LOG = '{method} {url} recieved {text} has returned {status}'
@@ -54,10 +57,13 @@ def __init__(self, token, session=None, timeout=10, is_async=False, **options):
             aiohttp.ClientSession(loop=self.loop, connector=self.connector) if self.is_async else requests.Session()
         )
         self.timeout = timeout
+        self.lock = asyncio.Lock() if options.get('prevent_ratelimit') is True else None
         self.api = API(options.get('base_url'))
+
         self.debug = options.get('debug', False)
         self.cache = TTLCache(900, 180)  # 5 requests/sec
-        self.ratelimit = [5, 5, 0]  # per second, remaining, time until reset
+        self.ratelimit = [3, 3, 0]  # per second, remaining, time until reset
+
         self.headers = {
             'Authorization': token,
             'User-Agent': 'brawlstats/{0} (Python {1[0]}.{1[1]})'.format(self.api.VERSION, sys.version_info),
@@ -148,7 +154,13 @@ def _request(self, url):
         return data
 
     async def _aget_model(self, url, model, key=None):
-        data, resp = await self._arequest(url)
+        if self.lock is not None:
+            async with self.lock:
+                data, resp = await self._arequest(url)
+                await asyncio.sleep(1 / self.ratelimit[0])
+        else:
+            data, resp = await self._arequest(url)
+
         if model == Constants:
             if key and not data.get(key):
                 raise KeyError('No such key for Brawl Stars constants "{}"'.format(key))

brawlstats/core.py

@@ -26,7 +26,7 @@ def __getattr__(self, attr):
             try:
                 return super().__getattr__(attr)
             except AttributeError:
-                return None  # makes it easier on the user's end
+                return None  # users can use an if statement rather than try/except to find a missing attribute
 
     def __getitem__(self, item):
         try:

brawlstats/models.py

@@ -6,7 +6,7 @@
 
 class API:
     def __init__(self, base_url):
-        self.BASE = base_url or 'https://brawlapi.cf/api'
+        self.BASE = base_url or 'https://api.brawlapi.cf/v1'
         self.PROFILE = self.BASE + '/player'
         self.CLUB = self.BASE + '/club'
         self.LEADERBOARD = self.BASE + '/leaderboards'
@@ -17,7 +17,7 @@ def __init__(self, base_url):
         self.BRAWLERS = [
             'shelly', 'nita', 'colt', 'bull', 'jessie',  # league reward 0-500
             'brock', 'dynamike', 'bo',                   # league reward 1000+
-            'el primo', 'barley', 'poco',                # rare
+            'el primo', 'barley', 'poco', 'rosa',        # rare
             'ricochet', 'penny', 'darryl', 'carl',       # super rare
             'frank', 'pam', 'piper',                     # epic
             'mortis', 'tara', 'gene',                    # mythic

brawlstats/utils.py

@@ -14,7 +14,7 @@ Welcome to Brawl Stats' documentation!
     :alt: MIT License
 
 | Brawl Stats is an easy to use async wrapper for the unofficial `Brawl Stars API`_.
-| Please note that both this API and wrapper are both still in beta, so there will be frequent breaking changes.
+| To keep up with API changes, discussions, and status, I recommend you join the API's `discord server`_.
 
 Features
 ~~~~~~~~