Merge pull request #301 from SPARCS-UP-Mindanao/stage

Devfest Release November 9

Author: ArJSarmiento

backend/.gitignore

@@ -8,3 +8,4 @@ node_modules
 .env
 .env.*
 .ruff_cache
+pyrightconfig.json

backend/constants/common_constants.py

@@ -63,8 +63,10 @@ class EmailType(str, Enum):
 class SpecialEmails(str, Enum):
     DURIAN_PY = 'durianpy.davao@gmail.com'
     AWSUG_DAVAO = 'hello@awsugdavao.ph'
+    GDG_DAVAO = 'davao.gdg@gmail.com'
 
 
 class SpecialSenders(str, Enum):
     DURIAN_PY = 'DurianPy - Davao Python User Group'
     AWSUG_DAVAO = 'AWS User Group Davao'
+    GDG_DAVAO = 'Google Developer Group Davao'

backend/controller/preregistration_router.py

@@ -5,6 +5,7 @@
 from constants.common_constants import CommonConstants
 from fastapi import APIRouter, Depends, Path, Query
 from model.common import Message
+from model.file_uploads.file_upload import FileDownloadOut
 from model.preregistrations.preregistration import (
     PreRegistrationIn,
     PreRegistrationOut,
@@ -197,7 +198,9 @@ def update_preregistration(
     _ = current_user
     preregistrations_uc = PreRegistrationUsecase()
     return preregistrations_uc.update_preregistration(
-        event_id=event_id, preregistration_id=entry_id, preregistration_in=preregistration
+        event_id=event_id,
+        preregistration_id=entry_id,
+        preregistration_in=preregistration,
     )
 
 
@@ -237,3 +240,35 @@ def delete_preregistration(
     _ = current_user
     preregistrations_uc = PreRegistrationUsecase()
     return preregistrations_uc.delete_preregistration(preregistration_id=entry_id, event_id=event_id)
+
+
+@preregistration_router.get(
+    '/{eventId}/csv_download',
+    response_model=FileDownloadOut,
+    responses={
+        404: {'model': Message, 'description': 'Pre-registration not found'},
+        500: {'model': Message, 'description': 'Internal server error'},
+    },
+    summary='Get CSV for pre-registration',
+)
+@preregistration_router.get(
+    '/{eventId}/csv_download/',
+    response_model=FileDownloadOut,
+    response_model_exclude_none=True,
+    response_model_exclude_unset=True,
+    include_in_schema=False,
+)
+def get_preregistration_csv(
+    event_id: str = Path(..., title='Event Id', alias=CommonConstants.EVENT_ID),
+):
+    """Get the CSV for a specific event
+
+    :param event_id: The event ID.
+    :type event_id: str
+
+    :return: The csv for the corresponding event
+    :rtype: FileDownloadOut
+
+    """
+    preregistrations_uc = PreRegistrationUsecase()
+    return preregistrations_uc.get_preregistration_csv(event_id=event_id)

backend/controller/registration_router.py

@@ -5,6 +5,7 @@
 from constants.common_constants import CommonConstants
 from fastapi import APIRouter, Depends, Path, Query
 from model.common import Message
+from model.file_uploads.file_upload import FileDownloadOut
 from model.registrations.registration import (
     RegistrationIn,
     RegistrationOut,
@@ -183,3 +184,35 @@ def delete_registration(
     _ = current_user
     registrations_uc = RegistrationUsecase()
     return registrations_uc.delete_registration(registration_id=entry_id, event_id=event_id)
+
+
+@registration_router.get(
+    '/{eventId}/csv_download',
+    response_model=FileDownloadOut,
+    responses={
+        404: {'model': Message, 'description': 'Registration not found'},
+        500: {'model': Message, 'description': 'Internal server error'},
+    },
+    summary='Get CSV for registration',
+)
+@registration_router.get(
+    '/{eventId}/csv_download/',
+    response_model=FileDownloadOut,
+    response_model_exclude_none=True,
+    response_model_exclude_unset=True,
+    include_in_schema=False,
+)
+def get_registration_csv(
+    event_id: str = Path(..., title='Event Id', alias=CommonConstants.EVENT_ID),
+):
+    """Get the CSV for a specific event
+
+    :param event_id: The event ID.
+    :type event_id: str
+
+    :return: The csv for the corresponding event
+    :rtype: FileDownloadOut
+
+    """
+    registrations_uc = RegistrationUsecase()
+    return registrations_uc.get_registration_csv(event_id=event_id)

backend/model/events/event.py

@@ -70,6 +70,8 @@ class Meta:
     konfhubId = UnicodeAttribute(null=True)
     konfhubApiKey = UnicodeAttribute(null=True)
 
+    platformFee = NumberAttribute(null=True)
+
     eventIdIndex = EventIdIndex()
 
 
@@ -98,6 +100,8 @@ class Config:
     konfhubId: Optional[str] = Field(None, title='Konfhub ID')
     konfhubApiKey: Optional[str] = Field(None, title='Konfhub API Key')
 
+    platformFee: Optional[float] = Field(None, title='Percent platform fee')
+
 
 class EventIn(EventDBIn):
     class Config:

backend/model/konfhub/konfhub.py

@@ -1,18 +1,18 @@
-from typing import Dict, List
+from typing import Dict, List, Optional
 
 from pydantic import BaseModel, EmailStr, Field
 
 
 class RegistrationDetail(BaseModel):
-    name: str = Field(..., description='Name of the registrant')
-    email_id: EmailStr = Field(..., description='Email ID of the registrant')
-    quantity: int = Field(..., description='Quantity of the registrant')
-    designation: str = Field(..., description='Designation of the registrant')
-    organisation: str = Field(..., description='Organisation of the registrant')
-    t_shirt_size: str = Field(..., description='T-shirt size of the registrant')
-    phone_number: str = Field(..., description='Phone number of the registrant')
-    dial_code: str = Field(..., description='Dial code of the registrant')
-    country_code: str = Field(..., description='Country code of the registrant')
+    name: Optional[str] = Field(None, description='Name of the registrant')
+    email_id: Optional[EmailStr] = Field(None, description='Email ID of the registrant')
+    quantity: Optional[int] = Field(None, description='Quantity of the registrant')
+    designation: Optional[str] = Field(None, description='Designation of the registrant')
+    organisation: Optional[str] = Field(None, description='Organisation of the registrant')
+    phone_number: Optional[str] = Field(None, description='Phone number of the registrant')
+    dial_code: Optional[str] = Field(None, description='Dial code of the registrant')
+    country_code: Optional[str] = Field(None, description='Country code of the registrant')
+    t_shirt_size: Optional[str] = Field(None, description='T-shirt size of the registrant')
 
 
 class KonfHubCaptureRegistrationIn(BaseModel):

backend/model/preregistrations/preregistration.py

@@ -78,7 +78,7 @@ class Config:
 
 class PreRegistrationPatch(PreRegistrationaDataIn):
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
 
     acceptanceStatus: Optional[AcceptanceStatus] = Field(None, title='Acceptance Status')
     acceptanceEmailSent: bool = Field(None, title='Acceptance Email Sent')

backend/scripts/import_pre_registration_from_csv.py

@@ -0,0 +1,206 @@
+import csv
+import re
+from datetime import datetime
+from enum import Enum
+from typing import Optional, Tuple
+
+import pytz
+import ulid
+from constants.common_constants import EntryStatus
+from model.preregistrations.preregistration import PreRegistration, PreRegistrationIn
+from model.preregistrations.preregistrations_constants import AcceptanceStatus
+from pydantic import BaseModel, EmailStr, Field, validator
+
+
+class CareerStatus(str, Enum):
+    STUDENT = 'Student'
+    WORKING_STUDENT = 'Working Student'
+    WORKING_PROFESSIONAL = 'Working Professional'
+    ENTREPRENEUR = 'Entrepreneur'
+
+
+class DeveloperStatus(str, Enum):
+    DEVELOPER = 'Developer'
+    NON_DEVELOPER = 'Non-developer'
+
+
+class LevelOfExperience(str, Enum):
+    BEGINNER = 'Beginner'
+    INTERMEDIATE = 'Intermediate'
+    ADVANCED = 'Advanced'
+
+
+class DevFestColumns:
+    TIMESTAMP = 'Timestamp'
+    EMAIL = 'Username'
+    NAME = 'Name'
+    PHONE_NUMBER = 'Phone number'
+    CAREER_STATUS = 'Which of the options best describe you?'
+    DEVELOPER_STATUS = 'Are you a'
+    JOB_TITLE = 'Job title'
+    LEVEL_OF_EXPERIENCE = 'Level of expertise'
+    COMPANY_AFFILIATION = 'Company or affiliation'
+    GENDER = 'Gender'
+    WHY_INTERESTED_IN_DEVFEST = 'Why are you interested in joining DevFest Davao 2024?'
+    HOW_DID_YOU_LEARN_ABOUT_DEVFEST = 'How did you learn about the event?'
+    INTEREST_IN_JOINING_AI_WORKSHOP = 'Are you interested in joining an AI/ML (Machine Learning) hands-on workshop?'
+    PREFERRED_SOCIAL_MEDIA = (
+        'When it comes to joining a group chat community, which social media platform/s would you prefer?'
+    )
+    PROCESSING_OF_PERSONAL_DATA = 'I hereby consent to the processing of the personal data that I have provided and declare my agreement with the data protection regulations in the data privacy statement.'
+
+
+class DevFestPreRegistrationSchema(BaseModel):
+    timestamp: str = Field(title=DevFestColumns.TIMESTAMP)
+    email: EmailStr = Field(None, title=DevFestColumns.EMAIL)
+    name: str = Field(None, title=DevFestColumns.NAME)
+    phone_number: str = Field(
+        None,
+        title=DevFestColumns.PHONE_NUMBER,
+        regex=r'^(09)\d{9}$',  # Philippine mobile number
+    )
+    career_status: Optional[CareerStatus] = Field(None, title=DevFestColumns.CAREER_STATUS)
+    developer_status: Optional[DeveloperStatus] = Field(None, title=DevFestColumns.DEVELOPER_STATUS)
+    job_title: Optional[str] = Field(None, title=DevFestColumns.JOB_TITLE)
+    level_of_experience: Optional[LevelOfExperience] = Field(None, title=DevFestColumns.LEVEL_OF_EXPERIENCE)
+    company_affiliation: Optional[str] = Field(None, title=DevFestColumns.COMPANY_AFFILIATION)
+    gender: Optional[str] = Field(None, title=DevFestColumns.GENDER)
+    why_interested_in_devfest: Optional[str] = Field(None, title=DevFestColumns.WHY_INTERESTED_IN_DEVFEST)
+    how_did_you_learn_about_devfest: Optional[str] = Field(None, title=DevFestColumns.HOW_DID_YOU_LEARN_ABOUT_DEVFEST)
+    interest_in_joining_ai_workshop: Optional[bool] = Field(None, title=DevFestColumns.INTEREST_IN_JOINING_AI_WORKSHOP)
+    preferred_social_media: Optional[str] = Field(None, title=DevFestColumns.PREFERRED_SOCIAL_MEDIA)
+    processing_of_personal_data: Optional[str] = Field(None, title=DevFestColumns.PROCESSING_OF_PERSONAL_DATA)
+
+    @validator('phone_number', pre=True)
+    def strip_and_clean_phone_number(cls, value):
+        """Strip and clean phone number to remove non-numeric characters before validation.
+
+        :param value: Phone number string.
+        :type value: str
+
+        :return: Cleaned phone number string.
+        :rtype: str
+        """
+        if value is None or value == '':
+            return None
+
+        value = re.sub(r'\D', '', value)
+
+        return value
+
+
+def separate_first_and_last_name(name: str) -> Tuple[str, str]:
+    """Separate first and last name from a full name string, excluding any middle initials.
+
+    The last name is assumed to be the last word in the full name string, while the first name
+    consists of all preceding words before the last name.
+
+    :param name: Full name string.
+    :type name: str
+
+    :return: A tuple containing the first name and last name, in that order.
+    :rtype: Tuple[str, str]
+
+    Examples:
+        >>> separate_first_and_last_name("John Doe")
+        ('John', 'Doe')
+
+        >>> separate_first_and_last_name("Juan Manuel C. Cruz")
+        ('Juan Manuel', 'Cruz')
+    """
+
+    name_parts = name.split()
+
+    if len(name_parts) > 2:
+        first_name = ' '.join(name_parts[:-2] + [name_parts[-2] if len(name_parts[-2]) > 2 else '']).strip()
+    else:
+        first_name = name_parts[0]
+
+    last_name = name_parts[-1] if len(name_parts) > 1 else 'N/A'
+
+    return first_name, last_name
+
+
+def import_pre_registration_from_csv(eventId: str, csv_file_path: str = 'input.csv') -> None:
+    """Import pre-registration data from a CSV file to a PreRegistration table.
+
+    :param eventId: Event ID.
+    :type eventId: str
+
+    :param csv_file_path: Path to the CSV file containing pre-registration data.
+    :type csv_file_path: str
+
+    :return: None
+    :rtype: None
+    """
+
+    with open(csv_file_path, mode='r') as csv_file:
+        csv_reader = csv.reader(csv_file)
+        headers = next(csv_reader)
+        pre_registration_data_rows: list[DevFestPreRegistrationSchema] = []
+
+        for line in csv_reader:
+            # Dictionary mapping of CSV columns to DevFestPreRegistrationSchema fields
+            pre_registration_data = {
+                'timestamp': line[headers.index(DevFestColumns.TIMESTAMP)],
+                'email': line[headers.index(DevFestColumns.EMAIL)],
+                'name': line[headers.index(DevFestColumns.NAME)],
+                'phone_number': line[headers.index(DevFestColumns.PHONE_NUMBER)].strip(),
+                'career_status': line[headers.index(DevFestColumns.CAREER_STATUS)],
+                'developer_status': line[headers.index(DevFestColumns.DEVELOPER_STATUS)],
+                'job_title': line[headers.index(DevFestColumns.JOB_TITLE)],
+                'level_of_experience': line[headers.index(DevFestColumns.LEVEL_OF_EXPERIENCE)],
+                'company_affiliation': line[headers.index(DevFestColumns.COMPANY_AFFILIATION)],
+                'gender': line[headers.index(DevFestColumns.GENDER)],
+                'why_interested_in_devfest': line[headers.index(DevFestColumns.WHY_INTERESTED_IN_DEVFEST)],
+                'how_did_you_learn_about_devfest': line[headers.index(DevFestColumns.HOW_DID_YOU_LEARN_ABOUT_DEVFEST)],
+                'interest_in_joining_ai_workshop': bool(
+                    line[headers.index(DevFestColumns.INTEREST_IN_JOINING_AI_WORKSHOP)]
+                ),
+                'preferred_social_media': line[headers.index(DevFestColumns.PREFERRED_SOCIAL_MEDIA)],
+                'processing_of_personal_data': line[headers.index(DevFestColumns.PROCESSING_OF_PERSONAL_DATA)],
+            }
+
+            pre_registration_data_rows.append(DevFestPreRegistrationSchema(**pre_registration_data))
+
+        with PreRegistration.batch_write() as batch:
+            current_date = datetime.now(tz=pytz.timezone('Asia/Manila')).isoformat()
+            items = []
+
+            for pre_registration in pre_registration_data_rows:
+                pre_registration_id = ulid.ulid()
+                first_name, last_name = separate_first_and_last_name(pre_registration.name)
+
+                preregistration_in = PreRegistrationIn(
+                    email=pre_registration.email,
+                    firstName=first_name,
+                    lastName=last_name,
+                    contactNumber=pre_registration.phone_number,
+                    careerStatus=pre_registration.career_status,
+                    yearsOfExperience=pre_registration.level_of_experience,
+                    organization=pre_registration.company_affiliation,
+                    title=pre_registration.job_title,
+                    eventId=eventId,
+                )
+
+                items.append(
+                    PreRegistration(
+                        hashKey=eventId,
+                        rangeKey=pre_registration_id,
+                        createDate=current_date,
+                        updateDate=current_date,
+                        entryStatus=EntryStatus.ACTIVE.value,
+                        preRegistrationId=pre_registration_id,
+                        acceptanceStatus=AcceptanceStatus.ACCEPTED.value,
+                        **preregistration_in.dict(),
+                    )
+                )
+
+            for item in items:
+                batch.save(item)
+
+
+if __name__ == '__main__':
+    event_id = 'testevent'
+    csv_file_path = 'scripts/input.csv'
+    import_pre_registration_from_csv(eventId=event_id, csv_file_path=csv_file_path)