Alternative DRY definition of the REST api top URL; this time in ietf/urls.py. This in itself is nicer, but I'm not so sure about the use of reverse() everywhere else, instead of referring to settings.

 - Legacy-Id: 8752

Author: levkowetz

ietf/api.py

@@ -4,6 +4,7 @@
 
 from django.conf import settings
 from django.http import HttpResponse
+from django.core.urlresolvers import reverse
 
 from tastypie.api import Api
 from tastypie.serializers import Serializer
@@ -30,11 +31,11 @@
 def top_level(request):
     available_resources = {}
 
-    apitop = settings.RESTAPI_V1_URL_TOP
+    apitop = reverse('ietf.api.top_level')
 
     for name in sorted([ name for name, api in _api_list if len(api._registry) > 0 ]):
         available_resources[name] = {
-            'list_endpoint': '/%s/%s/' % (apitop, name),
+            'list_endpoint': '%s/%s/' % (apitop, name),
         }
 
     serializer = Serializer()

ietf/settings.py

@@ -459,8 +459,6 @@ 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

@@ -65,13 +65,12 @@
 )
 
 # Endpoints for Tastypie's REST API
-apitop = settings.RESTAPI_V1_URL_TOP
 urlpatterns += patterns('',
-    (r'^%s/?$'%apitop, api.top_level),
+    (r'^api/v1/?$', api.top_level),
 )
 for n,a in api._api_list:
     urlpatterns += patterns('',
-        (r'^%s/'%apitop, include(a.urls)),
+        (r'^api/v1/', include(a.urls)),
     )
 
 if settings.SERVER_MODE in ('development', 'test'):

ietf/utils/tests_restapi.py

@@ -3,13 +3,11 @@
 import debug
 debug.debug = True
 
-from django.conf import settings
+from django.core.urlresolvers import reverse
 
 from tastypie.test import ResourceTestCase
-from ietf.utils.test_data import make_test_data
-
 
-    
+from ietf.utils.test_data import make_test_data
 
 class RestApi(ResourceTestCase):
     def list_recursively(self, resource, format):
@@ -34,12 +32,12 @@ def list_recursively(self, resource, format):
 
     def test_json_api_explore(self):
         make_test_data()
-        apitop = settings.RESTAPI_V1_URL_TOP
-        self.list_recursively('/%s/'%apitop, format='json')
+        apitop = reverse('ietf.api.top_level')
+        self.list_recursively('%s/'%apitop, format='json')
 
     def test_xml_api_explore(self):
-        apitop = settings.RESTAPI_V1_URL_TOP
-        self.assertValidXMLResponse(self.api_client.get('/%s/doc/'%apitop, format='xml'))
+        apitop = reverse('ietf.api.top_level')
+        self.assertValidXMLResponse(self.api_client.get('%s/doc/'%apitop, format='xml'))
 
     def test_json_doc_document(self):
         """
@@ -48,8 +46,8 @@ def test_json_doc_document(self):
         than 100 documents in the test-data (the current count is 10)
         """
         make_test_data()
-        apitop = settings.RESTAPI_V1_URL_TOP
-        r = self.api_client.get('/%s/doc/document/'%apitop, format='json', limit=100)
+        apitop = reverse('ietf.api.top_level')
+        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 (
@@ -68,12 +66,12 @@ def test_json_doc_relationships(self):
         of relationships give URLs which are handled without raising exceptions.
         """
         make_test_data()
-        apitop = settings.RESTAPI_V1_URL_TOP
-        r = self.api_client.get('/%s/doc/document/'%apitop, format='json')
+        apitop = reverse('ietf.api.top_level')
+        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('/%s/'%apitop):
+                if isinstance(value, basestring) and value.startswith('%s/'%apitop):
                     self.api_client.get(value, format='json')