- Introduzione
- Installazione
- Configurazione
- Rotte
- Parametri
- Output richieste
- Eccezioni
- Test
- Documentazione
- Autori
MetaStats ha lo scopo di effettuare statistiche e filtri, di un utente Facebook, relative ai post. Le statistiche riguardano le location italiane in cui l'utente è stato (come riferimento si prendono i post dell'utente); tali informazioni riguardo il luogo sono estrapolate dalle API fornite da Facebook che ci permettono di conoscere la data e ora in cui è stato pubblicato un determinato post, la descrizione relativa e l'id associato. Tramite la descrizione viene effettuato uno scan del testo per ricercare una città italiana presente in un database locale. I post dell' utente sono disponibili in formato JSON attraverso una rotta GET definita nel nostro controller, a seconda del tipo di statistica o di filtro che si vuole eseguire ci saranno diverse rotte.
- Filtri
- Città: Restituisce tutti i post che l' utente ha fatto in una o più città.
- Province: Restituisce tutti i post che l' utente ha fatto in una o più province.
- Regioni: Restituisce tutti i post che l' utente ha fatto in una o più regioni.
- Statistiche
- Ranking: viene stilata una classifica delle città più visitate dall' utente.
- Ranking: viene stilata una classifica delle province più visitate dall' utente.
- Ranking: viene stilata una classifica delle regioni più visitate dall' utente.
Per l'installazione bisogna clonare la repository dal terminale:
git clone https://github.com/dennisrapaccini/Progetto-OOP.git
E' possibile clonare la repository anche attraverso GitHub Desktop.
Per poter usufruire della nostra applicazione è necessario lanciarlo da Terminale oppure essere in possesso di un IDE, ad esempio Eclipse, che permetta di avviare il progetto come Spring boot application. Il client Postman permettrà l' utilizzo dell' applicazione che sarà in ascolto su una porta locale, nel nostro caso la seguente porta:
http://localhost:8081
Ovviamente la porta che si troverà in ascolto potrà essere modificata a piacere andando a modificare il seguente pezzo di codice:
https://github.com/dennisrapaccini/Progetto-OOP/blob/main/MetaStats/src/main/resources/application.properties
se si va al link si vedrà: server.port=${port:8081}.
Visualizzando il progetto (su Eclipse) è possibile modificare il token di accesso, fornito da Facebook per accedere alle API, che abbiamo utilizzato per testare le funzionalità della nostra applicazione; inserendo, quindi, il token dell' account di cui si vogliono fare le statistiche relative ai post.
Come token di default è inserito quello relativo all'utente Peppino Parlaforte, il quale è stato creato appositamente per lo sviluppo di questa applicazione. Tale utente ha pubblicato diversi post in diversi periodi con diverse località per permettere un testing efficace.
Abbiamo definito le seguenti rotte:
| N° | Tipo | Rotta | Descrizione |
|---|---|---|---|
| 1 | GET |
/posts |
restituisce un JSONObject in cui vengono mostrati tutti i post dell'utente |
| 2 | GET |
/posts/city |
restituisce un JSONObject in cui vengono mostrati tutti i post dell'utente filtrati per una o più città |
| 3 | GET |
/posts/province |
restituisce un JSONObject in cui vengono mostrati tutti i post dell'utente filtrati per una o più province |
| 4 | GET |
/posts/region |
restituisce un JSONObject in cui vengono mostrati tutti i post dell'utente filtrati per una o più regioni |
| 5 | GET |
/posts/stats/ranking |
restituisce un JSONObject in cui vengono fatte statistiche riguardo le città, province o regioni in cui l' utente è stato, in particolare il ranking per occorrenze delle tre categorie. E' possibile inoltre filtrare il ranking ulteriormente, limitando la classifica ad uno specifico periodo temporale. |
| 6 | GET |
/posts/location |
restituisce un JSONObject in cui vengono mostrate tute le città, province o regioni in cui l'utente è stato |
Di seguito saranno indicati le rotte che necessitano di alcuni parametri e anche il tipo di parametro. La prima rotta non è presente perché non necessita di parametri.
| N° | Parametri | Tipo | Richiesto |
|---|---|---|---|
| 2 | city |
List | SI |
| 3 | province |
List | SI |
| 4 | region |
List | SI |
| 5 | type, initialDate, finalDate |
String, String, String | SI, NO, NO |
| 6 | type |
String | SI |
Gli esempi delle risposte sono stati presi dal client Postman inserendo alcuni parametri manualmente quando richiesti.
In risposta alla prima richiesta si avrà:
{
"id": "107864155075941",
"posts": {
"data": [
{
"created_time": "2021-12-25T12:46:40+0000",
"id": "107864155075941_119047300624293",
"message": "Buon Natale a tutti i miei amici di Facebook, oggi pranzo con i lontani parenti di Firenze"
},
{
"created_time": "2021-12-20T22:12:08+0000",
"id": "107864155075941_117569294105427",
"message": "Un bel bombardino a Bolognola ci sta tutto"
}L'esempio precedente è stato troncato data la quantità non indifferente di post presenti.
In risposta alla seconda richiesta si avrà:
{
"city": [
{
"Posts in treia": [
{
"created_time": "2021-12-19T01:52:07+0000",
"id": "107864155075941_116943110834712",
"message": "Treia sfocata"
},
{
"created_time": "2021-12-10T18:46:16+0000",
"id": "107864155075941_112274567968233",
"message": "Ahhh la mia Treia♥️"
},
{
"created_time": "2021-12-10T07:17:12+0000",
"id": "107864155075941_110806978114992",
"message": "N'ha fatta tanta a Treia😁"
},
{
"created_time": "2021-12-07T22:02:55+0000",
"id": "107864155075941_107495008446189",
"message": "E' stata una bella esperienza ad Cagliari, ora purtroppo si ritorna a casa a Treia😞😞😞"
}
]
}
]
}In risposta alla terza richiesta si avrà:
{
"province": [
{
"Posts in: mc": [
{
"Message": "Tornando da lavoro, giretto a Pioraco. Tanta roba🤩",
"Created Time": "2021-12-09T12:20:47+0000"
},
{
"Message": "Ahhh la mia Treia♥️",
"Created Time": "2021-12-10T18:46:16+0000"
},
{
"Message": "N'ha fatta tanta a Treia😁",
"Created Time": "2021-12-10T07:17:12+0000"
},
{
"Message": "O a Macerata?",
"Created Time": "2021-12-10T23:09:44+0000"
},
{
"Message": "Verso Civitanova Marche😜",
"Created Time": "2021-12-11T16:32:49+0000"
},
{
"Message": "Vi pare normale che tornando a casa da Amsterdam mi ritrovo installata a qualche km dalla mia abitazione (vicino Tolentino) questa ANTENNA 5G!!!\nNON SIAMO CAVIE!!! #Stop5G",
"Created Time": "2021-12-07T22:59:32+0000"
},
{
"Message": "Treia sfocata",
"Created Time": "2021-12-19T01:52:07+0000"
},
{
"Message": "Un bel bombardino a Bolognola ci sta tutto",
"Created Time": "2021-12-20T22:12:08+0000"
}
]
}
]
}In risposta alla quarta richiesta si avrà:
{
"region": [
{
"Posts in: marche": [
{
"Message": "Tornando da lavoro, giretto a Pioraco. Tanta roba🤩",
"Created Time": "2021-12-09T12:20:47+0000"
},
{
"Message": "Un bel bombardino a Bolognola ci sta tutto",
"Created Time": "2021-12-20T22:12:08+0000"
},
{
"Message": "Treia sfocata",
"Created Time": "2021-12-19T01:52:07+0000"
},
{
"Message": "Porto San Giorgio, bella anche d'inverno",
"Created Time": "2021-12-17T21:08:46+0000"
},
{
"Message": "N'ha fatta tanta a Treia😁",
"Created Time": "2021-12-10T07:17:12+0000"
},
{
"Message": "Ahhh la mia Treia♥️",
"Created Time": "2021-12-10T18:46:16+0000"
},
{
"Message": "Giretto in Ancona?",
"Created Time": "2021-12-10T20:37:39+0000"
},
{
"Message": "Verso Civitanova Marche😜",
"Created Time": "2021-12-11T16:32:49+0000"
},
{
"Message": "O a Macerata?",
"Created Time": "2021-12-10T23:09:44+0000"
},
{
"Message": "Oggi a pranzo in Ancona grande mangiata di biscottiii😁😁",
"Created Time": "2021-12-08T13:43:20+0000"
},
{
"Message": "Vi pare normale che tornando a casa da Amsterdam mi ritrovo installata a qualche km dalla mia abitazione (vicino Tolentino) questa ANTENNA 5G!!!\nNON SIAMO CAVIE!!! #Stop5G",
"Created Time": "2021-12-07T22:59:32+0000"
}
]
}
]
}In risposta alla quinta richiesta si avrà:
{
"Ranking region": [
{
"Occurences": 11,
"Region": "Marche"
},
{
"Occurences": 3,
"Region": "Umbria"
},
{
"Occurences": 3,
"Region": "Sardegna"
},
{
"Occurences": 2,
"Region": "Basilicata"
},
{
"Occurences": 1,
"Region": "Piemonte"
},
{
"Occurences": 1,
"Region": "Lazio"
},
{
"Occurences": 1,
"Region": "Molise"
},
{
"Occurences": 1,
"Region": "Lombardia"
},
{
"Occurences": 1,
"Region": "Toscana"
}
]
}In risposta alla sesta richiesta si avrà:
"province": [
[
"SS",
"MT",
"CA",
"RM",
"FI",
"MC",
"PG",
"TO",
"MI",
"AN",
"FM",
"CB"
]
]
}
Le eccezioni che sono state aggiunte e gestite sono le seguenti:
- EmptyListException: lanciata quando un elemento (ad esempio Array) è vuoto.
- FileManagementException: lanciata quando occorre un errore nella lettura del file di database delle città.
- NonExistingLocationException: lanciata quando una città inserita dall' utente (es. Paris) non è presente nel database.
- WrongFieldException: lanciata quando un campo (es. type = ccityy) non è valido.
- WrongParameterException: lanciata quando un parametro non è ammesso.
Il messaggio mostrato dalle eccezioni dipende dal metodo in cui sono applicati.
I test sono stati eseguiti grazie l'ausilio del framework JUnit già presente nell' ambiente di sviluppo Eclipse. Sono stati implementati tre classi di test unitari:
- Test 1: controllo correttezza lancio eccezione FileManagementException.
- Test 2: controllo correttezza output del metodo getPostsFromRegion.
- Test 3: controllo correttezza output del metodo ranking.
Il progetto è interamente documentato in javadoc
Il progetto è stato realizzato da:
- Dennis Rapaccini (50%)
- Cheikh Cisse (50%)