flask_api_updown_auth

Uma API escrita em Python/Flask para o Desafio Hyperativa.

Insere cartões individualmente ou enviados por um arquivo de texto, recuperando o id de tabela quando solicitada busca por número de cartão.

Utiliza SQLAlchemy para comunicação com o banco de dados (SQLite nessa versão) e JWT para autenticação.

Instalação

Crie um clone, baixe ou copie esse repositório, exemplo:

git clone https://github.com/LionyxML/flask_api_updown_auth.git

Em seguida instale as dependências com:

pip3 install requirements.txt

Rode a aplicação com:

flask run

Por padrão a aplicação apiupdown será servida em localhost (127.0.0.1) na porta 5050. Essa porta, o modo de Debug e o ambiente utilizado podem ser configurados no arquivo .flaskenv

Utilização

Autenticação

Para obter um token, enviar um POST com corpo JSON para a url:

localhost:5050/auth

Com o conteúdo:

{
	"username" : "admin",
	"password" : "admin"
}

Os usuários cadastrados no banco são: admin e user, as senhas são admin e user respectivamente.

No caso de insucesso de autenticação, o sistema retornará a mensagem:

{
    "description": "Invalid credentials",
    "error": "Bad Request",
    "status_code": 401
}

No caso de sucesso, um token será retornado, como no exemplo:

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2MjA2OTIyNDgsImlhdCI6MTYyMDY5MTk0OCwibmJmIjoxNjIwNjkxOTQ4LCJpZGVudGl0eSI6MX0.SiUhq4P939Wlai8xZ7IYgiuE6tdJ322_dMHSAvEuoto"
}

Para todas as requisições ao sistema, utilizar no cabeçalho (HEADER) a chave (Key) chamada "Authorization" com o valor (Value) "JWT <token>"

Onde <token> é o access_token retornado no passo anterior.

Não utilizar um token ou utilizar um token inválido, resulta na mensagem:

{
    "description": "Invalid crypto padding",
    "error": "Invalid token",
    "status_code": 401
}

Retorno

As mensagens de retorno da API estão em formato JSON e seguem o padrão:

  {
      "msg" : "Mensagem em formato string",
      "success" : true
  }

Onde "msg" carrega uma mensagem e "success" um booleano de indicação de status da requisição.

Inserção de cartão

Para inserir o valor de um único cartão, utilizar um método POST na URL:

localhost:5050/insere_linha/<linha>

Onde é uma string de 51 colunas, dividida em: 01-01: Identificador de coluna 02-07: Numeração do Lote 08-26: Número de cartão completo

Exemplo:

localhost:5050/insere_linha/C2     4456897999999999

Retorna:

{
  "msg": "Inserido: 'C'-'2'-'4456897999999999'",
  "success": true
}

Consulta de cartão

Para verificar se o número de cartão está presente na base de dados e ter como retorno o seu número de identificação (id) na tabela do banco de dados, deve-se utilizar o método GET na URL:

localhost:5050/consulta/<numero>

Onde <numero> é o número do cartão.

Exemplo:

localhost:5050/consulta/4456897999999999

Retorna:

{
    "id": "44",
    "success": true
}

Caso procure um número que não está na base, o retorno é:

{
    "msg": "Cartao nao encontrado na base",
    "success": false
}

Envio de arquivo de texto com várias linhas

Utilizar o arquivo "arquivo.txt" padrão encontrado na pasta doc/ como base.

O parser não aceita alteração no formato apresentado. Deve chegar formatado.

Enviar o arquivo .txt através do método POST na URL:

http://localhost:5050/insere_arquivo/<arquivo>

Onde <arquivo> é o nome do arquivo para upload.

Exemplo:

http://localhost:5050/insere_arquivo/arquivo.txt

Retorna:

{
    "msg": "Adicionados 10 cartoes do LOTE0001.",
    "success": true
}

Reset

Para reiniciar a aplicação em seu estado inicial, realizar a seguinte sequência:

Parar o servidor
Deletar o arquivo db.sqlite em apiupdown/db/
Executar o shell com flask shell
Dentro do shell rodar os comandos:

from apiupdown import *
db.create_all()

Sair do shell
Reiniciar o servidor

Logs

Todas as requests e responses são logadas no arquivo app.log em apiupdown/api.log

Contagem máxima de 10Mb por arquivo, mantendo o limite de 3 arquivos de backup.

TODOs

O código foi elaborado para ser limpo e de fácil interpretação.

Certamente, algumas melhorias poderiam ser realizadas com tempo útil. O código possui tags TODO com comentários para esses casos.

Em uma próxima versão, trataria os seguintes pontos:

Melhoria no gerenciamento das mensagens de erro e log
Separação do arquivo .py seguindo modelo MVC
Criação de uma Client básico
Hash de senhas
Métodos de criação de novo usuário
Limite de tempo para o token
Registro do usuário logado nas operações do log
Regra para validar formato/tamanho dos números do cartão
Regra para validar o que acontece com números de cartão duplicados

lionyxml / flask_api_updown_auth Goto Github PK