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

Author: EliuX

commons/data_access_layer/cosmos_db.py

@@ -219,8 +219,8 @@ 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: []) -> 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)

tests/time_tracker_api/activities/activities_namespace_test.py

@@ -258,4 +258,4 @@ def test_delete_activity_should_return_422_for_invalid_id_format(client: FlaskCl
 
     assert HTTPStatus.UNPROCESSABLE_ENTITY == response.status_code
     repository_remove_mock.assert_called_once_with(str(invalid_id),
-                                                   partition_key_value=tenant_id)
+                                                   partition_key_value=tenant_id)

tests/time_tracker_api/customers/customers_namespace_test.py

@@ -3,6 +3,7 @@
 from flask.testing import FlaskClient
 from flask_restplus._http import HTTPStatus
 from pytest_mock import MockFixture
+from werkzeug.datastructures import ImmutableMultiDict
 
 fake = Faker()
 
@@ -68,6 +69,20 @@ def test_list_all_customers(client: FlaskClient,
     assert [] == json_data
     repository_find_all_mock.assert_called_once()
 
+def test_list_all_customers_with_conditions(client: FlaskClient, mocker: MockFixture):
+    from time_tracker_api.customers.customers_namespace import customer_dao
+    repository_find_all_mock = mocker.patch.object(customer_dao.repository,
+                                                   'find_all',
+                                                   return_value=[])
+
+    response = client.get("/customers?a=b", follow_redirects=True)
+
+    assert HTTPStatus.OK == response.status_code
+    json_data = json.loads(response.data)
+    assert [] == json_data
+    repository_find_all_mock.assert_called_once_with(conditions=ImmutableMultiDict({'a': 'b'}),
+                                                     partition_key_value='ioet')
+
 
 def test_get_customer_should_succeed_with_valid_id(client: FlaskClient,
                                                    mocker: MockFixture,

tests/time_tracker_api/project_types/project_types_namespace_test.py

@@ -269,4 +269,4 @@ def test_delete_project_should_return_unprocessable_entity_for_invalid_id_format
 
     assert HTTPStatus.UNPROCESSABLE_ENTITY == response.status_code
     repository_remove_mock.assert_called_once_with(str(invalid_id),
-                                                   partition_key_value=tenant_id)
+                                                   partition_key_value=tenant_id)

tests/time_tracker_api/projects/projects_namespace_test.py

@@ -269,4 +269,4 @@ def test_delete_project_should_return_unprocessable_entity_for_invalid_id_format
 
     assert HTTPStatus.UNPROCESSABLE_ENTITY == response.status_code
     repository_remove_mock.assert_called_once_with(str(invalid_id),
-                                                   partition_key_value=tenant_id)
+                                                   partition_key_value=tenant_id)

time_tracker_api/activities/activities_namespace.py

@@ -1,6 +1,7 @@
 from faker import Faker
 from flask_restplus import fields, Resource, Namespace
 from flask_restplus._http import HTTPStatus
+from flask import request
 
 from time_tracker_api.activities.activities_model import create_dao
 from time_tracker_api.api import common_fields
@@ -44,7 +45,7 @@ class Activities(Resource):
     @ns.marshal_list_with(activity)
     def get(self):
         """List all activities"""
-        return activity_dao.get_all()
+        return activity_dao.get_all(conditions=request.args)
 
     @ns.doc('create_activity')
     @ns.response(HTTPStatus.CONFLICT, 'This activity already exists')

time_tracker_api/api.py

@@ -1,7 +1,7 @@
 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, reqparse
 from flask_restplus._http import HTTPStatus
 
 from commons.data_access_layer.cosmos_db import CustomError
@@ -18,6 +18,14 @@
     security="TimeTracker JWT",
 )
 
+# Filters
+def create_attributes_filter(attributes_filter):
+    filter_attributes_parser = reqparse.RequestParser()
+    for attribute in attributes_filter:
+        filter_attributes_parser.add_argument(f'filters[{attribute}]', location='args')
+
+    return filter_attributes_parser
+
 # 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}'
 

time_tracker_api/collections/dictionary_utils.py

@@ -0,0 +1,16 @@
+import re
+
+def remove_none_values(dictionary):
+    dictionary_with_values = {}
+    for key, value in dictionary.items():
+        if value is not None:
+            dictionary_with_values.update({key: value})
+    return dictionary_with_values
+
+
+def remove_filters_wrapper_from_keys(dictionary):
+    dictionary_with_unwrapped_keys = {}
+    for key, value in dictionary.items():
+        unwrapped_key = re.search('\\[(.+?)\\]', key).groups()[0]
+        dictionary_with_unwrapped_keys.update({unwrapped_key: value})
+    return dictionary_with_unwrapped_keys

time_tracker_api/customers/customers_namespace.py

@@ -1,6 +1,7 @@
 from faker import Faker
 from flask_restplus import Namespace, Resource, fields
 from flask_restplus._http import HTTPStatus
+from flask import request
 
 from time_tracker_api.api import common_fields
 from time_tracker_api.customers.customers_model import create_dao
@@ -45,7 +46,7 @@ class Customers(Resource):
     @ns.marshal_list_with(customer)
     def get(self):
         """List all customers"""
-        return customer_dao.get_all()
+        return customer_dao.get_all(conditions=request.args)
 
     @ns.doc('create_customer')
     @ns.response(HTTPStatus.CONFLICT, 'This customer already exists')

time_tracker_api/project_types/project_types_namespace.py

@@ -1,6 +1,7 @@
 from faker import Faker
 from flask_restplus import Namespace, Resource, fields
 from flask_restplus._http import HTTPStatus
+from flask import request
 
 from time_tracker_api.api import common_fields, UUID_REGEX
 from time_tracker_api.project_types.project_types_model import create_dao
@@ -60,7 +61,7 @@ class ProjectTypes(Resource):
     @ns.marshal_list_with(project_type)
     def get(self):
         """List all project types"""
-        return project_type_dao.get_all()
+        return project_type_dao.get_all(conditions=request.args)
 
     @ns.doc('create_project_type')
     @ns.response(HTTPStatus.CONFLICT, 'This project type already exists')