Testy na prawo jazdy

Backend do aplikacji z testami na prawo jazdy

Objectives

• Parsing the csv document
• Entity Relationship Diagram - basic models
• Spring Security with JWT authentication
• Logic related to generating exams
• Learning mode
• Statistics
• History
• Documentation
• Deployment to Heroku
• Mobile application
• Testing

Mobile application (Android / iOS)

Testy na prawo jazdy App

Contributions

Mateusz Janczak | Przemysław Kuca | Mateusz Mądel

Endpointy

Demo account

POST /auth/login

Request
{
    "username": "DEMO",
    "password": "DEMO123"
}

Response
{
    "token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJERU1PIiwiZXhwIjoxNjE2MzQ1NTg3fQ.vqbqrhmQTVCesUNsqcDNyu4w5ahefyIyBdNlPxGg0rXetxIrHTX8ItqCHzfM8hNu1a9oCmKglCfnK4zUW67Syg",
    "refreshToken": "IE25dzAOkPoOKRJf7CWA38tdf3FkkzTUdSgcHIA3ynkx8OHN4vtCNng3shVNb11xMab2au2fZXnHxQykMAmThB3pxTsJY0qDW4JqZNWn0SHaBYjOa3latxdHQZTWvjDd"
}

Dla zalogowanych

Generowanie egzaminu

POST /exam/start/{category}

Category { A1, A, A2, B, C, PT, D, T, AM, D1, C1, B1 }

Response
{
    "examId": 34,
    "primaryTaskList": [
        {
            "id": 2,
            "primaryTask": {
                "id": 1479,
                "question": "Czy w przedstawionej sytuacji masz obowiązek zrezygnować z wyprzedzania, jeżeli kierujący pojazdem poprzedzającym włączył prawy kierunkowskaz?",
                "correctAnswer": false,
                "filename": "D26_286org.jpg",
                "points": 3,
                "categories": [
                    {
                        "category": "A"
                    },
                    {
                        "category": "B"
                    },
                    {
                        "category": "C"
                    },
                    {
                        "category": "D"
                    },
                    {
                        "category": "A1"
                    },
                    {
                        "category": "A2"
                    },
                    {
                        "category": "C1"
                    },
                    {
                        "category": "D1"
                    }
                ]
            },
            "correct": false
        }, {...}
    ],
    "specialistTaskList": [
        {
            "id": 22,
            "specialistTask": {
                "id": 10894,
                "question": "Jakie dokumenty masz obowiązek mieć przy sobie i okazywać na żądanie uprawnionego organu podczas kontroli drogowej?",
                "answerA": "Orzeczenie psychologiczne, jeżeli wykonujesz zarobkowy przewóz osób.",
                "answerB": "Pokwitowanie zatrzymania prawa jazdy w okresie, w którym upoważnia ono do kierowania.",
                "answerC": "Orzeczenie lekarskie. ",
                "correctAnswer": "B",
                "filename": "",
                "points": 2,
                "categories": [
                    {
                        "category": "B"
                    }
                ]
            },
            "correct": false
        }, {...}
    ]
}

Wysyłanie odpowiedzi do egzaminu

POST /exam/finish/{id}

Request
{
    "examId": 34,
    "primaryTaskList": [
        {
            "id": 2,
            "chosenAnswer": false
        },
        {...}
    ],
    "specialistTaskList": [
        {
            "id": 22,
            "chosenAnswer": "C"
        },
        {...}
    ]
}

Response
{
    "examId": 34,
    "primaryTaskList": [
        {
            "id": 2,
            "primaryTask": {
                "id": 8284,
                "question": "Czy w tej sytuacji masz obowiązek użyć sygnału dźwiękowego, aby skłonić rowerzystę do szybszej jazdy?",
                "correctAnswer": false,
                "filename": "265_1024x576.jpg",
                "points": 3,
                "categories": [
                    {
                        "category": "B"
                    }
                ]
            },
            "correct": true
        },
        {...}
    ],
    "specialistTaskList": [
        {
            "id": 22,
            "specialistTask": {
                "id": 7237,
                "question": "Z jaką prędkością nie możesz poruszać się w strefie zamieszkania?",
                "answerA": "10 km/h.",
                "answerB": "15 km/h.",
                "answerC": "25 km/h.",
                "correctAnswer": "C",
                "filename": "2A118.jpg",
                "points": 3,
                "categories": [
                    {
                        "category": "B"
                    },
                    {
                        "category": "B1"
                    }
                ]
            },
            "correct": true
        },
        {...}
    ]
}

Tryb nauki - generowanie pojedynczych pytań

POST /learn/primaryTask/start/{category}
POST /learn/specialistTask/start/{category}

Response 1
{
    "id": 2,
    "primaryTask": {
        "id": 2443,
        "question": "Czy wolno Ci wjechać na przejazd kolejowy, jeżeli półzapory zostały całkowicie podniesione, a sygnał czerwony jeszcze nie został wyłączony?",
        "correctAnswer": false,
        "filename": "d19_2org.mp4",
        "points": 3,
        "categories": [
            {
                "category": "A"
            },
            {
                "category": "B"
            },
            {
                "category": "C"
            },
            {
                "category": "D"
            },
            {
                "category": "T"
            },
            {
                "category": "AM"
            },
            {
                "category": "A1"
            },
            {
                "category": "A2"
            },
            {
                "category": "B1"
            },
            {
                "category": "C1"
            },
            {
                "category": "D1"
            }
        ]
    },
    "user": {
        "id": 1
    },
    "selectedAnswer": null,
    "correct": false
}

Response 2
{
    "id": 1,
    "specialistTask": {
        "id": 10840,
        "question": "W jaki sposób przewozisz dziecko o wzroście mniejszym niż 150 cm na przednim siedzeniu samochodu osobowego, który ma pięć miejsc siedzących?",
        "answerA": " Na kolanach pasażera.",
        "answerB": " W foteliku bezpieczeństwa lub innym urządzeniu przytrzymującym dziecko.",
        "answerC": "W foteliku bezpieczeństwa tyłem do kierunku jazdy, jeżeli pojazd ma aktywną poduszkę powietrzną dla pasażera.",
        "correctAnswer": "B",
        "filename": "",
        "points": 2,
        "categories": [
            {
                "category": "B"
            }
        ]
    },
    "user": {
        "id": 1
    },
    "selectedAnswer": null,
    "correct": false
}

Tryb nauki - wysyłanie rozwiązania

POST /learn/primaryTask/finish/{id}
POST /learn/specialistTask/finish/{id}

Request 1
{
    "id": 2,
    "chosenAnswer": false
}

Response 1
{
    "id": 2,
    "primaryTask": {
        "id": 2443,
        "question": "Czy wolno Ci wjechać na przejazd kolejowy, jeżeli półzapory zostały całkowicie podniesione, a sygnał czerwony jeszcze nie został wyłączony?",
        "correctAnswer": false,
        "filename": "d19_2org.mp4",
        "points": 3,
        "categories": [
            {
                "category": "A"
            },
            {
                "category": "B"
            },
            {
                "category": "C"
            },
            {
                "category": "D"
            },
            {
                "category": "T"
            },
            {
                "category": "AM"
            },
            {
                "category": "A1"
            },
            {
                "category": "A2"
            },
            {
                "category": "B1"
            },
            {
                "category": "C1"
            },
            {
                "category": "D1"
            }
        ]
    },
    "user": {
        "id": 1
    },
    "selectedAnswer": "false",
    "correct": true
}

Request 2
{
    "id": 1,
    "chosenAnswer": "B"
}

Response 2
{
    "id": 1,
    "specialistTask": {
        "id": 10840,
        "question": "W jaki sposób przewozisz dziecko o wzroście mniejszym niż 150 cm na przednim siedzeniu samochodu osobowego, który ma pięć miejsc siedzących?",
        "answerA": " Na kolanach pasażera.",
        "answerB": " W foteliku bezpieczeństwa lub innym urządzeniu przytrzymującym dziecko.",
        "answerC": "W foteliku bezpieczeństwa tyłem do kierunku jazdy, jeżeli pojazd ma aktywną poduszkę powietrzną dla pasażera.",
        "correctAnswer": "B",
        "filename": "",
        "points": 2,
        "categories": [
            {
                "category": "B"
            }
        ]
    },
    "user": {
        "id": 1
    },
    "selectedAnswer": "B",
    "correct": true
}

Historia egzaminów

GET /exam/history

Response
[
    {
        "examId": 34,
        "score": 0,
        "category": "B",
        "date": "2021-05-08T19:25:28.230+00:00"
    }
]

Wynik egzaminu

GET /exam/result/{id}

Response
{
    "id": 34,
    "examPrimaryTasks": [
        {
            "id": 2,
            "primaryTask": {
                "id": 1427,
                "question": "Czy w przedstawionej sytuacji wolno Ci skręcić w lewo?",
                "correctAnswer": false,
                "filename": "IMG_1645d6org.jpg",
                "points": 3,
                "categories": [
                    {
                        "category": "A"
                    },
                    {
                        "category": "B"
                    },
                    {
                        "category": "C"
                    },
                    {
                        "category": "D"
                    },
                    {
                        "category": "T"
                    },
                    {
                        "category": "AM"
                    },
                    {
                        "category": "A1"
                    },
                    {
                        "category": "A2"
                    },
                    {
                        "category": "B1"
                    },
                    {
                        "category": "C1"
                    },
                    {
                        "category": "D1"
                    }
                ]
            },
            "correct": false
        },
        {...}
    ],
    "examSpecialistTasks": [
        {
            "id": 22,
            "specialistTask": {
                "id": 3723,
                "question": "Który z wymienionych elementów stanowi obowiązkowe wyposażenie każdego samochodu osobowego?",
                "answerA": "Trójkąt ostrzegawczy.",
                "answerB": "Apteczka.",
                "answerC": "Koło zapasowe.",
                "correctAnswer": "A",
                "filename": "",
                "points": 3,
                "categories": [
                    {
                        "category": "B"
                    }
                ]
            },
            "correct": false
        }, 
        {...}
    ],
    "user": {
        "id": 1
    },
    "score": 0,
    "category": "B",
    "date": "2021-05-08T19:25:28.230+00:00"
}

Statystyki z ostatniego miesiąca

GET /exam/statistics

Response
[
    {
        "date": "2021-05-21T00:00:00.000+00:00",
        "averageScore": 0,
        "failedTests": 1,
        "allTests": 1
    },
    {
        "date": "2021-05-18T00:00:00.000+00:00",
        "averageScore": 1,
        "failedTests": 2,
        "allTests": 2
    }
]

Dla niezalogowanych

POST /auth/login

Request
{
    "username": "foo",
    "password": "bar"
}

Response
{
    "token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJmb28iLCJleHAiOjE2MTI2NTQ2Mzl9.BhwwnmeKkFVplC3iudqi7pATFxjpV9SEVMFqFa-09WEco4MvuD6MBPOKurFt8y8BpCvNSTr8sYRtxrxFEGS0Eg",
    "refreshToken": "FCglofZA0u6PxqZ29mqiQUvjOslNSVZCnPAqrS1Scg76DWuSSPNyZh412LU8bcUe8dx2OuZpQXMhIM0Q3uhNbnWHVKApeej64YvOP32BZumgI6E9Pt2zqaGrPYL30sUu"
}

Logowanie

POST /auth/login

Request
{
    "username": "foo",
    "password": "bar"
}

Response
{
    "token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJmb28iLCJleHAiOjE2MTI2NTQ2Mzl9.BhwwnmeKkFVplC3iudqi7pATFxjpV9SEVMFqFa-09WEco4MvuD6MBPOKurFt8y8BpCvNSTr8sYRtxrxFEGS0Eg",
    "refreshToken": "FCglofZA0u6PxqZ29mqiQUvjOslNSVZCnPAqrS1Scg76DWuSSPNyZh412LU8bcUe8dx2OuZpQXMhIM0Q3uhNbnWHVKApeej64YvOP32BZumgI6E9Pt2zqaGrPYL30sUu"
}

Rejestracja

POST /auth/register

Request
{
    "username": "foo",
    "password": "bar",
    "email": "foo@bar"
}

Response
{
    "username": "foo",
    "email": "foo@bar",
    "roles": [
        "ROLE_USER"
    ]
}

Weryfikacja adresu email

POST /auth/verifyEmail/{verificationToken}

Response
200 - OK

Odświeżanie tokena

POST /auth/token/refresh

Request
{
    "refreshToken": "FCglofZA0u6PxqZ29mqiQUvjOslNSVZCnPAqrS1Scg76DWuSSPNyZh412LU8bcUe8dx2OuZpQXMhIM0Q3uhNbnWHVKApeej64YvOP32BZumgI6E9Pt2zqaGrPYL30sUu"
}

Response
{
    "token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJmb28iLCJleHAiOjE2MTI2NTQ4MTh9.pH_jt4QTGBqLq49wzWFHBtmYGFt7d4n9vY7QoVIKHRCu3bHNpi9BmsjDn8g6sz2uEU_iizcQc99mfg_a9fvHdQ"
}

Wylogowywanie (usuwanie refresh tokena)

POST /auth/logout

Request
{
    "refreshToken": "FCglofZA0u6PxqZ29mqiQUvjOslNSVZCnPAqrS1Scg76DWuSSPNyZh412LU8bcUe8dx2OuZpQXMhIM0Q3uhNbnWHVKApeej64YvOP32BZumgI6E9Pt2zqaGrPYL30sUu"
}

Response
204 - NO CONTENT

Zmiana hasła

POST /auth/changePassword

Request
{
    "oldPassword": "DEMO123",
    "newPassword": "DEMO123456"
}

Response
200 - OK
403 - FORBIDDEN

Zmiana email

POST /auth/changeEmail

Request
{
    "password": "DEMO123",
    "newEmail": "admin@localhost"
}

Response
200 - OK
403 - FORBIDDEN

Whoami [do debugowania]

GET /auth/me

Response
{
    "id": 2,
    "email": "foo@bar",
    "username": "foo",
    "password": "$2a$10$Hf97x6iEbzfGLHh2Y3VRpOud5OhgUppnbnKto3sVFV6cHPF5BrCXm",
    "roles": [
        {
            "name": "ROLE_USER"
        }
    ],
    "enabled": true,
    "authorities": [
        {
            "authority": "ROLE_USER"
        }
    ],
    "accountNonExpired": true,
    "credentialsNonExpired": true,
    "accountNonLocked": true
}

Przykładowa obsługa błędów

Błędne dane logowania

{
    "errorCode": 403,
    "errorName": "FORBIDDEN",
    "errorMessage": "Incorrect login details"
}

Brak autoryzacji

{
    "errorCode": "401",
    "errorName": "UNAUTHORIZED",
    "errorMessage": "Full authentication is required to access this resource"
}

Brak uprawnień

{
    "errorCode": 403,
    "errorName": "FORBIDDEN",
    "errorMessage": "Access denied"
}

Użytkownik nie istnieje

{
    "errorCode": "401",
    "errorName": "UNAUTHORIZED",
    "errorMessage": "User not exist"
}

Walidacja obiektów

{
    "errorCode": 400,
    "errorName": "BAD_REQUEST",
    "errorMessage": "Object validation failed. Check fields errors.",
    "fieldsErrorList": [
        "Password cannot be null",
        "Email cannot be null",
        "Username cannot be null"
    ]
}

Wygasły token i inne wyjątki JWT [do debugowania]

{
    "errorCode": "400",
    "errorName": "BAD_REQUEST",
    "errorMessage": "JWT expired at 2020-07-21T22:06:43Z. Current time: 2020-07-21T23:36:57Z, a difference of 5414657 milliseconds.  Allowed clock skew: 0 milliseconds."
}