Add subpage, user and status API

rurusetto/api/serializers.py

@@ -1,5 +1,5 @@
 from rest_framework import serializers
-from wiki.models import Ruleset, Subpage
+from wiki.models import Ruleset, Subpage, RulesetStatus
 from users.models import Profile
 from django.contrib.auth.models import User
 
@@ -30,11 +30,12 @@ class RulesetListingSerializer(serializers.ModelSerializer):
     Serializer for essential information that is user in listing page.
     """
     owner_detail = serializers.SerializerMethodField()
+    status = serializers.SerializerMethodField()
 
     class Meta:
         model = Ruleset
         fields = ['id', 'name', 'slug', 'description', 'icon', 'light_icon', 'owner_detail', 'verified',
-                  'direct_download_link', 'can_download']
+                  'direct_download_link', 'can_download', 'status']
 
     def get_owner_detail(self, obj):
         try:
@@ -43,52 +44,117 @@ def get_owner_detail(self, obj):
         except Profile.DoesNotExist:
             return {}
 
+    def get_status(self, obj):
+        try:
+            return StatusDetailSerializer(RulesetStatus.objects.get(ruleset=obj)).data
+        except RulesetStatus.DoesNotExist:
+            return {}
+
 
 # Serializer for rulesets detail
 
 
-class RulesetsDetailSubpageSerializer(serializers.ModelSerializer):
+class StatusDetailSerializer(serializers.ModelSerializer):
     """
-    Serializer for Subpage model that use in RulesetsDetailSerializer
+    Serializer for Status model that use in RulesetsDetailSerializer
     """
     class Meta:
-        model = Subpage
-        fields = ['title', 'slug']
+        model = RulesetStatus
+        fields = ['latest_version', 'latest_update', 'pre_release', 'changelog', 'file_size', 'playable']
 
 
 class RulesetsDetailSerializer(serializers.ModelSerializer):
     """
     Serializer for essential information in wiki view of each rulesets
     """
-    # subpage = serializers.SerializerMethodField()
     creator_detail = serializers.SerializerMethodField()
     owner_detail = serializers.SerializerMethodField()
     last_edited_by_detail = serializers.SerializerMethodField()
+    status = serializers.SerializerMethodField()
 
     class Meta:
         model = Ruleset
         fields = ['id', 'name', 'slug', 'description', 'icon', 'light_icon', 'logo', 'cover_image', 'cover_image_light',
                   'opengraph_image', 'custom_css', 'content', 'source',
                   'github_download_filename', 'direct_download_link', 'can_download', 'creator_detail', 'created_at', 'owner_detail',
-                  'last_edited_at', 'last_edited_by_detail', 'verified', 'archive']
+                  'last_edited_at', 'last_edited_by_detail', 'verified', 'archive', 'status']
 
     def get_creator_detail(self, obj):
         try:
-            creator = Profile.objects.get(id=obj.creator)
-            return ProfileMiniSerializer(creator).data
+            return ProfileMiniSerializer(Profile.objects.get(id=obj.creator)).data
         except Profile.DoesNotExist:
             return {}
 
     def get_owner_detail(self, obj):
         try:
-            owner = Profile.objects.get(id=obj.owner)
-            return ProfileMiniSerializer(owner).data
+            return ProfileMiniSerializer(Profile.objects.get(id=obj.owner)).data
         except Profile.DoesNotExist:
             return {}
 
     def get_last_edited_by_detail(self, obj):
         try:
-            last_edited_by = Profile.objects.get(id=obj.last_edited_by)
-            return ProfileMiniSerializer(last_edited_by).data
+            return ProfileMiniSerializer(Profile.objects.get(id=obj.last_edited_by)).data
         except Profile.DoesNotExist:
             return {}
+
+    def get_status(self, obj):
+        try:
+            return StatusDetailSerializer(RulesetStatus.objects.get(ruleset=obj)).data
+        except RulesetStatus.DoesNotExist:
+            return {}
+
+# Serializer for subpoge
+
+class RulesetsSubpageSerializer(serializers.ModelSerializer):
+    """
+    Serializer for Subpage model to get only detail that use in rulesets
+    """
+    class Meta:
+        model = Subpage
+        fields = ['title', 'slug']
+
+
+class SubpageSerializer(serializers.ModelSerializer):
+    """
+    Serializer for Subpage model to get full detail of subpage
+    """
+    ruleset_detail = serializers.SerializerMethodField()
+    last_edited_by_detail = serializers.SerializerMethodField()
+    creator_detail = serializers.SerializerMethodField()
+
+    class Meta:
+        model = Subpage
+        fields = ['ruleset_detail', 'title', 'slug', 'content', 'creator_detail', 'last_edited_by_detail', 'last_edited_at',
+                  'created_at']
+
+    def get_ruleset_detail(self, obj):
+        try:
+            return RulesetListingSerializer(Ruleset.objects.get(id=obj.ruleset_id)).data
+        except Ruleset.DoesNotExist:
+            return {}
+
+    def get_creator_detail(self, obj):
+        try:
+            return ProfileMiniSerializer(Profile.objects.get(id=obj.creator)).data
+        except Profile.DoesNotExist:
+            return {}
+
+    def get_last_edited_by_detail(self, obj):
+        try:
+            return ProfileMiniSerializer(Profile.objects.get(id=obj.last_edited_by)).data
+        except Profile.DoesNotExist:
+            return {}
+
+
+# Serializer for user and profile
+
+class UserFullSerializer(serializers.ModelSerializer):
+    """
+    Serializer for full detail of users
+    """
+    user = UserSerializer()
+
+    class Meta:
+        model = Profile
+        fields = ['id', 'user', 'image', 'cover', 'cover_light', 'about_me', 'osu_username']
+        depth = 1

rurusetto/api/urls.py

@@ -4,4 +4,7 @@
 urlpatterns = [
     path('rulesets', views.listing),
     path('rulesets/<slug:slug>', views.ruleset_detail),
+    path('subpage/<slug:rulesets_slug>', views.all_ruleset_subpage),
+    path('subpage/<slug:rulesets_slug>/<slug:subpage_slug>', views.subpage),
+    path('profile/<int:user_id>', views.user)
 ]

rurusetto/api/views.py

@@ -1,6 +1,8 @@
 from .serializers import *
 from django.views.decorators.csrf import csrf_exempt
-from wiki.models import Ruleset
+from wiki.models import Ruleset, Subpage
+from users.models import Profile
+from django.contrib.auth.models import User
 from django.http import HttpResponse, JsonResponse
 
 
@@ -45,3 +47,61 @@ def ruleset_detail(request, slug):
     if request.method == 'GET':
         serializer = RulesetsDetailSerializer(ruleset)
         return JsonResponse(serializer.data)
+
+
+@csrf_exempt
+def all_ruleset_subpage(request, rulesets_slug):
+    """
+    View for return the list of subpage title in targeted ruleset
+
+    :param request: WSGI request from user
+    :return: list of subpage title in targeted ruleset
+    """
+    try:
+        all_public_subpage = Subpage.objects.filter(hidden=False, ruleset_id=str(Ruleset.objects.get(slug=rulesets_slug).id))
+    except Ruleset.DoesNotExist:
+        return JsonResponse(make_404_json_response('The ruleset is not found'), status=404, content_type="application/json")
+
+    if request.method == 'GET':
+        serializer = RulesetsSubpageSerializer(all_public_subpage, many=True)
+        return JsonResponse(serializer.data, safe=False)
+
+@csrf_exempt
+def subpage(request, rulesets_slug, subpage_slug):
+    """
+    View for return full detail of subpage
+
+    :param request: WSGI request from user
+    :return: full detail of requested subpage
+    """
+    try:
+        subpage = Subpage.objects.get(slug=subpage_slug, ruleset_id=str(Ruleset.objects.get(slug=rulesets_slug).id), hidden=False)
+    except Ruleset.DoesNotExist:
+        return JsonResponse(make_404_json_response('The ruleset is not found'), status=404, content_type="application/json")
+    except Subpage.DoesNotExist:
+        return JsonResponse(make_404_json_response('The subpage is not found'), status=404,
+                            content_type="application/json")
+
+    if request.method == 'GET':
+        serializer = SubpageSerializer(subpage)
+        return JsonResponse(serializer.data)
+
+@csrf_exempt
+def user(request, user_id):
+    """
+    View for return full detail of subpage
+
+    :param request: WSGI request from user
+    :return: full detail of requested subpage
+    """
+    try:
+        profile = Profile.objects.get(id=user_id)
+    except Profile.DoesNotExist:
+        return JsonResponse(make_404_json_response('The user is not found'), status=404, content_type="application/json")
+    except User.DoesNotExist:
+        return JsonResponse(make_404_json_response('The user is not found'), status=404,
+                            content_type="application/json")
+
+    if request.method == 'GET':
+        serializer = UserFullSerializer(profile)
+        return JsonResponse(serializer.data)