Create API endpoint for proximity analysis

backend/app/analysis/proximity.py

@@ -32,7 +32,6 @@ def run_analysis(corpus_id, word_window):
             genders,
             word_window
         )
-        breakpoint()
 
     return results
 
@@ -55,12 +54,12 @@ def generate_gender_token_counters(pos_tags, genders, word_window):
     results = {}
 
     for gender in genders:
-        results[gender] = dict()
+        results[str(gender)] = dict()
 
         for PRONOUN_TYPE in PronounSeries.PRONOUN_TYPES:
             pronoun_set = gender.pronoun_series.values_list(PRONOUN_TYPE, flat=True)
             doc_result = generate_token_counter(pos_tags, pronoun_set, word_window)
-            results[gender][PRONOUN_TYPE] = doc_result
+            results[str(gender)][PRONOUN_TYPE] = doc_result
 
     return results
 

backend/app/analysis/proximity_test.py

@@ -0,0 +1,18 @@
+from ..models import Document, Corpus
+from rest_framework.test import APIRequestFactory
+from app.views import add_proximity_analysis
+
+
+def proximity_view_test(text):
+    """A function for testing the proximity analysis posting,
+    check api/all_proximity to see the updates list
+    """
+    c1 = Corpus(title="Corpus Test", description="This is the testing corpus")
+    c1.save()
+    Document.objects.create_document(title='document_1', year=2021, text=text)
+    d1 = Document.objects.get(title='document_1')
+    c1.documents.add(d1)
+    factory = APIRequestFactory()
+    request = factory.post('api/all_proximity', {'word_window': '2', 'corpus_id': c1.id})
+    add_proximity_analysis(request)
+

backend/app/views.py

@@ -20,23 +20,24 @@
     'component_name': 'ExampleId'
 }
 """
-import json
 
 from rest_framework.decorators import api_view
 from rest_framework.response import Response
 from django.shortcuts import render
 from .models import (
     Document,
     Gender,
-    Corpus
+    Corpus,
+    ProximityAnalysis
 )
 from .serializers import (
     DocumentSerializer,
     SimpleDocumentSerializer,
     GenderSerializer,
-    CorpusSerializer
+    CorpusSerializer,
+    ProximityAnalysisSerializer,
 )
-
+from .analysis.proximity import run_analysis
 
 @api_view(['GET'])
 def get_example(request, example_id):
@@ -243,6 +244,43 @@ def get_corpus(request, corpus_id):
     return Response(serializer.data)
 
 
+@api_view(['GET'])
+def all_proximity(request):
+    prox_objs = ProximityAnalysis.objects.all()
+    serializer = ProximityAnalysisSerializer(prox_objs, many=True)
+    return Response(serializer.data)
+
+
+@api_view(['POST'])
+def add_proximity_analysis(request):
+    """
+    API endpoint for posting the proximity analysis
+    """
+    attributes = request.data
+    corpus_id = int(attributes['corpus_id'])
+    word_window = int(attributes['word_window'])
+
+    proximity_query = ProximityAnalysis.objects.filter(corpus__id=corpus_id, word_window=word_window)
+
+    if proximity_query.exists():
+        proximity_obj = proximity_query.get()
+
+    else:
+        results = run_analysis(corpus_id, word_window)
+        fields = {
+            'corpus': Corpus.objects.get(pk=corpus_id),
+            'word_window': word_window,
+            'results': results,
+        }
+
+        proximity_obj = ProximityAnalysis.objects.create(**fields)
+        gender_ids = list(Gender.objects.values_list('pk', flat=True))
+        proximity_obj.genders.add(*gender_ids)
+
+    serializer = ProximityAnalysisSerializer(proximity_obj)
+    return Response(serializer.data)
+
+
 def corpora(request):
     """
     Corpora page
@@ -274,4 +312,3 @@ def corpus(request, corpus_id):
     }
 
     return render(request, 'index.html', context)
-

backend/config/urls.py

@@ -35,6 +35,8 @@
     path('api/update_corpus_docs', views.update_corpus_docs),
     path('api/delete_corpus', views.delete_corpus),
     path('api/corpus/<int:corpus_id>', views.get_corpus),
+    path('api/proximity', views.add_proximity_analysis),
+    path('api/all_proximity', views.all_proximity),
 
     # View paths
     path('', views.index, name='index'),