Merge pull request #20 from HackNCState/kkozturk/add-remaining-core

Add core features

Author: IAmThe2ndHuman

README.md

@@ -7,6 +7,7 @@ i hope this all works if not let me know
 ### Prerequisites
 
 - `service-account.json` file with access to the Google Sheets API (let me know if you need access)
+- `CLIENT_SECRET` value for Discord OAuth2 (let me know if you need this)
 - Your Discord username in the Registration Google Sheet (so you can log in)
 
 ### 1. Tooling
@@ -21,21 +22,21 @@ i hope this all works if not let me know
 1. Create a Python virtual environment:
 
    ```bash
-   python -m venv .venv
+   python -m venv functions/venv
    ```
 
 2. Activate the virtual environment:
    - On Windows:
 
      ```powershell
-     .venv\Scripts\activate
+     functions\venv\Scripts\activate
       ```
 
    - On macOS/Linux:
 
-    ```bash
-    source .venv/bin/activate
-    ```
+      ```bash
+      source functions/venv/bin/activate
+      ```
 
 3. Install the required Python packages:
 
@@ -51,6 +52,14 @@ i hope this all works if not let me know
 
 5. This isn't best practice but we're using a service account file to allow you to access the spreadsheet data locally. Let me know and I'll share the file with you. Place it in the root of the project as `service-account.json`.
 
+6. You'll also need a file `functions/.env.local` with the following content:
+
+   ```env
+   CLIENT_SECRET=<???>
+   ```
+
+   Let me know and I'll share the client secret with you.
+
 ### 3. Running Locally
 
 1. Run the backend emulator suite:
@@ -69,6 +78,9 @@ i hope this all works if not let me know
        firebase emulators:start --project=hackncsu-today
        ```
 
+   The emulator will ask you to configure some parameters. I set defaults for these
+   so you can just hit enter to accept them.
+
 2. Run the frontend:
 
    ```bash

firestore.rules

@@ -2,8 +2,8 @@ rules_version = '2';
 
 service cloud.firestore {
   match /databases/{database}/documents {
-    
-    // Helper function to check for organizer role
+
+  // Helper function to check for organizer role
     function isOrganizer() {
       return request.auth.token.isOrganizer == true;
     }
@@ -22,10 +22,6 @@ service cloud.firestore {
       // Team members can read the entire team document.
       allow read: if request.auth.uid in resource.data.memberIds;
 
-      // Team members can only update the 'checklist' field.
-      allow update: if request.auth.uid in resource.data.memberIds &&
-                    request.resource.data.diff(resource.data).affectedKeys().hasOnly(['checklist']);
-      
       // Prevent members from creating or deleting teams (only organizers can do that via the global rule)
       allow create, delete: if false; 
     }

functions/api.py

@@ -1,13 +1,12 @@
 from dataclasses import dataclass, field
-from typing import Optional
-
+from typing import Literal, Optional
 
 @dataclass
 class User:
     id: str
     """Unique identifier for the user. Probably their Discord ID"""
 
-    role: str  # 'participant' | 'organizer'
+    role: Literal['participant', 'organizer']  # 'participant' | 'organizer'
     username: str
 
     # registration info (required for participant data structure)
@@ -19,10 +18,9 @@ class User:
     dietaryRestrictions: Optional[str] = None
     rfidUUID: Optional[str] = None
 
-    # init event info
+    # init event info (there may be more defined in the frontend...just because these are the ones used in auth)
     teamId: Optional[str] = None  # this will be unset (undefined) until team assignment
     attendedEvents: list[str] = field(default_factory=list)
-    isOrganizer: bool = False
 
     attrs: list[str] = field(default_factory=list)
     """Additional per-user attributes for future use."""

functions/auth/models.py

@@ -18,14 +18,14 @@
 )  # set this via command: firebase functions:secrets:set CLIENT_SECRET
 REDIRECT_URI = StringParam(
     "REDIRECT_URI",
-    default="https://us-central1-hackncsu-today.cloudfunctions.net/oauth_callback",
+    default="http://127.0.0.1:5001/hackncsu-today/us-central1/oauth_callback",
     description="The redirect URI for Discord OAuth2.",
-)  # set to http://127.0.0.1:5001/hackncsu-today/us-central1/oauth_callback in .env.local for local testing
+)  # set to https://us-central1-hackncsu-today.cloudfunctions.net/oauth_callback for prod deploys
 FRONTEND_AUTH_URI = StringParam(
     "FRONTEND_AUTH_URI",
-    default="https://today.hackncstate.org/auth",
+    default="http://localhost:8080/auth ",
     description="The frontend URI to redirect to after authentication is complete.",
-)  # set to http://localhost:8080/auth in .env.local for local testing
+)  # set to https://today.hackncstate.org/auth for prod deploys
 # set to https://hackncsu-today--dev-maisszg5.web.app/auth for dev deploys
 
 SPREADSHEET_URL = StringParam(
@@ -154,14 +154,17 @@ def _get_registration(uid: str, username: str) -> User:
         checked_in_idx = _get_col_index_from_headers(
             checkin_headers, CHECKED_IN_COL_C.value
         )
-        checked_in = _get_cell_from_row(checkin_row, checked_in_idx)
+        checked_in = _get_cell_from_row(checkin_row, checked_in_idx).upper()
 
         # participant did not check in
-        if str(checked_in).upper() != "TRUE":
+        if checked_in == "NO":
             raise ValueError(
                 "not_checked_in",
             )
 
+        # if checked in friday
+        friday_checked_in = checked_in == "FRIDAY"
+
         shirt_size_idx = _get_col_index_from_headers(
             reg_headers, SHIRT_SIZE_COL_R.value
         )
@@ -214,6 +217,8 @@ def _get_registration(uid: str, username: str) -> User:
             dietaryRestrictions=dietary_restrictions,
             shirtSize=shirt_size,
             rfidUUID=rfid_uuid,
+            # mark if they checked in on friday as having attended the career fair event
+            attendedEvents=["career_fair_friday"] if friday_checked_in else [],
         )