Entrega SOS - Back-end

API REST desenvolvida com Python/Flask, Postgres e Docker.

Importante:

Devido à urgência e tempo limitado dos voluntários, o projeto como um todo (back/front) foi desenvolvido "a toque de caixa" e precisa receber determinados ajustes, então contribuições são muito bem-vindas!

Conheça mais sobre o projeto: https://www.acordacidade.com.br/noticias/225389/entrega-sos-e-a-nova-plataforma-de-delivery-gratuita-para-comerciantes-de-feira.html

Configuração do Ambiente

Os serviços Flask e Postgres rodam na porta 5000 e 5432, respectivamente.

1. Instale o Docker: https://docs.docker.com/install/linux/docker-ce/ubuntu/

2. Instale o Docker Compose: https://docs.docker.com/compose/install/

3. Instale o Git: sudo apt install git

4. Clone este repositório: git clone https://github.com/entrega-sos/entrega-sos-backend.git

5. Entre no diretório: cd entrega-sos-backend/

6. Crie os containers (1x apenas): export ENV_APP=development ; docker-compose build

7. Execute (CTRL+C para exit): export ENV_APP=development ; docker-compose up

Executando a Aplicação

Instale o Insomnia ou equivalente: https://insomnia.rest/download/

Cidades

1. Consultar cidades:

• Endpoint (GET): http://localhost:5000/v1/cidades
• Response:

  {
      "cidades": [
          "Brumado",
          "Feira de Santana",
          "Guanambi",
          "Jequié",
          "Salvador",
          "Santo Antônio de Jesus"
      ]
  }

Bairros

1. Consultar bairros (Feira de Santana-BA):

• Endpoint (GET): http://localhost:5000/v1/bairros
• Response:

  {
      "bairros": [
          "35º BI",
          "Aeroporto",
          "Asa Branca",
          "Aviário",
          "Baraúnas",
          "Bonfim de Feira",
          "Brasília",
          ...
      ]
  }

Tipos de Negócios

1. Consultar tipos de negócios:

• Endpoint (GET): http://localhost:5000/v1/tiposNegocios
• Response:

  {
      "tipos_negocios": [
          "Acessórios",
          "Armarinho",
          "Bar ou Lanchonete",
          "Calçados",
          "Farmácia",
          ...
      ]
  }

Empresa

1. Criar empresa

• Endpoint (POST): http://localhost:5000/v1/empresas
• Request:

  {
      "descricao": "Mercadinho Espaço da Carne",
      "usuario": "msc",
      "email": "[email protected]",
      "telefone": "7522220000",
      "whatsapp" : "7599991111",
      "senha": "12345",
      "cep": "4444000",
      "endereco": "Rua São Jorge, n 80",
      "bairro": "George Américo",
      "cidade": "Feira de Santana",
      "uf": "BA",
      "tipo_negocio": "Mercado",
      "outro_negocio": "",
      "meio_pagamento": [
          "Dinheiro",
          "Crédito",
          "Débito"
      ],
      "dias_horarios": "Seg a Sex 8 as 18, Sab e Dom 8 as 12",
      "delivery": true,
      "instagram": "www.instagram.com/espaco_da_carne",
      "facebook": "www.facebook.com/espaco_da_carne",
      "site": "",
      "obs": "Fazemos entrega somente no bairro George Americo",
      "admin": true
  }

2. Consultar todas as empresas

• Endpoint (GET): http://localhost:5000/v1/empresas
• Response:

  {
      "_meta": {
          "page": 1,
          "per_page": 10,
          "total_pages": 1,
          "total_items": 1
      },
      "_links": {
          "self": "/v1/empresas?page=1&per_page=10",
          "next": null,
          "prev": null
      },
      "items": [
          {
              "id": "0ae7eaa6d63c4a2ea76ab1bb4a2455f6",
              "descricao": "Mercadinho Espaço da Carne",
              "usuario": "msc",
              "email": "[email protected]",
              "telefone": "7522220000",
              "whatsapp": "7599991111",
              "cep": "4444000",
              "endereco": "Rua São Jorge, n 80",
              "bairro": "George Américo",
              "cidade": "Feira de Santana",
              "uf": "BA",
              "tipo_negocio": "Mercado",
              "outro_negocio": "",
              "meio_pagamento": [
                  "Dinheiro",
                  "Crédito",
                  "Débito"
              ],
              "dias_horarios": "Seg a Sex 8 as 18, Sab e Dom 8 as 12",
              "delivery": true,
              "instagram": "www.instagram.com/espaco_da_carne",
              "facebook": "www.facebook.com/espaco_da_carne",
              "site": "",
              "obs": "Fazemos entrega somente no bairro George Americo",
              "admin": true
          }
      ]
  }

3. Consultar empresa pelo usuário

• Endpoint (GET): http://localhost:5000/v1/empresas/msc
  • Troque "msc" pelo respectivo usuário
• Response:

  {
      "id": "99602837a596498c85e214afb3a6f484",
      "descricao": "Mercadinho Espaço da Carne",
      "usuario": "msc",
      "email": "[email protected]",
      "telefone": "7522220000",
      "whatsapp": "7599991111",
      "cep": "4444000",
      "endereco": "Rua São Jorge, n 80",
      "bairro": "George Américo",
      "cidade": "Feira de Santana",
      "uf": "BA",
      "tipo_negocio": "Mercado",
      "outro_negocio": "",
      "meio_pagamento": [
          "Dinheiro",
          "Crédito",
          "Débito"
      ],
      "dias_horarios": "Seg a Sex 8 as 18, Sab e Dom 8 as 12",
      "delivery": true,
      "instagram": "www.instagram.com/espaco_da_carne",
      "facebook": "www.facebook.com/espaco_da_carne",
      "site": "",
      "obs": "Fazemos entrega somente no bairro George Americo",
      "admin": true
  }

4. Consultar empresa por "group"

Por cidade:

• Endpoint (GET): http://localhost:5000/v1/empresas?group=cidade
• Response:

  {
      "cidade": [
          "Feira de Santana",
          "Guanambi",
          "Jequié"
      ]
  }

Por tipo_negocio:

• Endpoint (GET): http://localhost:5000/v1/empresas?group=tipo_negocio
• Response:

  {
      "tipo_negocio": [
          "Mercado",
          "Farmácia"
      ]
  }

Por bairro:

• Endpoint (GET): http://localhost:5000/v1/empresas?group=bairro
• Response:

  {
      "bairro": [
          "Cidade Nova",
          "George Américo"
      ]
  }

Por cidade com filter para tipo_negocio:

• Endpoint (GET): http://localhost:5000/v1/empresas?group=cidade&filter=tipo_negocio
• Response:

  {
      "Feira de Santana": [
          "Farmácia",
          "Lanchonete",
          "Mercado"
      ],
      "Guanambi": [
          "Bazar",
          "Lanchonete"
      ],
      "Salvador": [
          "Bar",
          "Farmácia",
          "Lanchonete",
          "Mercado",
          "Serviços"
      ]
  }

5. Obter token

• Endpoint (POST): http://localhost:5000/v1/empresas/auth/token
• Response:

  {
      "token": "seYladgufOiX8EsfKEK5b6vt7CPojv0h"
  }

6. Revogar token

• Endpoint (DELETE): http://localhost:5000/v1/empresas/auth/token
• Configurar autenticação para Bearer Token e informar o respectivo token

7. Alterar dados de uma empresa

• Endpoint (PUT): http://localhost:5000/v1/empresas/msc
  • Troque "msc" pelo respectivo usuário
• Configurar autenticação para Bearer Token e informar o respectivo token
• Request:

  {
      "email": "[email protected]",
      "cep": "4444111"
  }

• Response:

  {
      "id": "99602837a596498c85e214afb3a6f484",
      "descricao": "Mercadinho Espaço da Carne",
      "usuario": "msc",
      "email": "[email protected]",
      "telefone": "7522220000",
      "whatsapp": "7599991111",
      "cep": "4444111",
      "endereco": "Rua São Jorge, n 80",
      "bairro": "George Américo",
      "cidade": "Feira de Santana",
      "uf": "BA",
      "tipo_negocio": "Mercado",
      "outro_negocio": "",
      "meio_pagamento": [
          "Dinheiro",
          "Crédito",
          "Débito"
      ],
      "dias_horarios": "Seg a Sex 8 as 18, Sab e Dom 8 as 12",
      "delivery": true,
      "instagram": "www.instagram.com/espaco_da_carne",
      "facebook": "www.facebook.com/espaco_da_carne",
      "site": "",
      "obs": "Fazemos entrega somente no bairro George Americo",
      "admin": true
  }

8. Deletar uma empresa

• Endpoint (DELETE): http://localhost:5000/v1/empresas/msc
  • Troque "msc" pelo respectivo usuário
• Configurar autenticação para Bearer Token e informar o respectivo token

Migrations

As migrations são executadas com Flask-Migrate.

1. Crie uma virtualenv: python3 -m virtualenv .venv && source .venv/bin/activate
2. Se o diretório "migrations" não existir no projeto: python3 manage.py db init
3. Para criar as migrations: python3 manage.py db migrate
4. Exportar para o Postgres: python3 manage.py db upgrade