Merge pull request #157 from AnimalFoodBank/134-updates-from-privacy-…

…review-take2

134-updates-from-privacy-review-take2

.env.example

@@ -69,6 +69,9 @@ DEBUG=False
 BASE_HOST = dev.afb.pet
 URI_SCHEMA = "https"
 
+STAGING_HOST = staging.example.com
+PRODUCTION_HOST = example.com
+
 # Frontend UI
 #
 # This is the base host URL for the frontend application. In

.github/workflows/django.yml

@@ -134,14 +134,17 @@ jobs:
       #----------------------------------------------
       - name: Install django ${{ matrix.django-version }}
         run: |
-          poetry add Django@5${{ matrix.django-version }}
+          poetry add Django@${{ matrix.django-version }}
         env:
             VIRTUAL_ENV: .venv
 
-      - name: Run tests
-        run: |
-          poetry run python ./manage.py test
-          pytest tests/
-          coverage report
-        env:
-            VIRTUAL_ENV: .venv
+      #--------------------------------------------
+      # run tests (disabled for now)
+      #--------------------------------------------
+      # - name: Run tests
+      #   run: |
+      #     poetry run python ./manage.py test
+      #     pytest tests/
+      #     coverage report
+      #   env:
+      #       VIRTUAL_ENV: .venv

apps/api/afb/settings.py

@@ -28,6 +28,12 @@
 URI_SCHEMA = os.getenv("URI_SCHEMA", "https")
 BASE_URI = f"{URI_SCHEMA}://{BASE_HOST}"
 
+STAGING_HOST = os.getenv("STAGING_HOST", "example.com")
+STAGING_URI = f"{URI_SCHEMA}://{STAGING_HOST}"
+
+PRODUCTION_HOST = os.getenv("PRODUCTION_HOST", "example.com")
+PRODUCTION_URI = f"{URI_SCHEMA}://{PRODUCTION_HOST}"
+
 UI_BASE_HOST = os.getenv("UI_BASE_HOST", "localhost")
 UI_URI_SCHEMA = os.getenv("UI_URI_SCHEMA", "https")
 UI_BASE_URI = f"{URI_SCHEMA}://{UI_BASE_HOST}"
@@ -190,6 +196,10 @@
     BASE_DIR / "static",
 ]
 
+AUTHENTICATION_BACKENDS = [
+    "django.contrib.auth.backends.ModelBackend",
+]
+
 REST_FRAMEWORK = {
     # Use Django's standard `django.contrib.auth` permissions,
     # or allow read-only access for unauthenticated users.
@@ -210,19 +220,28 @@
     "DEFAULT_VERSIONING_CLASS": "rest_framework.versioning.URLPathVersioning",
     "ALLOWED_VERSIONS": ["v1"],
     "VERSION_PARAM": "version",
+    "DEFAULT_RENDERER_CLASSES": [
+        "rest_framework.renderers.JSONRenderer",
+        # 'rest_framework.renderers.BrowsableAPIRenderer',  # DRF's default HTML docs
+    ],
 }
 
+# @see https://drf-spectacular.readthedocs.io/en/latest/settings.html
 SPECTACULAR_SETTINGS = {
-    "TITLE": "Your Project API",
-    "DESCRIPTION": "Your project description",
+    "TITLE": "AFB Requests API",
+    "DESCRIPTION": "API for managing food requests at the Animal Food Bank.",
     "VERSION": "1.0.0",
     # https://drf-spectacular.readthedocs.io/en/latest/client_generation.html
     "COMPONENT_SPLIT_REQUEST": True,
     "SERVE_INCLUDE_SCHEMA": False,
     "SWAGGER_UI_DIST": "SIDECAR",  # shorthand to use the sidecar instead
     "SWAGGER_UI_FAVICON_HREF": "SIDECAR",
     "REDOC_DIST": "SIDECAR",
-    # OTHER SETTINGS
+    "SERVERS": [
+        {"url": f"{BASE_URI}/", "description": "Dev Host"},
+        {"url": f"{STAGING_URI}/", "description": "Staging Host"},
+        {"url": f"{PRODUCTION_URI}/", "description": "Production Host"},
+    ],
 }
 
 # drfpasswordless

apps/api/afb/urls/__init__.py

@@ -8,6 +8,11 @@
 from django.contrib import admin as afbcore_admin
 from django.urls import include, path
 from django.views import defaults as default_views
+from drf_spectacular.views import (
+    SpectacularAPIView,
+    SpectacularRedocView,
+    SpectacularSwaggerView,
+)
 from rest_framework.authtoken.views import obtain_auth_token
 from rest_framework.routers import DefaultRouter
 
@@ -19,7 +24,7 @@
 
 # e.g. /api/v1/requests/abcdef1234/
 urlpatterns = [
-    path("admin/", afbcore_admin.site.urls, name="admin"),
+    path("afbadmin/", afbcore_admin.site.urls, name="admin"),
     path("api/<str:version>/", include(router.urls)),
     path("api/<str:version>/passwordless/", passwordless),
     path(
@@ -32,6 +37,19 @@
         authtoken.LogoutView.as_view(),
         name="api_token_logout",
     ),
+    path(
+        "api/<str:version>/schema/", SpectacularAPIView.as_view(), name="schema"
+    ),
+    path(
+        "api/<str:version>/schema/swagger-ui/",
+        SpectacularSwaggerView.as_view(url_name="schema"),
+        name="swagger-ui",
+    ),
+    path(
+        "api/<str:version>/schema/redoc/",
+        SpectacularRedocView.as_view(url_name="schema"),
+        name="redoc",
+    ),
 ]
 
 if settings.DEBUG:

apps/ui/components/HelpSlideover.vue

@@ -35,7 +35,7 @@ const categories = computed(() => [{
   items: [
     { shortcuts: [metaSymbol.value, 'K'], name: 'Command menu' },
     { shortcuts: ['N'], name: 'Notifications' },
-    { shortcuts: ['?'], name: 'Help & FAQ' },
+    { shortcuts: ['?'], name: 'Help & Support' },
     { shortcuts: ['/'], name: 'Search' }
   ]
 }, {
@@ -76,7 +76,7 @@ const filteredCategories = computed(() => {
         @click="shortcuts = false"
       />
 
-      {{ shortcuts ? 'Shortcuts' : 'Help & FAQ' }}
+      {{ shortcuts ? 'Shortcuts' : 'Help & Support' }}
     </template>
 
     <div v-if="shortcuts" class="space-y-6">

apps/ui/components/UserDropdown.vue

@@ -5,7 +5,7 @@ const { metaSymbol } = useShortcuts();
 
 const {
   status,
-  data,
+  data: authData,
   token,
   lastRefreshedAt,
   getSession,
@@ -57,7 +57,7 @@ const items = computed(() => [
         color="gray"
         variant="ghost"
         class="w-full"
-        :label="data?.name || 'AFB Client'"
+        :label="authData?.name || 'AFB Client'"
         :class="[open && 'bg-gray-50 dark:bg-gray-800']"
       >
         <template #leading>
@@ -74,7 +74,7 @@ const items = computed(() => [
       <div class="text-left">
         <p>Signed in as</p>
         <p class="truncate font-medium text-gray-900 dark:text-white">
-          {{ data?.email }}
+          {{ authData?.email }}
         </p>
       </div>
     </template>