#24 Implement REST API (#32)

* #24 Implement readonly bookmark API

* #24 Implement create/update bookmark API

* #24 Fix title, description not allowing blank values

* #24 Code cleanup

* #24 Add modification dates to response

* #24 Add API docs

* #24 Implement delete bookmark API

* #24 Fix API docs link

* #24 Fix API docs link

* #24 Implement tag API

Co-authored-by: Sascha Ißbrücker <sissbruecker@lyska.io>

bookmarks/api/routes.py

@@ -0,0 +1,47 @@
+from rest_framework import viewsets, mixins
+from rest_framework.routers import DefaultRouter
+
+from bookmarks import queries
+from bookmarks.api.serializers import BookmarkSerializer, TagSerializer
+from bookmarks.models import Bookmark, Tag
+
+
+class BookmarkViewSet(viewsets.GenericViewSet,
+                      mixins.ListModelMixin,
+                      mixins.RetrieveModelMixin,
+                      mixins.CreateModelMixin,
+                      mixins.UpdateModelMixin,
+                      mixins.DestroyModelMixin):
+    serializer_class = BookmarkSerializer
+
+    def get_queryset(self):
+        user = self.request.user
+        # For list action, use query set that applies search and tag projections
+        if self.action == 'list':
+            query_string = self.request.GET.get('q')
+            return queries.query_bookmarks(user, query_string)
+
+        # For single entity actions use default query set without projections
+        return Bookmark.objects.all().filter(owner=user)
+
+    def get_serializer_context(self):
+        return {'user': self.request.user}
+
+
+class TagViewSet(viewsets.GenericViewSet,
+                 mixins.ListModelMixin,
+                 mixins.RetrieveModelMixin,
+                 mixins.CreateModelMixin):
+    serializer_class = TagSerializer
+
+    def get_queryset(self):
+        user = self.request.user
+        return Tag.objects.all().filter(owner=user)
+
+    def get_serializer_context(self):
+        return {'user': self.request.user}
+
+
+router = DefaultRouter()
+router.register(r'bookmarks', BookmarkViewSet, basename='bookmark')
+router.register(r'tags', TagViewSet, basename='tag')

bookmarks/api/serializers.py

@@ -0,0 +1,44 @@
+from rest_framework import serializers
+
+from bookmarks.models import Bookmark, Tag, build_tag_string
+from bookmarks.services.bookmarks import create_bookmark, update_bookmark
+from bookmarks.services.tags import get_or_create_tag
+
+
+class TagListField(serializers.ListField):
+    child = serializers.CharField()
+
+
+class BookmarkSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Bookmark
+        fields = ['id', 'url', 'title', 'description', 'tag_names', 'date_added', 'date_modified']
+        read_only_fields = ['date_added', 'date_modified']
+
+    # Override readonly tag_names property to allow passing a list of tag names to create/update
+    tag_names = TagListField()
+
+    def create(self, validated_data):
+        bookmark = Bookmark()
+        bookmark.url = validated_data['url']
+        bookmark.title = validated_data['title']
+        bookmark.description = validated_data['description']
+        tag_string = build_tag_string(validated_data['tag_names'], ' ')
+        return create_bookmark(bookmark, tag_string, self.context['user'])
+
+    def update(self, instance: Bookmark, validated_data):
+        instance.url = validated_data['url']
+        instance.title = validated_data['title']
+        instance.description = validated_data['description']
+        tag_string = build_tag_string(validated_data['tag_names'], ' ')
+        return update_bookmark(instance, tag_string, self.context['user'])
+
+
+class TagSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Tag
+        fields = ['id', 'name', 'date_added']
+        read_only_fields = ['date_added']
+
+    def create(self, validated_data):
+        return get_or_create_tag(validated_data['name'], self.context['user'])