🧪 pdgt-covid 📊

Progetto Piattaforme Digitali per la Gestione del Territorio

Secondo appello sessione estiva 2019/2020
Edoardo Conti - 278717

Introduzione

Progetto finalizzato alla realizzazione di un Web Service RESTful con lo scopo di erogare API per garantire fruizione e manipolazione di dati relativi all'andamento del Covid-19 in Italia. Il sistema prevede due strati di sicurezza: autenticazione ed autorizzazione.

Gli obiettivi, nonchè funzionalità principali del progetto, sono di seguito riportati:

Trend Nazionale
- Visualizzazione trend nazionale
- Visualizzazione picco di nuovi positivi a livello nazionale
- Ricerca rilevazione trend giornaliero nazionale filtrato per data
- Aggiunta, Modifica e Rimozione rilevazione trend giornaliero nazionale
Trend Regionale
- Visualizzazione trend regionale
- Visualizzazione picco di nuovi positivi a livello regionale
- Ricerca trend regionale filtrato per data o regione
- Ricerca picco nuovi positivi filtrato per regione
Utenza
- Visualizzazione lista utenti registrati
- Ricerca utente per username
- Registrazione ed Accesso utente al sistema
- Rimozione utente dal sistema

Architettura e Scelte Implementative

Il progetto è stato sviluppato seguendo un approccio client-server in quanto si è scelto di sviluppare un applicativo dimostrativo (client) per la fruizione delle API. Il software è inoltre diviso in blocchi dalle funzionalità ben distinte rispettando il pattern architetturale Model-View-Controller (MVC). Da specificare che in questo caso la parte grafica è affidata al client, per tanto il server implementerà di conseguenza le parti di Modellazione delle strutture dati e Controller per la gestione delle funzionalità.

Quindi per quanto concerne il lato server, si è sposata la scelta del linguaggio di programmazione open source Go. Le motivazioni di tale scelta ricadono nell'efficienza di scrittura di codice che permette la realizzazione di software semplici ma affidabili, presenza di framework moderni per l'approccio alle comunicazioni HTTP e sopratutto sfruttare l'occasione per imparare questo linguaggio di programmazione che da tempo mi incuriosiva. La gestione delle richieste HTTP è stata affidata a Gin Web Framework il quale vanta performance 40x superiori rispetto a HttpRouter, un multiplexer alternativo sempre scritto in Go. Per installare il package Gin ed impostarlo nel workspace è sufficiente:

Utilizzare il seguente comando per installare Gin (necessario Go v1.11+).
```
$ go get -u github.com/gin-gonic/gin
```
Importare Gin nel progetto.
```
import "github.com/gin-gonic/gin"
```

Database

La scelta di come mantenere e manipolare i dati interessati, dopo diverse valutazioni, è ricaduta su Heroku Postgres: uno dei DBMS più popolari al mondo basato su SQL. Successivamente si discuterà della scelta d'utilizzo di Heroku per effettuare il deployment dell'applicativo, al momento è sufficiente essere a conoscenza della presenza di tale servizio. Per aggiungere l'addon PostgreSQL con piano hobby-dev-free alla propria App è sufficiente inviare il comando sottostante (richiede Heroku CLI):

$ heroku addons:create heroku-postgresql:hobby-dev
Creating heroku-postgresql:hobby-dev on ⬢ pdgt-covid... free
Created postgresql-concentric-70860 as DATABASE_URL

Così facendo si andrà a creare anche la variabile d'ambiente Heroku DATABASE_URL, che verrà impiegata per stabilire una connessione con il database per visualizzare e manipolare i dati relativi all'andamento del Covid-19 in Italia. Di seguito è riportato il comando per collegarsi alla console psql dell'addon Heroku (previo accesso tramite $ heroku login) e la lista di tabelle presenti nel database.

$ heroku pg:psql --app pdgt-covid
--> Connecting to postgresql-concentric-70860
psql (12.3)
SSL connection (protocol: TLSv1.2, cipher: ECDHE-RSA-AES256-GCM-SHA384, bits: 256, compression: off)
Type "help" for help.

pdgt-covid::DATABASE=> \dt
             List of relations
 Schema |  Name   | Type  |     Owner      
--------+---------+-------+----------------
 public | nazione | table | smmnpqlyusgxdh
 public | regioni | table | smmnpqlyusgxdh
 public | utenti  | table | smmnpqlyusgxdh
(3 rows)

La tabella nazione è dedicata allo storage dei trend nazionali del Covid-19. In seguito si riporta lo schema della tabella SQL e più sotto l'analoga struttura dati in golang per interfacciarsi con il DB, NationalTrend. Da notare la consistenza del nome dei campi per ridurre errori di battitura durante la stesura del codice e migliorare la leggibilità dello stesso.

pdgt-covid::DATABASE=> \d+ nazione
                 Table "public.nazione"                           
           Column           |          Type          
----------------------------+------------------------
 data                       | date                   
 stato                      | character varying(3)   
 ricoverati_con_sintomi     | integer                
 terapia_intensiva          | integer                
 totale_ospedalizzati       | integer                
 isolamento_domiciliare     | integer                
 totale_positivi            | integer                
 variazione_totale_positivi | integer                
 nuovi_positivi             | integer                
 dimessi_guariti            | integer               
 deceduti                   | integer              
 totale_casi                | integer                
 tamponi                    | integer                
 casi_testati               | integer               
 note_it                    | character varying(255) 
 note_en                    | character varying(255)

type NationalTrend struct {
	Data                     string         `json:"data"`
	Stato                    string         `json:"stato"`
	RicoveratiConSintomi     int            `json:"ricoverati_con_sintomi"`
	TerapiaIntensiva         int            `json:"terapia_intensiva"`
	TotaleOspedalizzati      int            `json:"totale_ospedalizzati"`
	IsolamentoDomiciliare    int            `json:"isolamento_domiciliare"`
	TotalePositivi           int            `json:"totale_positivi"`
	VariazioneTotalePositivi int            `json:"variazione_totale_positivi"`
	NuoviPositivi            int            `json:"nuovi_positivi"`
	DimessiGuariti           int            `json:"dimessi_guariti"`
	Deceduti                 int            `json:"deceduti"`
	TotaleCasi               int            `json:"totale_casi"`
	Tamponi                  int            `json:"tamponi"`
	CasiTestati              sql.NullInt64  `json:"casi_testati"`
	NoteIT                   sql.NullString `json:"note_it"`
	NoteEN                   sql.NullString `json:"note_en"`
}

Onde evitare ridondanza e mantenere il Readme a scopo riassuntivo, gli schemi e strutture delle tabelle regioni ed utenti non verranno riportate in questa sede ma restano ovviamente consultabili navigando nel codice del respository.

L'importazione dei dati è avvenuta tramite comando COPY via psql il quale, come suggerisce il nome, copia dati tra file e tabelle PostegreSQL. Nello specifico, inizialmente si è scaricato il file .csv contenente i dati interessati come specificato nella sezione più in basso Dati e Servizi Esterni. Successivamente è stato creato lo schema della tabella su Postgres seguendo il formato delle colonne e dei dati per poi andare ad effettuare l'importazione tramite un comando compilato simile al seguente:

$ PGPASSWORD=<db_password> psql -h <host> -U <username> <database> -c "\copy nazione (data,stato,ricoverati_con_sintomi,terapia_intensiva,totale_ospedalizzati,isolamento_domiciliare,totale_positivi,variazione_totale_positivi,nuovi_positivi,dimessi_guariti,deceduti,totale_casi,tamponi,casi_testati,note_it,note_en) FROM '<path_to_dpc-covid19-ita-andamento-nazionale.csv>' CSV HEADER DELIMITER ','"

Sistema di Autenticazione ed Autorizzazione

La sicurezza sulla modifica dei dati archiviati è gestita su due layer: autenticazione ed autorizzazione. Il sistema è stato pensato ponendo dei limiti di lettura e scrittura su utenti non autenticati. Per quanto riguarda quindi l'autenticazione: un utente registrato gode di privilegi di lettura superiori rispetto ad un visitatore e vanta la possibilità di effettuare richieste HTTP POST (all'infuori del signup e signin). L'autorizzazione si riferisce al role dell'utente, se Admin, possiede tutti i privilegi di lettura e scrittura. Per tanto oltre a quanto possibile ad un Utente, un Admin può effettuare richieste HTTP PATCH e DELETE. Di seguito è riportata una tabella che riassume i permessi delle API:

Visitatore	Utente	Admin
`GET /api/trend/*`	`GET /api/trend/*`	`GET /api/trend/*`
-	`GET /api/utenti/*`	`GET /api/utenti/*`
`POST /api/utenti/signin` `POST /api/utenti/signup`	`POST /api/*`	`POST /api/*`
-	-	`PATCH /api/*`
-	-	`DELETE /api/*`

Durante il signup, nel form di registrazione, è possibile specificare se l'utente che si sta tentando di creare godrà di privilegi di livello Admin semplicemente selezionando il checkbox relativo. Si ricorda che a fine file è possibile consultare degli screenshots dell'applicativo, compresa la schermata in questione.

Il login di un utente è verificato tramite JSON Web Token (JWT), uno standard open che definisce uno schema JSON per lo scambio di informazioni tra vari servizi. Il token generato verrà firmato con una chiave segreta impostata come variabile d'ambiente in Heroku (JWT_ACCESS_SECRET) tramite l'algoritmo HMAC. Durante la fase di login le credenziali vengono cryptate secondo l'algoritmo di hashing bcrypt. Ergo nel database viene salvato unicamente l'hash della password evitando di esporre password in chiaro in caso di falle di sicurezza. Lato server, sfruttando il metodo CompareHashAndPassword(...) della libreria bcrypt, si comparerà la password in chiaro proposta dall'utente e l'hash presente nel database.

Client

Per poter sfruttare le API messe a disposizione dal web service in questione si è scelto di sviluppare una Web App con tecnologia React, una libreria javascript per creare interfacce utente moderne. L'obiettivo imposto è stato quello di offrire un'interfaccia grafica per interrogare il web service fino ad ora discusso. Il design della GUI è stato realizzato con material-ui, componente React per un web development semplice e rapido con stile Material by Google.

Per impostare il workspace di una Web App React è sufficiente un semplice comando:

$ npx create-react-app pdgt-covid-webapp

Terminato il processo si avrà, senza aver battuto una singola riga di codice, una Single Sage Application (SPA) con tutte le directory e files di default predisposti pronti ad essere adattati per realizzare la propria applicazione. Il principale componente sfruttato per mostrare e manipolare i dati a disposizione è material-table, una semplice ma molto potente data-table per React basata su Material-UI Table. L'installazione prevede un singolo comando npm :

$ npm install material-table @material-ui/core --save

Le comunicazioni con protocollo HTTP lato client, comprensive di operazioni GET, POST, PATCH e DELETE, sono effettuate sfruttando axios che non è altro che un client HTTP promise-api-based per nodejs.

$ npm install axios

import axios from "axios";

Maggiori informazioni circa il funzionamento della web app sono disponibili nella sezione dedicata con tanto di screenshots del funzionamento.

Dati e Servizi Esterni

Il recupero dei dati relativi all'andamento del Covid-19 in Italia è stato ricavato dal Dipartimento della Protezione Civile (DPC) sotto licenza Creative Commons Attribution 4.0 International tramite file .csv ospitati nel repository pubblico GitHub pcm-dpc/COVID-19. Licenza dati.

La realizzazione della mappa interattiva accessibile dalla web app, che illustra la diffusione del Covid-19 in italia mediante cerchi di circonferenza in scala al totale dei casi della regione, è possibile grazie alle API di Google Maps. Termini di servizio.

L'immagine avatar degli utenti è ricavata sfruttando l'API del servizio DiceBear Avatars. Il servizio permette di effettuare richieste HTTP richiedendo diverse tipologie ed immagini di avatar in base alle preferenze imposte mediante il path dell'API. Licenza servizio.

Documentazione API

E' possibile accedere alla documentazione essenziale dell'API a questo indirizzo: https://app.swaggerhub.com/apis-docs/edoardo-conti/pdgt-covid/1.0.0

Per la documentazione completa si invita a continuare la lettura qui di seguito:

Trend Nazionale

Visualizzare tutto il trend nazionale

GET https://pdgt-covid.herokuapp.com/api/trend/nazionale

{
  "count": 106,
  "data": [
    {
      "data": "2020-02-23T00:00:00Z",
      "stato": "ITA",
      "ricoverati_con_sintomi": 4,
      "terapia_intensiva": 1,
      "totale_ospedalizzati": 1,
      "isolamento_domiciliare": 1,
      "totale_positivi": 1,
      "variazione_totale_positivi": -5,
      "nuovi_positivi": 1,
      "dimessi_guariti": 0,
      "deceduti": 0,
      "totale_casi": 1,
      "tamponi": 10,
      "casi_testati": {
        "Int64": 200,
        "Valid": true
      },
      "note_it": {
        "String": "",
        "Valid": false
      },
      "note_en": {
        "String": "",
        "Valid": false
      }
    },
    {
      "data": "2020-02-24T00:00:00Z",
      "stato": "ITA",
      "ricoverati_con_sintomi": 101,
      "terapia_intensiva": 26,
      "totale_ospedalizzati": 127,
      "isolamento_domiciliare": 94,
      "totale_positivi": 221,
      "variazione_totale_positivi": 0,
      "nuovi_positivi": 221,
      "dimessi_guariti": 1,
      "deceduti": 7,
      "totale_casi": 229,
      "tamponi": 4324,
      "casi_testati": {
        "Int64": 0,
        "Valid": false
      },
      "note_it": {
        "String": "",
        "Valid": false
      },
      "note_en": {
        "String": "",
        "Valid": false
      }
    },
    [...]
  ],
  "status": 200
}

Visualizzare il trend nazionale filtrato per data

GET https://pdgt-covid.herokuapp.com/api/trend/nazionale/data/:bydate

// https://pdgt-covid.herokuapp.com/api/trend/nazionale/data/2020-02-24
{
  "data": {
    "data": "2020-02-24T00:00:00Z",
    "stato": "ITA",
    "ricoverati_con_sintomi": 101,
    "terapia_intensiva": 26,
    "totale_ospedalizzati": 127,
    "isolamento_domiciliare": 94,
    "totale_positivi": 221,
    "variazione_totale_positivi": 0,
    "nuovi_positivi": 221,
    "dimessi_guariti": 1,
    "deceduti": 7,
    "totale_casi": 229,
    "tamponi": 4324,
    "casi_testati": {
      "Int64": 0,
      "Valid": false
    },
    "note_it": {
      "String": "",
      "Valid": false
    },
    "note_en": {
      "String": "",
      "Valid": false
    }
  },
  "status": 200
}

Visualizzare il picco di nuovi positivi in Italia

GET https://pdgt-covid.herokuapp.com/api/trend/nazionale/picco

{
  "data": {
    "data": "2020-03-21T00:00:00Z",
    "stato": "ITA",
    "ricoverati_con_sintomi": 17708,
    "terapia_intensiva": 2857,
    "totale_ospedalizzati": 20565,
    "isolamento_domiciliare": 22116,
    "totale_positivi": 42681,
    "variazione_totale_positivi": 4821,
    "nuovi_positivi": 6557,
    "dimessi_guariti": 6072,
    "deceduti": 4825,
    "totale_casi": 53578,
    "tamponi": 233222,
    "casi_testati": {
      "Int64": 0,
      "Valid": false
    },
    "note_it": {
      "String": "",
      "Valid": false
    },
    "note_en": {
      "String": "",
      "Valid": false
    }
  },
  "status": 200
}

Inserimento di un nuovo trend giornaliero nazionale (Richiesta Autenticazione)

POST https://pdgt-covid.herokuapp.com/api/trend/nazionale

// richiesta
// Authorization <token>
{
        "data": "2020-02-20",
        "ricoverati_con_sintomi": "178",
        "terapia_intensiva": "57",
        "totale_ospedalizzati": "265",
        "isolamento_domiciliare": "116",
        "totale_positivi": "481",
        "variazione_totale_positivi": "21",
        "nuovi_positivi": "67",
        "dimessi_guariti": "434",
        "deceduti": "425",
        "totale_casi": "578",
        "tamponi": "222",
        "casi_testati": "213"
}

// risposta
{
    "info": "/api/trend/nazionale/data/2020-02-20",
    "message": "Trend giornaliero nazionale registrato con successo.",
    "status": 200
}

Aggiornamento di un trend nazionale giornaliero già esistente (Richiesta Autorizzazione)

PATCH https://pdgt-covid.herokuapp.com/api/trend/nazionale/data/:bydate

// richiesta
// https://pdgt-covid.herokuapp.com/api/trend/nazionale/data/2020-02-20
// Authorization <token>
{
        "terapia_intensiva": 100,
        "totale_ospedalizzati": 300,
        "variazione_totale_positivi": -10,
        "tamponi": 101
}

// risposta
{
    "info": "/api/trend/nazionale/data/2020-02-20",
    "message": "Trend in data 2020-02-20 aggiornato con successo.",
    "status": 200
}

Eliminazione di un trend nazionale giornaliero già esistente (Richiesta Autorizzazione)

DELETE https://pdgt-covid.herokuapp.com/api/trend/nazionale/data/:bydate

// richiesta
// https://pdgt-covid.herokuapp.com/api/trend/nazionale/data/2020-02-20
// Authorization <token>

// risposta
{
    "message": "Trend in data 2020-02-20 eliminato dal database con successo.",
    "status": 200
}

Trend Regionale

Visualizzare tutti i trend regionali

GET https://pdgt-covid.herokuapp.com/api/trend/regionale

{
    "count": 105,
    "data": [
        {
            "data": "2020-02-24T00:00:00Z",
            "info": [
                {
                    "stato": "ITA",
                    "codice_regione": 13,
                    "denominazione_regione": "Abruzzo",
                    "lat": 42.35122196,
                    "long": 13.39843823,
                    "ricoverati_con_sintomi": 0,
                    "terapia_intensiva": 0,
                    "totale_ospedalizzati": 0,
                    "isolamento_domiciliare": 0,
                    "totale_positivi": 0,
                    "variazione_totale_positivi": 0,
                    "nuovi_positivi": 0,
                    "dimessi_guariti": 0,
                    "deceduti": 0,
                    "totale_casi": 0,
                    "tamponi": 5,
                    "casi_testati": null,
                    "note_it": null,
                    "note_en": null
                },
                {
                    "stato": "ITA",
                    "codice_regione": 17,
                    "denominazione_regione": "Basilicata",
                    "lat": 40.63947052,
                    "long": 15.80514834,
                    "ricoverati_con_sintomi": 0,
                    "terapia_intensiva": 0,
                    "totale_ospedalizzati": 0,
                    "isolamento_domiciliare": 0,
                    "totale_positivi": 0,
                    "variazione_totale_positivi": 0,
                    "nuovi_positivi": 0,
                    "dimessi_guariti": 0,
                    "deceduti": 0,
                    "totale_casi": 0,
                    "tamponi": 0,
                    "casi_testati": null,
                    "note_it": null,
                    "note_en": null
                },
                [...]
            ]
        },
        {
            "data": "2020-02-25T00:00:00Z",
            "info": [...]
        }
    ],
    "status": 200
}

Visualizzare tutti i trend regionali filtrati per data

GET https://pdgt-covid.herokuapp.com/api/trend/regionale/data/:bydata

// https://pdgt-covid.herokuapp.com/api/trend/regionale/data/2020-02-24
{
    "count": 1,
    "data": [
        {
            "data": "2020-02-24T00:00:00Z",
            "info": [
                {
                    "stato": "ITA",
                    "codice_regione": 13,
                    "denominazione_regione": "Abruzzo",
                    "lat": 42.35122196,
                    "long": 13.39843823,
                    "ricoverati_con_sintomi": 0,
                    "terapia_intensiva": 0,
                    "totale_ospedalizzati": 0,
                    "isolamento_domiciliare": 0,
                    "totale_positivi": 0,
                    "variazione_totale_positivi": 0,
                    "nuovi_positivi": 0,
                    "dimessi_guariti": 0,
                    "deceduti": 0,
                    "totale_casi": 0,
                    "tamponi": 5,
                    "casi_testati": null,
                    "note_it": null,
                    "note_en": null
                },
                {
                    "stato": "ITA",
                    "codice_regione": 17,
                    "denominazione_regione": "Basilicata",
                    "lat": 40.63947052,
                    "long": 15.80514834,
                    "ricoverati_con_sintomi": 0,
                    "terapia_intensiva": 0,
                    "totale_ospedalizzati": 0,
                    "isolamento_domiciliare": 0,
                    "totale_positivi": 0,
                    "variazione_totale_positivi": 0,
                    "nuovi_positivi": 0,
                    "dimessi_guariti": 0,
                    "deceduti": 0,
                    "totale_casi": 0,
                    "tamponi": 0,
                    "casi_testati": null,
                    "note_it": null,
                    "note_en": null
                },
                [...]
            ]
        }
    ],
    "status": 200
}

Visualizzare tutti i trend regionali filtrati per regione

GET https://pdgt-covid.herokuapp.com/api/trend/regionale/regione/:byregid

// https://pdgt-covid.herokuapp.com/api/trend/regionale/regione/11
{
    "count": 105,
    "data": [
        {
            "data": "2020-02-24T00:00:00Z",
            "info": [
                {
                    "stato": "ITA",
                    "codice_regione": 11,
                    "denominazione_regione": "Marche",
                    "lat": 43.61675973,
                    "long": 13.5188753,
                    "ricoverati_con_sintomi": 0,
                    "terapia_intensiva": 0,
                    "totale_ospedalizzati": 0,
                    "isolamento_domiciliare": 0,
                    "totale_positivi": 0,
                    "variazione_totale_positivi": 0,
                    "nuovi_positivi": 0,
                    "dimessi_guariti": 0,
                    "deceduti": 0,
                    "totale_casi": 0,
                    "tamponi": 16,
                    "casi_testati": null,
                    "note_it": null,
                    "note_en": null
                }
            ]
        },
        {
            "data": "2020-02-25T00:00:00Z",
            "info": [
                {
                    "stato": "ITA",
                    "codice_regione": 11,
                    "denominazione_regione": "Marche",
                    "lat": 43.61675973,
                    "long": 13.5188753,
                    "ricoverati_con_sintomi": 0,
                    "terapia_intensiva": 0,
                    "totale_ospedalizzati": 0,
                    "isolamento_domiciliare": 0,
                    "totale_positivi": 0,
                    "variazione_totale_positivi": 0,
                    "nuovi_positivi": 0,
                    "dimessi_guariti": 0,
                    "deceduti": 0,
                    "totale_casi": 0,
                    "tamponi": 21,
                    "casi_testati": null,
                    "note_it": null,
                    "note_en": null
                }
            ]
        },
        [...]
    ],
    "status": 200
}

Visualizzare il picco di nuovi positivi più alto tra tutti i trend regionali

GET https://pdgt-covid.herokuapp.com/api/trend/regionale/picco/

{
    "count": 1,
    "data": [
        {
            "data": "2020-03-21T00:00:00Z",
            "info": [
                {
                    "stato": "ITA",
                    "codice_regione": 3,
                    "denominazione_regione": "Lombardia",
                    "lat": 45.46679409,
                    "long": 9.190347404,
                    "ricoverati_con_sintomi": 8258,
                    "terapia_intensiva": 1093,
                    "totale_ospedalizzati": 9351,
                    "isolamento_domiciliare": 8019,
                    "totale_positivi": 17370,
                    "variazione_totale_positivi": 1950,
                    "nuovi_positivi": 3251,
                    "dimessi_guariti": 5050,
                    "deceduti": 3095,
                    "totale_casi": 25515,
                    "tamponi": 66730,
                    "casi_testati": null,
                    "note_it": null,
                    "note_en": null
                }
            ]
        }
    ],
    "status": 200
}

Visualizzare il picco di nuovi positivi di tutti i trend regionali filtrato per regione

GET https://pdgt-covid.herokuapp.com/api/trend/regionale/picco/:byregid

// https://pdgt-covid.herokuapp.com/api/trend/regionale/picco/11
{
    "count": 1,
    "data": [
        {
            "data": "2020-03-22T00:00:00Z",
            "info": [
                {
                    "stato": "ITA",
                    "codice_regione": 11,
                    "denominazione_regione": "Marche",
                    "lat": 43.61675973,
                    "long": 13.5188753,
                    "ricoverati_con_sintomi": 816,
                    "terapia_intensiva": 138,
                    "totale_ospedalizzati": 954,
                    "isolamento_domiciliare": 1277,
                    "totale_positivi": 2231,
                    "variazione_totale_positivi": 234,
                    "nuovi_positivi": 268,
                    "dimessi_guariti": 6,
                    "deceduti": 184,
                    "totale_casi": 2421,
                    "tamponi": 6391,
                    "casi_testati": null,
                    "note_it": null,
                    "note_en": null
                }
            ]
        }
    ],
    "status": 200
}

Utenti

Visualizzare tutti gli utenti registrati (Richiesta Autenticazione)

GET https://pdgt-covid.herokuapp.com/api/utenti/

// richiesta
// Authorization <token>

// risposta
{
    "count": 4,
    "data": [
        {
            "username": "edoardo",
            "is_admin": true,
            "avatar_url": "https://avatars.dicebear.com/api/initials/e.svg"
        },
        {
            "username": "professore",
            "is_admin": true,
            "avatar_url": "https://avatars.dicebear.com/api/initials/p.svg"
        },
	{
            "username": "test",
            "is_admin": false,
            "avatar_url": "https://avatars.dicebear.com/api/initials/t.svg"
        },
        [...]
    ],
    "status": 200
}

Visualizzare utente registrato filtrato per username (Richiesta Autenticazione)

GET https://pdgt-covid.herokuapp.com/api/utenti/:byusername

// richiesta
// https://pdgt-covid.herokuapp.com/api/utenti/test
// Authorization <token>

// risposta
{
    "data": {
        "username": "test",
        "is_admin": false,
        "avatar_url": "https://avatars.dicebear.com/api/initials/t.svg"
    },
    "status": 200
}

Registrazione utente nel database

POST https://pdgt-covid.herokuapp.com/api/utenti/signup

// richiesta
{
    "username": "mario",
    "password": "segreto",
    "is_admin": false
}

// risposta
{
    "info": "Per visualizzare: /utenti/mario",
    "message": "Utente registrato con successo.",
    "status": 200
}

Accesso utente nel sistema

POST https://pdgt-covid.herokuapp.com/api/utenti/signin

// richiesta
{
    "username": "test",
    "password": "test"
}

// risposta
{
    "message": "Utente test loggato con successo.",
    "status": 200,
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhZG1pbiI6ZmFsc2UsImF1dGhvcml6ZWQiOnRydWUsImV4cCI6MTU5MzAwOTAyMCwidXNlcm5hbWUiOiJ0ZXN0In0.4wCtltOGmB9G0JIY3LQ1PAH1M22U7bdUn5nmueHy7aE"
}

Eliminazione utente dal sistema per username (Richiesta Autorizzazione)

DELETE https://pdgt-covid.herokuapp.com/api/utenti/:byusername

// richiesta
// https://pdgt-covid.herokuapp.com/api/utenti/mario
// Authorization <token>

// risposta
{
    "message": "Utente mario eliminato dal database con successo.",
    "status": 200
}

Continuous Integration e Continuous Deployment (CI/CD)

L'integrazione continua (continuous integration o CI) è affidata al servizio Travis CI. Nel repository è possibile consultare il file .travis.yml che specifica i parametri fondamentali per poter integrare il repository nella piattaforma.

Nel file yaml in questione è presente il tag deploy, responsabile del deployment continuo (continuous deployment o CD) sul provider Heroku. Grazie a quest'ultimo è stato possibile creare un app dedicata al progetto e rendere quest'ultimo disponibile online tramite indirizzo web pubblicamente accessibile. L'API Key di Heroku è stata fornita in forma cryptata, ottenuta grazie a travis-ci cli, evitando problematiche a livello di sicurezza. Utile in questo frangente è stato GitGuardian. Infatti per mezzo di scansioni continue di vulnerabilità del repository permette di evitare possibili policy breaks.

Durante la fase di sviluppo, quando si raggiungeva un momento utile per effettuare il commit delle modifiche dei file sorgente, questo è l'ordine d'esecuzione dei comandi per l'upload del codice:

$ go mod tidy
$ go mod vendor
$ git add -A .
$ git commit -m "breve commento modifiche apportate"
$ git push

Ultimato il push nel repository Git, verrà triggerata la build in travis-ci dell'ultimo commit il quale imposterà l'ambiente di compilazione (comprensivo di go env), effettuerà una pull request del branch master ed avvierà la compilazione e deployment automatico su Heroku nell'app indicata. Ergo, dopo ogni git push l'implementazione di tale sistema CI/CD mi permetterà di poter accedere all'API all'indirizzo dell'applicativo Heroku dopo soli pochi istanti.

Il Web Service (API) è pertanto accessibile al seguente indirizzo: https://pdgt-covid.herokuapp.com

Client ed Esempi d'uso

Il repository pubblico del client è consultabile a questo indirizzo: https://github.com/edoardo-conti/pdgt-covid-client

L'applicativo è erogato secondo le stesse modalità CI/CD illustrate nella sezione appena sopra, ergo è accessibile al seguente indirizzo: https://pdgt-covid-client.herokuapp.com

Di seguito vengono riportate delle credenziali di testing:

username: test
password: test

Raggiunta la homepage della web app si verrà accolti da un messaggio di benvenuto. Nel menù superiore, a sinistra è possibile accedere alla lista di funzionalità del client. Si riportano screenshots del funzionamento dell'applicativo:

Fruizione da Visitatore

Visualizzazione trend nazionale e regionale senza permessi di modifica o eliminazione. La tabella utenti non è accessibile ad un visitatore.

Fruizione da Utente ed Admin

Sono state evidenziate le differenze accedendo alle pagine come utente invece che come visitatore. Sono disponibili icone per l'aggiunta, modifica e cancellazione di trend nazionali. E' inoltre possibile accedere alla tabella utenti in lettura e scrittura.

Gestione degli errori

Dimostrazione della gestione degli errori, elaborata in parte lato client ma sostanzialmente lato server riportando gli errori erogati direttamente dall'API.

Autorizzazione

Come riportato nella tabella dei privilegi, vi sono delle differenze tra ciò che un utente può effettuare rispetto ad un admin.

Notifica modifica avvenuta con successo

Gestione dei messaggi riportati dalle risposte delle richieste HTTP all'avvenuta aggiunta, modifica o cancellazione di dati.

Login e Menù

Screenshots della pagina di signup, signin e le differenze nel menù tra utente ed admin.

Licenza

Questo progetto è rilasciato sotto i termini della licenza MIT.

Name		Name	Last commit message	Last commit date
Latest commit History 49 Commits
bin		bin
controllers		controllers
middlewares		middlewares
models		models
vendor		vendor
.travis.yml		.travis.yml
LICENSE		LICENSE
Procfile		Procfile
README.md		README.md
go.mod		go.mod
go.sum		go.sum
main.go		main.go

License

edoardo-conti/pdgt-covid

Folders and files

Latest commit

History

Repository files navigation