Superevents

Adding superevents to GraceDB, including the necessary models, utility functions, and API resources. This has also resulted in changes to the overall configuration and some parts of the events model.

Many models in the events app, like Labels, Tags, EventLogs, etc. were needed in a similar form for superevents. We were able to completely reuse the existing Label and Tag models for superevents. In other cases, we had to abstract the main functionality of the class into an abstract base class and then implement separate models for events and superevents, due to foreign key requirements. This should leave the current functionality of the events models unchanged.

Some portions of the events API have been modified because of one of the following reasons:

• It didn't make sense and was unnecessarily difficult to duplicate for superevents
• It was inefficient or bad

These changes are documented here: https://bugs.ligo.org/redmine/issues/6133

gracedb/events/api/fields.py

+from rest_framework import serializers
+from django.contrib.auth import get_user_model
+
+from ..models import Event
+
+UserModel = get_user_model()
+
+import logging
+logger = logging.getLogger(__name__)
+
+class GenericField(serializers.Field):
+    # Field, property, or callable of the object which will be used to
+    # generate the representation of the object.
+    to_repr = None
+    lookup_field = 'id'
+    model = None
+
+    def __init__(self, *args, **kwargs):
+        self.to_repr = kwargs.pop('to_repr', self.to_repr)
+        self.lookup_field = kwargs.pop('lookup_field', self.lookup_field)
+        self.model = kwargs.pop('model', self.model)
+
+        assert self.to_repr is not None, ('Must specify to_repr')
+        assert self.model is not None, ('Must specify model')
+        super(GenericField, self).__init__(*args, **kwargs)
+
+    def to_representation(self, obj):
+        value = getattr(obj, self.to_repr)
+
+        # Handle case where we are given a function instead of
+        # a model field or a property
+        if callable(value):
+            value = value()
+        return value
+
+    def to_internal_value(self, data):
+        model_dict = self.get_model_dict(data)
+        try:
+            return self.model.objects.get(**model_dict)
+        except self.model.DoesNotExist:
+            error_msg = '{model} with {lf}={data} does not exist' \
+                .format(model=self.model.__name__, lf=model_dict.keys()[0],
+                data=model_dict.values()[0])
+            raise serializers.ValidationError(error_msg)
+
+    def get_model_dict(self, data):
+        return {self.lookup_field: data}
+
+
+class EventGraceidField(GenericField, serializers.RelatedField):
+    to_repr = 'graceid'
+    lookup_field = 'id'
+    model = Event
+    queryset = Event.objects.all()
+
+    def get_model_dict(self, data):
+        return {self.lookup_field: data[1:]}