From cae7ee8ab4639963d3da7fef6f078a6078340a0b Mon Sep 17 00:00:00 2001 From: Georgios Andreadis Date: Thu, 25 Jun 2020 16:06:22 +0200 Subject: Improve abstraction --- opendc/api/v2/users/endpoint.py | 28 ++++++++++++-------------- opendc/api/v2/users/userId/endpoint.py | 16 +++++++-------- opendc/api/v2/users/userId/test_endpoint.py | 8 ++++---- opendc/models/model.py | 31 +++++++++++++++++++++++++++++ opendc/models/user.py | 30 ++++++++++++++++------------ opendc/util/rest.py | 3 ++- 6 files changed, 75 insertions(+), 41 deletions(-) create mode 100644 opendc/models/model.py (limited to 'opendc') diff --git a/opendc/api/v2/users/endpoint.py b/opendc/api/v2/users/endpoint.py index 245ea49b..89dfc8c1 100644 --- a/opendc/api/v2/users/endpoint.py +++ b/opendc/api/v2/users/endpoint.py @@ -1,3 +1,4 @@ +from opendc.models.user import User from opendc.util import exceptions from opendc.util.database import DB from opendc.util.rest import Response @@ -11,12 +12,13 @@ def GET(request): except exceptions.ParameterError as e: return Response(400, str(e)) - user = DB.fetch_one({'email': request.params_query['email']}, 'users') + user = User.from_email(request.params_query['email']) - if user is None: - return Response(404, f'User with email {request.params_query["email"]} not found') + validation_error = user.validate() + if validation_error is not None: + return validation_error - return Response(200, f'Successfully retrieved {user}.', user) + return Response(200, f'Successfully retrieved user.', user.obj) def POST(request): @@ -27,16 +29,12 @@ def POST(request): except exceptions.ParameterError as e: return Response(400, str(e)) - request.params_body['user']['googleId'] = request.google_id - user = request.params_body['user'] - existing_user = DB.fetch_one({'googleId': user['googleId']}, 'users') + user = User(request.params_body['user']) + user.set_property('googleId', request.google_id) - if existing_user is not None: - return Response(409, f'{existing_user} already exists.') + validation_error = user.validate_insertion() + if validation_error is not None: + return validation_error - if not request.google_id == user['googleId']: - return Response(403, 'Forbidden from creating this User.') - - user = DB.insert(user, 'users') - - return Response(200, f'Successfully created {user}.', user) + user.insert() + return Response(200, f'Successfully created user.', user.obj) diff --git a/opendc/api/v2/users/userId/endpoint.py b/opendc/api/v2/users/userId/endpoint.py index 9418f70a..3fb2ecc8 100644 --- a/opendc/api/v2/users/userId/endpoint.py +++ b/opendc/api/v2/users/userId/endpoint.py @@ -11,14 +11,14 @@ def GET(request): except exceptions.ParameterError as e: return Response(400, str(e)) - user = User(request.params_path['userId']) + user = User.from_id(request.params_path['userId']) validation_error = user.validate() - if validation_error is None: - return Response(200, f'Successfully retrieved {user}.', user.obj) - else: + if validation_error is not None: return validation_error + return Response(200, f'Successfully retrieved user.', user.obj) + def PUT(request): """Update this User's given name and/or family name.""" @@ -32,7 +32,7 @@ def PUT(request): except exceptions.ParameterError as e: return Response(400, str(e)) - user = User(request.params_path['userId']) + user = User.from_id(request.params_path['userId']) validation_error = user.validate(request.google_id) if validation_error is not None: @@ -43,7 +43,7 @@ def PUT(request): user.update() - return Response(200, f'Successfully updated {user}.', user.obj) + return Response(200, f'Successfully updated user.', user.obj) def DELETE(request): @@ -54,7 +54,7 @@ def DELETE(request): except exceptions.ParameterError as e: return Response(400, str(e)) - user = User(request.params_path['userId']) + user = User.from_id(request.params_path['userId']) validation_error = user.validate(request.google_id) if validation_error is not None: @@ -62,4 +62,4 @@ def DELETE(request): user.delete() - return Response(200, f'Successfully deleted {user}.', user.obj) + return Response(200, f'Successfully deleted user.', user.obj) diff --git a/opendc/api/v2/users/userId/test_endpoint.py b/opendc/api/v2/users/userId/test_endpoint.py index 30edfdaa..01642fc3 100644 --- a/opendc/api/v2/users/userId/test_endpoint.py +++ b/opendc/api/v2/users/userId/test_endpoint.py @@ -23,12 +23,12 @@ def test_update_user_non_existing(client, mocker): def test_update_user_different_user(client, mocker): - mocker.patch.object(DB, 'fetch_one', return_value={'googleId': 'other_test'}) + mocker.patch.object(DB, 'fetch_one', return_value={'_id': '1', 'googleId': 'other_test'}) assert '403' in client.put('/api/v2/users/1', json={'user': {'givenName': 'A', 'familyName': 'B'}}).status def test_update_user(client, mocker): - mocker.patch.object(DB, 'fetch_one', return_value={'googleId': 'test'}) + mocker.patch.object(DB, 'fetch_one', return_value={'_id': '1', 'googleId': 'test'}) mocker.patch.object(DB, 'update', return_value=None) res = client.put('/api/v2/users/1', json={'user': {'givenName': 'A', 'familyName': 'B'}}) assert 'givenName' in res.json['content'] @@ -41,12 +41,12 @@ def test_delete_user_non_existing(client, mocker): def test_delete_user_different_user(client, mocker): - mocker.patch.object(DB, 'fetch_one', return_value={'googleId': 'other_test'}) + mocker.patch.object(DB, 'fetch_one', return_value={'_id': '1', 'googleId': 'other_test'}) assert '403' in client.delete('/api/v2/users/1').status def test_delete_user(client, mocker): - mocker.patch.object(DB, 'fetch_one', return_value={'googleId': 'test'}) + mocker.patch.object(DB, 'fetch_one', return_value={'_id': '1', 'googleId': 'test'}) mocker.patch.object(DB, 'delete_one', return_value=None) res = client.delete('/api/v2/users/1') assert 'googleId' in res.json['content'] diff --git a/opendc/models/model.py b/opendc/models/model.py new file mode 100644 index 00000000..d887e845 --- /dev/null +++ b/opendc/models/model.py @@ -0,0 +1,31 @@ +from opendc.util.database import DB +from opendc.util.rest import Response + + +class Model: + collection_name = '' + + @classmethod + def from_id(cls, _id): + return cls(DB.fetch_one({'_id': _id}, Model.collection_name)) + + def __init__(self, obj): + self.obj = obj + + def validate(self, request_google_id=None): + if self.obj is None: + return Response(404, f'Not found.') + + return None + + def set_property(self, key, value): + self.obj[key] = value + + def insert(self): + DB.insert(self.obj, self.collection_name) + + def update(self): + DB.update(self.obj['_id'], self.obj, self.collection_name) + + def delete(self): + DB.delete_one({'_id': self.obj['_id']}, self.collection_name) diff --git a/opendc/models/user.py b/opendc/models/user.py index 39437025..bbbb40e8 100644 --- a/opendc/models/user.py +++ b/opendc/models/user.py @@ -1,26 +1,30 @@ +from opendc.models.model import Model from opendc.util.database import DB from opendc.util.rest import Response -class User: - def __init__(self, obj_id): - self.obj_id = obj_id - self.obj = DB.fetch_one({'_id': obj_id}, 'users') +class User(Model): + collection_name = 'users' + + @classmethod + def from_email(cls, email): + return User(DB.fetch_one({'email': email}, User.collection_name)) def validate(self, request_google_id=None): - if self.obj is None: - return Response(404, f'User with ID {self.obj_id} not found.') + super_validation = super().validate(request_google_id) + + if super_validation is not None: + return super_validation if request_google_id is not None and self.obj['googleId'] != request_google_id: - return Response(403, f'Forbidden from editing user with ID {self.obj_id}.') + return Response(403, f'Forbidden from editing user with ID {self.obj["_id"]}.') return None - def set_property(self, key, value): - self.obj[key] = value + def validate_insertion(self): + existing_user = DB.fetch_one({'googleId': self.obj['googleId']}, self.collection_name) - def update(self): - DB.update(self.obj_id, self.obj, 'users') + if existing_user is not None: + return Response(409, f'User already exists.') - def delete(self): - DB.delete_one({'_id': self.obj_id}, 'users') + return None diff --git a/opendc/util/rest.py b/opendc/util/rest.py index 2f2e1b53..33371e52 100644 --- a/opendc/util/rest.py +++ b/opendc/util/rest.py @@ -44,7 +44,8 @@ class Request(object): module_path = self.path.replace('{', '').replace('}', '').replace('/', '.') self.module = importlib.import_module(module_base.format(module_path)) - except ImportError: + except ImportError as e: + print(e) raise exceptions.UnimplementedEndpointError('Unimplemented endpoint: {}.'.format(self.path)) # Check the method -- cgit v1.2.3