Added basic canonical support.

TODO

@@ -12,7 +12,9 @@ Short Term
 - Implement throttling.
 - Documentation.
 - Filtering
-- Pagination
+- A ``ResourceURI`` field.
+- A ``readonly`` attribute on fields.
+
 
 Long Term
 ---------

example/api/representations.py

@@ -3,5 +3,11 @@
 
 
 class NoteRepresentation(ModelRepresentation):
+    resource_uri = CharField()
+
     class Meta:
         queryset = Note.objects.all()
+
+    # FIXME: This should probably get significantly more automated.
+    def dehydrate_resource_uri(self, obj):
+        return self.get_resource_uri(obj)

example/api/urls.py

@@ -3,7 +3,7 @@
 from api.resources import NoteResource
 
 api = Api(api_name='v1')
-api.register(NoteResource())
+api.register(NoteResource(), canonical=True)
 
 urlpatterns = patterns('',
     (r'^', include(api.urls)),

tastypie/api.py

@@ -2,7 +2,7 @@
 from django.core.exceptions import ImproperlyConfigured
 from django.core.urlresolvers import reverse
 from django.http import HttpResponse
-from tastypie.exceptions import TastyPieError
+from tastypie.exceptions import TastyPieError, NotRegistered
 from tastypie.serializers import Serializer
 
 
@@ -27,16 +27,21 @@ def register(self, resource, canonical=False):
 
         self._registry[resource_name] = resource
 
-        # FIXME: Not sure about this yet.
-        # if canonical is True:
-        #     self._canonicals[resource_name] = resource
+        if canonical is True:
+            self._canonicals[resource_name] = resource
 
     def unregister(self, resource_name):
         if resource_name in self._registry:
             del(self._registry[resource_name])
-            return True
 
-        return False
+        if resource_name in self._canonicals:
+            del(self._canonicals[resource_name])
+
+    def canonical_resource_for(self, resource_name):
+        if resource_name in self._canonicals:
+            return self._canonicals[resource_name]
+
+        raise NotRegistered("No resource was registered as canonical for '%s'." % resource_name)
 
     def wrap_view(self, view):
         def wrapper(request, *args, **kwargs):

tastypie/exceptions.py

@@ -2,6 +2,10 @@ class TastyPieError(Exception):
     pass
 
 
+class NotRegistered(TastyPieError):
+    pass
+
+
 class NotFound(TastyPieError):
     pass
 

tests/core/tests/api.py

@@ -2,6 +2,7 @@
 from django.http import HttpRequest
 from django.test import TestCase
 from tastypie.api import Api
+from tastypie.exceptions import NotRegistered
 from tastypie.resources import Resource
 from tastypie.representations.models import ModelRepresentation
 from core.models import Note
@@ -45,16 +46,24 @@ def test_register(self):
         api.register(UserResource())
         self.assertEqual(len(api._registry), 2)
         self.assertEqual(sorted(api._registry.keys()), ['notes', 'users'])
+
+        self.assertEqual(len(api._canonicals), 0)
+        api.register(UserResource(), canonical=True)
+        self.assertEqual(len(api._registry), 2)
+        self.assertEqual(sorted(api._registry.keys()), ['notes', 'users'])
+        self.assertEqual(len(api._canonicals), 1)
 
     def test_unregister(self):
         api = Api()
         api.register(NoteResource())
-        api.register(UserResource())
+        api.register(UserResource(), canonical=True)
         self.assertEqual(sorted(api._registry.keys()), ['notes', 'users'])
 
+        self.assertEqual(len(api._canonicals), 1)
         api.unregister('users')
         self.assertEqual(len(api._registry), 1)
         self.assertEqual(sorted(api._registry.keys()), ['notes'])
+        self.assertEqual(len(api._canonicals), 0)
 
         api.unregister('notes')
         self.assertEqual(len(api._registry), 0)
@@ -64,6 +73,15 @@ def test_unregister(self):
         self.assertEqual(len(api._registry), 0)
         self.assertEqual(sorted(api._registry.keys()), [])
 
+    def test_canonical_resource_for(self):
+        api = Api()
+        api.register(NoteResource())
+        api.register(UserResource(), canonical=True)
+        self.assertEqual(len(api._canonicals), 1)
+
+        self.assertRaises(NotRegistered, api.canonical_resource_for, 'notes')
+        self.assertEqual(isinstance(api.canonical_resource_for('users'), UserResource), True)
+
     def test_urls(self):
         api = Api()
         api.register(NoteResource())