{"id":15405829,"url":"https://github.com/igor-starostenko/report_factory","last_synced_at":"2026-02-27T03:33:22.882Z","repository":{"id":189259236,"uuid":"108926885","full_name":"igor-starostenko/report_factory","owner":"igor-starostenko","description":"Rails reports storage for RSpec tests","archived":false,"fork":false,"pushed_at":"2020-01-20T05:33:02.000Z","size":305,"stargazers_count":1,"open_issues_count":14,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-06T16:31:08.772Z","etag":null,"topics":["json","json-api","qa","qatools","rails","rails5","report","report-factory","reporting","reports","rspec-report","server"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/igor-starostenko.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-10-31T01:07:18.000Z","updated_at":"2019-01-28T07:15:32.000Z","dependencies_parsed_at":"2023-08-19T03:10:24.788Z","dependency_job_id":null,"html_url":"https://github.com/igor-starostenko/report_factory","commit_stats":null,"previous_names":["igor-starostenko/report_factory"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/igor-starostenko/report_factory","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igor-starostenko%2Freport_factory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igor-starostenko%2Freport_factory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igor-starostenko%2Freport_factory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igor-starostenko%2Freport_factory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/igor-starostenko","download_url":"https://codeload.github.com/igor-starostenko/report_factory/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igor-starostenko%2Freport_factory/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29883764,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-26T23:51:21.483Z","status":"online","status_checked_at":"2026-02-27T02:00:06.759Z","response_time":57,"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":["json","json-api","qa","qatools","rails","rails5","report","report-factory","reporting","reports","rspec-report","server"],"created_at":"2024-10-01T16:18:43.116Z","updated_at":"2026-02-27T03:33:22.861Z","avatar_url":"https://github.com/igor-starostenko.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Report Factory\n\n[![Build Status](https://travis-ci.org/igor-starostenko/report_factory.svg?branch=master)](https://travis-ci.org/igor-starostenko/report_factory)\n[![Maintainability](https://api.codeclimate.com/v1/badges/5dcc1e927ff6ed345791/maintainability)](https://codeclimate.com/github/igor-starostenko/report_factory/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/5dcc1e927ff6ed345791/test_coverage)](https://codeclimate.com/github/igor-starostenko/report_factory/test_coverage)\n\n*Report Factory* is a storage for your test reports with intuitive API to manage all your projects test results.\n\nThe provided API are based on the [JSON API](http://jsonapi.org) convention.\nCurrently migrating to [GraphQL](https://graphql.org).\n\n## Getting Started\n\nFollow these [instructions](https://github.com/igor-starostenko/report_factory/blob/master/setup/INSTRUCTIONS.md) to get *Report Factory* running with *Docker*. The configuration is ready for production.\n\nThe image of this project can be pulled from [Dockerhub](https://hub.docker.com/r/reportfactory/server/):\n\n```bash\n  docker pull reportfactory/server\n```\n\n## Preconditions\n\n- Add `Content-Type` header with `application/vnd.api+json`\n- Add your account's `X-API-KEY` to header\n\n## Available API\n\n### Users\n\nTo login and get your `X-API-KEY`:\n\n_POST_ `/api/v1/users/login`\n\n```json\n{\n    \"data\":{\n        \"type\":\"users\",\n        \"attributes\":{\n            \"email\":\"new_user@mailinator.com\",\n            \"password\":\"Password1\"\n        }\n    }\n}\n```\n\n---\n\nTo return your user:\n\n_GET_  `/api/v1/user`\n\n---\n\nTo return all registered users:\n\n_GET_  `/api/v1/users`\n\n---\n\nTo create a user (Admin only):\n\n_POST_ `/api/v1/users/create`\n\n```json\n{\n    \"data\":{\n        \"type\":\"users\",\n        \"attributes\":{\n            \"name\":\"UserName\",\n            \"email\":\"new_user@mailinator.com\",\n            \"password\":\"Password1\",\n            \"type\":\"Tester\"\n        }\n    }\n}\n```\n\n---\n\nTo update a user (Admin only):\n\n_PUT_ `/api/v1/users/:id`\n\n```json\n{\n    \"data\":{\n        \"type\":\"users\",\n        \"attributes\":{\n            \"name\":\"UpdatedName\",\n            \"email\":\"updated_user@mailinator.com\"\n        }\n    }\n}\n```\n*Note:* You can promote user to Admin by passing `\"type\":\"Admin\"`\n\n---\n\nTo get user information:\n\n_GET_  `/api/v1/users/:id`\n\n---\n\nTo get all reports of a user:\n\n_GET_  `/api/v1/users/:id/reports`\n\n---\n\nTo get all RSpec reports of a user:\n\n_GET_  `/api/v1/users/:id/reports/rspec`\n\n---\nTo delete a user (Admin only):\n\n_DELETE_  `/api/v1/users/:id`\n\n---\n### Projects\n\nTo return all available projects:\n\n_GET_  `/api/v1/projects`\n\n---\n\nTo create a new project (Admin only):\n\n_POST_ `/api/v1/projects`\n\n```json\n{\n    \"data\":{\n        \"type\":\"project\",\n        \"attributes\":{\n            \"project_name\":\"MyAwesomeProject\"\n        }\n    }\n}\n```\n\n---\n\nTo get project by name:\n\n_GET_  `/api/v1/projects/:project_name`\n\n---\n\nTo update a project:\n\n_PUT_  `/api/v1/projects/:project_name`\n\n```json\n{\n    \"data\":{\n        \"type\":\"project\",\n        \"attributes\":{\n            \"project_name\":\"UpdatedProjectName\"\n        }\n    }\n}\n```\n\n---\n\nTo delete a project (Admin only):\n\n_DELETE_  `/api/v1/projects/:project_name`\n\n### Project Reports\n\nTo return all reports within a project:\n\n_GET_  `/api/v1/projects/:project_name/reports`\n\n---\n\nTo get all RSpec reports within a project:\n\n_GET_  `/api/v1/projects/:project_name/reports/rspec`\n\n---\n\nTo submit an RSpec report:\n\n_POST_ `/api/v1/projects/:project_name/reports/rspec`\n\n```json\n{\n  \"data\": {\n    \"type\": \"rspec_report\",\n    \"attributes\": {\n      \"version\": \"3.7.0\",\n      \"examples\": [\n        {\n          \"id\": \"./spec/routing/routes_spec.rb[1:4:1]\",\n          \"description\": \"routes GET /api/v1/projects/:project_name/reports/rspecto rspec_reports#index\",\n          \"full_description\": \"routing /api/v1/projects/:project_name/reports/rspec routes GET /api/v1/projects/:project_name/reports/rspecto rspec_reports#index\",\n          \"status\": \"passed\",\n          \"file_path\": \"./spec/routing/routes_spec.rb\",\n          \"line_number\": 59,\n          \"run_time\": 0.001341,\n          \"pending_message\": null,\n        },\n        {\n          \"id\": \"./spec/requests/rspec_reports_api_spec.rb[1:1:1]\",\n          \"description\": \"gets all rspec reports within project\",\n          \"full_description\": \"RspecReports GET index gets all rspec reports within project\",\n          \"status\": \"failed\",\n          \"file_path\": \"./spec/requests/rspec_reports_api_spec.rb\",\n          \"line_number\": 11,\n          \"run_time\": 0.032876,\n          \"pending_message\": null,\n          \"exception\": {\n            \"class\": \"RSpec::Expectations::ExpectationNotMetError\",\n            \"message\": \"\\nexpected: 200\\n     got: 204\\n\\n(compared using ==)\\n\",\n            \"backtrace\": [\n              \"./gems/rspec-support-3.7.0/lib/rspec/support.rb:97:in `block in \\u003cmodule:Support\\u003e'\",\n              \"./gems/rspec-support-3.7.0/lib/rspec/support.rb:106:in `notify_failure'\",\n              \"./gems/rspec-expectations-3.7.0/lib/rspec/expectations/fail_with.rb:35:in `fail_with'\",\n              \"./gems/rspec-expectations-3.7.0/lib/rspec/expectations/handler.rb:38:in `handle_failure'\",\n              \"./gems/rspec-expectations-3.7.0/lib/rspec/expectations/handler.rb:50:in `block in handle_matcher'\",\n            ]\n          }\n        }\n      ]\n      \"summary\": {\n        \"duration\": 0.747558,\n        \"example_count\": 2,\n        \"failure_count\": 1,\n        \"pending_count\": 0,\n        \"errors_outside_of_examples_count\": 0\n      },\n      \"summary_line\": \"2 examples, 1 failures\",\n    }\n  }\n}\n```\n\n---\n\nTo view an existing RSpec reports within a project:\n\n_GET_  `/api/v1/projects/:project_name/reports/rspec/:id`\n\n### Reports\n\nTo return all reports:\n\n_GET_  `/api/v1/reports`\n\n---\n\nTo get all RSpec reports:\n\n_GET_  `/api/v1/reports/rspec`\n\n### Scenarios\n\nTo return all scenarios:\n\n_GET_  `/api/v1/scenarios`\n\n---\n\nTo get all scenarios by project:\n\n_GET_  `/api/v1/projects/:project_name/scenarios`\n\n## GraphQL\n\nClients can fetch data using GraphQL from `/graphql' endpoint. Just make sure you pass `X-API-KEY` header with your user token.\nTo acccess GraphiQL in development you need to set the token in the environment variable:\n\n```bash\n  export X_API_KEY={your_x_api_key}\n```\n\nThen youl'll be able to access `/graphiql` on your localhost.\n\n## License\n\nThe application is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figor-starostenko%2Freport_factory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Figor-starostenko%2Freport_factory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figor-starostenko%2Freport_factory/lists"}