Implements /api/appauth/authortools API endpoint. Fixes ietf-tools#3396. Commit ready for merge.

kesara · kesara · commit dc833aa85c09 · 2021-09-06T11:42:16.000Z
- Legacy-Id: 19344
diff --git a/ietf/api/tests.py b/ietf/api/tests.py
@@ -355,14 +355,33 @@ def test_api_new_meeting_registration(self):
         missing_fields = [ f.strip() for f in fields.split(',') ]
         self.assertEqual(set(missing_fields), set(drop_fields))
 
-
     def test_api_version(self):
         url = urlreverse('ietf.api.views.version')
         r = self.client.get(url)
         data = r.json()
         self.assertEqual(data['version'], ietf.__version__+ietf.__patch__)
         self.assertIn(data['date'], ietf.__date__)
 
+    def test_api_appauth_authortools(self):
+        url = urlreverse('ietf.api.views.author_tools')
+        person = PersonFactory()
+        apikey = PersonalApiKey.objects.create(endpoint=url, person=person)
+
+        # error cases
+        # missing apikey
+        r = self.client.post(url, {})
+        self.assertContains(r, 'Missing apikey parameter', status_code=400)
+
+        # invalid apikey
+        r = self.client.post(url, {'apikey': 'foobar'})
+        self.assertContains(r, 'Invalid apikey', status_code=403)
+
+        # working case
+        r = self.client.post(url, {'apikey': apikey.hash()})
+        self.assertEqual(r.status_code, 200)
+        jsondata = r.json()
+        self.assertEqual(data['success'], True)
+
 
 class TastypieApiTestCase(ResourceTestCaseMixin, TestCase):
     def __init__(self, *args, **kwargs):
diff --git a/ietf/api/urls.py b/ietf/api/urls.py
@@ -40,6 +40,8 @@
     url(r'^submit/?$', submit_views.api_submit),
     # Datatracker version
     url(r'^version/?$', api_views.version),
+    # Authtools API key
+    url(r'^appauth/authortools', api_views.author_tools),
 ]
 
 # Additional (standard) Tastypie endpoints
diff --git a/ietf/api/views.py b/ietf/api/views.py
@@ -215,3 +215,10 @@ def version(request):
                 content_type='application/json',
             )
     
+
+@require_api_key
+@csrf_exempt
+def author_tools(request):
+    return HttpResponse(
+            json.dumps({'success': True}),
+            content_type='application/json')
diff --git a/ietf/person/models.py b/ietf/person/models.py
@@ -368,6 +368,7 @@ def salt():
     ("/api/meeting/session/video/url", "/api/meeting/session/video/url", "Recording Manager"),
     ("/api/notify/meeting/registration", "/api/notify/meeting/registration", "Robot"), 
     ("/api/notify/meeting/bluesheet", "/api/notify/meeting/bluesheet", "Recording Manager"), 
+    ("/api/appauth/authortools", "/api/appauth/authortools", None),
 ]
 PERSON_API_KEY_ENDPOINTS = sorted(list(set([ (v, n) for (v, n, r) in PERSON_API_KEY_VALUES ])))
 

Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,8 @@`
`40`	`40`	`url(r'^submit/?$', submit_views.api_submit),`
`41`	`41`	`# Datatracker version`
`42`	`42`	`url(r'^version/?$', api_views.version),`
	`43`	`+ # Authtools API key`
	`44`	`+ url(r'^appauth/authortools', api_views.author_tools),`
`43`	`45`	`]`
`44`	`46`
`45`	`47`	`# Additional (standard) Tastypie endpoints`
Original file line number	Diff line number	Diff line change
`@@ -368,6 +368,7 @@ def salt():`
`368`	`368`	`("/api/meeting/session/video/url", "/api/meeting/session/video/url", "Recording Manager"),`
`369`	`369`	`("/api/notify/meeting/registration", "/api/notify/meeting/registration", "Robot"),`
`370`	`370`	`("/api/notify/meeting/bluesheet", "/api/notify/meeting/bluesheet", "Recording Manager"),`
	`371`	`+ ("/api/appauth/authortools", "/api/appauth/authortools", None),`
`371`	`372`	`]`
`372`	`373`	`PERSON_API_KEY_ENDPOINTS = sorted(list(set([ (v, n) for (v, n, r) in PERSON_API_KEY_VALUES ])))`
`373`	`374`