Define the REST api top url in settings.py, rather than having literals in multiple places in the code.

 - Legacy-Id: 8751

Author: levkowetz

ietf/api.py

@@ -30,9 +30,11 @@
 def top_level(request):
     available_resources = {}
 
+    apitop = settings.RESTAPI_V1_URL_TOP
+
     for name in sorted([ name for name, api in _api_list if len(api._registry) > 0 ]):
         available_resources[name] = {
-            'list_endpoint': '/api/%s/' % name,
+            'list_endpoint': '/%s/%s/' % (apitop, name),
         }
 
     serializer = Serializer()

ietf/settings.py

@@ -459,6 +459,8 @@ def skip_unreadable_post(record):
 
 POSTCONFIRM_PATH   = "/a/postconfirm/test-wrapper"
 
+RESTAPI_V1_URL_TOP = "api/v1"           # no leading or trailing slash
+
 # Put the production SECRET_KEY in settings_local.py, and also any other
 # sensitive or site-specific changes.  DO NOT commit settings_local.py to svn.
 from settings_local import *            # pyflakes:ignore

ietf/urls.py

@@ -64,10 +64,14 @@
     (r'^googlea30ad1dacffb5e5b.html', TemplateView.as_view(template_name='googlea30ad1dacffb5e5b.html')),
 )
 
+# Endpoints for Tastypie's REST API
+apitop = settings.RESTAPI_V1_URL_TOP
+urlpatterns += patterns('',
+    (r'^%s/?$'%apitop, api.top_level),
+)
 for n,a in api._api_list:
     urlpatterns += patterns('',
-        (r'^api/?$', api.top_level),
-        (r'^api/', include(a.urls)),
+        (r'^%s/'%apitop, include(a.urls)),
     )
 
 if settings.SERVER_MODE in ('development', 'test'):

ietf/utils/tests_restapi.py

@@ -3,6 +3,8 @@
 import debug
 debug.debug = True
 
+from django.conf import settings
+
 from tastypie.test import ResourceTestCase
 from ietf.utils.test_data import make_test_data
 
@@ -32,10 +34,12 @@ def list_recursively(self, resource, format):
 
     def test_json_api_explore(self):
         make_test_data()
-        self.list_recursively('/api/', format='json')
+        apitop = settings.RESTAPI_V1_URL_TOP
+        self.list_recursively('/%s/'%apitop, format='json')
 
     def test_xml_api_explore(self):
-        self.assertValidXMLResponse(self.api_client.get('/api/doc/', format='xml'))
+        apitop = settings.RESTAPI_V1_URL_TOP
+        self.assertValidXMLResponse(self.api_client.get('/%s/doc/'%apitop, format='xml'))
 
     def test_json_doc_document(self):
         """
@@ -44,7 +48,8 @@ def test_json_doc_document(self):
         than 100 documents in the test-data (the current count is 10)
         """
         make_test_data()
-        r = self.api_client.get('/api/doc/document/', format='json', limit=100)
+        apitop = settings.RESTAPI_V1_URL_TOP
+        r = self.api_client.get('/%s/doc/document/'%apitop, format='json', limit=100)
         doclist = self.deserialize(r)["objects"]
         docs = dict( (doc["name"], doc) for doc in doclist )
         for name in (
@@ -63,11 +68,12 @@ def test_json_doc_relationships(self):
         of relationships give URLs which are handled without raising exceptions.
         """
         make_test_data()
-        r = self.api_client.get('/api/doc/document/', format='json')
+        apitop = settings.RESTAPI_V1_URL_TOP
+        r = self.api_client.get('/%s/doc/document/'%apitop, format='json')
         doclist = self.deserialize(r)["objects"]
         for doc in doclist:
             for key in doc:
                 value = doc[key]
-                if isinstance(value, basestring) and value.startswith('/api/'):
+                if isinstance(value, basestring) and value.startswith('/%s/'%apitop):
                     self.api_client.get(value, format='json')