adding rest apis

Author: davidslusser

src/django_project/core/settings.py

@@ -54,6 +54,7 @@
     "django.contrib.messages",
     "django.contrib.staticfiles",
     # third party apps
+    "djangoaddicts.codegen",
     "django_extensions",
     "django_filters",
     "drf_spectacular",
@@ -268,7 +269,9 @@
 # drf configuration
 REST_FRAMEWORK = {
     "DEFAULT_FILTER_BACKENDS": ("django_filters.rest_framework.DjangoFilterBackend",),
-    "DEFAULT_PERMISSION_CLASSES": ("rest_framework.permissions.IsAuthenticatedOrReadOnly",),
+    "DEFAULT_PERMISSION_CLASSES": ("rest_framework.permissions.IsAuthenticatedOrReadOnly",)
+    if DEBUG
+    else ("rest_framework.permissions.IsAuthenticated",),
     "DEFAULT_AUTHENTICATION_CLASSES": (
         "rest_framework.authentication.TokenAuthentication",
         "rest_framework.authentication.SessionAuthentication",

src/django_project/core/urls/rest.py

@@ -1,14 +1,22 @@
 from django.conf.urls import include
 from django.urls import path
 from rest_framework import routers
+from web.views import viewsets
 
 app_name = "rest"
 
-v1_router = routers.DefaultRouter()
+router = routers.DefaultRouter()
+
+# web API Endpoints
+router.register(r"event", viewsets.EventViewSet, "event")
+router.register(r"presentationrequest", viewsets.PresentationRequestViewSet, "presentationrequest")
+router.register(r"resource", viewsets.ResourceViewSet, "resource")
+router.register(r"resourcecategory", viewsets.ResourceCategoryViewSet, "resourcecategory")
+router.register(r"topicsuggestion", viewsets.TopicSuggestionViewSet, "topicsuggestion")
 
 
 urlpatterns = [
     # API views
-    path("", include(v1_router.urls)),
-    path("v1/", include(v1_router.urls)),
+    path("", include(router.urls)),
+    path("v1/", include(router.urls)),
 ]

src/django_project/core/urls/urls.py

@@ -31,7 +31,7 @@
     # 3rd party URLs
     path("handyhelpers/", include("handyhelpers.urls")),
     # RESTful API URLs
-    path("rest/", include("core.urls.rest", namespace="rest")),
+    path("rest/", include("core.urls.rest", namespace="")),
     path("rest/schema/", SpectacularAPIView.as_view(), name="schema"),
     path("rest/swagger/", SpectacularSwaggerView.as_view(url_name="schema"), name="swagger"),
     path("rest/redoc/", SpectacularRedocView.as_view(url_name="schema"), name="redoc"),

src/django_project/web/admin.py

@@ -12,33 +12,33 @@
 
 
 class ResourceCategoryAdmin(admin.ModelAdmin):
-    list_display: list[str] = ["id", "created_at", "updated_at", "name"]
+    list_display: list[str] = ["id", "name", "created_at", "updated_at"]
     search_fields: list[str] = ["id", "name"]
     list_filter: list[str | type[ListFilter] | tuple[str, type[ListFilter]]] = []
 
 
 class ResourceAdmin(admin.ModelAdmin):
-    list_display: list[str] = ["id", "created_at", "updated_at", "name", "description", "url", "category"]
+    list_display: list[str] = ["id", "name", "description", "url", "category", "created_at", "updated_at"]
     search_fields: list[str] = ["id", "name", "description", "url"]
     list_filter: list[str] = ["category"]
 
 
 class TopicSuggestionAdmin(admin.ModelAdmin):
-    list_display: list[str] = ["id", "created_at", "updated_at", "title", "description", "skill_level", "email"]
+    list_display: list[str] = ["id", "title", "description", "skill_level", "email", "created_at", "updated_at"]
     search_fields: list[str] = ["id", "title", "description", "skill_level", "email"]
     list_filter: list[str] = ["skill_level"]
 
 
 class PresentationRequestAdmin(admin.ModelAdmin):
     list_display: list[str] = [
         "id",
-        "created_at",
-        "updated_at",
         "presenter",
         "email",
         "title",
         "description",
         "skill_level",
+        "created_at",
+        "updated_at",
     ]
     search_fields: list[str] = ["id", "presenter", "email", "title", "description", "skill_level"]
     list_filter: list[str] = ["skill_level"]
@@ -47,13 +47,13 @@ class PresentationRequestAdmin(admin.ModelAdmin):
 class EventAdmin(admin.ModelAdmin):
     list_display: list[str] = [
         "id",
-        "created_at",
-        "updated_at",
         "name",
         "start_date_time",
         "end_date_time",
         "location",
         "description",
+        "created_at",
+        "updated_at",
     ]
     search_fields: list[str] = ["id", "name", "location", "description"]
     list_filter: list[str | type[ListFilter] | tuple[str, type[ListFilter]]] = []

src/django_project/web/filtersets.py

@@ -1,5 +1,110 @@
-"""filtersets for applicable web models"""
+"""filtersets for applicable app models"""
 
+from rest_framework_filters.filters import BooleanFilter, RelatedFilter
+from rest_framework_filters.filterset import FilterSet
 
 # import models
-# from web.models import ()
+from web.models import (
+    Event,
+    PresentationRequest,
+    Resource,
+    ResourceCategory,
+    TopicSuggestion,
+)
+
+
+class EventFilterSet(FilterSet):
+    """filterset class for Event"""
+
+    class Meta:
+        """Metaclass to define filterset model and fields"""
+
+        model = Event
+        fields = {
+            "created_at": "__all__",
+            "description": "__all__",
+            "end_date_time": "__all__",
+            "id": "__all__",
+            "location": "__all__",
+            "name": "__all__",
+            "start_date_time": "__all__",
+            "updated_at": "__all__",
+            "url": "__all__",
+        }
+
+
+class PresentationRequestFilterSet(FilterSet):
+    """filterset class for PresentationRequest"""
+
+    class Meta:
+        """Metaclass to define filterset model and fields"""
+
+        model = PresentationRequest
+        fields = {
+            "created_at": "__all__",
+            "description": "__all__",
+            "email": "__all__",
+            "id": "__all__",
+            "presenter": "__all__",
+            "skill_level": "__all__",
+            "title": "__all__",
+            "updated_at": "__all__",
+        }
+
+
+class ResourceFilterSet(FilterSet):
+    """filterset class for Resource"""
+
+    category = RelatedFilter(
+        "ResourceCategoryFilterSet", field_name="category", queryset=ResourceCategory.objects.all()
+    )
+
+    class Meta:
+        """Metaclass to define filterset model and fields"""
+
+        model = Resource
+        fields = {
+            "category": "__all__",
+            "created_at": "__all__",
+            "description": "__all__",
+            "id": "__all__",
+            "name": "__all__",
+            "updated_at": "__all__",
+            "url": "__all__",
+        }
+
+
+class ResourceCategoryFilterSet(FilterSet):
+    """filterset class for ResourceCategory"""
+
+    resources = RelatedFilter("ResourceFilterSet", field_name="resources", queryset=Resource.objects.all())
+    has_resources = BooleanFilter(field_name="resources", lookup_expr="isnull", exclude=True)
+
+    class Meta:
+        """Metaclass to define filterset model and fields"""
+
+        model = ResourceCategory
+        fields = {
+            "created_at": "__all__",
+            "id": "__all__",
+            "name": "__all__",
+            "updated_at": "__all__",
+        }
+
+
+class TopicSuggestionFilterSet(FilterSet):
+    """filterset class for TopicSuggestion"""
+
+    class Meta:
+        """Metaclass to define filterset model and fields"""
+
+        model = TopicSuggestion
+        fields = {
+            "created_at": "__all__",
+            "description": "__all__",
+            "email": "__all__",
+            "id": "__all__",
+            "skill_level": "__all__",
+            "title": "__all__",
+            "updated_at": "__all__",
+        }

src/django_project/web/serializers.py

@@ -1,5 +1,107 @@
-"""DRF serailizers for applicable web models"""
-
+from rest_flex_fields import FlexFieldsModelSerializer
+from rest_framework import serializers
 
 # import models
-# from web.models import ()
+from web.models import (
+    Event,
+    PresentationRequest,
+    Resource,
+    ResourceCategory,
+    TopicSuggestion,
+)
+
+
+class EventSerializer(FlexFieldsModelSerializer):
+    """serializer class for Event"""
+
+    class Meta:
+        """Metaclass to define filterset model and fields"""
+
+        model = Event
+        fields = [
+            "created_at",
+            "description",
+            "end_date_time",
+            "id",
+            "location",
+            "name",
+            "start_date_time",
+            "updated_at",
+            "url",
+        ]
+
+
+class PresentationRequestSerializer(FlexFieldsModelSerializer):
+    """serializer class for PresentationRequest"""
+
+    class Meta:
+        """Metaclass to define filterset model and fields"""
+
+        model = PresentationRequest
+        fields = [
+            "created_at",
+            "description",
+            "email",
+            "id",
+            "presenter",
+            "skill_level",
+            "title",
+            "updated_at",
+        ]
+
+
+class ResourceSerializer(FlexFieldsModelSerializer):
+    """serializer class for Resource"""
+
+    category = serializers.StringRelatedField()
+
+    class Meta:
+        """Metaclass to define filterset model and fields"""
+
+        model = Resource
+        fields = [
+            "category",
+            "created_at",
+            "description",
+            "id",
+            "name",
+            "updated_at",
+            "url",
+        ]
+
+        expandable_fields = {
+            "category": "web.serializers.ResourceCategorySerializer",
+        }
+
+
+class ResourceCategorySerializer(FlexFieldsModelSerializer):
+    """serializer class for ResourceCategory"""
+
+    class Meta:
+        """Metaclass to define filterset model and fields"""
+
+        model = ResourceCategory
+        fields = [
+            "created_at",
+            "id",
+            "name",
+            "updated_at",
+        ]
+
+
+class TopicSuggestionSerializer(FlexFieldsModelSerializer):
+    """serializer class for TopicSuggestion"""
+
+    class Meta:
+        """Metaclass to define filterset model and fields"""
+
+        model = TopicSuggestion
+        fields = [
+            "created_at",
+            "description",
+            "email",
+            "id",
+            "skill_level",
+            "title",
+            "updated_at",
+        ]

src/django_project/web/urls/__init__.py

@@ -1,6 +1,5 @@
 from .gui import urlpatterns as gui_urls
-from .rest import urlpatterns as rest_urls
 
 app_name = "web"
 
-urlpatterns = rest_urls + gui_urls
+urlpatterns = gui_urls