This is a Ruby client to communicate with the Battle.net API endpoints release by Blizzard Entertainment.
The gem depends on oj and faraday to properly communicate with these endpoints.
A few additional dependencies have been included to make the usage of the gem easier.
The implementation of the gem is based on the Official Blizzard Developer Documentation and requires you to understand the basics of OAuth and JSON API endpoints in order to properly configure the required API keys to make the gem function.
Please see the Usage Docs for more information on how to use the gem.
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/battle_net_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the BattleNetClient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.