Added back missing Api/ApiCollection/ApiVersion classes

Author: timsavage

baldr/api/__init__.py

@@ -7,9 +7,10 @@
 
 from collections import OrderedDict
 from django.conf import settings
-from django.conf.urls import url
+from django.conf.urls import url, include
 from django.core.exceptions import PermissionDenied
 from django.http import HttpResponse, Http404
+from django.utils.functional import lazy_property
 from django.views.decorators.csrf import csrf_exempt
 from odin.codecs import json_codec
 from odin.exceptions import CodecDecodeError, ValidationError
@@ -388,3 +389,73 @@ def options_response(self, request, route_key, **kwargs):
         response = HttpResponse(status=204)
         response['Allow'] = ','.join(method for method, route in routes.items() if route != 'options_response')
         return response
+
+
+class ApiCollection(object):
+    """
+    Collection of several resource API's.
+    Along with helper methods for building URL patterns.
+    ::
+        urlpatterns += Api(
+            ApiCollection(
+                UserApi(),
+                MyApi(),
+            )
+        ).patterns()
+    """
+    def __init__(self, *resource_apis, **kwargs):
+        self.api_name = kwargs.pop('api_name', 'api')
+        self.resource_apis = resource_apis
+
+    @lazy_property
+    def urls(self):
+        urls = []
+        for resource_api in self.resource_apis:
+            urls.extend(resource_api.urls)
+        return urls
+
+    def include(self, namespace=None):
+        return include(self.urls, namespace)
+
+    def patterns(self, api_name=None):
+        api_name = api_name or self.api_name
+        return [url(r'^%s/' % api_name, self.include())]
+
+
+class ApiVersion(ApiCollection):
+    """
+    A versioned collection of several resource API's.
+    Along with helper methods for building URL patterns.
+    """
+    def __init__(self, *resource_apis, **kwargs):
+        kwargs.setdefault('api_name', kwargs.pop('version', 'v1'))
+        super(ApiVersion, self).__init__(*resource_apis, **kwargs)
+
+
+class Api(object):
+    """
+    An API (made up of versions).
+    ::
+        urlpatterns += Api(
+            ApiVersion(
+                UserApi(),
+                MyApi(),
+                version='v1',
+            )
+        ).patterns()
+    """
+    def __init__(self, *versions, **kwargs):
+        self.versions = versions
+        self.api_name = kwargs.get('api_name', 'api')
+
+    def patterns(self):
+        urls = [url(r'^%s/%s/' % (self.api_name, v.api_name), v.include()) for v in self.versions]
+        urls.append(url(r'^%s/$' % self.api_name, self._unknown_version))
+        return urls
+
+    def _unknown_version(self, _):
+        supported_versions = [v.api_name for v in self.versions]
+        return HttpResponse(
+            "Unsupported API version. Available versions: %s" % ', '.join(supported_versions),
+            status=418  # I'm a teapot... Is technically a bad request but makes sense to have a different status code.
+        )