EM2024 Backend API

This repository contains the backend API for the EM2024 application.

Installation

To run the project, use the following command:

cp .env.example .env # please fill in the .env file

Database

If you want to have a test database, you can copy it from em2024-frontend when you initialize the application. Alternatively,

you can add the line fixtures::load_fixtures(&connection); in the file src/db/mod.rs. Then, start the server and access the URL once to create the database with fixtures.

pub fn establish_connection() -> SqliteResult<Connection> {
    ...
    let conn = if mode == "test" {
        ...
    } else {
        let database_url = env::var("DATABASE_URL").expect("DATABASE_URL must be set");
        let connection = Connection::open(database_url)?;
        //fixtures::load_fixtures(&connection); # only when we want to load fixtures for start you local server and you dont have db
        connection
    };

    Ok(conn)
}

cargo run

The server will be available at: http://localhost:8080/

Testing

To run tests, use the command:

cargo test

For code coverage, use the following command:

cargo tarpaulin --out Html

Objects

UserInfo

Represents information about a user.

• name: string - The name of the user.
• user_id: i32 - The unique identifier of the user.
• department: string - The department the user belongs to.
• position: i32 - The position of the user in the ranking.
• score_sum: i32 - The total score of the user.
• sum_win_exact: i32 - The number of exact wins predicted by the user.
• sum_score_diff: i32 - The number of score differences predicted by the user.
• sum_team: i32 - The total points for team predictions.
• extra_point: i32 - Extra points earned by the user.
• tips: Tip[] - The tips provided by the user.

Example:

{
  "name": "ninja",
  "user_id": 1,
  "department": "Langenfeld",
  "position": 16,
  "score_sum": 6,
  "sum_win_exact": 0,
  "sum_score_diff": 0,
  "sum_team": 6,
  "extra_point": 0,
  "tips": []
}

Tip

Represents a user's prediction for a match.

• match_id: string - The unique identifier for the match.
• user: string - The name of the user.
• user_id: i32 - The unique identifier of the user.
• score: i32 - The score given by the user for the match.
• team1: Team - The first team in the match.
• team2: Team - The second team in the match.
• tip_home: i32 - The predicted score for the home team.
• tip_away: i32 - The predicted score for the away team.
• score_home: i32 - The actual score for the home team.
• score_away: i32 - The actual score for the away team.
• date: i64 - The timestamp of the match.

Example:

{
  "match_id": "428759",
  "user": "ninja",
  "user_id": 1,
  "score": 1,
  "team1": {
    "name": "Serbia",
    "tla": "SRB"
  },
  "team2": {
    "name": "England",
    "tla": "ENG"
  },
  "tip_home": 0,
  "tip_away": 2,
  "score_home": 0,
  "score_away": 1,
  "date": 1718564400
}

Team

Represents a football team.

• name: string - The name of the team.
• tla: string - The three-letter acronym for the team.

Example:

{
  "name": "England",
  "tla": "ENG"
}

API Endpoints

• [GET] /rating: Retrieves all users sorted by position. Returns a list of UserInfo objects without tips (tips are an empty array).
• [GET] /user/{user_id}: Retrieves a user by their user_id. Returns a UserInfo object with tips (tips are an array of Tip).
• [GET] /game/{game_id}: Retrieves all user tips for a specific game. Returns an array of Tip objects.
• [GET] /: Returns a JSON object with the status: { "status": "works" }.