Updated for 2.3

Author: lovelydinosaur

snippets/models.py

@@ -9,6 +9,7 @@
 LANGUAGE_CHOICES = sorted([(item[1][0], item[0]) for item in LEXERS])
 STYLE_CHOICES = sorted((item, item) for item in get_all_styles())
 
+
 class Snippet(models.Model):
     created = models.DateTimeField(auto_now_add=True)
     title = models.CharField(max_length=100, blank=True, default='')

snippets/permissions.py

@@ -1,15 +1,12 @@
 from rest_framework import permissions
 
+
 class IsOwnerOrReadOnly(permissions.BasePermission):
     """
     Custom permission to only allow owners of an object to edit it.
     """
 
-    def has_permission(self, request, view, obj=None):
-        # Skip the check unless this is an object-level test
-        if obj is None:
-            return True
-
+    def has_object_permission(self, request, view, obj):
         # Read permissions are allowed to any request
         if request.method in permissions.SAFE_METHODS:
             return True

snippets/serializers.py

@@ -2,6 +2,7 @@
 from snippets.models import Snippet
 from django.contrib.auth.models import User
 
+
 class SnippetSerializer(serializers.HyperlinkedModelSerializer):
     owner = serializers.Field(source='owner.username')
     highlight = serializers.HyperlinkedIdentityField(view_name='snippet-highlight', format='html')

snippets/views.py

@@ -1,98 +1,47 @@
 from django.contrib.auth.models import User
-from rest_framework import generics
 from rest_framework import permissions
 from rest_framework import renderers
-from rest_framework.decorators import api_view
+from rest_framework import viewsets
+from rest_framework.decorators import link
 from rest_framework.response import Response
-from rest_framework.reverse import reverse
 from snippets.models import Snippet
 from snippets.permissions import IsOwnerOrReadOnly
 from snippets.serializers import SnippetSerializer, UserSerializer
 
-@api_view(('GET',))
-def api_root(request, format=None):
-    """
-    This is the entry point for the API described in the
-    [REST framework tutorial][tutorial].
-
-    Follow the hyperinks each resource offers to explore the API.
-
-    Note that you can also explore the API from the command line, for instance
-    using the `curl` command-line tool.
-
-    For example: `curl -X GET http://restframework.herokuapp.com/ -H "Accept: application/json; indent=4"`
 
-    [tutorial]: http://django-rest-framework.org/tutorial/1-serialization.html
+class SnippetViewSet(viewsets.ModelViewSet):
     """
-    return Response({
-        'users': reverse('user-list', request=request, format=format),
-        'snippets': reverse('snippet-list', request=request, format=format)
-    })
-
-
-class SnippetList(generics.ListCreateAPIView):
-    """
-    This view presents a list of code snippets, and allows new snippets to
-    be created.
-
-    Try it yourself by logging in as one of these four users: **amy**, **max**,
-    **jose** or **aziz** - The passwords are the same as the usernames.
-
-    Note that code snippets are paginated to a maximum of 10 per page,
-    and the maximum number of code snippets is capped at 100 instances.
-    """
-    model = Snippet
-    serializer_class = SnippetSerializer
-    permission_classes = (permissions.IsAuthenticatedOrReadOnly,)
-
-    def pre_save(self, obj):
-        obj.owner = self.request.user
-
-
-class SnippetDetail(generics.RetrieveUpdateDestroyAPIView):
-    """
-    This view presents an instance of a code snippet.
+    This endpoint presents code snippets.
 
     The `highlight` field presents a hyperlink to the hightlighted HTML
     representation of the code snippet.
 
-    The **owner** of the code snippet may update or delete this instance.
+    The **owner** of the code snippet may update or delete instances
+    of the code snippet.
 
     Try it yourself by logging in as one of these four users: **amy**, **max**,
-    **jose** or **aziz** - The passwords are the same as the usernames.
+    **jose** or **aziz**.  The passwords are the same as the usernames.
     """
-    model = Snippet
+    queryset = Snippet.objects.all()
     serializer_class = SnippetSerializer
     permission_classes = (permissions.IsAuthenticatedOrReadOnly,
                           IsOwnerOrReadOnly,)
 
-    def pre_save(self, obj):
-        obj.owner = self.request.user
-
-
-class SnippetHighlight(generics.SingleObjectAPIView):
-    model = Snippet
-    renderer_classes = (renderers.StaticHTMLRenderer,)
-
-    def get(self, request, *args, **kwargs):
+    @link(renderer_classes=(renderers.StaticHTMLRenderer,))
+    def highlight(self, request, *args, **kwargs):
         snippet = self.get_object()
         return Response(snippet.highlighted)
 
+    def pre_save(self, obj):
+        obj.owner = self.request.user
 
-class UserList(generics.ListAPIView):
-    """
-    This view presents a list of all the users in the system.
 
-    As you can see, related snippet instances are serialized using a
-    hyperlinked representation.
+class UserViewSet(viewsets.ReadOnlyModelViewSet):
     """
-    model = User
-    serializer_class = UserSerializer
-
+    This endpoint presents the users in the system.
 
-class UserDetail(generics.RetrieveAPIView):
-    """
-    This view presents a instance of one of the users in the system.
+    As you can see, the collection of snippet instances owned by a user are
+    serialized using a hyperlinked representation.
     """
-    model = User
+    queryset = User.objects.all()
     serializer_class = UserSerializer

tutorial/settings.py

@@ -11,7 +11,7 @@
 
 DATABASES = {
     'default': {
-        'ENGINE': 'django.db.backends.sqlite3', # Or use an alternate database backend.
+        'ENGINE': 'django.db.backends.sqlite3',  # Or use an alternate database backend.
         'NAME': 'tmp.db',                       # Path to sqlite3 database file.
         'USER': '',                      # Not used with sqlite3.
         'PASSWORD': '',                  # Not used with sqlite3.
@@ -153,7 +153,7 @@
 }
 
 REST_FRAMEWORK = {
-    'PAGINATE_BY': 10
+    'PAGINATE_BY': 10,
 }
 
 import os

tutorial/urls.py

@@ -1,16 +1,12 @@
 from snippets import views
 from django.conf.urls import patterns, url, include
-from rest_framework.urlpatterns import format_suffix_patterns
+from rest_framework.routers import DefaultRouter
 
-urlpatterns = format_suffix_patterns(patterns('snippets.views',
-    url(r'^$', 'api_root'),
-    url(r'^snippets/$', views.SnippetList.as_view(), name='snippet-list'),
-    url(r'^snippets/(?P<pk>[0-9]+)/$', views.SnippetDetail.as_view(), name='snippet-detail'),
-    url(r'^snippets/(?P<pk>[0-9]+)/highlight/$', views.SnippetHighlight.as_view(), name='snippet-highlight'),
-    url(r'^users/$', views.UserList.as_view(), name='user-list'),
-    url(r'^users/(?P<pk>[0-9]+)/$', views.UserDetail.as_view(), name='user-detail')
-))
+router = DefaultRouter()
+router.register(r'snippets', views.SnippetViewSet)
+router.register(r'users', views.UserViewSet)
 
-urlpatterns += patterns('',
+urlpatterns = patterns('',
+    url(r'^', include(router.urls)),
     url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
 )