feat: /user/profile endpoint

bookmarks/api/routes.py

@@ -4,7 +4,7 @@
 from rest_framework.routers import DefaultRouter
 
 from bookmarks import queries
-from bookmarks.api.serializers import BookmarkSerializer, TagSerializer
+from bookmarks.api.serializers import BookmarkSerializer, TagSerializer, UserProfileSerializer
 from bookmarks.models import Bookmark, BookmarkFilters, Tag, User
 from bookmarks.services.bookmarks import archive_bookmark, unarchive_bookmark, website_loader
 from bookmarks.services.website_loader import WebsiteMetadata
@@ -94,7 +94,17 @@ def get_queryset(self):
     def get_serializer_context(self):
         return {'user': self.request.user}
 
+class UserViewSet(viewsets.GenericViewSet):
+    def get_serializer_context(self):
+        return {'user': self.request.user}
+
+    @action(methods=['get'], detail=False)
+    def profile(self, request):
+            return Response(UserProfileSerializer(request.user.profile).data)
+
+
 
 router = DefaultRouter()
 router.register(r'bookmarks', BookmarkViewSet, basename='bookmark')
 router.register(r'tags', TagViewSet, basename='tag')
+router.register(r'user', UserViewSet, basename='user')

bookmarks/api/serializers.py

@@ -2,7 +2,7 @@
 from rest_framework import serializers
 from rest_framework.serializers import ListSerializer
 
-from bookmarks.models import Bookmark, Tag, build_tag_string
+from bookmarks.models import Bookmark, Tag, build_tag_string, UserProfile
 from bookmarks.services.bookmarks import create_bookmark, update_bookmark
 from bookmarks.services.tags import get_or_create_tag
 
@@ -86,3 +86,15 @@ class Meta:
 
     def create(self, validated_data):
         return get_or_create_tag(validated_data['name'], self.context['user'])
+
+class UserProfileSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = UserProfile
+        fields = [
+            "theme",
+            "bookmark_date_display",
+            "bookmark_link_target",
+            "web_archive_integration",
+            "enable_sharing",
+            "enable_favicons"
+        ]

docs/API.md

@@ -234,3 +234,24 @@ Example payload:
   "name": "example"
 }
 ```
+
+### User
+
+**Profile**
+
+```
+GET /api/user/profile/
+```
+
+User preferences.
+
+```json
+{
+  "theme": "auto",
+  "bookmark_date_display": "relative",
+  "bookmark_link_target": "_blank",
+  "web_archive_integration": "disabled",
+  "enable_sharing": false,
+  "enable_favicons": false
+}
+```