Paladins
This gem wraps Hi-Rez Studios' Paladins API.
See Paladins API DOCS for more information.
Status
Alpha (see CHANGELOG.md)
Installation
Add this line to your application's Gemfile:
gem 'paladins'
And then execute:
$ bundle
Or install it yourself as:
$ gem install paladins
Usage
Create an initializer in config/initializers
to set your dev_id
and auth_key
in a block:
Paladins.configure do |config|
config.dev_id = ''
config.auth_key = ''
end
Paladins.
or
config = Paladins::Configuration.new
config.dev_id = ''
config.auth_key = ''
client = Paladins::Client.new(config)
client.
Configs are then available like:
Paladins.configuration.dev_id # => ''
Development
You are welcome to contribute to this gem!
Before everything, make sure you get valid dev_id
and auth_key
by submitting a request here. You will get an email with keys and API instruction.
Make sure to export your keys as ENV
variables (note that var names must be exactly PALADINS_DEV_ID
and PALADINS_AUTH_KEY
)
export PALADINS_DEV_ID=xxxx
export PALADINS_AUTH_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
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
.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/davideghz/paladins.
License
The gem is available as open source under the terms of the MIT License.