Merge pull request #147 from FAIRDataPipeline/json_ld

Json ld

Author: antony-wilson

data_management/prov.py

@@ -67,6 +67,19 @@ def render(self, data, media_type=None, renderer_context=None):
         return data
 
 
+class JSONLDRenderer(renderers.BaseRenderer):
+    """
+    Custom renderer for returning JSON-LD data.
+    """
+    media_type = 'application/ld+json'
+    format = 'json-ld'
+    charset = 'utf8'
+    render_style = 'text'
+
+    def render(self, data, media_type=None, renderer_context=None):
+        return data
+
+
 class ProvnRenderer(renderers.BaseRenderer):
     """
     Custom renderer for returning PROV-N data (as defined in https://www.w3.org/TR/2013/REC-prov-n-20130430/).
@@ -95,27 +108,32 @@ def render(self, data, media_type=None, renderer_context=None):
 
 class ProvReportView(views.APIView):
     """
-    API view for returning a PROV report for a DataProduct.
+    ***The provenance report for a `DataProduct`.***
+
+    The provenance report can be generated as `JSON`, `JSON-LD`, `XML` or `PROV-N`.
+    Optionally `JPEG` and `SVG` versions of the provenance may be available.
+
+    ### Query parameters:
+
+    `attributes` (optional): A boolean, when `True` (default) show additional
+    attributes of the objects on the image
 
-    This report can be returned as JSON (default) or XML or PROV-N using the custom
-    renderers. In addition if GraphViz is installed then JPEG and SVG renderers are also
-    available.
+    `aspect_ratio` (optional): A float used to define the ratio for the `JPEG` and
+    `SVG` images. The default is 0.71, which is equivalent to A4 landscape.
 
-    This method makes use of the following optional query parameters:
-        aspect_ratio: a float used to define the ratio for images
-        dpi:  a float used to define the dpi for images
-        show_attributes: a boolean, shows attributes of elements when True
+    `dpi` (optional): A float used to define the dpi for the `JPEG` and `SVG` images
 
     """
     try:
         Dot(prog='dot').create()
         # GraphViz is installed so the JPEG and SVG renderers are made available.
         renderer_classes = [renderers.BrowsableAPIRenderer, renderers.JSONRenderer,
-                            JPEGRenderer, SVGRenderer, XMLRenderer, ProvnRenderer]
+                            JSONLDRenderer, JPEGRenderer, SVGRenderer, XMLRenderer,
+                            ProvnRenderer]
     except FileNotFoundError:
         # GraphViz is not installed so the JPEG and SVG renderers are NOT available.
         renderer_classes = [renderers.BrowsableAPIRenderer, renderers.JSONRenderer,
-                            XMLRenderer, ProvnRenderer]
+                            JSONLDRenderer, XMLRenderer, ProvnRenderer]
 
     def get(self, request, pk):
         data_product = get_object_or_404(models.DataProduct, pk=pk)

data_management/rest/views.py

@@ -12,6 +12,7 @@
     StorageRoot,
     Issue,
     Namespace,
+    UserAuthor,
 )
 from django.contrib.auth import get_user_model
 
@@ -23,13 +24,11 @@ def reset_db():
     Namespace.objects.all().delete()
 
 
-def init_db(test=True):
+def init_db():
     user = get_user_model().objects.first()
-
-    if test:
-        get_user_model().objects.create(username="testusera")
-        get_user_model().objects.create(username="testuserb")
-        get_user_model().objects.create(username="testuserc")
+    usera = get_user_model().objects.create(username="testusera")
+    get_user_model().objects.create(username="testuserb")
+    get_user_model().objects.create(username="testuserc")
 
     sr_github = StorageRoot.objects.create(
         updated_by=user,
@@ -132,6 +131,7 @@ def init_db(test=True):
     a1 = Author.objects.create(updated_by=user, name="Ivana Valenti")
     a2 = Author.objects.create(updated_by=user, name="Maria Cipriani")
     a3 = Author.objects.create(updated_by=user, name="Rosanna Massabeti")
+    UserAuthor.objects.get_or_create(updated_by=user, user=usera, author=a1)
 
     o_code = Object.objects.create(updated_by=user, storage_location=sl_code)
     o_code_2 = Object.objects.create(updated_by=user, storage_location=sl_code)
@@ -295,7 +295,7 @@ def init_db(test=True):
     cr2.outputs.set([o_output_3.components.first()])
 
     cr3 = CodeRun.objects.create(
-        updated_by=user,
+        updated_by=usera,
         run_date="2021-07-17T19:21:11Z",
         submission_script=o_script,
     )
@@ -306,5 +306,4 @@ def init_db(test=True):
 
 
 if __name__ == "__main__":
-    # reset_db()
-    init_db(test=False)
+    init_db()