{"id":30756430,"url":"https://github.com/luccagiankolenez/ruby-rails-api","last_synced_at":"2026-04-05T22:37:07.753Z","repository":{"id":310906664,"uuid":"1041695803","full_name":"LuccaGianKolenez/ruby-rails-api","owner":"LuccaGianKolenez","description":"API em Ruby on Rails (API-only) com autenticação JWT, PostgreSQL, Docker e CI/CD. Inclui CRUD de usuários e tarefas, testes automatizados e ferramentas de segurança e lint.","archived":false,"fork":false,"pushed_at":"2025-08-20T22:44:56.000Z","size":16,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-21T00:28:05.167Z","etag":null,"topics":["backend","brakeman","docker","docker-compose","github-actions","jwt-authentication","postgres","rails-api","rest-api","rspec","ruby-on-rails","simplecov"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/LuccaGianKolenez.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,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-20T22:01:12.000Z","updated_at":"2025-08-20T22:45:02.000Z","dependencies_parsed_at":"2025-08-21T00:28:08.872Z","dependency_job_id":"233ae3b3-131f-4df6-b8ad-d07ade0f805a","html_url":"https://github.com/LuccaGianKolenez/ruby-rails-api","commit_stats":null,"previous_names":["luccagiankolenez/ruby-rails-api"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/LuccaGianKolenez/ruby-rails-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuccaGianKolenez%2Fruby-rails-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuccaGianKolenez%2Fruby-rails-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuccaGianKolenez%2Fruby-rails-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuccaGianKolenez%2Fruby-rails-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LuccaGianKolenez","download_url":"https://codeload.github.com/LuccaGianKolenez/ruby-rails-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuccaGianKolenez%2Fruby-rails-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273589298,"owners_count":25132860,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-04T02:00:08.968Z","response_time":61,"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":["backend","brakeman","docker","docker-compose","github-actions","jwt-authentication","postgres","rails-api","rest-api","rspec","ruby-on-rails","simplecov"],"created_at":"2025-09-04T10:02:31.160Z","updated_at":"2025-11-11T18:17:11.132Z","avatar_url":"https://github.com/LuccaGianKolenez.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c\u003c\u003c\u003c\u003c\u003c\u003c HEAD\n# ruby-rails-api\n=======\n# Portfolio Ruby on Rails API\n\nAPI desenvolvida em **Ruby on Rails (API mode)** com **PostgreSQL**, **JWT**, **Docker/Compose** e **CI/CD**.  \nO projeto implementa autenticação JWT e CRUD de usuários e tarefas, servindo como base para projetos mais complexos e como exemplo de boas práticas em Rails moderno.\n\n---\n\n## Tecnologias\n\n- **Linguagem**: Ruby 3.3\n- **Framework**: Rails 7.2 (API-only)\n- **Banco de dados**: PostgreSQL 16\n- **Auth**: JWT (Bearer Token)\n- **Testes**: RSpec, FactoryBot, Faker, SimpleCov\n- **Qualidade**: RuboCop (lint), Brakeman (segurança)\n- **Infra**: Docker + Docker Compose\n- **CI/CD**: GitHub Actions\n\n---\n\n## Estrutura de pastas\n\n```text\n.\n├── app\n│   ├── controllers        # Controllers da API (Application, Auth, Users, Tasks)\n│   ├── models             # Models (User, Task, ApplicationRecord)\n│   ├── serializers        # Serialização de objetos (opcional)\n│   └── ...\n├── config\n│   ├── application.rb     # Configuração principal da aplicação\n│   ├── database.yml       # Configuração de banco\n│   ├── environments/      # Configs por ambiente (dev/test/prod)\n│   └── routes.rb          # Rotas da API\n├── db\n│   ├── migrate/           # Migrations de schema\n│   └── seeds.rb           # Seeds iniciais (usuário demo + tasks)\n├── spec                   # Testes RSpec\n│   ├── requests           # Testes de controllers/endpoints\n│   ├── models             # Testes de models\n│   └── support            # Helpers de testes\n├── Dockerfile\n├── docker-compose.yml\n├── Gemfile\n├── Rakefile\n└── README.md\n```\n\n---\n\n## Rotas\n\n### Health\n| Método | Endpoint   | Descrição        | Auth |\n|--------|------------|------------------|------|\n| GET    | `/health`  | Status da API    | ❌   |\n\n### Auth\n| Método | Endpoint         | Descrição        | Body |\n|--------|-----------------|------------------|------|\n| POST   | `/auth/sign_in` | Login e gera JWT | `{ \"email\": \"...\", \"password\": \"...\" }` |\n\n### Users\n| Método | Endpoint   | Descrição           | Auth |\n|--------|------------|---------------------|------|\n| POST   | `/users`   | Criar usuário       | ❌   |\n| GET    | `/users`   | Listar usuários     | ✅   |\n| GET    | `/users/:id` | Detalhar usuário  | ✅   |\n\n### Tasks\n| Método | Endpoint    | Descrição               | Auth |\n|--------|-------------|-------------------------|------|\n| GET    | `/tasks`    | Listar tasks do usuário | ✅   |\n| POST   | `/tasks`    | Criar task              | ✅   |\n| GET    | `/tasks/:id`| Detalhar task           | ✅   |\n| PUT    | `/tasks/:id`| Atualizar task          | ✅   |\n| DELETE | `/tasks/:id`| Remover task            | ✅   |\n\n---\n\n## Autenticação JWT\n\n1. Crie um usuário (`POST /users`).\n2. Faça login (`POST /auth/sign_in`) → retorna um `token`.\n3. Use o token nas rotas protegidas:\n   ```http\n   Authorization: Bearer \u003cTOKEN\u003e\n   ```\n\n---\n\n## Como rodar\n\n### Com Docker\n```bash\ndocker compose up --build -d\ndocker compose run --rm api bash -lc \"bundle exec rails db:create db:migrate db:seed\"\ncurl http://localhost:3000/health\n```\n\n### Sem Docker\n```bash\nbundle install\nexport DATABASE_URL=\"postgres://postgres:postgres@localhost:5432/rails_api_dev\"\nexport JWT_SECRET=\"supersecretjwt\"\nbin/rails db:create db:migrate db:seed\nbin/rails s -p 3000\n```\n\n---\n\n## Testes, Lint e Segurança\n\n```bash\n# Testes\ndocker compose run --rm api bash -lc \"bundle exec rspec\"\n\n# Cobertura de testes\nopen coverage/index.html\n\n# Linter\ndocker compose run --rm api bash -lc \"bundle exec rubocop\"\n\n# Segurança\ndocker compose run --rm api bash -lc \"bundle exec brakeman -q\"\n```\n\n---\n\n## Postman\n\n1. Importe o arquivo **`Portfolio-Rails-API.postman_collection.json`**.  \n2. Configure variáveis:\n   - `base_url = http://localhost:3000`\n   - `jwt` será preenchido automaticamente após **Sign In**.  \n3. Ordem sugerida:\n   1. Criar usuário\n   2. Sign In\n   3. Criar/Listar/Atualizar/Deletar Tasks\n\n---\n\n## CI/CD (GitHub Actions)\n\nPipeline executa automaticamente em `push` e `pull_request`:\n- RSpec (testes)\n- Brakeman (segurança)\n- RuboCop (lint)\n\n\n\u003e\u003e\u003e\u003e\u003e\u003e\u003e 9c5a663 (docs(readme): documentação completa (stack, rotas, setup, testes, CI))\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluccagiankolenez%2Fruby-rails-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluccagiankolenez%2Fruby-rails-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluccagiankolenez%2Fruby-rails-api/lists"}