{"id":22180220,"url":"https://github.com/andridus/gitx","last_synced_at":"2026-04-27T12:05:32.860Z","repository":{"id":216515549,"uuid":"741119026","full_name":"andridus/gitx","owner":"andridus","description":"Serviço que recupera todas as issues de um determinado repositório no github e retorna um JSON assincronamente via webhook com as issues e contribuidores que existiam no projeto no momento da chamada.","archived":false,"fork":false,"pushed_at":"2024-01-10T16:08:53.000Z","size":125,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T18:50:27.444Z","etag":null,"topics":["fetch-issues","github","issues","webhook"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andridus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2024-01-09T18:27:13.000Z","updated_at":"2024-07-19T11:25:26.000Z","dependencies_parsed_at":"2024-01-10T18:34:49.017Z","dependency_job_id":null,"html_url":"https://github.com/andridus/gitx","commit_stats":null,"previous_names":["andridus/gitx"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/andridus/gitx","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andridus%2Fgitx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andridus%2Fgitx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andridus%2Fgitx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andridus%2Fgitx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andridus","download_url":"https://codeload.github.com/andridus/gitx/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andridus%2Fgitx/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32335359,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T23:26:28.701Z","status":"online","status_checked_at":"2026-04-27T02:00:06.769Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fetch-issues","github","issues","webhook"],"created_at":"2024-12-02T09:17:29.140Z","updated_at":"2026-04-27T12:05:32.842Z","avatar_url":"https://github.com/andridus.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Gitx\n\nServiço que recupera todas as issues de um determinado repositório no github e retorna um JSON assincronamente via webhook com as issues e contribuidores que existiam no projeto no momento da chamada.\n\n## Observação Adicionais\n\n  É necessário implementar prevenção de rate_limit para muitas requisições no Github (60 req/hora) visto que para obter os `issues` e `contributors` é executado uma consulta recursiva na Api do github que retorna sempre 100 de cada, caso o repositorio solicitado tenha muitos contribuidores e muitas issues então o limite de 60 req/hora será facilmente estourado.\n\n  A estratégia que poderiamos implementar é um Genserver para realizar as consultas no github, de maneira que conseguiremos controlar objetivamente a quantidade de requisicoes realizadas, e depois, caso tenha se esgotado as requisicoes durante a montagem dos dados de um repo, o worker esperaria o tempo de disponibilidade para realizar novas (o tempo é informado no header do retorno do github), e então continuaria a montar os dados do repo e somente qundo finalizasse este, iria para o próximo da fila. visto que os jobs `Job.Github` somente performa 1 por vez.\n\n## Entradas e Saídas esperados\n- Entrada: Nome do usuário Nome do repositório\n- Expectativa de retorno de JSON em um webhook(Utilizar o https://webhook.site/):\n\n```elixir\n{ user: nome_usuario\n  repository: nome_repositorio\n  issues: [\n    {title, author and labels},\n    {title, author and labels},\n    ...\n  ],\n  contributors: [\n    {name, user, qtd_commits},\n    {name, user, qtd_commits},\n    ....\n  ]\n }\n```\n\n## Processo\n\n  Criamos as entidades `Issue`, `Contributor` e `GithubRepo` para formar o json de resposta, esperado acima.\n  Adicionamos validações aos campos nas entidades, tudo orientado a TDD.\n\n  Em temos de biblioteca externa, utilizamos o Ecto com PostgresSQL somente para a execução dos jobs. E também no propósito de deixar o projeto todo mais leve possivel, não incluímos o Html (visto que não teriamos interface web.)\n\n  Para testes utilizamos `faker`, `httpmock`, `mimic`, `mix_test_watch` e `:credo`.\n  Para bibliotecas externas, além do phoenix framework (sem ecto e html) utilizamos `httpoison`, `sqlite`, `ecto` e `oban`\n\n  - [x] Criação da entidade `Issue`\n  - [x] Criação da entidade `Contributor`\n  - [x] Criação da entidade `GithubRepo`\n  - [x] Criação do Recurso API com HTTPoison\n  - [x] Tratamento da informação proveniente da API em Github.Response\n  - [x] Configurar Mock em testes de API Externa (requisição HTTPoison)\n  - [x] Criação da função para obter os dados do repo do Github\n  - [x] Criação da função para obter os dados de issues do repo do Github\n  - [x] Criação da função para obter os dados de contribuidores do repo do Github\n  - [x] Criação da função de contexto para retorno dos issues\n  - [x] Criação da função de contexto para retorno dos contributors\n  - [x] Criação da função de contexto para criação do retorno da `saída esperada`\n  - [x] Configuração de testes para rate limit\n  - [x] Configuração de testes gerenciar estados por testes individuais\n  - [x] Ajustar função de obter issues e contributors recursivamente.\n  - [x] Criaçao da função para popular o webhook\n  - [x] Configuração do Oban com SQLite para agendar operações pro proximo dia\n  - [x] Criação de um job imediato (até 1 por vez) para obter os dados do Github\n  - [x] Criação de um job agendado (até 10 por vez) para efetuar push pro Webhook\n  - [x] Implementar endpoint para realizar `entrada esperada`\n  - [] Implantar RateLimit para multiplas requisições do Github\n\n## Enpoint para `entrada esperada`\n\n  - `POST /schedule`\n\n    ```bash\n      curl --request POST \\\n        --url http://localhost:4000/schedule \\\n        --header 'Content-Type: application/json' \\\n        --data '{\n            \"username\": \"andridus\",\n            \"repository\": \"lx\"\n          }'\n    ```\n\n## Observação final\n  É necessário implementar prevenção de rate_limit para muitas requisições no Github (60 req/hora) visto que para obter os `issues` e `contributors` é executado uma consulta recursiva na Api do github que retorna sempre 100 de cada, caso o repositorio solicitado tenha muitos contribuidores e muitas issues então o limite de 60 req/hora será facilmente estourado.\n\n  A estratégia que poderiamos implementar é um Genserver para realizar as consultas no github, de maneira que conseguiremos controlar objetivamente a quantidade de requisicoes realizadas, e depois, caso tenha se esgotado as requisicoes durante a montagem dos dados de um repo, o worker esperaria o tempo de disponibilidade para realizar novas (o tempo é informado no header do retorno do github), e então continuaria a montar os dados do repo e somente qundo finalizasse este, iria para o próximo da fila. visto que os jobs `Job.Github` somente performa 1 por vez.\n\n## Para rodar a aplicação\n  Configuramos a aplicação para ficar pronta em docker afim de que a execução seja facilitada, além de poder medir o tamanho da imagem e prever a quantidade de recursos que ela necessitará, em caso de rodando em kubernetes.\n\n  * Executar `docker-compose up` para rodar a aplicação através do docker, a porta `4000` será exposta e então poderá utilizar o cURL acima.\n  * No `docker-compose.yml` deixamos algumas configurações a nivel de ENV, a saber:\n      - `WEBHOOK_ID`=f855fbda-72e2-4c0c-8f67-a28146931f84 ( Aqui é pra colocar a chave do webhook.api, assumindo que estamos utilizando ele)\n      - `DATABASE_PATH`=/app/data/base.db (por padrão está localizado nessa pasta internamente na imagem do docker - para manter uma persistencia eventual)\n      - DELIVERY=minute ( pode se escolher o tempo que demora a entrega do resultado no webhook, sendo que o padrão é `day`, podendo ser `minute` | `hour` | `day`, com valor sempre em 1, exemplo `1 day`)\n      - SECRET_KEY_BASE=8RSQ6spireSlcocKD7tDzC104BhqMkaVM5uJdGFGl1IQ4d0aUA4ozYAkjZ68J/vB (secret do phoenix)\n\n## Para contribuir com o projeto\n\n  1. Instale a versão mais 1.14 do [Elixir](https://elixir-lang.org/install.html);\n  2. Configuramos um script com as validações necessárias para garantir a qualidade do código, e deve ser executado antes de realizar o commit, ou então instale o [pre-commit](https://pre-commit.com/) para que seja configurado para rodar automaticamente antes de subir qualquer commit;\n\n    - Instale o pre-commit com `pip install pre-commit`\n    - execute o comando `pre-commit install`na raiz do projeto para configurar a validação no hook do pre-commit.\n    - execute o comando `pre-commit run --all-files` para verificar se está tudo ok.\n\n  3. Pode-se executar a qualquer momento o script `validate.sh` que executa uma sequência de validações para garantir a qualidade do código, equivalente ao (2);\n  4. É necessário criar a base de dados com os comandos.\n  - `mix ecto.create`\n  - `mix ecto.migrate`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandridus%2Fgitx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandridus%2Fgitx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandridus%2Fgitx/lists"}