rahenrique / rah.artbook-neo4j

Projeto para aprendizado de tecnologias: API de um catálogo de artes e artistas, construído sobre o Framework Flask, com Graph Database Neo4J.

Hi there 👋

rah.artbook-neo4j's Issues

Criar modelos de domínio

Criar classes para representar modelos de domínio, separados em arquivos:

• Artista
• Grupo de Artistas
• Obra
• Série
• Evento

Tipo PlaceInTime para tratar eventos temporais em um determinado local

Certos eventos, como a data de nascimento de um artista, são basicamente um agregado de dois tipos: local e data (eventualmente, uma data imprecisa)

Exemplos:

"place_of_birth": {
    "date": "2000-12-01",
    "place": "Lisboa, Portugal"
},

"some_imprecise_date": {
    "date": "2021",
    "place": "São Paulo, Brasil"
}

• Python: classe para armazenar o tipo
• Neo4J: estudar como implementar o novo tipo

Implementar HATEOAS

Implementar separação de camadas seguindo Domain Driven Design

Tornar a arquitetura mais explícita no código.
Ver os seguintes artigos para insight:

• Reflecting architecture and domain in code - Herberto Graça
• DDD, Hexagonal, Onion, Clean, CQRS, … How I put it all together - Herberto Graça

Tipo UncertainDate para tratar datas imprecisas

Certas datas, como a data de criação de uma obra de arte, geralmente são imprecisas, referenciando um período com certa flexibilidade (ex: "cerca de 1200", "entre 03/1900 e 05/1900")

• Python: classe para armazenar o tipo de data imprecisa
• Neo4J: estudar como implementar o novo tipo de data

Ver: https://flask-restx.readthedocs.io/en/latest/api.html#flask_restx.inputs.iso8601interval

Implementar Repository Pattern

Criar Repositories para desacoplar as responsabilidades das classes de domínio.
Exemplo de implementação de Repository Pattern em Python: https://stackoverflow.com/questions/9699598/implementation-of-repository-pattern-in-python/13504166#13504166

Criar estruturas de relacionamento

Criar estruturas de relacionamento:

• Autoria
• Participação
• Membro de Grupo

Uma estrutura completa deve possuir seu repositório, resource e rota

Create e Update de obras com parâmetro `techniques`

Remover os métodos `hydrate` da camada Model

Os métodos hydrate presentes na camada Business Model está quebrando diretizes do DDD, pois precisa conhecer a implementação de datas do Neo4J (que pertence à camada de Infra/Adapters)

Planejar de alguma maneira mover para a camada de service, ou algo assim

Create e Update de artistas com parâmetro `alternative_names`

Implementar Testes automatizados

• Testes de rotas de eventos
• Testes de rotas de obras
• Testes de rotas de artistas
• Testes de rotas de autoria
• Testes de rotas de participação
• Configurar testes para rodar em app/db isolados

Implementar conceitos de web semântica

Estudar conceitos de Linked Data
https://www.w3.org/standards/semanticweb/
https://www.w3.org/2002/03/tutorials#semanticweb_data

Implementar documentação Swagger

• Documentar rotas de artistas
• Documentar rotas de obras
• Documentar rotas de eventos
• Configurar exemplos de variáveis na documentação das APIs
• Especificar tipos corretamente das variáveis nas rotas (ex: UUID)

Implementar constraints no banco de dados

ver: https://neo4j.com/graphacademy/training-best-practices-40/01-best-practices40-defining-constraints-data/

algumas constraints necessárias:
CREATE CONSTRAINT UniqueArtistUUIDConstraint ON (a:Artist) ASSERT a.uuid IS UNIQUE
CREATE CONSTRAINT ExistsArtistName ON (a:Artist) ASSERT exists(a.name)

Entretanto, levar em conta casos de obras sem título, e autores desconhecidos (o que fazer com campos obrigatórios nestes casos)

Modularizar aplicação seguindo padrão Flask

Implementar Flask, FlaskRestFull, Marshmallow e separação em Blueprints

ver:
https://medium.com/analytics-vidhya/building-rest-apis-using-flask-restplus-sqlalchemy-marshmallow-cff76b202bfb