Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add layer for calls to even3 api #28

Merged
merged 2 commits into from
Jun 21, 2024

Conversation

Azanniel
Copy link
Collaborator

@Azanniel Azanniel commented Jun 20, 2024

TL;DR

Para auxiliar nas atividades que requerem chamadas a api da Even3, nessa solicitação é implementada:

  • Uma camada para chamadas a api da Even3 seguindo um pouco da documentação deles
  • Validação das variáveis de ambiente (Necessário agora que devemos usar um token de acesso)

⚠️ Atenção, pois é necessário configurar as variáveis do repositório.

Descrição

Algumas das atividades (issues) aqui do repositório precisam consultar a API da Even3, logo, a estruturação de uma camada da qual possa ser usada para realizar as chamadas é necessária.

Nesta solicitação foi adicionada na pasta lib uma camada denominada even3 da qual utiliza de um token de acesso para realizar as chamadas a api no lado do servidor.

Para que esse token de acesso não seja exposto, foi criada uma validação das variáveis de ambiente que, atualmente, possui somente a variável EVEN3_API_TOKEN. Essa variável é muito importante, pois adiciona o token no cabeçalho para gerar a autenticidade da requisição.

E para dar o exemplo, foi utilizada algumas informações da api para popular alguns dados estáticos que haviam no site, como por exemplo:

  • Dias do evento
  • Sobre o evento

image

Isso ajudará, principalmente, nas issues que precisam realizar chamadas para api e consultar diversos dados, tais issues como:

⚠️ Atenção revisor

É extremamente importante que antes de aceitar essa solicitação a variável de ambiente EVEN3_API_TOKEN seja adicionada as variáveis do repositório, dado que usamos o GitHub Pages para realizar a implantação do site.

Além disso, a documentação, ou README precisa ser ajustado para que essa variável de ambiente seja requisito para rodar o site localmente.

Cada desenvolvedor que clonar o projeto deve adicionar um arquivo na raiz do projeto chamado .env.local com a variável de ambiente:

EVEN3_API_TOKEN="example-token-access-api-even-3"

Tipo de mudança 🏗️

Minha mudança é uma:

  • Novo recurso (alteração que adiciona funcionalidades)
  • Esta alteração requer uma atualização de documentação

Como isso foi testado? 🧪

Após clonar o projeto:

  • Crie um arquivo .env.local na raiz do projeto contento o conteúdo EVEN3_API_TOKEN="example-token-access-api-even-3"
  • Inicie o site rodando o comando npm run dev
  • Acesse a URL local http://localhost:3000

Checklist da PR ✅

  • Meu código segue as diretrizes de estilo deste projeto
  • Realizei uma autoavaliação do meu próprio código
  • Fiz alterações correspondentes na documentação
  • Minhas alterações não geram novos warnings
  • O título do meu PR está seguindo o padrão (scope): subject.

In addition, the environment variables are validated and the API is used to search for the specific event, replacing the static data
@Azanniel Azanniel requested a review from meu-bem June 20, 2024 02:33
@Azanniel Azanniel self-assigned this Jun 20, 2024
@Azanniel Azanniel marked this pull request as draft June 20, 2024 02:36
@Azanniel Azanniel marked this pull request as draft June 20, 2024 02:36
@Azanniel Azanniel marked this pull request as ready for review June 20, 2024 02:38
@meu-bem meu-bem merged commit b8781cd into main Jun 21, 2024
1 check passed
@meu-bem meu-bem deleted the feature/structure-for-calls-to-even3-api branch June 21, 2024 01:03
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.

2 participants