Added /ping to /api/v2

src/publisher/api_v2_urls.py

@@ -2,6 +2,7 @@
 from . import api_v2_views as views
 
 urlpatterns = [
+    url(r'^ping$', views.ping, name='ping'),
     url(r'articles$', views.article_list, name='article-list'),
     url(r'articles/(?P<id>\d+)$', views.article, name='article'),
     url(r'articles/(?P<id>\d+)/versions$', views.article_version_list, name='article-version-list'),

src/publisher/api_v2_views.py

@@ -3,7 +3,8 @@
 from . import models, logic, fragment_logic
 from .utils import ensure, isint, lmap
 from rest_framework import status
-from rest_framework.decorators import api_view
+from rest_framework.decorators import api_view, renderer_classes
+from rest_framework.renderers import StaticHTMLRenderer
 from rest_framework.response import Response
 from django.shortcuts import Http404
 from django.conf import settings
@@ -56,6 +57,13 @@ def is_authenticated(request):
     #LOG.info("authenticated? %s type %s" % (val, type(val)))
     return val or False
 
+@api_view(['GET'])
+@renderer_classes((StaticHTMLRenderer,))
+def ping(request):
+    "returns a test response for monitoring, *never* to be cached"
+
+    return Response('pong', content_type='text/plain; charset=UTF-8', headers={'Cache-Control': 'must-revalidate, no-cache, no-store, private'})
+
 @api_view(['GET'])
 def article_list(request):
     "returns a list of snippets"

src/publisher/tests/test_api_v2_views.py

@@ -116,6 +116,13 @@ def setUp(self):
             mware.CGROUPS: 'admin',
         })
 
+    def test_ping(self):
+        resp = self.c.get(reverse('v2:ping'))
+        self.assertEqual(resp.status_code, 200)
+        self.assertEqual(resp.content_type, 'text/plain; charset=UTF-8')
+        self.assertEqual(resp['Cache-Control'], 'must-revalidate, no-cache, no-store, private')
+        self.assertEqual(resp.content.decode('utf-8'), 'pong')
+
     def test_article_list(self):
         "a list of published articles are returned to an unauthenticated response"
         resp = self.c.get(reverse('v2:article-list'))