General Stats from a Single City

[tloriato]

We need to come up with ~8 statistics that would be relevant for the city.

Related to sdec-brasil/old-dashboard#60

[dbeyda]

I suggest we try to calculate everything for each request.
If that this gets too slow, we can create a new model CityStats, and have one instance for each city, and keep it updated. Each time an invoice changes status or a new company is registered, for example, we update the correct city CityStats to consider that change. Then, when the request comes, we only have to fetch it from the DB and serve it to the user.

[tloriato]

I think we can consider optimizations once we know which stats we are going to take into consideration, but overall I agree we should keep an eye on cache'ing this.

[dbeyda]

Current status:

Request

GET https://localhost:8000/v1/city-stats/1100015?month=5&year=2019

Response:

{
    "city": {
        "codigoMunicipio": "1100015",
        "cnpj": "18511471000120",
        "municipio.codigoIbge": "1100015",
        "municipio.nome": "Alta Floresta D'Oeste",
        "municipio.uf": "RO",
        "municipio.nomeRegiao": "Leste Rondoniense",
        "municipio.estado.sigla": "RO",
        "municipio.estado.nome": "Rondônia",
        "municipio.regiao.nomeRegiao": "Leste Rondoniense",
        "municipio.regiao.uf": "RO"
    },
    "lateIssValue": 0,
    "avgLiquidValue": 2044,
    "emitedInvoicesCount": 30,
    "avgIss": 557,
    "biggestIssuer": "Adesivos ColaComigo e Colas S.A."
}

[tloriato]

Let's move that info for /v1/cities/{city}/ , shall we?

Also, biggestIssuer CNPJ / address would be useful for navigating data.

[dbeyda]

Moved into /v1/cities/<city>/general-stats/ as requested.
added more info to the biggestIssuer:

    "biggestIssuer": {
        "cnpj": "1231231231234",
        "enderecoBlockchain": "1HB5XMLmzFVj8ALj6mfBsbifRoD4miY37c",
        "razaoSocial": "Adesivos ColaComigo e Colas S.A.",
        "nomeFantasia": "Cola-Comigo Adesivos"
    }

[tloriato]

Looks good