Merge branch 'amfoss:master' into dev

Author: he1senbrg

LICENSE

@@ -0,0 +1,58 @@
+<div align="center">
+  <h1>Root</h1>
+  <p>a backend to manage all club information</p>
+</div>
+
+### Overview
+**Root** is a backend for managing all club related info; most other projects will be getting or publishing their data to root.
+
+### Setup Instructions
+
+#### Prerequisites
+1. Ensure you have Rust installed. Use `rustup` for easy installation.  
+   ```bash
+   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+   source $HOME/.cargo/env
+   ```
+2. Install the Shuttle CLI.
+   ```bash
+   cargo install shuttle-cli
+   ```
+
+3. Install Docker. Check [this](https://docs.docker.com/desktop/setup/install/linux/) out for instructions.
+
+#### Clone the Repository
+```bash
+git clone https://github.com/amfoss/root.git
+cd root
+```
+
+#### Set up Secrets
+Create a `Secrets.toml` file in the root directory with the secret key
+```
+ROOT_SECRET='secret_key'
+```
+
+#### Run Locally
+```bash
+cargo shuttle run
+```
+
+---
+
+### Documentation
+
+Explore the [API documentation](/docs/docs.md) for detailed information and usage guidelines.
+
+---
+
+### How to Contribute
+
+1. Fork the repository and clone it to your local machine.
+2. Set up the project by following the installation instructions above.
+3. Identify an issue or feature you'd like to work on, and create an issue to track it.
+4. Develop the patch or feature, ensuring it is thoroughly tested.
+5. Submit a pull request, referencing the relevant issue number.
+
+### License
+This project is licensed under GNU General Public License V3. You are welcome to adapt it, make it yours. Just make sure that you credit us too.

README.md

@@ -0,0 +1,5 @@
+# API Documentation
+
+## Contents
+- [GraphQL Queries](/docs/queries.md)
+- [GraphQL Mutations](/docs/mutations.md)

docs/docs.md

@@ -0,0 +1,91 @@
+## GraphQL Mutations
+
+## Contents
+- [addMember](#addmember)
+- [markAttendance](#markattendance)
+- [addAttendance](#addattendance)
+
+---
+
+### addMember
+Add a new member to the database.
+
+#### GraphQL Mutation
+```graphql
+mutation {
+    addMember(name: "name", email: "email", year: 2) {
+        id
+        name
+        year
+    }
+}
+```
+
+#### Arguments (all required)
+```graphql
+rollno: String!
+name: String!
+hostel: String!
+email: String!
+sex: String!
+year: Int!
+macaddress: String!
+discordId: String
+```
+
+**Note:** The `year` field represents the members's current college year
+- `1` for first-year
+- `2` for second-year
+- `3` for third-year
+- `4` for fourth-year
+
+---
+
+### markAttendance
+Record attendance for a member.
+
+#### GraphQL Mutation  
+```graphql
+mutation {
+    markAttendance(id: 0, date: "YYYY-MM-DD", isPresent: true, hmacSignature: "hmac_signature") {
+        id
+        date
+        isPresent
+        hmacSignature
+    }
+}
+```
+
+#### Arguments (all required)
+```graphql
+id: Int!
+date: NaiveDate!
+isPresent: Boolean!
+hmacSignature: String!
+```
+
+---
+
+### addAttendance
+Initiate attendance records for the day (*used internally*).
+
+#### GraphQL Mutation
+```graphql
+mutation {
+    addAttendance(id: 0, date: "YYYY-MM-DD", timein: "%H:%M:%S%.f", timeout: "%H:%M:%S%.f", isPresent:true) {
+        id
+        date
+        isPresent
+        hmacSignature
+    }
+}
+```
+
+#### Arguments (all required)
+```graphql
+id: Int!
+date: NaiveDate!
+timein: NaiveTime!
+timeout: NaiveTime!
+isPresent: Boolean!
+```

docs/mutations.md

@@ -0,0 +1,64 @@
+## GraphQL Queries
+
+## Contents
+- [getMember](#getmember)
+- [getAttendance](#getattendance)
+
+---
+
+### getMember
+Retrieve all the members from the database.
+
+#### GraphQL Query
+```graphql
+query {
+    getMember {
+        id
+        name
+        email
+    }
+}
+```
+
+#### Fields
+```graphql
+id: Int!
+rollno: String!
+name: String!
+hostel: String!
+email: String!
+sex: String!
+year: Int!
+macaddress: String!
+discordId: String!
+```
+
+---
+
+### getAttendance
+Retrieve attendance records for a specific date.
+
+#### GraphQL Query
+```graphql
+query {
+    getAttendance(date: "YYYY-MM-DD") {
+        id
+        date
+        timein
+        timeout
+        isPresent
+    }
+}
+```
+
+#### Arguments
+- `date` (required): A date in the format `YYYY-MM-DD`.
+
+#### Fields
+```graphql
+id: Int!
+date: NaiveDate!
+timein: NaiveTime!
+timeout: NaiveTime!
+isPresent: Boolean!
+```

docs/queries.md

@@ -0,0 +1 @@
+ALTER TABLE Member ADD COLUMN discord_id TEXT;

migrations/20241017154637_add_discord_id_field.sql

@@ -14,4 +14,5 @@ pub struct Member {
     pub sex: String,
     pub year: i32,
     pub macaddress: String,
+    pub discord_id: Option<String>,
 }

src/db/member.rs

@@ -29,14 +29,15 @@ impl MutationRoot {
         sex: String, 
         year: i32,
         macaddress: String,
+        discord_id: String,
 
     ) -> Result<Member, sqlx::Error> {
         let pool = ctx.data::<Arc<PgPool>>().expect("Pool not found in context");
 
 
 
         let member = sqlx::query_as::<_, Member>(
-            "INSERT INTO Member (rollno, name, hostel, email, sex, year, macaddress) VALUES ($1, $2, $3, $4, $5, $6, $7) RETURNING *"
+            "INSERT INTO Member (rollno, name, hostel, email, sex, year, macaddress, discord_id) VALUES ($1, $2, $3, $4, $5, $6, $7, $8) RETURNING *"
         )
         .bind(rollno)
         .bind(name)
@@ -45,6 +46,7 @@ impl MutationRoot {
         .bind(sex)
         .bind(year)
         .bind(macaddress)
+        .bind(discord_id)
         .fetch_one(pool.as_ref())
         .await?;