bug 1159406 - Namespace the v1 API views

Use the DRF NamespaceVersioning strategy for serving the v1 API.  This
will allow the v2 API to exist alongside the v1 API.

webplatformcompat/jinja2/webplatformcompat/base.html

@@ -42,7 +42,7 @@
             <li{% if request.path.startswith(url('about')) %} class="active"{% endif %}>
               <a href="{{url('about')}}">About</a></li>
             <li{% if request.path.startswith(url('api_root')) %} class="active"{% endif %}>
-              <a href="{{url('api-root')}}">API</a></li>
+              <a href="{{url('v1:api-root')}}">API</a></li>
             <li{% if request.path.startswith(url('browse')) %} class="active"{% endif %}>
               <a href="{{url('browse')}}">Browse</a></li>
             <li{% if request.path.startswith(url('feature_page_list')) %} class="active"{% endif %}>

webplatformcompat/jinja2/webplatformcompat/home.html

@@ -30,7 +30,7 @@ <h2>Browse the Data</h2>
     <div class="col-md-3">
       <h2>Explore the API</h2>
       <p>Jump right into the self-documenting API.</p>
-      <p><a class="btn btn-default" href="{{ url('api-root') }}" role="button">API &raquo;</a></p>
+      <p><a class="btn btn-default" href="{{ url('v1:api-root') }}" role="button">API &raquo;</a></p>
     </div>
     <div class="col-md-3">
       <h2>Import from MDN</h2>

webplatformcompat/renderers.py

@@ -1,8 +1,10 @@
 from collections import OrderedDict
 from json import loads
 
+from django.core.urlresolvers import get_resolver
 from django.template import loader
 from django.utils import encoding, translation
+from django.utils.six.moves.urllib.parse import urlparse, urlunparse
 
 from rest_framework.relations import ManyRelatedField
 from rest_framework.renderers import TemplateHTMLRenderer
@@ -223,6 +225,17 @@ def fields_from_resource(self, resource):
         else:
             return super(JsonApiRenderer, self).fields_from_resource(resource)
 
+    def url_to_template(self, view_name, request, template_name):
+        prefix, resolver = get_resolver(None).namespace_dict['v1']
+        info = resolver.reverse_dict[view_name]
+        path_template = info[0][0][0]
+        id_field = info[0][0][1][0]
+        path = prefix + path_template % {id_field: '{%s}' % template_name}
+        parsed_url = urlparse(request.build_absolute_uri())
+        return urlunparse(
+            [parsed_url.scheme, parsed_url.netloc, path, '', '', '']
+        )
+
 
 class JsonApiTemplateHTMLRenderer(TemplateHTMLRenderer):
     """Render to a template, but use JSON API format as context."""

webplatformcompat/tests/base.py

@@ -12,13 +12,14 @@
 class TestMixin(object):
     """Useful methods for testing"""
     maxDiff = None
+    namespace = 'v1'
 
     def tearDown(self):
         cache.clear()
 
     def api_reverse(self, viewname, **kwargs):
-        """Create a path to an API view"""
-        return reverse(viewname, kwargs=kwargs)
+        """Create a path to a namespaced API view."""
+        return reverse("%s:%s" % (self.namespace, viewname), kwargs=kwargs)
 
     def login_user(self, groups=None):
         """Create and login a user, saving to self.user.

webplatformcompat/urls.py

@@ -21,7 +21,7 @@
         namespace='rest_framework')),
     url(r'^api/$', RedirectView.as_view(url='/api/v1/', permanent=False),
         name='api_root'),
-    url(r'^api/v1/', include(router.urls)),
+    url(r'^api/v1/', include(router.urls, namespace='v1')),
     url(r'^importer$', RedirectView.as_view(
         url='/importer/', permanent=False)),
     url(r'^importer/', include(mdn_urlpatterns)),

webplatformcompat/view_serializers.py

@@ -81,6 +81,8 @@ class Meta:
 
 class DjangoResourceClient(object):
     """Implement tools.client.Client using Django native functions"""
+    namespace = 'v1'
+
     def url(self, resource_type, resource_id=None):
         """Use Django reverse to determine URL."""
         if resource_type == 'maturities':
@@ -89,9 +91,10 @@ def url(self, resource_type, resource_id=None):
             singular = resource_type[:-1]
         if resource_id:
             return reverse(
-                singular + '-detail', kwargs={'pk': resource_id})
+                self.namespace + ':' + singular + '-detail',
+                kwargs={'pk': resource_id})
         else:
-            return reverse(singular + '-list')
+            return reverse(self.namespace + ':' + singular + '-list')
 
     def open_changeset(self):
         """Skip opening changesets (opened at the request/view level)."""

wpcsite/settings.py

@@ -313,6 +313,8 @@ def env_to_bool(environ_key, default):
     ],
     'DEFAULT_PAGINATION_CLASS': 'webplatformcompat.pagination.Pagination',
     'PAGE_SIZE': 10,
+    'DEFAULT_VERSIONING_CLASS': (
+        'rest_framework.versioning.NamespaceVersioning'),
 }
 
 # Django nose