Add service document endpoint

debian/control

@@ -6,7 +6,10 @@ Build-Depends: debhelper (>= 9),
                dh-python,
                python3-all,
                python3-aiohttp,
-               python3-swh.core,
+               python3-swh.core (>= ~0.0.14),
+               python3-defusedxml,
+               python3-jinja2,
+               python3-click,
                python3-vcversioner
 Standards-Version: 3.9.6
 Homepage: https://forge.softwareheritage.org/diffusion/<PHABRICATOR_CALLSIGN>/

requirements.txt

@@ -4,5 +4,7 @@
 vcversioner
 
 aiohttp
+defusedxml
+jinja
 retrying
 click

swh/sword/server.py → swh/deposit/server.py

@@ -6,73 +6,73 @@
 import asyncio
 import aiohttp.web
 import click
-import json
-import multidict
+import jinja2
 
 from swh.core import config
-from swh.core.api_async import (SWHRemoteAPI, decode_request)
+from swh.core.api_async import SWHRemoteAPI
 
 
 DEFAULT_CONFIG = {
     'host': ('str', '0.0.0.0'),
     'port': ('int', 5012),
+    'max_upload_size': ('int', 200 * 1024 * 1024)
 }
 
 
-def encode_data(data, **kwargs):
+template_loader = jinja2.FileSystemLoader(
+    searchpath=["swh/deposit/templates"])
+template_env = jinja2.Environment(loader=template_loader)
+
+
+def encode_data(data, template_name=None, **kwargs):
     return aiohttp.web.Response(
-        body=json.dumps(data),
-        headers=multidict.MultiDict({'Content-Type': 'application/json'}),
+        body=data,
+        headers={'Content-Type': 'application/xml'},
         **kwargs
     )
 
 
 @asyncio.coroutine
 def index(request):
-    return aiohttp.web.Response(text='SWH SWORD Server')
-
-
-@asyncio.coroutine
-def hello(request):
-    name = request.match_info.get('name', "Anonymous")
-    text = "Hello, %s\n" % name
-    return aiohttp.web.Response(text=text)
+    return aiohttp.web.Response(text='SWH Deposit Server')
 
 
 @asyncio.coroutine
-def service_document():
-    pass
+def service_document(request):
+    tpl = template_env.get_template('service_document.xml')
+    output = tpl.render(
+        noop=True, verbose=False, max_upload_size=200*1024*1024)
+    return encode_data(data=output)
 
 
 @asyncio.coroutine
-def create_document():
+def create_document(request):
     pass
 
 
 @asyncio.coroutine
-def update_document():
+def update_document(request):
     pass
 
 
 @asyncio.coroutine
-def status_operation():
+def status_operation(request):
     pass
 
 
 @asyncio.coroutine
-def delete_document():
+def delete_document(request):
     raise ValueError('Not implemented')
 
 
 def make_app(config, **kwargs):
     app = SWHRemoteAPI(**kwargs)
-    app.router.add_route('GET', '/', index)
-    app.router.add_route('GET', '/{name}', hello)
-    app.router.add_route('GET', '/v1/software/', service_document)
-    app.router.add_route('GET', '/v1/status/', status_operation)
-    app.router.add_route('POST', '/v1/software/', create_document)
-    app.router.add_route('PUT', '/v1/software/', update_document)
-    app.router.add_route('DELETE', '/v1/software/', delete_document)
+    app.router.add_route('GET',    '/', index)
+    app.router.add_route('GET',    '/api/1/deposit/', service_document)
+    app.router.add_route('GET',    '/api/1/status/', status_operation)
+    app.router.add_route('POST',   '/api/1/deposit/', create_document)
+    app.router.add_route('PUT',    '/api/1/deposit/', update_document)
+    app.router.add_route('DELETE', '/api/1/deposit/', delete_document)
     app.update(config)
     return app
 

swh/sword/templates/service_document.xml → swh/deposit/templates/service_document.xml

@@ -5,25 +5,22 @@
     xmlns="http://www.w3.org/2007/app">
 
     <sword:version>2.0</sword:version>
-    <sword:maxUploadSize>${max_upload_size}</sword:maxUploadSize>
-    <!-- <sword:verbose>true</sword:verbose> -->
-    <!-- <sword:noOp>true</sword:noOp> -->
+    <sword:maxUploadSize>{{ max_upload_size }}</sword:maxUploadSize>
+    <sword:verbose>{{ verbose }}</sword:verbose>
+    <sword:noOp>{{ noop }}</sword:noOp>
 
     <workspace>
         <atom:title>The Software Heritage (SWH) archive</atom:title>
 
-        <collection href="https://sword.softwareherigage.org/v1/software/">
-            <atom:title>SWH Software Collection</atom:title>
-            <accept>application/zip</accept>
+        <collection href="https://sword.softwareherigage.org/v1/deposit/">
+            <atom:title>SWH Software Archive</atom:title>
             <accept>application/gzip</accept>
-            <accept alternate="multipart-related">application/zip</accept>
             <accept alternate="multipart-related">application/gzip</accept>
             <sword:collectionPolicy>Collection Policy</sword:collectionPolicy>
-            <dcterms:abstract>Software Heritage's software collection</dcterms:abstract>
-            <sword:mediation>true</sword:mediation>
-            <sword:treatment>Treatment description</sword:treatment>
+            <dcterms:abstract>Software Heritage Archive</dcterms:abstract>
+            <sword:mediation>false</sword:mediation>
             <sword:acceptPackaging>http://purl.org/net/sword/package/SimpleZip</sword:acceptPackaging>
-            <sword:service>https://sword.softwareheritage.org/v1/software/</sword:service>
+            <sword:service>https://sword.softwareheritage.org/v1/deposit/</sword:service>
         </collection>
     </workspace>
 </service>