Add requests_remaining and requests_per_day properties (#6)

* Add requests_remaining and requests_per_day properties

Author: bieniu

.github/workflows/run_tests.yml

@@ -24,7 +24,11 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install flake8 pep517
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        if [ -f requirements-test.txt ]; then \
+          pip install -r requirements-test.txt; \
+        elif [ -f requirements.txt ]; then \
+          pip install -r requirements.txt; \
+        fi
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names

airly/__init__.py

@@ -48,3 +48,23 @@ def create_measurements_session_point(
         return MeasurementsSession(
             self._rh, MeasurementsSession.Mode.POINT,
             latitude=latitude, longitude=longitude)
+
+    @property
+    def requests_remaining(self):
+        """
+        Returns the remaining number of requests on a given day as Int or None if value
+        is unavailable. The counter is reset each day at midnight UTC.
+        """
+
+        return self._rh.requests_remaining
+
+    @property
+    def requests_per_day(self):
+        """
+        Returns the allowed number of requests per day as Int or None if value is
+        unavailable.
+        According to the API documentation, the default rate limit per API key is 100
+        requests per day. But for old API keys (pre-2020), the rate limit is 1000
+        requests per day.
+        """
+        return self._rh.requests_per_day

airly/_private.py

@@ -27,11 +27,20 @@ def __init__(self, api_key, session: aiohttp.ClientSession, base_url,
             self.headers['Accept-Language'] = language
         self.base_url = base_url
         self.session = session
+        self.requests_per_day = None
+        self.requests_remaining = None
 
     async def get(self, request_path):
         url = self.base_url + request_path
         _LOGGER.debug("Sending request: " + url)
         async with self.session.get(url, headers=self.headers) as response:
+            # The values for the X-RateLimit-Limit-day and X-RateLimit-Remaining-day
+            # headers should be returned for HTTP status code 200 and 429, but sometimes
+            # they are missing for unknown reasons.
+            if "X-RateLimit-Limit-day" in response.headers:
+                self.requests_per_day = int(response.headers["X-RateLimit-Limit-day"])
+            if "X-RateLimit-Remaining-day" in response.headers:
+                self.requests_remaining = int(response.headers["X-RateLimit-Remaining-day"])
             if response.status != 200:
                 _LOGGER.warning("Invalid response from Airly API: %s",
                                 response.status)

requirements-test.txt

@@ -0,0 +1,3 @@
+-e .
+aioresponses
+aiounittest

requirements.txt

@@ -1 +1 @@
--e .
+-e .

tests/test__private.py

@@ -1,6 +1,16 @@
-from airly._private import _DictToObj
+import json
 from unittest import TestCase
 
+import aiohttp
+from aioresponses import aioresponses
+from aiounittest import AsyncTestCase
+
+from airly import Airly
+from airly._private import _DictToObj
+
+LATITUDE = 12
+LONGITUDE = 21
+
 class _DictToObjTestCase(TestCase):
     def test_init_with_iterable(self):
         data = { 'key1': 'value1', 'key2': 2 }
@@ -16,3 +26,50 @@ def test_init_with_kwargs(self):
         self.assertEqual('value1', sut.key1)
         self.assertEqual(2, sut['key2'])
         self.assertEqual(2, sut.key2)
+
+
+class RemainingRequestsTestCase(AsyncTestCase):
+    async def test_valid_remaining_requests_headers(self):
+        with open("data/measurements_typical.json") as file:
+            data = json.load(file)
+        headers = {"X-RateLimit-Limit-day": "1000", "X-RateLimit-Remaining-day": "993"}
+
+        session = aiohttp.ClientSession()
+
+        with aioresponses() as session_mock:
+            session_mock.get(
+                'https://airapi.airly.eu/v2/measurements/point?lat=12.000000&lng=21.000000',
+                payload=data,
+                headers=headers,
+            )
+            airly = Airly("abcdef", session)
+            measurements = airly.create_measurements_session_point(LATITUDE, LONGITUDE)
+            await measurements.update()
+
+        await session.close()
+
+        self.assertEqual(1000, airly.requests_per_day)
+        self.assertEqual(993, airly.requests_remaining)
+
+    async def test_invalid_remaining_requests_headers(self):
+        with open("data/measurements_typical.json") as file:
+            data = json.load(file)
+        headers = {}
+        
+        session = aiohttp.ClientSession()
+
+        with aioresponses() as session_mock:
+            session_mock.get(
+                'https://airapi.airly.eu/v2/measurements/point?lat=12.000000&lng=21.000000',
+                payload=data,
+                headers=headers,
+            )
+            airly = Airly("abcdef", session)
+            measurements = airly.create_measurements_session_point(LATITUDE, LONGITUDE)
+            await measurements.update()
+        
+        await session.close()
+
+        self.assertIsNone(airly.requests_per_day)
+        self.assertIsNone(airly.requests_remaining)
+