oreqizer / pa165-yellow-yak

PA165 Enterprise Java project. :lightning:

Yellow Yak

Authors, github name:

1. Matej Horniak, MatejHor
2. Lukas Mikula, Lukinooo
3. Matej Knazik, D1LL1G4F
4. Boris Petrenko, oreqizer

Assigment

Online gaming management system

The goal of the system is to manage teams of users participating to eSports competitions. The system should allow to track the different team members with their records and statistics depending on different online games. It should also allow to manage the teams and their results in the competitions against other teams. Competitions with other teams can be set in some location together with prizes and score results from all the participants. History of all the results can be seen by the users with the best teams according to different games and statistics.

Class diagram

UseCase diagram

REST api

1. mvn clean install -DskipTests
2. cd GamingManagement-rest
3. mvn cargo:run

OR

mvn clean install -DskipTests && cd GamingManagement-rest && mvn cargo:run

REST url: http://localhost:8080/pa165/rest/

API

Competition:

• GET /competitions/:id -> CompetitionFacade.findById curl -i -X GET http://localhost:8080/pa165/rest/competitions/{id}
• POST /competitions -> CompetitionFacade.create curl --location --request POST 'http://localhost:8080/pa165/rest/competitions/create' --header 'Content-Type: application/json' --data-raw '{ "game": {"id": 4,"name": "game_4"},"name": "competition_6"}'
• DELETE /competitions/:id -> CompetitionFacade.remove curl -i -X DELETE http://localhost:8080/pa165/rest/competitions/{id}
• GET /competitions/game/:gameId -> CompetitionFacade.findByGame curl -i -X GET http://localhost:8080/pa165/rest/competitions/game/{gameId}
• GET /competitions -> CompetitionFacade.findAll curl -i -X GET http://localhost:8080/pa165/rest/competitions/

Game:

• GET /games/:id -> GameFacade.findById curl -i -X GET http://localhost:8080/pa165/rest/games/{id}
• POST /games -> GameFacade.create curl --location --request POST 'http://localhost:8080/pa165/rest/games/create' --header 'Content-Type: application/json' --data-raw '{"name": "game_6"}'
• DELETE /games/:id -> GameFacade.remove curl -i -X DELETE http://localhost:8080/pa165/rest/games/{id}
• GET /games/name/:name -> GameFacade.findByName curl -i -X GET http://localhost:8080/pa165/rest/games/name/{name}
• GET /games -> GameFacade.findAll curl -i -X GET http://localhost:8080/pa165/rest/games/

Player:

• GET /players/ -> PlayerFacade.findAll
  curl -i -X GET http://localhost:8080/pa165/rest/players/
• GET /players/:id -> PlayerFacade.findById
  curl -i -X GET http://localhost:8080/pa165/rest/players/{id}
• POST /players -> PlayerFacade.create
  curl --location --request POST 'http://localhost:8080/pa165/rest/players/create' --header 'Content-Type: application/json' --data-raw '{"username": "player_8", "email": "[e-mail]", "team": {"id": 1}}'
• DELETE /players/:id -> PlayerFacade.remove
  curl -i -X DELETE http://localhost:8080/pa165/rest/players/{id}
• GET /players/username/:username -> PlayerFacade.findByUsername
  curl -i -X GET http://localhost:8080/pa165/rest/players/username/{username}
• GET /players/team/:teamId -> PlayerFacade.findByTeam
  curl -i -X GET http://localhost:8080/pa165/rest/players/team/{teamId}

Score:

• GET /scores/:id -> ScoreFacade.findById curl -i -X GET 'http://localhost:8080/pa165/rest/scores/{id}'
• POST /scores/create body:{competition: {id: number}, player: {id: number}} -> ScoreFacade.create curl --location --request POST 'http://localhost:8080/pa165/rest/scores/create' --header 'Content-Type: application/json' --data-raw '"competition": { "id": 1 }, "player": {"id": 1 }
• POST /scores/result body:{id: number, result: string} -> ScoreFacade.setResult business 1 curl --location --request POST 'http://localhost:8080/pa165/rest/scores/result' --header 'Content-Type: application/json' --data-raw '"id": 1, "result": "5:2"
• DELETE /scores/:id -> ScoreFacade.remove curl -i -X DELETE 'http://localhost:8080/pa165/rest/scores/{id}'
• GET /scores/findBy/GameId/:gameId/PlayerId/:playerId -> ScoreFacade.findByPlayerGame curl -i -X GET 'http://localhost:8080/scores/findBy/GameId/{gameId}/PlayerId/{playerId}'
• GET /scores/findBy/CompetitionId/:competitionId -> ScoreFacade.findByCompetition` business 2 curl -i -X GET 'http://localhost:8080/pa165/rest/scores/findBy/CompetitionId/{id}'

Team:

• GET /teams/:id -> TeamFacade.findById curl -i -X GET http://localhost:8080/pa165/rest/teams/{id}
• POST /teams -> TeamFacade.create curl --location --request POST 'http://localhost:8080/pa165/rest/teams/create' --header 'Content-Type: application/json' --data-raw '{"name": "team_6"}'
• DELETE /teams/:id -> TeamFacade.remove curl -i -X DELETE http://localhost:8080/pa165/rest/teams/{id}
• GET /teams/name/:name= -> TeamFacade.findByName curl -i -X GET http://localhost:8080/pa165/rest/teams/name/{name}

Auth:

• POST /login -> Auth.login for admin email: [e-mail] password: admin curl --location --request POST 'http://localhost:8080/pa165/rest/login' --header 'Content-Type: application/json' --data-raw '{"email": "[e-mail]", "password": "admin"}'

Auth flow

• visit /
• user enters email and password
• call to /login, returns { token: string }
• app gets unlocked, further calls contain header Authorization with value Bearer <token> (without the <>), check every request