Add a API URL to retrieve basic subscription details for the logged in user

Author: nirvn

docker-app/qfieldcloud/subscription/serializers.py

@@ -0,0 +1,28 @@
+from qfieldcloud.subscription.models import CurrentSubscription
+from rest_framework import serializers
+
+
+class CurrentSubscriptionSerializer(serializers.ModelSerializer):
+    storage_used_bytes = serializers.SerializerMethodField()
+    active_plan_display_name = serializers.SerializerMethodField()
+
+    def get_storage_used_bytes(self, obj):
+        return obj.account.storage_used_bytes
+
+    def get_active_plan_display_name(self, obj):
+        return obj.plan.display_name if obj.plan else None
+
+    class Meta:
+        model = CurrentSubscription
+        fields = (
+            "storage_used_bytes",
+            "active_storage_total_bytes",
+            "active_plan_display_name",
+            "active_until",
+        )
+        read_only_fields = (
+            "storage_used_bytes",
+            "active_storage_total_bytes",
+            "active_plan_display_name",
+            "active_until",
+        )

docker-app/qfieldcloud/subscription/views.py

@@ -0,0 +1,25 @@
+from rest_framework.generics import RetrieveAPIView
+from rest_framework.permissions import IsAuthenticated
+from rest_framework.response import Response
+
+from qfieldcloud.subscription.serializers import CurrentSubscriptionSerializer
+
+
+class CurrentSubscriptionView(RetrieveAPIView):
+    """Read current subscription information including storage details.
+
+    Accepts nothing, returns the current subscription information.
+    """
+
+    serializer_class = CurrentSubscriptionSerializer
+    permission_classes = (IsAuthenticated,)
+
+    def get_object(self):
+        return self.request.user.useraccount.current_subscription
+
+    def get(self, request):
+        return Response(
+            CurrentSubscriptionSerializer(
+                self.request.user.useraccount.current_subscription
+            ).data
+        )

docker-app/qfieldcloud/urls.py

@@ -28,6 +28,7 @@
     SpectacularSwaggerView,
 )
 from qfieldcloud.authentication import views as auth_views
+from qfieldcloud.subscription import views as subscription_views
 from qfieldcloud.core.views import files_views
 from rest_framework import permissions
 
@@ -75,6 +76,10 @@
     path("api/v1/auth/token/", auth_views.LoginView.as_view()),
     path("api/v1/auth/user/", auth_views.UserView.as_view()),
     path("api/v1/auth/logout/", auth_views.LogoutView.as_view()),
+    path(
+        "api/v1/subscription/current/",
+        subscription_views.CurrentSubscriptionView.as_view(),
+    ),
     path("api/v1/", include("qfieldcloud.core.urls")),
     path("auth/", include("rest_framework.urls")),
     path("accounts/", include("allauth.urls")),