Initial account list endpoint

This adds an account listing endpoint to an event that serializes the accounts within the event and annotates them with total number of inconsistencies (evaluators hit), and months of data for the account.

I've added these annotations to the `AccountActivityQuerySet` object management for `AccountActivity` (which is defined in `evaluate_m2`), so they're available on any `AccountActivity.objects` query.

Author: willbarton

django/evaluate_m2/managers.py

@@ -1,5 +1,6 @@
 from django.db import models
-from django.db.models import Q
+from django.db.models import Count, IntegerField, OuterRef, Q, Subquery, Value
+from django.db.models.functions import Coalesce, TruncMonth
 
 
 class AccountActivityQuerySet(models.QuerySet):
@@ -9,3 +10,49 @@ def no_previous_bankruptcy_indicators(self):
                 Q(previous_values__cons_info_ind_assoc__isnull=True)
             ) & Q(previous_values__cons_info_ind='')
         )
+
+    def with_inconsistency_counts(self, event):
+        from evaluate_m2.models import EvaluatorResult
+
+        # Subquery for the number of inconsistencies (evaluators hit) for
+        # each account. This is just a count of hits.
+        subquery = EvaluatorResult.objects.filter(
+            result_summary__event=event,
+            acct_num=OuterRef("cons_acct_num"),
+        ).order_by().values("acct_num").annotate(
+            n=Count("result_summary__evaluator_id", distinct=True),
+        ).values("n")[:1]
+
+        return self.annotate(
+            total_inconsistencies=Coalesce(
+                Subquery(subquery, output_field=IntegerField()),
+                Value(0),
+            ),
+        )
+
+    def with_months_of_data(self, event):
+        # Subquery for the number of months of data. This counts **distinct**
+        # months, not the number of months in the total range.
+        # I.e. if there's data for Feb, March, and May, but not April, that's
+        # three months of data, not four.
+        subquery = self.model._default_manager.filter(
+            data_file__event=event,
+            cons_acct_num=OuterRef("cons_acct_num"),
+        ).order_by().annotate(
+            month=TruncMonth("activity_date"),
+        ).values("cons_acct_num").annotate(
+            n=Count("month", distinct=True),
+        ).values("n")[:1]
+
+        return self.annotate(
+            months_of_data=Coalesce(
+                Subquery(subquery, output_field=IntegerField()),
+                Value(0),
+            )
+        )
+
+    def distinct_accounts(self):
+        return self.order_by(
+            "cons_acct_num",
+            "-activity_date",
+        ).distinct("cons_acct_num")

django/evaluate_m2/serializers.py

@@ -6,8 +6,8 @@
     parse_fields_from_csv,
     plain_to_code_field_map,
 )
-
-from .models import EvaluatorMetadata, EvaluatorResultSummary
+from evaluate_m2.models import EvaluatorMetadata, EvaluatorResultSummary
+from parse_m2.serializers import AccountActivitySerializer
 
 
 class EventsViewSerializer(serializers.ModelSerializer):
@@ -224,3 +224,14 @@ def validate(self, data):
         if invalid_fields:
             raise serializers.ValidationError(f"Invalid field names: {invalid_fields}")
         return data
+
+
+class AccountListSerializer(AccountActivitySerializer):
+    total_inconsistencies = serializers.IntegerField(read_only=True)
+    months_of_data = serializers.IntegerField(read_only=True)
+
+    class Meta(AccountActivitySerializer.Meta):
+        default_fields = list(AccountActivitySerializer.Meta.default_fields) + [
+            "total_inconsistencies",
+            "months_of_data",
+        ]

django/evaluate_m2/urls.py

@@ -9,9 +9,11 @@
          eval_views.download_evaluator_results_csv),
     path('<int:event_id>/evaluator/<str:evaluator_id>/',
          eval_views.EvaluatorResultsView().as_view()),
+    path('<int:event_id>/account/',
+        eval_views.AccountsListView().as_view()),
     path('<int:event_id>/account/<str:account_number>/',
-         eval_views.account_summary_view),
+        eval_views.account_summary_view),
     path('<int:event_id>/account/<str:account_number>/account_holder/',
-         eval_views.account_pii_view),
+        eval_views.account_pii_view),
      path('<int:event_id>/', eval_views.events_view),
 ]

django/evaluate_m2/views.py

@@ -24,6 +24,7 @@
 )
 from evaluate_m2.pagination import EvaluatorResultsPaginator
 from evaluate_m2.serializers import (
+    AccountListSerializer,
     EvaluatorMetadataSerializer,
     EventsViewSerializer,
 )
@@ -58,6 +59,7 @@ def download_evaluator_metadata_csv(request):
 
     return response
 
+
 @api_view(('GET',))
 def download_evaluator_results_csv(request, event_id, evaluator_id):
     logger = logging.getLogger('views.download_evaluator_results_csv')
@@ -131,6 +133,7 @@ def account_summary_view(request, event_id, account_number):
         logger.error(error['message'])
         return Response(error, status=status.HTTP_404_NOT_FOUND)
 
+
 @api_view(('GET',))
 def account_pii_view(request, event_id, account_number):
     logger = logging.getLogger('views.account_pii_view')
@@ -153,6 +156,7 @@ def account_pii_view(request, event_id, account_number):
         logger.error(error['message'])
         return Response(error, status=status.HTTP_404_NOT_FOUND)
 
+
 @api_view()
 def events_view(request, event_id):
     logger = logging.getLogger('views.evaluator_results_view')
@@ -188,6 +192,7 @@ def events_view(request, event_id):
         logger.error(error['message'])
         return Response(error, status=status.HTTP_404_NOT_FOUND)
 
+
 ###########################################
 ## Helper methods for eval results when S3_ENABLED == True
 def fetch_csv_results_from_s3(request, event_id, evaluator_id):
@@ -209,6 +214,7 @@ def fetch_csv_results_from_s3(request, event_id, evaluator_id):
             logger.error(error['message'])
             return Response(error, status=status.HTTP_404_NOT_FOUND)
 
+
 def fetch_json_results_from_s3(request, event_id, evaluator_id):
     logger = logging.getLogger('views.fetch_json_results_from_s3')
     s3 = s3_session()
@@ -319,3 +325,44 @@ def list(self, request, *args, **kwargs):
             many=True,
         )
         return self.get_paginated_response(serializer.data)
+
+
+
+
+class AccountsListView(generics.ListAPIView):
+    filter_backends = [
+        django_filters.rest_framework.DjangoFilterBackend,
+    ]
+    # filterset_class = EvaluatorResultFilterSet
+
+    def get_queryset(self):
+        event_id = self.kwargs["event_id"]
+        event = Metro2Event.objects.get(id=event_id)
+
+        queryset = event.get_all_account_activity().select_related(
+            "k2",
+            "k4",
+            "l1"
+        ).with_inconsistency_counts(
+            event
+        ).with_months_of_data(
+            event
+        )
+
+        return queryset
+
+    def list(self, request, *args, **kwargs):
+        event_id = self.kwargs["event_id"]
+        event = Metro2Event.objects.get(id=event_id)
+
+        # TODO: replace using DRF permissions/check_permissions()
+        if not has_permissions_for_request(request, event):
+            return HttpResponse('Unauthorized', status=401)
+
+        queryset = self.filter_queryset(
+            self.get_queryset()
+        ).distinct_accounts()
+
+        # Paginate the results
+        serializer = AccountListSerializer(queryset, many=True)
+        return Response(serializer.data)