views.py

The file is responsible to handle the API request URL endpoints for the OpenRecords application.
The routes are defined to:

Edits the privacy privacy options of a request's title and agency request summary,
Edits the title and agency request summary of a FOIL request through an API PUT method,
Returns a set of events (id, type, and template), ordered by date descending, and starting from a specific index,
Returns a set of responses (id, type, and template), ordered by date descending, and starting from a specified index.

Code Issues

• The function get_request_events() is almost 100 lines and the if loop being long is difficult to follow since it is in a for loop.
• Similary, function get_request_responses() is also too long with a lot of repetitive parameters in functions like filter(), and is_allowed().
  Example: Function is_allowed() is called 6 times in get_request_responses() with only one variant - permission_type (called in another function get_permission() call).
  A separate function can be made which is passed just the permission_type which will inturn call is_allowed function which will fetch from permission_utils.py. This will reduce the number of lines of get_request_responses().
  
  

      
      edit_response_permission=is_allowed(user=current_user,
                                          request_id=response.request_id,
                                          permission=get_permission(permission_type='edit',
                                                                    response_type=type(response))),
      delete_response_permission=is_allowed(user=current_user,
                                            request_id=response.request_id,
                                            permission=get_permission(permission_type='delete',
                                                                      response_type=type(response))),
      edit_response_privacy_permission=is_allowed(user=current_user,
                                                  request_id=response.request_id,
                                                  permission=get_permission(
                                                      permission_type='privacy',
                                                      response_type=type(
                                                          response))),
  
      
      

app/request/api/views.py:221:31: E712 comparison to False should be 'if cond is False:' or 'if not cond:'
app/request/api/views.py:232:31: E712 comparison to False should be 'if cond is False:' or 'if not cond:'
app/request/api/views.py:245:31: E712 comparison to False should be 'if cond is False:' or 'if not cond:'
                        

.. module:: api.request.views.

:synopsis: Handles the API request URL endpoints for the OpenRecords application