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/superevents/api/paginators.py

 from rest_framework import pagination
 from rest_framework.response import Response
 
+import urllib
 from collections import OrderedDict
 
 import logging
 logger = logging.getLogger(__name__)
 
+# TP (30 Apr 2018):
+# This module has a bunch of hacked together pagination which is intended
+# to match the existing "pagination" of the events API.  We should definitely
+# redo both APIs to do something reasonable and consistent when we have a
+# chance.
+
 
 def BasePaginationFactory(links_dict=True, results_name='results'):
     class CustomBasePagination(pagination.PageNumberPagination):
@@ -53,3 +60,37 @@ class CustomLogTagPagination(pagination.PageNumberPagination):
         ])
 
         return Response(output)
+
+
+class CustomSupereventPagination(pagination.LimitOffsetPagination):
+    default_limit = 3
+    limit_query_param = 'count'
+    offset_query_param = 'start'
+
+    def get_paginated_response(self, data):
+        numRows = self.count
+
+        # Get base URI
+        base_uri = self.request.build_absolute_uri(self.request.path)
+
+        # Construct custom link for "last" page
+        last = max(0, (numRows / self.limit)) * self.limit
+        param_dict = {
+            'start': last,
+            self.limit_query_param: self.limit,
+        }
+        last_uri = base_uri + '?' + urllib.urlencode(param_dict)
+
+        output = OrderedDict([
+            ('numRows', numRows),
+            ('superevents', data),
+            ('links',
+                OrderedDict([
+                    ('self', self.request.build_absolute_uri()),
+                    ('next', self.get_next_link()),
+                    ('previous', self.get_previous_link()),
+                    ('first', base_uri),
+                    ('last', last_uri),
+                ])),
+        ])
+        return Response(output)