Prezentare generală

Responsabili: Florin-Alexandru STANCU, Ioana-Alina TUDORACHE, Anne-Marie ONCIULESCU-DRAGOMIR, Alexandru-Ioan CĂRUŢAŞU, Mihăiţă-Petruţ DINU, Rareș-Alexandru BALAN, Razvan Popa, Alina-Andreea Pirlog, Alin-Calin Dutu, Gabriel Gutu-Robu, Mihai-Catalin Stan, Raluca-Monica Birladeanu, Alexandra Ana-Maria ION, Corina-Elena Ulariu, Cătălin LEORDEANU

Stai pe canapea, sâmbătă seara. Te plictisești. Te uiți lung la pereți, apoi la pisică, apoi la telecomandă. O ridici… dar vai! Nu știi la ce să te uiți. Netflix? Prea complicat. YouTube? Prea zgomotos. Într-un moment de inspirație demn de un hacker de Hollywood, îți spui: "Ce-ar fi să scriu un client HTTP?". Evident, pentru că așa gândește orice automatist normal într-o seară leneșă de weekend.

Așa începe aventura ta: nu cu popcorn, ci cu sockets. Nu cu seriale, ci cu GET și POST. Ținta? Să creezi un client HTTP în C/C++ care să poată comunica cu un REST API ca un adevărat internaut: politicos, precis și cu headers bine aranjați. Fără biblioteci de lux – doar cod curat, ambiție și un pic de cafea (sau ceai, dacă ești chill).

Hai să vedem ce poate face acest client HTTP – și dacă sâmbăta ta chiar n-a fost irosită.

Motivatie & Obiective

Un procent foarte mare din aplicațiile moderne este reprezentat de aplicații web.
Multe dintre aceste aplicații web, în ciuda complexității pe care o au, se bazează pe modelul clasic “client-server”.
Pentru a înțelege cum funcționează modelul client-server în contextul web modern, este nevoie să înțelegeți cum funcționează protocolul HTTP.

Obiectivele pe care le urmărim sunt:

Înțelegerea mecanismelor de comunicare prin HTTP
Interacțiunea cu un REST API
Înțelegerea conceptelor des folosite în web precum JSON, sesiune, JWT
Utilizarea unor biblioteci externe pentru manipularea obiectelor JSON REST API

Descriere generală

Serverul (infrastructură existentă) va expune un API (Application Programmable Interface) de tip REST (Representational State Transfer).
Puteți să vă gândiți la el ca la o cutie neagră ce primește o serie de intrări reprezentate de rute HTTP.
În urma cererilor HTTP, serverul efectuează o acțiune.

În contextul temei, serverul simulează un library online (de filme) și este deja complet implementat.

Clientul (pe care îl veți construi) este un program scris în C/C++ care acceptă comenzi de la tastatură (stdin) și trimite, în funcție de comandă, cereri către server.
Scopul lui este de a funcționa ca o interfață în linia de comandă (CLI) cu library-ul virtual.

Fiecare student are un singur utilizator de admin cu care se poate loga pentru a crea, șterge și vizualiza conturile utilizatorilor normali. Un user de admin are DOAR functionalitatile de gestiune a utilizatorilor, nu si de gestiune a filmelor / colectiilor.

JSON & Token JWT

JSON

JSON (JavaScript Object Notation) este un format de reprezentare / schimb de date text foarte popular, mai ales în sfera de programare Web, deoarece este și relativ ușor de construit & parsat de către mașini (în orice limbaj), cât și relativ inteligibil de către oameni (fapt ce ajută deseori la depanare):

{  
  "employee": {
    "name": "sonoo",
    "salary": 56000,
    "married": true
  }  
}

Majoritatea API-urilor web (REST-ful) folosesc deseori această reprezentare pentru a structura atât datele de intrare (e.g. POST body), cât și cele de ieșire (corp răspuns HTTP), marcate prin antetul Content-Type: application/json. La fel este folosit și de către serverul temei.

Astfel, pentru a parsa răspunsurile primite de la server, puteţi (şi e recomandat) să folosiţi o bibliotecă. Vă sugerăm parson [1] pentru C sau nlohmann [2] pentru C++, însă puteţi folosi orice (inclusiv o soluţie proprie), justificând alegerea în README.

[1] https://github.com/kgabis/parson

[2] https://github.com/nlohmann/json

Observație

‼️ Va trebui să includeți codul bibliotecilor în sursă, altfel arhiva nu va compila pe checker.

Token JWT

Tokenurile JWT (JSON Web Token) sunt o modalitate de transmitere a informaţiilor de autentificare/autorizare dintre un client şi un server. Acestea sunt codificate binar şi semnate pentru verificarea integrităţii. Astfel se asigură că un potenţial atacator nu poate modifica datele împachetate.

Pentru a trimite tokenul către server, este necesară adăugarea acestuia în headerul Authorization. Valoarea tokenului trebuie să fie prefixată de cuvântul Bearer.

Authorization: Bearer eijjkwuqioueu9182712093801293

Pentru mai multe informaţii puteţi să consultaţi documentaţia oficială:

https://jwt.io/introduction

Descriere Server

Datele de conectare

HOST: 63.32.125.183 PORT: 8081

Mod de funcționare

Serverul va permite efectuarea următoarelor acțiuni:

4.1 Autentificare admin

Ruta de acces:

POST /api/v1/tema/admin/login

Tip payload:

application/json

Payload:

{
  "username": String,
  "password": String
}

Răspuns:
🍪 Întoarce cookie de sesiune.

Erori tratate:
👎 Credențialele nu se potrivesc.
👎 Reautentificare când deja logat.

4.2 Adăugarea unui utilizator normal

Ruta de acces:

POST /api/v1/tema/admin/users

Tip payload:

application/json

Payload:

{
  "username": String,
  "password": String
}

Observații:
❗ Trebuie să demonstrați că aveți rol de admin.
❗ Userul aparține adminului curent.

Erori tratate:
👎 Lipsă rol admin.
👎 Informații incomplete/incorecte.

4.3 Vizualizare utilizatori normali

Ruta de acces:

GET /api/v1/tema/admin/users

Observații:
❗ Trebuie să demonstrați că aveți rol de admin.

Răspuns:

{
  "users": [
    {
      "id": Number,
      "password": String,
      "username": String
    }
  ]
}

Erori tratate:
👎 Lipsă permisiuni admin.

4.4 Ștergerea unui utilizator

Ruta de acces:

DELETE /api/v1/tema/admin/users/:username

e.g: /api/v1/tema/admin/users/user123

Observații:
❗ Necesită rol de admin.

Erori tratate:
👎 Lipsă rol admin.
👎 Username invalid.

4.5 Logout admin

Ruta de acces:

GET /api/v1/tema/admin/logout

Observații:
❗ Necesită autentificare.

Erori tratate:
👎 Neautentificat.

4.6 Autentificare utilizator

Ruta de acces:

POST /api/v1/tema/user/login

Tip payload:

application/json

Payload:

{
  "admin_username": String,
  "username": String,
  "password": String
}

Răspuns:
🍪 Trebuie să demonstraţi că sunteţi autentificaţi!

Erori tratate:
👎 Credențialele nu se potrivesc.
👎 Reautentificare.

4.7 Cerere acces library

Ruta de acces:

GET /api/v1/tema/library/access

Observații:
❗ Necesită autentificare.

Răspuns:
🍪 Trebuie să demonstraţi că sunteţi autentificaţi!

Erori tratate:
👎 Neautentificat.

4.8 Vizualizare toate filmele

Ruta de acces:

GET /api/v1/tema/library/movies

Observații:
🍪 Trebuie să demonstraţi că aveţi acces la library! (JWT token)

Răspuns:

[
  {
    "id": Number,
    "title": String
  }
]

Erori tratate:
👎 Fără acces library.

4.9 Vizualizare detalii film

Ruta de acces:

GET /api/v1/tema/library/movies/:movieId

e.g: /api/v1/tema/library/movies/123

Observații:
🍪 Trebuie să demonstraţi că aveţi acces la library! (JWT token)

Răspuns:

{
  "id": Number,
  "title": String,
  "year": Number,
  "description": String,
  "rating": Number
}

Erori tratate:
👎 Fără acces library.
👎 ID invalid.

4.10 Adăugare film

Ruta de acces:

POST /api/v1/tema/library/movies

Tip payload:

application/json

Payload:

{
  "title": String,
  "year": Number,
  "description": String,
  "rating": Number
}

Observații:
🍪 Trebuie să demonstraţi că aveţi acces la library! (JWT token)

Erori tratate:
👎 Fără acces library.
👎 Date invalide/incomplete.

4.11 Actualizare film

Ruta de acces:

PUT /api/v1/tema/library/movies/:movieId

Tip payload:

application/json

Payload:

{
  "title": String,
  "year": Number,
  "description": String,
  "rating": Number
}

Observații:
🍪 Trebuie să demonstraţi că aveţi acces la library! (JWT token)

Erori tratate:
👎 Fără acces library.
👎 ID invalid.
👎 Date invalide/incomplete.

4.12 Ștergere film

Ruta de acces:

DELETE /api/v1/tema/library/movies/:movieId

e.g: /api/v1/tema/library/movies/123

Observații:
🍪 Trebuie să demonstraţi că aveţi acces la library! (JWT token)

Erori tratate:
👎 Fără acces library.
👎 ID invalid.

4.13 Vizualizare colecții

Ruta de acces:

GET /api/v1/tema/library/collections

Observații:
🍪 Trebuie să demonstraţi că aveţi acces la library! (JWT token)

Răspuns:

[
  {
    "id": Number,
    "title": String,
    "owner": String,
    "movies": [
      {
        "id": Number,
        "title": String
      }
    ]
  }
]

Erori tratate:
👎 Fără acces library.

4.14 Vizualizare detalii colecție

Ruta de acces:

GET /api/v1/tema/library/collections/:collectionId

Observații:
🍪 Trebuie să demonstraţi că aveţi acces la library! (JWT token)

e.g: /api/v1/tema/library/collections/123

Răspuns:

{
  "id": Number,
  "title": String,
  "owner": String,
  "movies": [
    {
      "id": Number,
      "title": String
    }
  ]
}

Erori tratate:
👎 Fără acces library.
👎 ID invalid.

4.15 Adăugare colecție

Ruta de acces:

POST /api/v1/tema/library/collections

Tip payload:

application/json

Payload:

{
  "title": String
}

Observații:
🍪 Trebuie să demonstraţi că aveţi acces la library! (JWT token)
❗ Owner este utilizatorul curent.

Erori tratate:
👎 Fără acces library.
👎 Date invalide/incomplete.

4.16 Ștergere colecție

Ruta de acces:

DELETE /api/v1/tema/library/collections/:collectionId

Observații:
🍪 Trebuie să demonstraţi că aveţi acces la library! (JWT token)
❗ Trebuie să fiți owner.

Erori tratate:
👎 Fără acces library.
👎 Nu sunteți owner.
👎 ID invalid.

4.17 Adăugare film în colecție

Ruta de acces:

POST /api/v1/tema/library/collections/:collectionId/movies

Tip payload:

{
  "id": Number
}

Observații:
🍪 Trebuie să demonstraţi că aveţi acces la library! (JWT token)
❗ Trebuie să fiți owner.

Erori tratate:
👎 Fără acces library.
👎 Nu sunteți owner.
👎 Date invalide/incomplete.

4.18 Ștergere film din colecție

Ruta de acces:

DELETE /api/v1/tema/library/collections/:collectionId/movies/:movieId

e.g: /api/v1/tema/library/collections/5/movies/123

Observații:
🍪 Trebuie să demonstraţi că aveţi acces la library! (JWT token)
❗Trebuie să fiți owner.
❗ Filmul trebuie să existe în colecție.

Erori tratate:
👎 Fără acces library.
👎 Nu sunteți owner.
👎 ID invalid.

4.19 Logout utilizator

Ruta de acces:

GET /api/v1/tema/user/logout

Observații:
❗ Necesită autentificare.

Erori tratate:
👎 Neautentificat.

Observație

‼️ Toate functionalitatile mentionate pentru server sunt testate de checker-ul oferit, dar nu sunt incluse toate cazurile de testare pentru corner case-uri.

Testare server

Pentru a interacţiona neprogramatic cu serverul, puteţi folosi utilitare ce simulează clienţii HTTP, precum Postman [1], Insomnia [2] sau chiar clienţi scrişi de mână în alte limbaje de programare.

[1] https://www.postman.com/

[2] https://insomnia.rest/

Clientul

Clientul va trebui să interpreteze comenzi de la tastatură pentru a putea interacţiona cu serverul. În urma primirii unei comenzi, clientul va forma obiectul json (dacă e cazul), va executa cererea către server şi va afişa răspunsul acestuia (de succes sau de eroare). Procesul se repetă până la introducerea comenzii exit.

‼️ Atât comenzile cât şi câmpurile împreună cu valorile aferente se scriu pe linii separate!

‼️ Conexiunea la server trebuie realizata DOAR cu API-ului de sockets! (ca in laboratorul de HTTP)

Datele introduse de către utilizator de la tastatura sunt cele marcate cu text astfel!

Listă comenzi

login_admin - efectuează autentificarea pentru admin (doar admin)
add_user - adaugă un nou utilizator normal (doar admin)
get_users - cere toti utilizatorii de pe server (doar admin)
delete_user - șterge un utilizator normal (doar admin)
logout_admin - efectuează delogarea pentru admin (doar admin)
login - efectuează autentificarea pentru utilizator normal
get_access - cere acces pentru colectia de filme
get_movies - cere toate filmele de pe server
get_movie - cere informaţie despre un film
add_movie - adaugă un film
delete_movie - șterge un film
update_movie - actualizeaza datele unui film
get_collections - cere toate colecțiile de filme de pe server
get_collection - cere informaţie despre o colecție de filme
add_collection - adaugă o colecție de filme
delete_collection - șterge o colecție de filme
add_movie_to_collection - adaugă un film intr-o colecție
delete_movie_from_collection - șterge un film dintr-o colecție
logout - efectueaza delogarea utilizatorului
exit - efectueaza ieșirea din program

Observație

‼️ Textul mesajelor returnate de server sunt alese de voi, însă trebuie să țineți cont de următoarele convenții:

dacă rezultatul HTTP a fost un cod de eroare, mesajul să conțină cuvantul ERROR
dacă operațiunea a avut loc cu succes, atunci să conțină cuvantul SUCCESS

‼️ Punctajele pentru fiecare comanda sunt raportate la 100p. De exemplu, comanda get_users valoreaza 10p/100p.

Comenzi

1. Login_admin (2.5p)

Oferă prompt pentru username și password.

login_admin

username=something
password=something

Protocoale de Comunicație 🌐