feat: Close #93 Add filter to projects, project-types and time-entries

Author: EliuX

commons/data_access_layer/cosmos_db.py

@@ -176,7 +176,8 @@ def find_all(self, partition_key_value: str, conditions: dict = {}, max_count=No
 
     def partial_update(self, id: str, changes: dict, partition_key_value: str,
                        peeker: 'function' = None, visible_only=True, mapper: Callable = None):
-        item_data = self.find(id, partition_key_value, peeker=peeker, visible_only=visible_only, mapper=dict)
+        item_data = self.find(id, partition_key_value, peeker=peeker,
+                              visible_only=visible_only, mapper=dict)
         item_data.update(changes)
         return self.update(id, item_data, mapper=mapper)
 
@@ -219,8 +220,9 @@ class CosmosDBDao(CRUDDao):
     def __init__(self, repository: CosmosDBRepository):
         self.repository = repository
 
-    def get_all(self) -> list:
-        return self.repository.find_all(partition_key_value=self.partition_key_value)
+    def get_all(self, conditions: dict = {}) -> list:
+        return self.repository.find_all(partition_key_value=self.partition_key_value,
+                                        conditions=conditions)
 
     def get(self, id):
         return self.repository.find(id, partition_key_value=self.partition_key_value)

commons/data_access_layer/database.py

@@ -15,7 +15,7 @@
 
 class CRUDDao(abc.ABC):
     @abc.abstractmethod
-    def get_all(self):
+    def get_all(self, conditions: dict):
         raise NotImplementedError  # pragma: no cover
 
     @abc.abstractmethod

tests/conftest.py

@@ -3,10 +3,10 @@
 import jwt
 import pytest
 from faker import Faker
-from flask import Flask, url_for
+from flask import Flask
 from flask.testing import FlaskClient
 
-from commons.data_access_layer.cosmos_db import CosmosDBRepository, datetime_str, current_datetime
+from commons.data_access_layer.cosmos_db import CosmosDBRepository
 from commons.data_access_layer.database import init_sql
 from time_tracker_api import create_app
 from time_tracker_api.security import get_or_generate_dev_secret_key
@@ -160,7 +160,7 @@ def running_time_entry(time_entry_repository: TimeEntryCosmosDBRepository,
     yield created_time_entry
 
     time_entry_repository.delete_permanently(id=created_time_entry.id,
-                                 partition_key_value=tenant_id)
+                                             partition_key_value=tenant_id)
 
 
 @pytest.fixture(scope="session")

tests/time_tracker_api/activities/activities_namespace_test.py

@@ -67,7 +67,8 @@ def test_list_all_activities(client: FlaskClient,
     assert HTTPStatus.OK == response.status_code
     json_data = json.loads(response.data)
     assert [] == json_data
-    repository_find_all_mock.assert_called_once_with(partition_key_value=tenant_id)
+    repository_find_all_mock.assert_called_once_with(partition_key_value=tenant_id,
+                                                     conditions={})
 
 
 def test_get_activity_should_succeed_with_valid_id(client: FlaskClient,

tests/time_tracker_api/api_test.py

@@ -0,0 +1,24 @@
+from flask_restplus.reqparse import RequestParser
+from pytest import fail
+
+
+def test_create_attributes_filter_with_invalid_attribute_should_fail():
+    from time_tracker_api.api import create_attributes_filter
+    from time_tracker_api.projects.projects_namespace import project, ns
+
+    try:
+        create_attributes_filter(ns, project, ['invalid_attribute'])
+
+        fail("It was expected to fail")
+    except Exception as e:
+        assert type(e) is ValueError
+
+
+def test_create_attributes_filter_with_valid_attribute_should_succeed():
+    from time_tracker_api.api import create_attributes_filter
+    from time_tracker_api.projects.projects_namespace import project, ns
+
+    filter = create_attributes_filter(ns, project, ['name'])
+
+    assert filter is not None
+    assert type(filter) is RequestParser

time_tracker_api/__init__.py

@@ -3,7 +3,6 @@
 
 from flask import Flask
 
-
 flask_app: Flask = None
 
 

time_tracker_api/api.py

@@ -1,11 +1,14 @@
 from azure.cosmos.exceptions import CosmosResourceExistsError, CosmosResourceNotFoundError, CosmosHttpResponseError
 from faker import Faker
 from flask import current_app as app
-from flask_restplus import Api, fields
+from flask_restplus import Api, fields, Model
+from flask_restplus import namespace
 from flask_restplus._http import HTTPStatus
+from flask_restplus.reqparse import RequestParser
 
 from commons.data_access_layer.cosmos_db import CustomError
 from time_tracker_api import security
+from time_tracker_api.security import UUID_REGEX
 from time_tracker_api.version import __version__
 
 faker = Faker()
@@ -18,8 +21,22 @@
     security="TimeTracker JWT",
 )
 
-# For matching UUIDs
-UUID_REGEX = '[0-9a-f]{8}\-[0-9a-f]{4}\-4[0-9a-f]{3}\-[89ab][0-9a-f]{3}\-[0-9a-f]{12}'
+
+# Filters
+def create_attributes_filter(ns: namespace, model: Model, filter_attrib_names: list) -> RequestParser:
+    attribs_parser = ns.parser()
+    model_attributes = model.resolved
+    for attrib in filter_attrib_names:
+        if attrib not in model_attributes:
+            raise ValueError(f"{attrib} is not a valid filter attribute for {model.name}")
+
+        attribs_parser.add_argument(attrib, required=False,
+                                    store_missing=False,
+                                    help="(Filter) %s " % model_attributes[attrib].description,
+                                    location='args')
+
+    return attribs_parser
+
 
 # Common models structure
 common_fields = {

time_tracker_api/project_types/project_types_namespace.py

@@ -2,8 +2,9 @@
 from flask_restplus import Namespace, Resource, fields
 from flask_restplus._http import HTTPStatus
 
-from time_tracker_api.api import common_fields, UUID_REGEX
+from time_tracker_api.api import common_fields, create_attributes_filter
 from time_tracker_api.project_types.project_types_model import create_dao
+from time_tracker_api.security import UUID_REGEX
 
 faker = Faker()
 
@@ -16,7 +17,7 @@
         required=True,
         max_length=50,
         description='Name of the project type',
-        example=faker.random_element(["Customer","Training","Internal"]),
+        example=faker.random_element(["Customer", "Training", "Internal"]),
     ),
     'description': fields.String(
         title='Description',
@@ -53,14 +54,21 @@
 
 project_type_dao = create_dao()
 
+attributes_filter = create_attributes_filter(ns, project_type, [
+    "customer_id",
+    "parent_id",
+])
+
 
 @ns.route('')
 class ProjectTypes(Resource):
     @ns.doc('list_project_types')
+    @ns.expect(attributes_filter)
     @ns.marshal_list_with(project_type)
     def get(self):
         """List all project types"""
-        return project_type_dao.get_all()
+        conditions = attributes_filter.parse_args()
+        return project_type_dao.get_all(conditions=conditions)
 
     @ns.doc('create_project_type')
     @ns.response(HTTPStatus.CONFLICT, 'This project type already exists')

time_tracker_api/projects/projects_namespace.py

@@ -2,8 +2,9 @@
 from flask_restplus import Namespace, Resource, fields
 from flask_restplus._http import HTTPStatus
 
-from time_tracker_api.api import common_fields, UUID_REGEX
+from time_tracker_api.api import common_fields, create_attributes_filter
 from time_tracker_api.projects.projects_model import create_dao
+from time_tracker_api.security import UUID_REGEX
 
 faker = Faker()
 
@@ -36,8 +37,7 @@
     'project_type_id': fields.String(
         title='Identifier of the project type',
         required=False,
-        description='This id allows to created a tree-like structure for projects, '
-                    'grouped by project types',
+        description='Id of the project type it belongs. This allows grouping the projects.',
         pattern=UUID_REGEX,
         example=faker.uuid4(),
     ),
@@ -54,14 +54,21 @@
 
 project_dao = create_dao()
 
+attributes_filter = create_attributes_filter(ns, project, [
+    "customer_id",
+    "project_type_id",
+])
+
 
 @ns.route('')
 class Projects(Resource):
     @ns.doc('list_projects')
+    @ns.expect(attributes_filter)
     @ns.marshal_list_with(project)
     def get(self):
         """List all projects"""
-        return project_dao.get_all()
+        conditions = attributes_filter.parse_args()
+        return project_dao.get_all(conditions=conditions)
 
     @ns.doc('create_project')
     @ns.response(HTTPStatus.CONFLICT, 'This project already exists')

time_tracker_api/security.py

@@ -24,8 +24,10 @@
     }
 }
 
-iss_claim_pattern = re.compile(
-    r"(.*).b2clogin.com/(?P<tenant_id>[0-9a-f]{8}\-[0-9a-f]{4}\-4[0-9a-f]{3}\-[89ab][0-9a-f]{3}\-[0-9a-f]{12})")
+# For matching UUIDs
+UUID_REGEX = '[0-9a-f]{8}\-[0-9a-f]{4}\-4[0-9a-f]{3}\-[89ab][0-9a-f]{3}\-[0-9a-f]{12}'
+
+iss_claim_pattern = re.compile(r"(.*).b2clogin.com/(?P<tenant_id>%s)" % UUID_REGEX)
 
 
 def current_user_id() -> str: