Split topics into three: "project", "wn", and a "virtual" combination

Based on what we discussed in #291

Author: ptgolden

editorsnotes/api/ld.py

@@ -10,6 +10,7 @@
     ('itm', 'http://spi-fm.uca.es/spdef/models/genericTools/itm/1.0#'),
     ('rdf', 'http://www.w3.org/1999/02/22-rdf-syntax-ns#'),
     ('schema', 'http://schema.org/'),
+    ('vaem', 'http://www.linkedmodel.org/schema/vaem#'),
     ('xsd', 'http://www.w3.org/2001/XMLSchema#'),
     ('wn', ROOT_NAMESPACE),
 ))
@@ -25,6 +26,11 @@
         ('@id', '@graph'),
         ('@container', '@index'),
     ))),
+    ('aspects', 'vaem:hasAspect'),
+    ('data', OrderedDict((
+        ('@id', '@graph'),
+        ('@container', '@index'),
+    ))),
     ('display_name', 'schema:name'),
     ('embedded', OrderedDict((
         ('@id', '@graph'),

editorsnotes/api/serializers/topics.py

@@ -1,25 +1,69 @@
 from rest_framework import serializers
+from rest_framework.reverse import reverse
 
 from editorsnotes.main.models import Topic
 
 from .. import fields
-from ..ld import ROOT_NAMESPACE
 from ..validators import UniqueToProjectValidator
 
 from .mixins import EmbeddedItemsMixin, RelatedTopicSerializerMixin
 
 
-__all__ = ['TopicSerializer']
+__all__ = ['TopicSerializer', 'ENTopicSerializer']
 
 
-class TopicSerializer(RelatedTopicSerializerMixin, EmbeddedItemsMixin,
-                      serializers.ModelSerializer):
+class TopicSerializer(EmbeddedItemsMixin, serializers.ModelSerializer):
     url = fields.IdentityURLField(view_name='api:topics-detail')
-    type = serializers.SerializerMethodField()
+    data = serializers.SerializerMethodField()
+    aspects = serializers.SerializerMethodField()
     project = fields.HyperlinkedAffiliatedProjectField(
         default=fields.CurrentProjectDefault())
     updaters = fields.UpdatersField()
 
+    class Meta:
+        model = Topic
+        fields = (
+            'url',
+            'project',
+            'updaters',
+            'created',
+            'last_updated',
+            'aspects',
+            'data',
+
+        )
+        embedded_fields = (
+            'project',
+            'updaters',
+        )
+
+    def get_aspects(self, obj):
+        return [
+            reverse('api:topics-wn-detail',
+                    args=[obj.project.slug, obj.pk],
+                    request=self.context['request']),
+            reverse('api:topics-proj-detail',
+                    args=[obj.project.slug, obj.pk],
+                    request=self.context['request'])
+        ]
+
+    def get_data(self, obj):
+        en_topic_url, project_topic_url = self.get_aspects(obj)
+        return {
+            en_topic_url: {
+                "@id": en_topic_url,
+                "@graph": ENTopicSerializer(obj, context=self.context).data
+            },
+            project_topic_url: {
+                "@id": project_topic_url,
+                "@graph": {}
+            }
+        }
+
+
+class ENTopicSerializer(RelatedTopicSerializerMixin, EmbeddedItemsMixin,
+                        serializers.ModelSerializer):
+    url = fields.IdentityURLField(view_name='api:topics-detail')
     related_topics = fields.TopicAssignmentField(many=True)
 
     references = fields.UnqualifiedURLField(
@@ -30,37 +74,21 @@ class TopicSerializer(RelatedTopicSerializerMixin, EmbeddedItemsMixin,
     class Meta:
         model = Topic
         fields = (
-            'id',
             'url',
-            'type',
-            'project',
-
             'preferred_name',
-
-            'created',
-            'last_updated',
-            'updaters',
-
-            'types',
-            'same_as',
             'alternate_names',
 
+            'related_topics',
+
             'markup',
             'markup_html',
 
-            'related_topics',
             'references',
             'referenced_by',
         )
         embedded_fields = (
-            'project',
-            'updaters',
-
             'related_topics',
             'references',
             'referenced_by',
         )
         validators = [UniqueToProjectValidator('preferred_name')]
-
-    def get_type(self, obj):
-        return ROOT_NAMESPACE + 'Topic'

editorsnotes/api/tests/serializers.py

@@ -48,7 +48,8 @@ def get_project_url(self, obj):
         )
 
         data = json.loads(JSONRenderer().render(test_serializer.data))
-        project_data = json.loads(JSONRenderer().render(project_serializer.data))
+        project_data = json.loads(
+            JSONRenderer().render(project_serializer.data))
 
         self.assertEqual(data, {
             'project_url': project_url,
@@ -92,10 +93,66 @@ def test_document_serializer(self):
         )
 
         self.assertEqual(
-            self.dummy_request.build_absolute_uri(transcript.get_absolute_url()),
+            self.dummy_request.build_absolute_uri(
+                transcript.get_absolute_url()),
             transcript_url)
 
         serializer = en_serializers.DocumentSerializer(
             instance=self.document, context=self.context,
             include_embeds=True)
         self.assertNotEqual(serializer.data['embedded'][transcript_url], None)
+
+
+class TopicSerializerTestCase(ClearContentTypesTransactionTestCase):
+    fixtures = ['projects.json']
+
+    def setUp(self):
+        self.dummy_request = RequestFactory().get('/')
+        self.context = {'request': self.dummy_request}
+
+        self.project = Project.objects.get(slug='emma')
+        self.user = self.project.members.get()
+
+        self.topic = main_models.Topic.objects.create(
+            creator=self.user,
+            last_updater=self.user,
+            project=self.project,
+            preferred_name='Emma Goldman'
+        )
+
+    def test_topic_serializer(self):
+        serializer = en_serializers.TopicSerializer(
+            instance=self.topic,
+            context=self.context,
+            include_embeds=True
+        )
+
+        base_url = self.dummy_request.build_absolute_uri(
+            self.topic.get_absolute_url())
+        wn_topic_url = base_url + 'w/'
+        project_topic_url = base_url + 'p/'
+
+        self.assertEqual(serializer.data['url'], base_url)
+        self.assertListEqual(serializer.data['aspects'], [
+            wn_topic_url,
+            project_topic_url
+        ])
+
+        self.assertDictEqual(serializer.data['data'][wn_topic_url], {
+            "@id": wn_topic_url,
+            "@graph": {
+                "url": base_url,
+                "preferred_name": "Emma Goldman",
+                "alternate_names": [],
+                "related_topics": [],
+                "markup": None,
+                "markup_html": None,
+                "references": [],
+                "referenced_by": []
+            }
+        })
+
+        self.assertDictEqual(serializer.data['data'][project_topic_url], {
+            "@id": project_topic_url,
+            "@graph": {}
+        })

editorsnotes/api/urls.py

@@ -35,6 +35,8 @@ def format_patterns(urlpatterns):
     ### Topics ###
     url(r'^/topics/$', views.TopicList.as_view(), name='topics-list'),
     url(r'^/topics/(?P<pk>\d+)/$', views.TopicDetail.as_view(), name='topics-detail'),
+    url(r'^/topics/(?P<pk>\d+)/w/$', views.ENTopicDetail.as_view(), name='topics-wn-detail'),
+    url(r'^/topics/(?P<pk>\d+)/p/$', views.TopicDetail.as_view(), name='topics-proj-detail'),
     url(r'^/topics/(?P<pk>\d+)/confirm_delete$', views.TopicConfirmDelete.as_view(), name='topics-confirm-delete'),
 
     ### Notes ###

editorsnotes/api/views/topics.py

@@ -1,13 +1,18 @@
 from editorsnotes.main.models import Topic
 
 from .. import filters as es_filters
-from ..serializers.topics import TopicSerializer
+from ..serializers.topics import TopicSerializer, ENTopicSerializer
 
 from .base import BaseListAPIView, BaseDetailView, DeleteConfirmAPIView
 from .mixins import (ElasticSearchListMixin, EmbeddedReferencesMixin,
                      HydraAffordancesMixin)
 
-__all__ = ['TopicList', 'TopicDetail', 'TopicConfirmDelete']
+__all__ = [
+    'TopicList',
+    'TopicDetail',
+    'ENTopicDetail',
+    'TopicConfirmDelete'
+]
 
 
 class TopicList(ElasticSearchListMixin, BaseListAPIView):
@@ -28,6 +33,13 @@ class TopicDetail(EmbeddedReferencesMixin, HydraAffordancesMixin,
     hydra_project_perms = ('main.change_topic', 'main.delete_topic',)
 
 
+class ENTopicDetail(EmbeddedReferencesMixin, HydraAffordancesMixin,
+                    BaseDetailView):
+    queryset = Topic.objects.all()
+    serializer_class = ENTopicSerializer
+    hydra_project_perms = ('main.change_topic', 'main.delete_topic',)
+
+
 class TopicConfirmDelete(DeleteConfirmAPIView):
     queryset = Topic.objects.all()
     permissions = {