Serializers

.github/workflows/ci.yml

@@ -49,7 +49,7 @@ jobs:
     - name: Run Django tests
       run: |
         cd backend
-        python manage.py test
+        python manage.py test apps.main
 
   analysis_tests:
     runs-on: ubuntu-latest
@@ -63,7 +63,7 @@ jobs:
       run: |
         pip install -r requirements.txt
         python setup.py develop
-        
+
     - name: Run analysis tests
       run: |
         cd analysis

README.md

@@ -12,6 +12,18 @@ To create or update Django databases, run in terminal (in the backend folder):
 2. python manage.py migrate
 
 Note: 
-- the api does not work at (http://127.0.0.1:8000/api/) as it's not set up for this repo.  You can skip the step.
 - there is no `frontend/src/App.js`. Use `frontend/src/main/main.js`
 instead.
+
+The api is functional: (http://127.0.0.1:8000/api/person_info/)
+
+If you would like to find a person through the API,
+paste the above url, followed by:
+
+?full_name=Relevant Person Name
+
+If the person is not in the database, 
+the API will return an "empty" person whose full name will be
+shown as: Relevant Person Name not found.
+Otherwise, a dictionary with the information in the
+database associated with that person will be returned.

backend/apps/main/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 2.2.4 on 2019-10-25 20:15
+# Generated by Django 2.2.4 on 2019-12-06 22:05
 
 from django.db import migrations, models
 
@@ -11,6 +11,20 @@ class Migration(migrations.Migration):
     ]
 
     operations = [
+        migrations.CreateModel(
+            name='DjangoPerson',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('last', models.CharField(max_length=250)),
+                ('first', models.CharField(max_length=250)),
+                ('middle', models.CharField(max_length=250)),
+                ('full_name', models.CharField(max_length=250, unique=True)),
+                ('most_likely_org', models.CharField(max_length=250)),
+                ('positions', models.TextField()),
+                ('aliases', models.TextField()),
+                ('count', models.IntegerField()),
+            ],
+        ),
         migrations.CreateModel(
             name='Document',
             fields=[
@@ -30,6 +44,8 @@ class Migration(migrations.Migration):
                 ('text', models.TextField(blank=True)),
                 ('tid', models.CharField(max_length=250, unique=True)),
                 ('title', models.CharField(blank=True, max_length=250)),
+                ('authors', models.ManyToManyField(related_name='document_by_authors', to='main.DjangoPerson')),
+                ('recipients', models.ManyToManyField(related_name='document_by_recipients', to='main.DjangoPerson')),
             ],
         ),
     ]

backend/apps/main/models.py

@@ -77,7 +77,6 @@ class Document(models.Model):
         text: TextField, text of the document
         tid: CharField, document ID
         title: CharField, title of the document
-
         authors: ManyToManyField, connect Document and its authors' DjangoPerson objects in database
         recipients: ManyToManyField, connect Document and its recipients' DjangoPerson objects in
         database

backend/apps/main/serializers.py

@@ -3,15 +3,19 @@
 in ways that can be transported across the backend/frontend divide, or
 allow the frontend to suggest changes to the backend/database.
 """
+import json
+from pathlib import Path
 from rest_framework import serializers
+from .models import DjangoPerson
 
 
-class PersonSerializer(serializers.Serializer):
+class EdgeSerializer(serializers.Serializer):
     """
-    Serializer for the Person model
+    Serializer for the Edge model
     """
     pk = serializers.IntegerField(read_only=True)  # pylint: disable=C0103
-    name = serializers.CharField(read_only=True)
+    node1 = serializers.CharField(read_only=True)
+    node2 = serializers.CharField(read_only=True)
     docs = serializers.IntegerField(read_only=True)
     words = serializers.IntegerField(read_only=True)
 
@@ -22,19 +26,66 @@ def update(self, instance, validated_data):
         """ We will not update data using this serializer """
 
 
-class EdgeSerializer(serializers.Serializer):
+class PersonInfoSerializer(serializers.ModelSerializer):
     """
-    Serializer for the Edge model
+    Serializer for the DjangoPerson Info model
     """
-    pk = serializers.IntegerField(read_only=True)  # pylint: disable=C0103
-    node1 = serializers.CharField(read_only=True)
-    node2 = serializers.CharField(read_only=True)
-    docs = serializers.IntegerField(read_only=True)
-    words = serializers.IntegerField(read_only=True)
-
+    class Meta:
+        model = DjangoPerson
+        fields = ["last", "first", "middle", "full_name", "most_likely_org", "positions",
+                  "aliases", "count"]
 
     def create(self, validated_data):
         """ We will not create new objects using this serializer """
 
     def update(self, instance, validated_data):
         """ We will not update data using this serializer """
+
+
+class Edge:
+    """
+    Python object to store edges, should be replaced if the DjangoPerson class is replaced
+    """
+    def __init__(self, pk: int, node1: str, node2: str,  # pylint: disable-msg=R0913
+                 docs: int, words: int):
+        self.pk = pk  # pylint: disable=C0103
+        self.node1 = node1  # could be replaced with DjangoPerson
+        self.node2 = node2
+        self.docs = docs
+        self.words = words
+
+
+def load_network_json_data(return_type: str):
+    """
+    Loads test json data for initial prototyping
+    :param return_type: string, determines which list needs to be determined, has the
+    precondition that it either must be 'nodes' or 'edges'
+    :return: list, contains all of the edges or all of the nodes (people at this point in time)
+    from network_test_data.json
+    """
+    if return_type not in ['nodes', 'edges']:
+        raise ValueError("Specified return type needs to be nodes or edges")
+
+    json_path = Path('/Users/kimba/Documents/GitHub/tobacco_networks/backend', 'data',
+                     'network_test_data.json')
+    with open(json_path) as json_file:
+        data = json.load(json_file)
+    if return_type == "edges":
+        edges = []
+        for edges_dict in data['links']:
+            pk = int(edges_dict.get('id'))  # pylint: disable=C0103
+            node1 = edges_dict.get('node1')
+            node2 = edges_dict.get('node2')
+            docs = edges_dict.get('docs')
+            words = int(edges_dict.get('words'))
+            edges.append(Edge(pk, node1, node2, docs, words))
+        return edges
+    else:
+        people = []
+        for person_dict in data['nodes']:
+            pk = int(person_dict.get('id'))  # pylint: disable=C0103
+            name = person_dict.get('name')
+            docs = person_dict.get('docs')
+            words = int(person_dict.get('words'))
+            people.append(DjangoPerson(pk, name, docs, words))
+        return people