Project

lolxin

0.0
No commit activity in last 3 years
No release in over 3 years
Savage memes can't melt playoff dreams
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

>= 0
 Project Readme

Gem Version Build Status Code Climate Test Coverage Issue Count

Lolxin

The not-so-smooth API wrapper for League of Legends. Pronounced lo-shin like lotion! Too clever I know.

Supported endpoints

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

Installation

Add this line to your application's Gemfile:

gem 'lolxin'

And then execute:

$ bundle

Or install it yourself as:

$ gem install lolxin

Usage

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

Development

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.

Release

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.

Testing

Change up the regions per spec file so that you don't run into rate limiting issues often.

TODO

  • Add the remaining DTOs
  • Parse API responses with DTOs
  • TOURNAMENT/TOURNAMENT-STUB endpoints
  • VCR record http responses?
  • Make tests deterministic

Contributing

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.

License

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