Updates outputs from the backend to camelCase for easy ingestion

CONTRIBUTING.md

@@ -191,7 +191,7 @@ git remote add upstream https://github.com/activist-org/activist.git
 4. Start your docker images with the following:
 
    ```bash
-   # --build only necessary with new dependencies or backend model changes
+   # --build only necessary with new dependencies or backend model changes.
    docker compose --env-file .env.dev up --build
 
    # And to stop the containers when you're done working:

backend/authentication/serializers.py

@@ -106,6 +106,10 @@ class Meta:
 # MARK: Methods
 
 
+class DeleteUserResponseSerializer(serializers.Serializer):
+    message = serializers.CharField(max_length=200)
+
+
 class SignupSerializer(serializers.ModelSerializer[UserModel]):
     password_confirmed = serializers.CharField(write_only=True)
 

backend/authentication/views.py

@@ -26,6 +26,7 @@
     UserTopic,
 )
 from .serializers import (
+    DeleteUserResponseSerializer,
     LoginSerializer,
     PasswordResetSerializer,
     SignupSerializer,
@@ -239,6 +240,7 @@ def post(self, request: Request) -> Response:
 class DeleteUserView(APIView):
     queryset = UserModel.objects.all()
     permission_classes = (IsAuthenticated,)
+    serializer_class = DeleteUserResponseSerializer
 
     def delete(self, request: Request, pk: UUID | str) -> Response:
         user = UserModel.objects.get(pk=pk)

backend/backend/settings.py

@@ -19,6 +19,7 @@
 django_stubs_ext.monkeypatch(extra_classes=(viewsets.ModelViewSet,))
 dotenv.load_dotenv()
 
+# MARK: DB
 
 DATABASE_HOST = os.getenv("DATABASE_HOST")
 DATABASE_NAME = os.getenv("DATABASE_NAME")
@@ -45,26 +46,29 @@
     "DJANGO_CSRF_TRUSTED_ORIGINS", "http://localhost"
 ).split(" ")
 
-# Application definition
+# MARK: Apps
 
 INSTALLED_APPS = [
-    "rest_framework",
-    "rest_framework.authtoken",
+    "corsheaders",
     "django.contrib.admin",
     "django.contrib.auth",
     "django.contrib.contenttypes",
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
+    "djangorestframework_camel_case",
+    "drf_spectacular",
+    "rest_framework",
+    "rest_framework.authtoken",
     "backend",
     "authentication",
     "entities",
     "content",
     "events",
-    "drf_spectacular",
-    "corsheaders",
 ]
 
+# MARK: Middleware
+
 MIDDLEWARE = [
     "django.middleware.security.SecurityMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",
@@ -75,14 +79,19 @@
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
     "corsheaders.middleware.CorsMiddleware",
     "django.middleware.common.CommonMiddleware",
+    "djangorestframework_camel_case.middleware.CamelCaseMiddleWare",
 ]
 
+# MARK: URLs
+
 CORS_ALLOWED_ORIGINS = [
     "http://localhost:3000",
 ]
 
 ROOT_URLCONF = "backend.urls"
 
+# MARK: Templates
+
 TEMPLATES = [
     {
         "BACKEND": "django.template.backends.django.DjangoTemplates",
@@ -100,7 +109,7 @@
 ]
 
 
-# Database
+# MARK: Database
 # https://docs.djangoproject.com/en/4.2/ref/settings/#databases
 
 DATABASES = {
@@ -115,7 +124,7 @@
 }
 
 
-# Password validation
+# MARK: Pass Validation
 # https://docs.djangoproject.com/en/4.2/ref/settings/#auth-password-validators
 
 AUTH_PASSWORD_VALIDATORS = [
@@ -135,7 +144,7 @@
 
 AUTH_USER_MODEL = "authentication.UserModel"
 
-# Internationalization
+# MARK: I18n
 # https://docs.djangoproject.com/en/4.2/topics/i18n/
 
 LANGUAGE_CODE = "en-us"
@@ -147,18 +156,18 @@
 USE_TZ = True
 
 
-# Static files (CSS, JavaScript, Images)
+# MARK: Static Files
 # https://docs.djangoproject.com/en/4.2/howto/static-files/
 
 STATIC_ROOT = BASE_DIR / "static/"
 STATIC_URL = "static/"
 
-# Default primary key field type
+# MARK: Primary Key
 # https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field
 
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
 
-# Email Settings
+# MARK: Email
 # https://docs.djangoproject.com/en/5.0/topics/email/
 
 EMAIL_HOST = os.getenv("EMAIL_HOST")
@@ -169,6 +178,8 @@
 # DEVELOPMENT ONLY
 EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
 
+# MARK: REST Framework
+
 REST_FRAMEWORK = {
     "DEFAULT_THROTTLE_CLASSES": [
         "rest_framework.throttling.AnonRateThrottle",
@@ -183,19 +194,36 @@
         "rest_framework.authentication.TokenAuthentication",
     ],
     "EXCEPTION_HANDLER": "backend.exception_handler.bad_request_logger",
+    "DEFAULT_RENDERER_CLASSES": (
+        "djangorestframework_camel_case.render.CamelCaseJSONRenderer",
+        "djangorestframework_camel_case.render.CamelCaseBrowsableAPIRenderer",
+    ),
+    "DEFAULT_PARSER_CLASSES": (
+        "djangorestframework_camel_case.parser.CamelCaseFormParser",
+        "djangorestframework_camel_case.parser.CamelCaseMultiPartParser",
+        "djangorestframework_camel_case.parser.CamelCaseJSONParser",
+    ),
 }
 
+# MARK: Spectacular
+
 SPECTACULAR_SETTINGS = {
     "TITLE": "activist.org API",
-    "DESCRIPTION": "Open-source, nonprofit activism platform",
+    "DESCRIPTION": "An open-source activism platform",
     "VERSION": "0.1.0",
     "SERVE_INCLUDE_SCHEMA": False,
+    "CAMELIZE_NAMES": False,
+    "POSTPROCESSING_HOOKS": [
+        "drf_spectacular.hooks.postprocess_schema_enums",
+        "drf_spectacular.contrib.djangorestframework_camel_case.camelize_serializer_fields",
+    ],
+    "SWAGGER_UI_FAVICON_HREF": "https://github.com/activist-org/activist/blob/main/backend/static/swagger_favicon.png?raw=true",
 }
 
 # Workaround #471 / monkeypatch() is overriding the REST_FRAMEWORK dict.
 api_settings.reload()
 
-# Logging Configuration
+# MARK: Logging
 # https://docs.djangoproject.com/en/4.2/topics/logging/
 
 LOGGING = {

backend/entities/factories.py

@@ -33,6 +33,7 @@ class Meta:
     name = factory.Faker("word")
     tagline = factory.Faker("word")
     social_links = ["https://www.instagram.com/activist_org/"]
+    get_involved_url = "https://activist.org/"
     created_by = factory.SubFactory("authentication.factories.UserFactory")
     terms_checked = factory.Faker("boolean")
     status = factory.SubFactory("entities.factories.StatusTypeFactory", name="Active")

backend/entities/serializers.py

@@ -40,7 +40,7 @@ class Meta:
 
 
 class OrganizationTextSerializer(serializers.ModelSerializer[OrganizationText]):
-    orgID = serializers.StringRelatedField(source="org_id.id")
+    org_id = serializers.StringRelatedField(source="org_id.id")
 
     class Meta:
         model = OrganizationText

backend/requirements-dev.in

@@ -1,13 +1,13 @@
 # In order to add, delete or modify a dependency, please update
-# the reference here and then run:
+# the reference here and then the following in ./backend:
 #
-# - `pip-compile --rebuild requirements.in`
-# - `pip-compile --rebuild requirements-dev.in`
+# - pip-compile --rebuild requirements.in
+# - pip-compile --rebuild requirements-dev.in
 #
 # Make sure we use production deps for constraining installed dev packages. This
 # is important as otherwise we could be running tests with different versions
 # than production.
-#
+
 -r requirements.txt
 
 factory-boy

backend/requirements-dev.txt

@@ -53,6 +53,8 @@ djangorestframework==3.15.2
     # via
     #   -r requirements.txt
     #   drf-spectacular
+djangorestframework-camel-case==1.4.2
+    # via -r requirements.txt
 djangorestframework-stubs==3.14.4
     # via -r requirements.txt
 drf-spectacular==0.26.5

backend/requirements.in

@@ -1,15 +1,15 @@
 # In order to add, delete or modify a dependency, please update
-# the reference here and then run:
-#
-# - `pip-compile --rebuild requirements.in`
-# - `pip-compile --rebuild requirements-dev.in`
+# the reference here and then run the following in ./backend:
 #
+# - pip-compile --rebuild requirements.in
+# - pip-compile --rebuild requirements-dev.in
 
 Django
 django-cors-headers
 django-stubs
 django-stubs-ext
 djangorestframework
+djangorestframework-camel-case
 djangorestframework-stubs
 drf-spectacular
 gunicorn

backend/requirements.txt

@@ -36,6 +36,8 @@ djangorestframework==3.15.2
     # via
     #   -r requirements.in
     #   drf-spectacular
+djangorestframework-camel-case==1.4.2
+    # via -r requirements.in
 djangorestframework-stubs==3.14.4
     # via -r requirements.in
 drf-spectacular==0.26.5

frontend/components/EmptyState.vue

@@ -3,7 +3,7 @@
     class="flex w-full flex-col items-center bg-light-layer-0 text-light-text dark:bg-dark-layer-0 dark:text-dark-text"
   >
     <PageContent
-      :imgURL="BOOTSTRAP_CLOUD_MOON_URL"
+      :imgUrl="BOOTSTRAP_CLOUD_MOON_URL"
       imgAltText="components.empty_state.img_alt_text"
     >
       <div>

frontend/components/card/CardConnect.vue

@@ -120,11 +120,11 @@ const props = defineProps<{
 }>();
 
 const { userIsSignedIn } = useUser();
-const paramsID = useRoute().params.id;
-const paramsIDGroup = useRoute().params.groupID;
+const paramsId = useRoute().params.id;
+const paramsIdGroup = useRoute().params.groupId;
 
-const id = typeof paramsID === "string" ? paramsID : undefined;
-const idGroup = typeof paramsIDGroup === "string" ? paramsIDGroup : undefined;
+const id = typeof paramsId === "string" ? paramsId : undefined;
+const idGroup = typeof paramsIdGroup === "string" ? paramsIdGroup : undefined;
 
 const organizationStore = useOrganizationStore();
 const groupStore = useGroupStore();
@@ -135,13 +135,13 @@ let group: Group;
 let event: Event;
 
 if (props.pageType == "organization") {
-  await organizationStore.fetchByID(id);
+  await organizationStore.fetchById(id);
   organization = organizationStore.organization;
 } else if (props.pageType == "group") {
-  await groupStore.fetchByID(idGroup);
+  await groupStore.fetchById(idGroup);
   group = groupStore.group;
 } else if (props.pageType == "event") {
-  await eventStore.fetchByID(id);
+  await eventStore.fetchById(id);
   event = eventStore.event;
 }
 

frontend/components/card/CardDocsEntry.vue

@@ -10,13 +10,13 @@
       <img
         v-if="$colorMode.value == 'light'"
         :class="imgDimensions"
-        :src="imgURL + '_' + 'dark.png'"
+        :src="imgUrl + '_' + 'dark.png'"
         :alt="$t(imgAltText)"
       />
       <img
         v-else
         :class="imgDimensions"
-        :src="imgURL + '_' + 'light.png'"
+        :src="imgUrl + '_' + 'light.png'"
         :alt="$t(imgAltText)"
       />
     </div>
@@ -34,7 +34,7 @@ const localPath = useLocalePath();
 
 defineProps<{
   url: string;
-  imgURL: string;
+  imgUrl: string;
   imgDimensions: string;
   imgAltText: string;
   title: string;

frontend/components/card/CardOrgApplicationVote.vue

@@ -7,7 +7,7 @@
         class="mr-5 fill-light-text dark:fill-dark-text"
       >
         <Icon
-          v-if="organization.iconURL === undefined"
+          v-if="organization.iconUrl === undefined"
           name="IconOrganization"
           size="3em"
         />
@@ -16,7 +16,7 @@
           class="rounded border border-light-section-div dark:border-dark-section-div"
         >
           <img
-            :src="organization.iconURL"
+            :src="organization.iconUrl"
             class="h-full w-12"
             :alt="
               $t('_global.entity_logo', {

frontend/components/card/about/CardAboutEvent.vue

@@ -67,7 +67,7 @@ const idParam = useRoute().params.id;
 const id = typeof idParam === "string" ? idParam : undefined;
 
 const eventStore = useEventStore();
-await eventStore.fetchByID(id);
+await eventStore.fetchById(id);
 
 const { event } = eventStore;
 

frontend/components/card/about/CardAboutGroup.vue

@@ -87,7 +87,7 @@ const idParam = useRoute().params.id;
 const id = typeof idParam === "string" ? idParam : undefined;
 
 const groupStore = useGroupStore();
-await groupStore.fetchByID(id);
+await groupStore.fetchById(id);
 
 const { group } = groupStore;
 

frontend/components/card/about/CardAboutOrganization.vue

@@ -95,7 +95,7 @@ const idParam = useRoute().params.id;
 const id = typeof idParam === "string" ? idParam : undefined;
 
 const organizationStore = useOrganizationStore();
-await organizationStore.fetchByID(id);
+await organizationStore.fetchById(id);
 
 const { organization } = organizationStore;
 

frontend/components/card/get-involved/CardGetInvolvedGroup.vue

@@ -19,9 +19,9 @@
       />
       <div class="flex space-x-2 pt-2 lg:absolute lg:right-0 lg:pt-0">
         <BtnRouteInternal
-          v-if="group.getInvolvedURL"
+          v-if="group.getInvolvedUrl"
           :cta="true"
-          :linkTo="group.getInvolvedURL"
+          :linkTo="group.getInvolvedUrl"
           label="_global.join_group"
           fontSize="sm"
           :rightIcon="IconMap.ARROW_RIGHT"