Merge pull request #1 from JozefTkocz/feature/delete_athletes_from_token_store

Feature/delete athletes from token store

Author: JozefTkocz

setup.py

@@ -16,7 +16,7 @@ def read_requirements(requirements_file):
 setup(
     name="stravaclient",
     python_requires=">=3.8,<4.0",
-    version="0.0.4",
+    version="0.0.5",
     author="Jozef Tkocz",
     author_email="[email protected]",
     description=("Python client for the Strava API"),

stravaclient/storage/tokens.py

@@ -1,4 +1,5 @@
-from typing import Protocol
+import logging
+from typing import Protocol, Dict
 import boto3
 import tinydb
 from botocore.exceptions import ClientError
@@ -26,21 +27,24 @@ def build(self, type: str, **kwargs):
 
 
 class TokenCache(Protocol):
-    def upsert_authorisation_token(self, authorisation):
+    def upsert_authorisation_token(self, authorisation: Dict):
         ...
 
-    def get_authorisation_token(self, athlete_id):
+    def get_authorisation_token(self, athlete_id: int) -> Dict:
         ...
 
-    def total_tokens(self):
+    def delete_authorisation_token(self, athlete_id: int):
+        ...
+
+    def total_tokens(self) -> int:
         ...
 
 
 class LocalTokenCache:
-    def __init__(self, filename):
+    def __init__(self, filename: str):
         self.database = tinydb.TinyDB(filename)
 
-    def upsert_authorisation_token(self, authorisation):
+    def upsert_authorisation_token(self, authorisation: Dict):
         athlete_id = authorisation['athlete']['id']
         auth_expiry = authorisation['expires_at']
         auth_access_token = authorisation['access_token']
@@ -52,11 +56,14 @@ def upsert_authorisation_token(self, authorisation):
              'refresh_token': auth_refresh_token},
             doc_id=athlete_id))
 
-    def get_authorisation_token(self, athlete_id):
+    def get_authorisation_token(self, athlete_id: int) -> Dict:
         return self.database.get(doc_id=athlete_id)
 
+    def delete_authorisation_token(self, athlete_id: int):
+        self.database.remove(doc_ids=[athlete_id])
+
     @property
-    def total_tokens(self):
+    def total_tokens(self) -> int:
         return len(self.database)
 
 
@@ -68,7 +75,7 @@ def __init__(self, aws_access_key_id, aws_secret_access_key, region_name, table_
                                               aws_secret_access_key=aws_secret_access_key)
         self.table = self.dynamodb_client.Table(table_name)
 
-    def upsert_authorisation_token(self, authorisation):
+    def upsert_authorisation_token(self, authorisation: Dict):
         athlete_id = authorisation['athlete']['id']
         auth_expiry = authorisation['expires_at']
         auth_access_token = authorisation['access_token']
@@ -83,11 +90,12 @@ def upsert_authorisation_token(self, authorisation):
             }
         )
 
-    def get_authorisation_token(self, athlete_id):
+    def get_authorisation_token(self, athlete_id: int) -> Dict:
         try:
             response = self.table.get_item(Key={'athlete_id': str(athlete_id)})
         except ClientError as e:
-            print(e.response['Error']['Message'])
+            logging.error('Failed to retrieve access token')
+            logging.error(e.response['Error']['Message'])
         else:
             data = response['Item']
             expires_at = int(data['expires_at'])
@@ -98,6 +106,13 @@ def get_authorisation_token(self, athlete_id):
 
             return data
 
+    def delete_authorisation_token(self, athlete_id: int):
+        try:
+            self.table.delete_item(Key={'athlete_id': str(athlete_id)})
+        except ClientError as e:
+            logging.error(f'Failed to remove athlete {athlete_id}')
+            logging.error(e.response['Error']['Message'])
+
     @property
-    def total_tokens(self):
+    def total_tokens(self) -> int:
         return self.table.item_count

tests/test_storage.py

@@ -46,6 +46,19 @@ def test_total_tokens_returns_one_when_one_token(self):
         assert cache.total_tokens == 1
         self.teardown_db(cache)
 
+    def test_delete_authorisation_token_removes_token_from_database(self):
+        cache = LocalTokenCache(self.test_db_file)
+        authorisation = {'athlete': {'id': 123},
+                         'expires_at': 1,
+                         'access_token': 'abc',
+                         'refresh_token': 'abc123'}
+        cache.upsert_authorisation_token(authorisation=authorisation)
+        cache.delete_authorisation_token(athlete_id=123)
+
+        document = cache.get_authorisation_token(athlete_id=123)
+        assert document is None
+        self.teardown_db(cache)
+
 
 class TestDynamoDBCache:
     class MockDynamoTable: