Merge pull request #22 from fga-eps-mds/feature/ranking

feat(ranking): orquestracao do ranking (geral, amigos, turma, lista)

Author: GenilsonJrs

src/modules/ranking/ranking.controller.ts

@@ -0,0 +1,126 @@
+import type { NextFunction, Request, Response } from "express";
+
+import { CodigoDeErro } from "@/shared/errors/codigos-de-erro";
+import { ErroAplicacao } from "@/shared/errors/erro-aplicacao";
+
+import type { RankingService } from "./ranking.service";
+
+type RequisicaoAutenticada = Pick<Request, "usuario" | "headers">;
+
+const LIMITE_MAXIMO_GERAL = 200;
+
+export class RankingController {
+  constructor(private readonly rankingService: RankingService) {}
+
+  geral = async (request: Request, response: Response, next: NextFunction) => {
+    try {
+      const usuario = this.obterUsuario(request);
+      const authorization = this.obterAuthorization(request);
+      const limite = this.obterLimite(request);
+
+      const resultado = await this.rankingService.rankingGeral(usuario, authorization, limite);
+
+      return response.status(200).json(resultado);
+    } catch (error) {
+      return next(error);
+    }
+  };
+
+  amigos = async (request: Request, response: Response, next: NextFunction) => {
+    try {
+      const usuario = this.obterUsuario(request);
+      const authorization = this.obterAuthorization(request);
+
+      const resultado = await this.rankingService.rankingAmigos(usuario, authorization);
+
+      return response.status(200).json(resultado);
+    } catch (error) {
+      return next(error);
+    }
+  };
+
+  turma = async (
+    request: Request<{ turmaId: string }>,
+    response: Response,
+    next: NextFunction,
+  ) => {
+    try {
+      const usuario = this.obterUsuario(request);
+      const authorization = this.obterAuthorization(request);
+
+      const resultado = await this.rankingService.rankingTurma(
+        usuario,
+        authorization,
+        request.params.turmaId,
+      );
+
+      return response.status(200).json(resultado);
+    } catch (error) {
+      return next(error);
+    }
+  };
+
+  lista = async (
+    request: Request<{ turmaId: string; listaId: string }>,
+    response: Response,
+    next: NextFunction,
+  ) => {
+    try {
+      const usuario = this.obterUsuario(request);
+      const authorization = this.obterAuthorization(request);
+
+      const resultado = await this.rankingService.rankingLista(
+        usuario,
+        authorization,
+        request.params.turmaId,
+        request.params.listaId,
+      );
+
+      return response.status(200).json(resultado);
+    } catch (error) {
+      return next(error);
+    }
+  };
+
+  private obterLimite(request: Request): number | undefined {
+    const bruto = request.query.limite;
+
+    if (typeof bruto !== "string") {
+      return undefined;
+    }
+
+    const numero = Number.parseInt(bruto, 10);
+
+    if (!Number.isFinite(numero) || numero <= 0) {
+      return undefined;
+    }
+
+    return Math.min(numero, LIMITE_MAXIMO_GERAL);
+  }
+
+  private obterUsuario(request: RequisicaoAutenticada) {
+    if (!request.usuario?.id) {
+      throw new ErroAplicacao({
+        codigoStatus: 401,
+        codigo: CodigoDeErro.NAO_AUTORIZADO,
+        mensagem: "Usuario nao autenticado.",
+      });
+    }
+
+    return request.usuario;
+  }
+
+  private obterAuthorization(request: RequisicaoAutenticada): string {
+    const authorization = request.headers.authorization;
+
+    if (!authorization) {
+      throw new ErroAplicacao({
+        codigoStatus: 401,
+        codigo: CodigoDeErro.NAO_AUTORIZADO,
+        mensagem: "Token de acesso ausente.",
+      });
+    }
+
+    return authorization;
+  }
+}

src/modules/ranking/ranking.routes.ts

@@ -0,0 +1,28 @@
+import { Router } from "express";
+
+import { middlewareAutenticacao } from "@/shared/middlewares/autenticacao.middleware";
+
+import { RankingController } from "./ranking.controller";
+import { RankingService } from "./ranking.service";
+
+const rankingService = new RankingService();
+const rankingController = new RankingController(rankingService);
+
+const rankingRouter = Router();
+
+rankingRouter.use(middlewareAutenticacao);
+
+// Aluno (e professor/admin): ranking geral de todos os alunos visiveis.
+rankingRouter.get("/geral", rankingController.geral);
+
+// Aluno: ranking entre os amigos confirmados + ele mesmo.
+rankingRouter.get("/amigos", rankingController.amigos);
+
+// Professor/Admin: ranking dos alunos de uma turma (desempenho geral no AnatoQuiz).
+// A autorizacao por papel e garantida pelo Quiz-Service (apenasGestao).
+rankingRouter.get("/turmas/:turmaId", rankingController.turma);
+
+// Professor/Admin: ranking dos alunos em uma lista especifica da turma.
+rankingRouter.get("/listas/:turmaId/:listaId", rankingController.lista);
+
+export { rankingRouter };