comment & validate api_task_manager #22

Author: blahosyl

api_task_manager/permissions.py

@@ -1,8 +1,10 @@
 from rest_framework import permissions
 
-
+"""
+Only give permission to manage objects to users who own them
+"""
 class IsOwnerOrReadOnly(permissions.BasePermission):
-  def has_object_permission(self, request, view, obj):
-    if request.method in permissions.SAFE_METHODS:
-      return True
-    return obj.owner == request.user
+    def has_object_permission(self, request, view, obj):
+        if request.method in permissions.SAFE_METHODS:
+            return True
+        return obj.owner == request.user

api_task_manager/serializers.py

@@ -14,6 +14,7 @@ class CurrentUserSerializer(UserDetailsSerializer):
 
     class Meta(UserDetailsSerializer.Meta):
         fields = UserDetailsSerializer.Meta.fields + (
-            'profile_id', 'profile_firstname', 'profile_lastname', 
+            'profile_id', 'profile_firstname', 'profile_lastname',
             'profile_image'
-        )
+        )
+        

api_task_manager/settings.py

@@ -75,6 +75,7 @@
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
 
+# get allowe hosts from the environment
 ALLOWED_HOSTS = [os.environ.get('ALLOWED_HOST'),]
 
 # allowed frontend apps
@@ -157,13 +158,16 @@
 # Database
 # https://docs.djangoproject.com/en/3.2/ref/settings/#databases
 
+
+# use the built-in SQLite database in development
 if 'DEV' in os.environ:
     DATABASES = {
         'default': {
             'ENGINE': 'django.db.backends.sqlite3',
             'NAME': BASE_DIR / 'db.sqlite3',
         }
     }
+# use the database specified in the environment in production
 else:
     DATABASES = {
         'default': dj_database_url.parse(os.environ.get("DATABASE_URL"))

api_task_manager/urls.py

@@ -2,16 +2,6 @@
 
 The `urlpatterns` list routes URLs to views. For more information please see:
     https://docs.djangoproject.com/en/3.2/topics/http/urls/
-Examples:
-Function views
-    1. Add an import:  from my_app import views
-    2. Add a URL to urlpatterns:  path('', views.home, name='home')
-Class-based views
-    1. Add an import:  from other_app.views import Home
-    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
-Including another URLconf
-    1. Import the include() function: from django.urls import include, path
-    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
 from django.contrib import admin
 from django.urls import path, include

api_task_manager/views.py

@@ -6,13 +6,15 @@
 )
 
 
+# Welcome message by the APi when viewed in the browser or called from the FE
 @api_view()
 def root_route(request):
     return Response({
         "message": "Welcome to the Task Manager API!"
     })
 
-# dj-rest-auth logout view fix
+
+# Fix know dj-rest-auth logout view issue by defining a custom view
 @api_view(['POST'])
 def logout_route(request):
     response = Response()
@@ -34,4 +36,4 @@ def logout_route(request):
         samesite=JWT_AUTH_SAMESITE,
         secure=JWT_AUTH_SECURE,
     )
-    return response
+    return response