GET /api/v2/cases/{case_identifier}/notes-directories should accept parameter per_page

Author: c8y3

source/app/blueprints/rest/v2/case_routes/notes_directories.py

@@ -22,6 +22,7 @@
 
 from app.blueprints.access_controls import ac_api_requires
 from app.blueprints.access_controls import ac_fast_check_current_user_has_case_access
+from app.blueprints.rest.parsing import parse_pagination_parameters
 from app.blueprints.rest.endpoints import response_api_created
 from app.blueprints.rest.endpoints import response_api_success
 from app.blueprints.rest.endpoints import response_api_deleted
@@ -64,7 +65,8 @@ def search(self, case_identifier):
         if not ac_fast_check_current_user_has_case_access(case_identifier, [CaseAccessLevel.full_access]):
             return ac_api_return_access_denied(case_identifier)
 
-        directories = notes_directories_filter(case_identifier)
+        pagination_parameters = parse_pagination_parameters(request, default_order_by='name', default_direction='asc')
+        directories = notes_directories_filter(case_identifier, pagination_parameters)
         return response_api_paginated(self._schema_search, directories)
 
     def create(self, case_identifier):

source/app/business/notes_directories.py

@@ -23,10 +23,11 @@
 from app.datamgmt.case.case_notes_db import get_directory
 from app.datamgmt.case.case_notes_db import delete_directory
 from app.datamgmt.case.case_notes_db import paginate_notes_directories
+from app.models.pagination_parameters import PaginationParameters
 
 
-def notes_directories_filter(case_identifier: int):
-    return paginate_notes_directories(case_identifier)
+def notes_directories_filter(case_identifier: int, pagination_parameters: PaginationParameters):
+    return paginate_notes_directories(case_identifier, pagination_parameters)
 
 
 def notes_directories_create(directory: NoteDirectory):

source/app/datamgmt/case/case_notes_db.py

@@ -20,13 +20,15 @@
 from sqlalchemy import or_
 from sqlalchemy.exc import IntegrityError
 from datetime import datetime
+from flask_sqlalchemy.pagination import Pagination
 
 from app import db
 from app.datamgmt.persistence_error import PersistenceError
 from app.blueprints.iris_user import iris_current_user
 from app.datamgmt.manage.manage_attribute_db import get_default_custom_attributes
 from app.datamgmt.states import update_notes_state
-from app.models.comments import Comments, NotesComments
+from app.models.comments import Comments
+from app.models.comments import NotesComments
 from app.models.models import NoteDirectory
 from app.models.models import NoteRevisions
 from app.models.models import Notes
@@ -35,6 +37,8 @@
 from app.models.authorization import User
 from app.models.cases import Cases
 from app.models.models import Client
+from app.models.pagination_parameters import PaginationParameters
+from app.datamgmt.filtering import paginate
 
 
 def get_note(note_id):
@@ -164,7 +168,7 @@ def update_note_revision(note: Notes) -> bool:
         raise PersistenceError(e)
 
 
-def add_note(note_title, creation_date, user_id, caseid, directory_id, note_content=""):
+def add_note(note_title, creation_date, user_id, caseid, directory_id, note_content=''):
     note = Notes()
     note.note_title = note_title
     note.note_creationdate = note.note_lastupdate = creation_date
@@ -279,7 +283,7 @@ def add_note_group(group_title, caseid, userid, creationdate):
     db.session.commit()
 
     if group_title == '':
-        ng.group_title = "New notes group"
+        ng.group_title = 'New notes group'
 
     db.session.commit()
 
@@ -420,7 +424,7 @@ def delete_note_comment(note_id, comment_id):
         Comments.comment_user_id == iris_current_user.id
     ).first()
     if not comment:
-        return False, "You are not allowed to delete this comment"
+        return False, 'You are not allowed to delete this comment'
 
     NotesComments.query.filter(
         NotesComments.comment_note_id == note_id,
@@ -430,7 +434,7 @@ def delete_note_comment(note_id, comment_id):
     db.session.delete(comment)
     db.session.commit()
 
-    return True, "Comment deleted"
+    return True, 'Comment deleted'
 
 
 def get_directories_with_note_count(case_id):
@@ -454,16 +458,10 @@ def get_directories_with_note_count(case_id):
     return directories_with_note_count
 
 
-def paginate_notes_directories(case_id):
-    query = NoteDirectory.query.filter_by(case_id=case_id).order_by(
-        NoteDirectory.name.asc()
-    )
+def paginate_notes_directories(case_id, pagination_parameters: PaginationParameters) -> Pagination:
+    query = NoteDirectory.query.filter_by(case_id=case_id)
 
-    return query.paginate(
-        #page=pagination_parameters.get_page(),
-        #per_page=pagination_parameters.get_per_page(),
-        error_out=False
-    )
+    return paginate(NoteDirectory, pagination_parameters, query)
 
 def get_directory_with_note_count(directory):
     note_count = Notes.query.filter_by(directory_id=directory.id).count()

source/app/datamgmt/case/case_rfiles_db.py

@@ -25,10 +25,11 @@
 from app.datamgmt.manage.manage_attribute_db import get_default_custom_attributes
 from app.datamgmt.states import update_evidences_state
 from app.models.models import CaseReceivedFile
-from app.models.comments import Comments, EvidencesComments
+from app.models.comments import Comments
+from app.models.comments import EvidencesComments
 from app.models.authorization import User
 from app.models.pagination_parameters import PaginationParameters
-from app.datamgmt.conversions import convert_sort_direction
+from app.datamgmt.filtering import paginate
 
 
 def get_rfiles(caseid):
@@ -45,18 +46,8 @@ def get_paginated_evidences(case_identifier, pagination_parameters: PaginationPa
     query = CaseReceivedFile.query.filter(
         CaseReceivedFile.case_id == case_identifier
     )
-    order_func = convert_sort_direction(pagination_parameters.get_direction())
 
-    order_by = pagination_parameters.get_order_by()
-    column = getattr(CaseReceivedFile, order_by)
-
-    query = query.order_by(order_func(column))
-
-    return query.paginate(
-        page=pagination_parameters.get_page(),
-        per_page=pagination_parameters.get_per_page(),
-        error_out=False
-    )
+    return paginate(CaseReceivedFile, pagination_parameters, query)
 
 
 def add_rfile(evidence: CaseReceivedFile, caseid, user_id):

source/app/datamgmt/filtering.py

@@ -209,11 +209,15 @@ def get_filtered_data(model,
             log.exception(e)
             raise BusinessProcessingError(f'Error parsing custom_conditions: {e}')
 
-    # Apply ordering if requested.
+    return paginate(model, pagination_parameters, query)
+
+
+def paginate(model, pagination_parameters: PaginationParameters, query):
     order_by = pagination_parameters.get_order_by()
     if order_by is not None and hasattr(model, order_by):
         order_func = convert_sort_direction(pagination_parameters.get_direction())
-        query = query.order_by(order_func(getattr(model, order_by)))
+        column = getattr(model, order_by)
+        query = query.order_by(order_func(column))
 
     # Paginate and return the results.
     result = query.paginate(

tests/tests_rest_notes_directories.py

@@ -276,6 +276,13 @@ def test_get_notes_directories_filter_should_return_total(self):
         self._subject.create(f'/api/v2/cases/{case_identifier}/notes-directories', body).json()
 
         response = self._subject.get(f'/api/v2/cases/{case_identifier}/notes-directories').json()
-
         self.assertEqual(1, response['total'])
 
+    def test_get_notes_directories_filter_should_accept_per_page_query_parameter(self):
+        case_identifier = self._subject.create_dummy_case()
+        body = {'name': 'directory_name'}
+        self._subject.create(f'/api/v2/cases/{case_identifier}/notes-directories', body).json()
+        self._subject.create(f'/api/v2/cases/{case_identifier}/notes-directories', body).json()
+
+        response = self._subject.get(f'/api/v2/cases/{case_identifier}/notes-directories', {'per_page': 1}).json()
+        self.assertEqual(1, len(response['data']))