Skip to content

Adiciona relatórios provisórios com cobertura parcial - #162

Merged
pitangainnovare merged 8 commits into
scieloorg:mainfrom
pitangainnovare:melhoria/relatorios-provisorios
Nov 11, 2026
Merged

pitangainnovare merged 8 commits into
scieloorg:mainfrom
pitangainnovare:melhoria/relatorios-provisorios

Conversation

@pitangainnovare

Copy link
Copy Markdown
Contributor

O que esse PR faz?

  • Adiciona /r51/extensions/reports/<report_id> para consultar PR, TR, TR_J3, TR_B3 e IR com os dias confirmados de meses incompletos.
  • Inclui cobertura e avisos em JSON, Excel e TSV, sem alterar as rotas COUNTER oficiais.
  • Atualiza a versão para 2.8.0.

Onde a revisão poderia começar?

counter_api/generation.py e counter_api/extensions/reports.py.

Como este poderia ser testado manualmente?

No ambiente com a branch instalada:

  1. Consultar /r51/extensions/reports/tr?platform=scl&begin_date=2025-01&end_date=2025-12&item_id=Online_ISSN:1518-8345 e conferir provisional, coverage e warnings.
  2. Repetir com format=xlsx e format=tsv e conferir a cobertura nos arquivos.
  3. Confirmar que coverage_policy=strict retorna 400 e que /r51/reports/tr continua omitindo meses incompletos.

Validação local: 122 testes aprovados, 3 pulados; Flake8, Black e isort aprovados.

Algum cenário de contexto que queira dar?

Os resultados da extensão são provisórios, não relatórios conformes ao fechamento mensal exigido pelo COUNTER.

Screenshots

Não se aplica.

Quais são os tickets relevantes?

Nenhum informado.

Referências

COUNTER R5.1 — Delivery of COUNTER Reports


Segurança da informação (NSI.04)

Este PR manipula dados sensíveis ou pessoais (LGPD)?

  • Sim
  • Não — consulta métricas agregadas, sem expor IPs ou sessões individuais.

Este PR altera autenticação, autorização, controle de acesso ou gerenciamento de sessão?

  • Sim
  • Não — reutiliza os controles e quotas existentes.

Este PR introduz, atualiza ou remove dependências de terceiros?

  • Sim
  • Não

Este PR foi validado pelo pipeline de segurança (SonarQube / Trivy)?

  • Sim — link do job:
  • Não aplicável a este PR (justifique):

Pendente de validação no PR; não executado localmente.

Este PR concatena, monta ou executa comandos SQL, HTML ou JavaScript a partir de entrada externa?

  • Sim
  • Não

Este PR expõe novos endpoints, telas ou serviços?

  • Sim — nova rota sob /r51/, com os controles de acesso e quotas existentes. Manter HTTPS na publicação, sem alteração de TLS/ingress neste PR.
  • Não

Algum segredo, senha, chave ou token está sendo adicionado ao código-fonte?

  • Não, nenhum segredo foi commitado
  • Sim (bloquear merge e corrigir antes de prosseguir)

Reutiliza a seleção diária das extensões nos quatro contadores. Meses completos usam os totais mensais, sem somar as mesmas parcelas duas vezes; consultas sem cobertura conservam as somas anteriores.
Acrescenta um modo interno provisório ao gerador compartilhado, com seleção temporal, cobertura e avisos. O caminho padrão permanece restrito aos meses completos e mantém as validações de livros.
Oferece pontos de extensão para o parser, o gerador e o prefixo dos downloads. Preserva os componentes e nomes de arquivo usados pela rota COUNTER oficial.
Exporta a cobertura em uma aba do Excel e em uma seção após os dados no TSV, inclusive sem itens. Os downloads COUNTER padrão não recebem essas seções.
Expõe /r51/extensions/reports/<report_id> sem exigir coverage_policy e rejeita strict. Centraliza datas e schema nos módulos correspondentes e reutiliza a view e o gerador existentes, preservando acesso e quotas.
Mantém dois testes essenciais para o contrato HTTP: modo parcial implícito, rejeição de políticas incompatíveis e preservação da rota oficial; cobertura e avisos nos arquivos Excel e TSV sem itens.
Apresenta a rota sempre parcial, um exemplo sem parâmetro de política e a cobertura dos downloads. Direciona consultas de meses completos à rota COUNTER oficial e detalhes de contrato ao OpenAPI.
Marca a inclusão dos relatórios provisórios com cobertura parcial, preservando as rotas COUNTER existentes.
@pitangainnovare
pitangainnovare merged commit 85492a3 into scieloorg:main Nov 11, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant