docs/Documento_de_arquitetura.md
# Documento de Arquitetura de Software
## Histórico de Revisão
Data|Versão|Descrição|Autor
-|-|-|-
13/02/2021|1.0|Abertura do Documento|João Pedro
15/02/2021|1.0.1|Padronização de Documento|João Pedro
17/02/2020|1.1|Adição do tópico Representação Arquitetural|Victor Lima
19/02/2021|1.1.1|Padronização de Wiki|Carlos Eduardo e João Pedro
21/02/2021|1.2|Refatoração do tópico 2 e adição do tópico 3|João Pedro e Matheus
22/02/2021|1.3|Adição de links na parte de referências|João Pedro e Matheus
01/03/2021|1.4|Adição do tópico 4|João Pedro e Matheus
08/03/2021|1.5|Adição do tópico "Visão de Casos de Uso"|Brenno e Matheus
09/03/2021|1.6|Adição do tópico 5|Carlos Eduardo e Lucas
13/03/2021|1.6.1|Correção de erros na digitação|Lucas Braun
24/03/2021|1.7|Adição do tópico 6 e mudanças nos diagramas|Brenno, Carlos e João
28/03/2021|1.7.1|Correção do diagrama de pacotes|João
29/03/2021|1.7.2|Padronização da Visão Geral|Vitor Lamego
29/03/2021|1.7.3|Revisão do documento|Joao Moura e Matheus Calixto
04/04/2021|1.7.4|Revisão tópico 6|Carlos Eduardo
25/04/2021|1.8|Mudanças na visão de implementação e casos de uso|Carlos Eduardo
03/05/2021|1.9|Atualização dos diagramas DER e e modelagem de banco de dados|João Pedro
## 1. Introdução
### 1.1 Finalidade
<p align = "justify">    O Seguinte documento tem como finalidade mostrar e esclarecer de uma forma geral a arquitetura utilizada no projeto, tornando o seu processo de entendimento o mais simples possível. Além disso, esse documento também tem como objetivo demonstrar as decisões arquiteturais tomadas pelo grupo em relação ao projeto.</p>
### 1.2 Escopo
<p align = "justify">    Esse documento visa permitir ao leitor se informar sobre a arquitetura utilizada no projeto, incentivando um entendimento mais simples e eficaz acerca do produto.</p>
### 1.3 Definições, Acrônimos e Abreviações
Abreviação|Significado
-|-
**MDS**| Métodos de Desenvolvimento de Software
**UnB**| Universidade de Brasília
**DRF**| Django REST Framework
**ORM**| Object-relational Mapping
**MVT**| Model-View-Template
**MVC**| Model-View-Controller
### 1.4 Visão Geral
***
**Introdução:** Fornece uma visão geral e introdutória sobre o documento;
***
**Representação Arquitetural:** Fornece informações sobre as tecnologias e os motivos pelos quais elas foram escolhidas;
***
**Metas e Restrições:** Demonstra as metas e restrições aplicadas no projeto;
***
**Visão Lógica:** Apresenta como os frameworks interagem entre si e com o usuário;
***
**Visão de Casos de Uso:** Representa as interações possiveis no sistema;
***
**Visão de Implementação** Representa a organização arquitetural do banco de dados;
***
## 2. Representação Arquitetural
### 2.1 Back-end
#### 2.1.1 Django REST Framework
<p align = "justify">    <i>Representational State Transfer</i> ou REST, representa um conjunto de princípios e definições necessários para a criação de um projeto seguindo boas práticas e com interfaces bem definidas. O DRF então, é um framework do framework Django que permite a criação simples, ágil, poderosa e flexível de API's Web.</p>
#### 2.1.2 Django
<p align = "justify">    Django é um framework web de alto nível baseado em Python que preza pelo rápido desenvolvimento com um design limpo e pragmático. Um dos motivos pela escolha desse framework como back-end se dá pelo fato da linguagem de desenvolvimento utilizada pelo Django ser de grande interesse dos integrantes do grupo, bem como sua crescente utilização do mercado de trabalho e sua interessante curva de aprendizado.</p>
<p align="justify">    Além disso o framework dispõe de bastante segurança através da utilização da técnica de Mapeamento objeto-relacional (ORM) que realiza queries sem se utilizar de código SQL para acesso ao banco de dados, útil para o grupo que possui poucos conhecimentos sobre Sistema de Banco de Dados.</p>
<p align="justify">    Outro ponto de interesse no framework se diz respeito da utilização do padrão Model-View-Template, modelo esse baseado no Model-View-Controller. O MVT, ao contrário do MVC, conta com as funções da Controller disponibilizados pelos outros módulos e o acréscimo da Template.</p>
- **Model**: Camada responsável pelo acesso ao banco de dados.
- **View**: Camada responsável por processar requests de usuários e retornar responses.
### 2.2 Front-End
#### 2.2.1 Flutter
<p align = "justify">   O Flutter é um framework desenvolvido pela Google na linguagem Dart e permite que sejam criadas aplicações nativas para os aparelhos iOS e Android. Por ter essa facilidade de desenvolvimento para dois sistemas diferentes, o framework tem crescido bastante e tornado cada vez maior a quantidade de informação para aprendizado.</p>
<p align = "justify">    Além disso, por ser um framework que possui uma curva de aprendizado muito boa e alguns dos integrantes do grupo já terem conhecimento prévio relacionado à linguagem, ela foi selecionada para atuar no front-end.</p>
<p align = "justify">    Outro ponto importante na escolha desse framework se deve ao fato do Dart ser otimizado bem como ser especializado para criação de interfaces para usuários através do uso dos widgets (estrutura baseada no React). Assim também, o uso de <b>Blocs</b> permite que o software seja dividido em questão de interface de usuário e regras de negócio, e o uso de <b>
Stream</b> permite eventos assíncronos no aplicativo.</p>
### 2.3 Banco de Dados
#### 2.3.1 PostgreSQL
<p align = "justify">   O PostgreSQL é um banco de dados poderoso, open source e objeto-relacional que faz o uso e extensão da linguagem SQL. Por sua robustez, confiabilidade, integridade de dados e dedicação na comunidade open source essa ferramenta tem crescido muito no mercado de trabalho, por esses motivos esse banco de dados foi escolhido para o projeto.</p>
## 3. Metas e Restrições
### 3.1 Metas
<p align = "justify">    O projeto visa facilitar a divulgação dos produtos de pequenos produtores rurais bem como a comunicação com possíveis compradores, através de um aplicativo online e de fácil utilização.</p>
### 3.2 Restrições
#### 3.2.1 Compatibilidade
- O aplicativo será compatível com os aparelhos celulares que possuem o sistema operacional Android e tem acesso à Play Store, bem como é necessário o acesso à internet.
#### 3.2.2 Usabilidade
- O sistema visa ser intuitivo e de simples uso, evitando assim que a utilização não seja um empecilho.
#### 3.2.3 Confiabilidade
- A aplicação buscará obter ao menos 90% de cobertura em testes, garantindo assim a funcionalidade do sistema.
## 4. Visão Lógica
<p align = "justify">    As ações do usuário no ambiente mobile serão interpretadas pelo Flutter como gestos, onde cada gesto está associado com um evento que irá disparar uma ação. Algumas dessas ações poderão ser tratadas no lado do cliente (client side), como ações de iteratividade que não precisam de comunicação externa.</p>
<p align = "justify">   Já em outras ações será preciso consultar um banco de dados no lado do servidor (server side), assim sendo preciso enviar uma solicitação (HttpRequest) para o servidor, utilizado o protocolo de comunicação HTTP e respeitando as regras de interface REST, visto que Django REST é utilizado.</p>
<p align = "justify">   Uma vez que o servidor receba a solicitação do cliente, será preciso interpretar o request com base na URL e no método HTTP utilizado. Essa computação é realizada no módulo URL Dispatcher, onde é verificado se o endpoint faz parte das urlpatterns, caso verdadeiro é mapeado para endpoint da aplicação com o módulo que possui as informações solicitadas. Quando o app do Django REST está integrado com o Django, essa etapa ocorre em dois processos. Primeiramente o Django verifica se a url requisitada faz parte da API que o Django REST fornece, se fizer parte o Django passa o controle para o Django REST para que finalize o processo e mapeie a requisição.</p>
<p align = "justify">    Uma vez que a url já foi mapeada para o módulo que possui as informações requisitadas, geralmente uma classe models.py, será responsável por utilizar o OMR (Mapeamento objeto-relacional) para mapear um modelo da aplicação com um modelo do banco de dados. Após o devido mapeamento, o banco de dados irá retornar um conjunto de informações que será tratada pelo Django REST.</p>
<p align = "justify">    O Django REST já com os dados em mãos, poderá serializar as informações, de maneira mais rápida e fácil que o Django, no formato padrão da API, em JSON. A serialização que é importante para definir uma interface que vários sistemas poderão consumir. Uma vez que os dados já foram serializados, o Django REST passa o controle para o Django que carrega uma viewset apropiada e devolve um objeto HttpResponse.
Essa resposta será obtida pelo Flutter, que com os dados recebidos irá disponibilizar uma interface construída em views, de forma que o usuário possa ver e interagir com ela. </p>
### 4.1 Visão Geral: Pacotes e Camadas
<p align = "justify">    O sistema será desenvolvido utilizando o Django REST Framework e o Flutter. Irão se comunicar através da API REST fornecida pelo backend do sistema. </p>
#### 4.1.1 Diagrama de Pacotes
- **Frontend**
- **Flutter**: framework para apps mobile android e IOS.
- **pubspec.yaml**: é um arquivo transversal a todos os aplicativos e pacotes, onde são adicionados metadados ao projeto, estipulados restrições do SDK do Dart e Flutter, gerenciamento das dependências e configurações do Flutter.
- **lib**: diretório onde são inseridos todos os pacotes da aplicação.
- **main.dart**: arquivo inicial da aplicação, onde o programa se inicia e termina.
- **data/**: diretório que contem arqivos com requisição à API/backend.
- **views/**: diretório onde se encontra as páginas/telas da aplicação.
- **models/**: diretório onde se encontra as models globais da aplicação.
- **componentes globais/locais**: diretório onde são armazenados os componentes utilizados nas views.
- **Backend**
- **Django REST API**: framework para criação de API's Web.
- **settings.py**: arquivo em que estão contidas todas as configurações do projeto. Desde a configuração básica do banco de dados até os apps.
- **urls.py**: armazena entry-points e endpoints da API.
- **app**: diretório constituído de models, viewsets, testes, urls, serializers e admin.
- **models**: arquivo de models do app.
- **viewsets**: arquivo de views do app.
- **urls**: mapeia as views com template de cada app.
- **serializer**: serialização das entidades do app.
- **admin**: arquivo de conexão do app com o admin.
- **Docker-Compose**: conjunto de containers docker.
- **PostgreSQL**: banco de dados da aplicação.
## 5. Visão de Casos de Uso
### 5.1 Atores
#### 5.1.1 Não Logado
<p align = "justify">    Usuário não logado capaz apenas de realizar ações de registro e login.</p>
#### 5.1.2 Usuário
<p align = "justify">    Ator geral, que possui ações comuns no aplicativo.</p>
#### 5.1.3 Produtor
<p align = "justify">    Especialização de usuário que compreende funcionalidades relacionadas ao anúncio e gerenciamento de produtos e localizações.</p>
#### 5.1.4 Consumidor
<p align = "justify">    Especialização de usuário que abrange as funcionalidades de visualização e pesquisa de produtos, produtores, reclamações e localizações, além de favoritá-los e/ou curti-los e criar reclamações.</p>
### 5.2 Diagrama de Casos de Uso
## 6. Visão de Implementação
### 6.1 Banco de Dados
<p align = "justify">    Para desenvolver e instanciar o banco de dados do projeto, foi pensado quais seriam as entidades do sistema e seus atributos, além de como se relacionariam, ou seja, suas cardinalidades.</p>
#### 6.1.1 Entidades
- Usuário
- Comprador
- Produtor
- Anúncio
- Imagem
- Localização
- Reclamação
<p align = "justify">    O usuário pode ser tanto um comprador quanto um produtor, que necessita de autenticação para acessar algumas áreas do aplicativo.</p>
#### 6.1.2 Atributos
<p align = "justify">    Todos os Usuários irão ter email, nome e senha, sendo o email e senha usados para acessar a conta e nome para reconhecimento.</p>
<p align = "justify">    Os Compradores e Produtores poderão cadastrar uma foto de perfil. </p>
<p align = "justify">    Um Anúncio poderá ter uma ou várias fotos cadastradas, para identificar e mostrar os produtos do anúncio.</p>
<p align = "justify">    Um Anúncio terá em seu cadastro número de likes, um nome, descrição e se há ou não estoque.</p>
<p align = "justify">    O Produtor terá a possibilidade de adicionar uma ou mais localizações. </p>
<p align = "justify">    O Comprador terá a possibilidade de adicionar uma Reclamação contra vários Produtores. </p>
#### 6.1.3 Relacionamentos
<p align = "justify">    Um Comprador ou Produtor poderá ter foto de perfil ou não, mas uma foto pertence a apenas 1 Comprador ou Produtor. Cardinalidade(0,n)</p>
<p align = "justify">    Um Anúncio pode ser curtido por vários Compradores ou nenhum, e o Comprador pode curtir vários Anúncios ou nenhum. Cardinalidade(0,n)</p>
<p align = "justify">    Um Comprador pode favoritar vários Produtores, e um Produtor pode ser favoritado por vários Compradores. Cardinalidade(0,n)</p>
<p align = "justify">    Um Comprador pode criar uma reclamação para cada Produtor. Cardinalidade(0,n)</p>
<p align = "justify">    Um Produtor pode ter várias reclamações ou não, mas cada reclamação pertence a apenas 1 Produtor. Cardinalidade(0,n)</p>
<p align = "justify">    Uma Reclamação poderá ter foto ou não, mas uma foto pertence a apenas 1 Reclamação. Cardinalidade(0,n)</p>
<p align = "justify">    Um Produtor pode possuir vários Anúncios, mas um Anúncio pertence a apenas 1 Produtor. Cardinalidade(1,n)</p>
<p align = "justify">    Um Anúncio pode ter nenhuma foto ou várias, mas cada foto pertence a apenas 1 Anúncio. Cardinalidade(0,n)</p>
<p align = "justify">    Um Produtor pode ter várias localizações, mas cada localização pertence a apenas 1 Produtor. Cardinalidade(1,n)</p>
### 6.2 Diagrama Entidade-Relacionamento (DER)
### 6.3 Modelagem do Banco de Dados
### Referências
> About PostgreSQL. Disponível em: < [https://www.postgresql.org/about/](https://www.postgresql.org/about/) > Acesso em 01 de Março de 2021
> BloC Flutter Documentation. Disponível em: < [https://www.flutterparainiciantes.com.br/gerenciamento-de-estado/bloc](https://www.flutterparainiciantes.com.br/gerenciamento-de-estado/bloc) > Acesso em 24 de Fevereiro de 2021
> Como documentar a arquitetura de software. Disponível em: < [http://www.linhadecodigo.com.br/artigo/3343/como-documentar-a-arquitetura-de-software.aspx](http://www.linhadecodigo.com.br/artigo/3343/como-documentar-a-arquitetura-de-software.aspx) > Acesso em: 13 de Fevereiro de 2021
> Django Documentation. Disponivel em: < [https://docs.djangoproject.com/en/3.1/](https://docs.djangoproject.com/en/3.1/) > Acesso em: 22 de Fevereiro de 2021
> Documento de arquitetura Acácia. Disponível em: < [https://fga-eps-mds.github.io/2019.2-Acacia/#/architecture_document](https://fga-eps-mds.github.io/2019.2-Acacia/#/architecture_document) > Acesso em: 13 de Fevereiro de 2021
> Documento de arquitetura VCU. Disponível em: < [https://fga-eps-mds.github.io/2020.1-VC_Usuario/#/docs/Documento_de_Arquitetura](https://fga-eps-mds.github.io/2020.1-VC_Usuario/#/docs/Documento_de_Arquitetura) > Acesso em: 13 de Fevereiro de 2021
> Flutter Documentation. Disponível em: < [https://flutter.dev/docs](https://flutter.dev/docs) > Acesso em: 24 de Fevereiro de 2021
> Quickstart - Django REST framework. Disponivel em: < [https://www.django-rest-framework.org/tutorial/quickstart/](https://www.django-rest-framework.org/tutorial/quickstart/) > acesso em: 22 de Fevereiro de 2021
> TEMPLATE Documento de Arquitetura de Software. Disponível em: < [https://github.com/DroidFoundry/DroidMetronome/wiki/TEMPLATE-Documento-de-Arquitetura-de-Software](https://github.com/DroidFoundry/DroidMetronome/wiki/TEMPLATE-Documento-de-Arquitetura-de-Software) > Acesso em: 13 de Fevereiro de 2021