Ryze

Ryze is a Ruby gem that provides a simple interface to the League of Legends Riot API.

Please note that this gem is still in development and is not yet ready for production use.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add Ryze

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install Ryze

Documentation

The documentation for this gem can be found here

Usage

To use the gem, you must first obtain an API key from Riot. You can do so by visiting the Riot Developer Portal.

Than, you can create a new client by passing your API key as an argument:

require 'ryze'

client = Client.new(api_key: 'YOUR_API_KEY')

You can then use the client to make requests to the Riot API:

client.summoner.retrieve_summoner_by_name(summoner_name: 'Faker')

Roadmap

• Finish implementing RBS files
• Add methods to Object classes to make it easier to access data
• Add tests
• Add possibility to change region
• Finish implementing all endpoints

Endpoints

• [x] Summoner-v4
• [ ] Match-v5
• [ ] Champion-Mastery-v4
• [ ] Spectator-V4
• [ ] League-V4

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/clement0910/Ryze. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

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