{"id":31790745,"url":"https://github.com/xarlybovi/halo-api","last_synced_at":"2025-10-10T16:29:25.982Z","repository":{"id":48100932,"uuid":"102191424","full_name":"xarlybovi/halo-api","owner":"xarlybovi","description":"Wrapper for Halo Public API (BETA). https://developer.haloapi.com","archived":false,"fork":false,"pushed_at":"2021-08-06T16:11:53.000Z","size":944,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-07T20:22:28.136Z","etag":null,"topics":["api-wrapper","gem","halo","ruby"],"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/xarlybovi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-02T11:17:14.000Z","updated_at":"2023-12-15T11:17:53.000Z","dependencies_parsed_at":"2022-08-12T18:40:23.856Z","dependency_job_id":null,"html_url":"https://github.com/xarlybovi/halo-api","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/xarlybovi/halo-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xarlybovi%2Fhalo-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xarlybovi%2Fhalo-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xarlybovi%2Fhalo-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xarlybovi%2Fhalo-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xarlybovi","download_url":"https://codeload.github.com/xarlybovi/halo-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xarlybovi%2Fhalo-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279004706,"owners_count":26083750,"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-10-10T02:00:06.843Z","response_time":62,"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":["api-wrapper","gem","halo","ruby"],"created_at":"2025-10-10T16:29:24.110Z","updated_at":"2025-10-10T16:29:25.977Z","avatar_url":"https://github.com/xarlybovi.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HaloAPI\n[![Gem Version](https://badge.fury.io/rb/halo-api.svg)](https://badge.fury.io/rb/halo-api)\n[![Code Climate](https://codeclimate.com/github/xarlybovi/halo-api.png)](https://codeclimate.com/github/xarlybovi/halo-api)\n[![Actions Status](https://github.com/xarlybovi/halo-api/workflows/CI/badge.svg)](https://github.com/xarlybovi/halo-api/actions)\n[![codecov](https://codecov.io/gh/xarlybovi/halo-api/branch/master/graph/badge.svg?token=NJLMA4MDU1)](https://codecov.io/gh/xarlybovi/halo-api)\n\nWrapper for Halo Public API (BETA). https://developer.haloapi.com\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'halo-api', '~\u003e 1.0.0'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install halo-api\n\n## Usage\n\nBasic configuration:\n````ruby\nHalo.configure do |config|\n  config.api_key = ENV['HALO_API_KEY']\nend\n````\n\nConfiguration with redis and region (optional parameters)\n````ruby\nHalo.configure do |config|\n  config.api_key = ENV['HALO_API_KEY']\n  config.region  = ENV['HALO_REGION']  # default 'en'\n  config.redis   = ENV['HALO_REDIS']\n  config.ttl     = ENV['HALO_TTL']     # default 1800\nend\n````\n\n````ruby\nhalo5_client = Halo.halo5\n# =\u003e Halo::Halo5\nhalo_wars2_client = Halo.halo_wars2\n# =\u003e Halo::HaloWars2\n\nh5_missions = halo5_client.metadata.campaign_missions\n# =\u003e Array\nh5_enemies  = halo5_client.metadata.enemies\n# =\u003e Array\nh5_player_appearance = halo5_client.profile(player: 'xarly bovi').player_appearance\n# =\u003e Array\nhw2_campaign_levels  = halo_wars2_client.metadata.campaign_levels\n# =\u003e Array\nhw2_seasons = halo_wars2_client.metadata.seasons\n# =\u003e Array\n````\n\n## TODO\n\n- [x] Halo 5 endpoints\n- [x] Halo Wars 2 endpoints\n- [x] Redis response caching support\n- [ ] Request rate limiter\n- [ ] Custom query builder\n- [ ] Paged requests\n- [ ] Documentation\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxarlybovi%2Fhalo-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxarlybovi%2Fhalo-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxarlybovi%2Fhalo-api/lists"}