The not-so-smooth API wrapper for League of Legends. Pronounced lo-shin like lotion! Too clever I know.
| Endpoint | Version |
|---|---|
| CHAMPION-MASTERY | 3 |
| CHAMPION | 3 |
| LEAGUE | 3 |
| LOL-STATIC-DATA | 3 |
| LOL-STATUS | 3 |
| MATCH | 3 |
| SPECTATOR | 3 |
| SUMMONER | 3 |
| THIRD-PARTY-CODE | ? |
| TOURNAMENT-STUB | N/A |
| TOURNAMENT | N/A |
Add this line to your application's Gemfile:
gem 'lolxin'And then execute:
$ bundle
Or install it yourself as:
$ gem install lolxin
Refer to the source code for methods to hit the RIOT API. For the most part just set up your environment variable API_KEY that you get from the RIOT developer console
Quick example usage...
client = Client.new(ENV['API_KEY'], region: :na1)
client.lol_static_data.champions
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.
For testing purposes I am using the gem dotenv to load my API key. I recommend you do the same and not to commit your .env file to git to keep it a secret by adding it to your .gitignore file. If you decide not to use dotenv for whatever reason make sure to comment it out in the bin/console script. Also add/remove any variables you see fit to speed up manual testing.
To install this gem onto your local machine, run bundle exec rake install.
To release a new version, update the version number in lib/lolxin/helpers/version.rb, and then
run bundle exec rake release, which will create a git tag for the version, push git commits and
tags, and push the .gem file to rubygems.org.
Change up the regions per spec file so that you don't run into rate limiting issues often.
- Add the remaining DTOs
- Parse API responses with DTOs
- TOURNAMENT/TOURNAMENT-STUB endpoints
- VCR record http responses?
- Make tests deterministic
Bug reports and pull requests are welcome on GitHub at https://github.com/jonwho/lolxin. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.