HaloAPI

Wrapper for Halo Public API (BETA). https://developer.haloapi.com

Installation

Add this line to your application's Gemfile:

gem 'halo-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install halo-api

Usage

Basic examples:

Halo.configure do |config|
  config.api_key = ENV['HALO_API_KEY']
  config.region  = ENV['HALO_REGION']
end

halo5_client = Halo.halo5
halo_wars2_client = Halo.halo_wars2

h5_missions = halo5_client.metadata.campaign_missions
h5_player_appearance = halo5_client.profile(player: 'xarly bovi').player_appearance
h2w_campaign_levels = halo_wars2_client.metadata.campaign_levels

TODO

[x] Halo 5 endpoints
[x] Halo Wars 2 endpoints
[ ] Documentation

Contributing

Bug reports and pull requests are welcome!

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

License

The gem is available as open source under the terms of the MIT License.