Patch up oversights (#46)

* fix: add missing id to response of /users endpoint

* docs: more concise and better documented readme

Author: CodeF0x

readme.md

@@ -1,201 +1,193 @@
-> Warning: You should probably not use this in production or with any data that is sensitive as the authentication
-> system
-> is made very amateurish.
+# Cira - A Minimalistic Ticket System Backend
 
-# Cira - a minimalistic ticket system backend
+Cira is a minimalistic backend for managing tickets in small projects. It provides essential APIs to handle ticket creation, updates, deletion, labeling, assignment, and filtering.
 
-Cira is a minimalistic ticket system backend for small and simple projects.
-You could even use it as an overcomplicated todo app.
+## Overview
+Cira offers foundational API functionalities for managing tickets including:
+- Creation and deletion of tickets
+- Updating existing tickets
+- Grouping tickets by labels
+- Assigning tickets to users
+- Filtering tickets by various criteria
+- User authentication via bearer tokens
 
-The only thing it does is to provide an api.
-The rest is up to you.
-Create a native desktop or smartphone app, or keep in the web as most ticket boards to.
-You decide, the possibilities are endless.
+## Setup & Usage
 
-## Features
+### Prerequisites
+Ensure you have installed the following tools:
+- [Rust](https://rust-lang.org)
+- [Git](https://git-scm.com/)
+- [Diesel](https://diesel.rs)
+- [SQLite](https://www.sqlite.org/)
 
-Cira gives you the foundation to:
+### Running Locally
 
-- create and delete tickets
-- update tickets after creation
-- group tickets by labels
-- assign tickets to users
-- filter tickets by labels, assignee, status and labels
-- authentication with bearer tokens
+1. **Clone the repository**:
+   ```bash
+   git clone https://github.com/CodeF0x/cira.git
+   cd cira
+   ```
+2. **Install Diesel CLI for SQLite** and set up database:
+   ```bash
+   cargo install diesel_cli --no-default-features --features "sqlite"
+   diesel setup
+   ```
+3. **Build and run**:
+   ```bash
+   cargo build --release
+   ./target/release/cira
+   ```
 
-## Run Locally
+**Note**: Make sure to update both `HASH_SECRET` and `JWT_SECRET` in the `.env` file with cryptographically secure values!
 
-Simply clone the repository, set up the database and compile the application locally.
-Then start it.
-You are required to have installed: [the rust programming language](https://rust-lang.org),
-[git](https://git-scm.com/), [diesel](https://diesel.rs), [sqlite](https://www.sqlite.org/)
+### Troubleshooting
 
-```bash
-git clone https://github.com/CodeF0x/cira.git
-cd cira
-cargo install diesel_cli --no-default-features --features "sqlite"
-diesel setup
-cargo build --release
-./target/release/cira
-```
-
-If you're on Debian and get `error: linking with 'cc' failed: exit status: 1`, make sure to have `build-essential`
-installed. Same goes for other distros (build-essential might be called different / have an equivalent).
-
-If this error accours while installing `diesel_cli`, try `sudo apt install -y libsqlite3-dev libpq-dev libmysqlclient-dev`.
-
-There are some default values set in the .env file, you can adjust them as you wish.
-Keep in mind to change the code as well.
-> ⚠️ Be sure to update both `HASH_SECRET` and `JWT_SECRET` to something cryptographically safe! 
-
-If everything went well and there is no output after running the last command, cira is listening on port `8080`.
-
-You can also launch it in a screen or in a container, so it runs without an active shell session.
+If you encounter errors during installation or setup:
+- On Debian, if you get a `linking with 'cc' failed: exit status: 1` error, ensure `build-essential` is installed.
+- For issues while installing Diesel CLI, try running: `sudo apt install -y libsqlite3-dev libpq-dev libmysqlclient-dev`.
 
-## Running Tests
+---
 
-To run tests, set up a fake database that is independent of the actual production database.
-You need to have installed [diesel](https://diesel.rs), [sqlite](https://www.sqlite.org/) and [rust](https://rust-lang.org).
+## API Documentation
 
-```bash
-diesel migration run --database-url test-backend.sqlite
-cargo test
-```
+### General Information
+- **Authorization**: Every endpoint requires a Bearer Token for authentication except the endpoints related to user login and signup (`/api/login` and `/api/signup`).
 
-## API Reference
+### Ticket Management
 
-#### Create a new ticket
+#### Create a New Ticket
 
 ```http
-  POST /api/tickets
+POST /api/tickets
 ```
 
-Your payload must be valid JSON and contain the following properties:
+**Payload**:
 
 | Property        | Type            | Description                                                                   |
 |:----------------|:----------------|:------------------------------------------------------------------------------|
-| `title`         | `string`        | **Required**. The title of your ticket                                        |
-| `body`          | `string`        | **Required**. The body of your ticket                                         |
-| `labels`        | `Array<string>` | **Required**. Labels of your ticket                                           |
-| `status`        | `string`        | **Required**. The status of your ticket (set it to "Open")                    |
-| `assigned_user` | `id \| null`    | **Optional**. A user the ticket should be assigned to. Can be omitted or null |
+| `title`         | `string`        | **Required**. Title of the ticket                                            |
+| `body`          | `string`        | **Required**. Body content of the ticket                                     |
+| `labels`        | `Array<string>` | **Required**. Labels for categorizing the ticket                            |
+| `status`        | `string`        | **Required**. Status (e.g., 'Open')                                         |
+| `assigned_user` | `id \| null`    | **Optional**. ID of user assigned to this ticket or `null`.                  |
+
+**Status Options**:
+
+- Open
+- Closed
 
-Possible Status options:
+**Label Options**:
 
-- `Open`
-- `Closed`
+- Feature
+- Bug
+- WontFix
+- Done
+- InProgress
 
-Possible Label options:
+#### Get All Tickets
 
-- `Feature`
-- `Bug`
-- `WontFix`
-- `Done`
-- `InProgress`
+```http
+GET /api/tickets
+```
 
-Creates a new ticket and returns it.
+Retrieves all tickets.
 
-#### Get tickets
+#### Delete a Ticket
 
 ```http
-  GET /api/tickets
+DELETE /api/tickets/{id}
 ```
 
-Get all tickets.
+**Path Parameters**:
+
+| Parameter | Type   | Description                        |
+|:----------|:-------|:-----------------------------------|
+| `id`      | number | **Required**. ID of the ticket     |
 
-#### Delete ticket
+#### Edit a Ticket
 
 ```http
-  DELETE /api/tickets/{id}
+PUT /api/tickets/{id}
 ```
 
-URL parameters:
+**Path Parameters**: (Same as Delete Ticket)
 
-| Property | Type     | Description                        |
-|:---------|:---------|:-----------------------------------|
-| `id`     | `number` | **Required**. The id of the ticket |
+**Payload**: (Same structure as Create a New Ticket)
 
-Deletes a ticket and returns it.
+### User Authentication
 
-#### Edit a ticket
+#### Sign Up
 
 ```http
-  PUT /api/tickets/{id}
+POST /api/signup
 ```
 
-URL parameters:
+**Payload**:
 
-| Property | Type     | Description                        |
-|:---------|:---------|:-----------------------------------|
-| `id`     | `number` | **Required**. The id of the ticket |
+| Property       | Type   | Description                            |
+|:---------------|:-------|:---------------------------------------|
+| `display_name` | string | **Required**. Display name             |
+| `email`        | string | **Required**. Email address            |
+| `password`     | string | **Required**. Password                 |
 
-Your payload must be valid JSON and contain the following properties:
+#### Login
 
-| Property        | Type            | Description                                                                   |
-|:----------------|:----------------|:------------------------------------------------------------------------------|
-| `title`         | `string`        | **Required**. The title of your ticket                                        |
-| `body`          | `string`        | **Required**. The body of your ticket                                         |
-| `labels`        | `Array<string>` | **Required**. Labels of your ticket                                           |
-| `status`        | `string`        | **Required**. The status of your ticket (set it to "Open")                    |
-| `assigned_user` | `id \| null`    | **Optional**. A user the ticket should be assigned to. Can be omitted or null |
+```http
+POST /api/login
+```
 
-Possible Status options:
+**Payload**:
 
-- `Open`
-- `Closed`
+| Property  | Type   | Description                            |
+|:----------|:-------|:---------------------------------------|
+| `email`   | string | **Required**. Email address            |
+| `password` | string | **Required**. Password                 |
 
-Possible Label options:
+Returns a bearer token upon successful login.
 
-- `Feature`
-- `Bug`
-- `WontFix`
-- `Done`
-- `InProgress`
+#### Logout
 
-Updates a ticket and returns it.
+```http
+POST /api/logout
+```
 
-#### Sign up
+Logs out the user by invalidating their current token.
 
-```
-  POST /api/signup
-```
+### User Management
 
-Your payload must be valid JSON and contain the following properties:
+#### Get All Users
 
-| Property       | Type     | Description                            |
-|:---------------|:---------|:---------------------------------------|
-| `display_name` | `string` | **Required**. The user's display name  |
-| `email`        | `string` | **Required**. The user's email address |
-| `password`     | `string` | **Required**. The user's password      |
+```http
+GET /api/users
+```
 
-Create a new user and return it.
+Retrieves all users in a simplified format (`id`, `email`, `display_name`).
 
-#### Filter tickets
+### Filter Tickets
 
 ```http
-  POST /api/filter
+POST /api/filter
 ```
 
-Your payload must be valid JSON and contain the following properties:
+**Payload**:
 
 | Property        | Type                    | Description                                                     |
 |:----------------|:------------------------|:----------------------------------------------------------------|
 | `title`         | `string \| null`        | **Optional**. Title to search for. Can be omitted or null       |
 | `labels`        | `Array<string> \| null` | **Optional**. Labels to search for. Can be omitted or null      |
 | `status`        | `string \| null`        | **Optional**. Status to search for. Can be omitted or null      |
-| `assigned_user` | `id \| null`            | **Optional**. Assignee id to search for. Can be omitted or null |
+| `assigned_user` | `id \| null`            | **Optional**. Assignee ID to search for. Can be omitted or null |
+
+Returns filtered results.
 
-Lets you filter for tickets and return results.
+---
 
 ## Contributing
 
-Contributions are always welcome!
+Contributions in any form (issues, PRs, feedback) are welcome!
 
-Either by submitting issues, pull requests or just general constructive feedback in the form of issues,
-emails or direct messages on Telegram.
+---
 
 ## License
 
 [MIT](https://choosealicense.com/licenses/mit/)
-
-MIT or "I do not care what you do with this as long as you don't claim it to be your own"-license.

src/database.rs

@@ -11,7 +11,7 @@ use crate::schema::sessions::token;
 use crate::schema::tickets::dsl::tickets;
 use crate::schema::tickets::{body, id, labels, last_modified, status, title};
 use crate::schema::users::dsl::users;
-use crate::schema::users::{display_name, email};
+use crate::schema::users::{display_name, email, id as user_id};
 use actix_web::web::Json;
 use argonautica::Hasher;
 use diesel::{Connection, ExpressionMethods, QueryDsl, QueryResult, RunQueryDsl, SqliteConnection};
@@ -145,7 +145,7 @@ pub fn get_user_by_email(
 
 pub fn get_all_users(connection: &mut SqliteConnection) -> QueryResult<Vec<DisplayUser>> {
     users
-        .select((email, display_name))
+        .select((user_id, email, display_name))
         .load::<DisplayUser>(connection)
 }
 

src/main.rs

@@ -786,6 +786,7 @@ mod tests {
 
             assert_eq!(response[0].email, "[email protected]");
             assert_eq!(response[0].display_name, "user");
+            assert_eq!(response[0].id, 1);
         }
     }
 

src/models.rs

@@ -103,6 +103,7 @@ pub struct DataBaseUser {
 
 #[derive(Serialize, Deserialize, Debug, Queryable)]
 pub struct DisplayUser {
+    pub id: i32,
     pub email: String,
     pub display_name: String,
 }