LoLBase Build Status Code Climate Gem Version

A basic Ruby wrapper for the League of Legends API.

Installation

Add this line to your application's Gemfile:

gem 'lolbase'

And in the console, execute:

$ bundle

Usage

1. Configuration

LoLBase can be globally configured through the LoLBase::configure method. The values shown are the defaults set by the gem.

LoLBase.configure do |config|
  config.default_region = "na"    # Default region for summoner lookup
  config.default_key = nil        # Default API key

  # Determines which API version to use
  config.version_champion = "1.1"
  config.version_game = "1.2"
  config.version_league = "2.2"
  config.version_stats = "1.2"
  config.version_summoner = "1.2"
  config.version_team = "2.2"

  # Current season - used as a default value for ranked stats
  config.current_season = "3"
end

2. Connection

connection = LoLBase.new "your-api-key-here"

All connections begin by calling LoLBase::new which takes an API key as an argument (this can be left blank if it was provided in the config). Multiple connections can be used if you have more than one key available to you.

3. Data Retrieval

3.1 Summoner

# Fetch a summoner by their name...
summoner = connection.summoner("A Summoner Name", "na")

# ...or by their ID
summoner = connection.summoner(12345, "euw")

# Retrieve data associated to the summoner
summoner.id
summoner.name
summoner.region
summoner.level
summoner.last_modified

3.2 Profile Icon

summoner.profile_icon.id

3.3 Statistics

# A specified ranked season is passed - defaults to LoLBase.config.current_season
summary = summoner.stats.summary(3)    
ranked = summoner.stats.ranked(3)

# JSON data from the API is returned, parsed as a Ruby object
summary["playerStatSummaries"]
ranked["champions"]

Resources