app.py

# =============================================================================
""" 1 - Carga Inicial.
"""
# =============================================================================
from flask_openapi3 import OpenAPI, Info, Tag
from flask import redirect, request
from urllib.parse import unquote
from flask import jsonify

from sqlalchemy.exc import IntegrityError
from sqlalchemy import func

from model import Session, Obra
from schemas import *
from flask_cors import CORS

from logger import setup_logger

# ===============================================================================
""" 2 - Inicializa variáveis de Informações gerais de identificação do serviço.
"""
#  ==============================================================================
info = Info(title="API Obras de Arte", version="1.0.1")
app = OpenAPI(__name__, info=info)

home_tag = Tag(name="Documentação", description="Apresentação da documentação via Swagger.")
obra_tag = Tag(name="Rotas em app", description="Deleção, Adição, Consulta e Busca de obras da base")
doc_tag = Tag(name="Rota em app", description="Documentação da API de manipulação da BD Obras de Arte")

# ==============================================================================
""" 3 - Inicializa "service_name" para fins de geração de arquivo de log.
"""
# ==============================================================================
service_name = "app"
logger = setup_logger(service_name)

# ==============================================================================
""" 4 - Configurações de "Cross-Origin Resource Sharing" (CORS).
# Foi colocado "supports_credentials=False" para evitar possíveis conflitos com
# algum tipo de configuração de browser. Mas não é a melhor recomendação por 
# segurança. Para melhorar a segurança desta API, o mais indicado segue nas 
# linhas abaixo comentadas.
#> origins_permitidas = ["Obras de Arte"]
#> Configurando o CORS com suporte a credenciais
#> CORS(app, origins=origins_permitidas, supports_credentials=True)
#> CORS(app, supports_credentials=True, expose_headers=["Authorization"])
#> Adicionalmente utilizar da biblioteca PyJWT
"""
# ==============================================================================
CORS(app, supports_credentials=False)

# ================================================================================
""" 5.1 - DOCUMENTAÇÂO: Rota "/" para geração da documentação via Swagger.
"""
# ================================================================================
@app.get('/', tags=[home_tag])
def home():
    """Redireciona para /openapi/swagger.
    """
    return redirect('/openapi/swagger')

# ================================================================================
""" 5.2 - DOCUMENTAÇÂO: Rota "/doc" para documentação via github.
"""
# ================================================================================
@app.get('/doc', tags=[doc_tag])
def doc():
    """Redireciona para documentação no github.
    """
    return redirect('https://github.com/Moriblo/app')

# ========================================================================================
""" 6.1 - Rota /obra para tratar o fetch de `POST`.
"""
# ========================================================================================
@app.post('/obra', tags=[obra_tag],
          responses={"200": ObraViewSchema, "409": ErrorSchema, "400": ErrorSchema})
def add_obra(form: ObraSchema):
    """Adiciona uma nova obra à base de dados.
    """
    obra = Obra(
        nome=form.nome,
        artista=form.artista,
        estilo=form.estilo,
        tipo=form.tipo,
        link=form.link)
    
    logger.debug(f"Adicionando obra de nome: '{obra.nome}' e artista '{obra.artista}'")
    
    try:
        # Criando conexão com a base
        session = Session()
        # Adicionando obra
        session.add(obra)
        # Efetivando o comando de adição de novo item na tabela
        session.commit()
        
        logger.debug(f"Adicionada obra de nome: '{obra.nome}' e artista '{obra.artista}'")
        
        return apresenta_obra(obra), 200

    except IntegrityError as e:
        """ A duplicidade é verificada pela obra e pelo artista. Vide "UniqueConstraint"
            no model.obra.py.
        """
        error_msg = "Obra de mesmo nome já salva na base para este artista :/"
        logger.warning(f"Erro ao adicionar obra '{obra.nome}' e artista '{obra.artista}'. {error_msg}")
        return {"mesage": error_msg}, 409

    except Exception as e:
        # Caso um erro fora do previsto
        error_msg = "Não foi possível salvar nova obra :/"
        logger.warning(f"Erro: {error_msg}")
        return {"mesage": error_msg}, 400

    # Comando de fechamento da sessão.
    finally:
        session.close()

# ========================================================================================
""" 6.2 - Rota /obras para tratar o fetch de `GET`.
"""
# ========================================================================================
@app.get('/obras', tags=[obra_tag],
         responses={"200": ListagemObrasSchema, "404": ErrorSchema})
def get_obras():
    """Faz a busca por todas as obras cadastradas.
    """
    logger.debug(f"Coletando obras ")
    # Criando conexão com a base
    session = Session()

    # Fazendo a busca
    obras = session.query(Obra).all()

    if not obras:
        # Se não há obras cadastradas
        logger.debug(f"Não há obras na base")
        return {"obras": []}, 200
    else:
        logger.debug(f"%d obras econtradas" % len(obras))
        # Retorna a representação de obra
        print(obras)
        return apresenta_obras(obras), 200
    
# ========================================================================================
""" 6.3 - Rota /obra para tratar o fetch de `DELETE`.
"""
# ========================================================================================
@app.delete('/obra', tags=[obra_tag],
            responses={"200": ObraDelSchema, "404": ErrorSchema})
def del_obra(query: ObraBuscaSchema):
    """Deleta uma obra a partir da obra e do artista informados.
    """
    obra_nome = unquote(query.nome)
    obra_artista = unquote(query.artista)

    print(obra_nome, obra_artista)
    logger.debug(f"Deletando dados sobre obra {obra_nome} e artista {obra_artista}")
    # Criando conexão com a base
    session = Session()
    
    # Fazendo a deleção da obra relacionada ao artista especificado
    count = session.query(Obra).filter(Obra.nome == obra_nome, Obra.artista == obra_artista).delete()
    session.commit()

    if count:
        # Retorna a representação da mensagem de confirmação
        logger.debug(f"Deletada obra {obra_nome} e {obra_artista}")
        return {"mesage": "Obra removida", "nome": obra_nome, "artista" : obra_artista}
    else:
        # Se a obra não foi encontrada
        error_msg = "Erro: Obra + Artista não encontradados na base :/"
        error_code = "404"
        logger.warning(f"Erro ao deletar obra '{obra_nome}' e artista '{obra_artista}', {error_msg}")
        return {"mesage": error_msg}, error_code

# ========================================================================================
""" 6.4 - Rota /obrart para tratar o fetch de GET para consulta obra + artista.
    2ª Regra de negócio (RN2) para evitar tupla com obra + artista repetida
"""
# ========================================================================================
@app.get('/obrart', methods=['GET'], tags=[obra_tag],
            responses={"200": ObrartSchema, "404": ErrorSchema})

def get_obrart(query: ObraBuscaSchema):
    """Verifica  se a compinação Obra + Artista existe na base de dados.
    """
    obra_nome = request.args.get('nome')
    obra_artista = request.args.get('artista')

    logger.debug(f"*** Consultando Obra ***")
    # Criando conexão com a base
    session = Session()
    # Fazendo a busca 
    result = session.query(func.count(Obra.artista)).filter(Obra.artista == obra_artista, Obra.nome == obra_nome).scalar()
    logger.debug(f"Resultado da busca {obra_nome}, {obra_artista}, {result}")
    session.commit()

    if result:
        # Retorna o resultado da busca com "result" com o número de ocorrências
        return jsonify(obra_nome, obra_artista, result)
    
    else:
        # Se a obra não foi encontrada
        error_msg = "Erro: Obra + Artista não encontradados na base :/"
        error_code = "404"
        logger.warning(f"´{error_msg}´ '{obra_nome}' + '{obra_artista}´")
        
        return jsonify(obra_nome, obra_artista, result), 404

# ===============================================================================
""" 7 - Garante a disponibilidade da API em "suspenso".
"""
# ===============================================================================
if __name__ == '__main__':
    app.run(port=5000, debug=True)