module Taric

Combines operations of LoL API.

Constants

PRESEASON2014
PRESEASON2015
PRESEASON3

seasons

RANKED_SOLO_5X5

rankedQueues

RANKED_TEAM_3X3
RANKED_TEAM_5X5
SEASON2014
SEASON2015
SEASON3
VERSION

Attributes

configuration[RW]

Public Class Methods

client(region: :na, api_key: nil, config: @configuration ||= Taric::Configuration.new) click to toggle source

Creates a [Taric::Client], the main interface to the LoL API. If the api_key is provided in .configure!, then only the region needs to be set. If .configure! is used, but a different api_key is provided, then the latter takes precedence.

@see Taric::Client::REGION_ENDPOINT_INFO @param region [Symbol] region code, also accepts [String], default is :na @param api_key [String] rito API key @param config [Taric::Configuration] configuration options. If not provided, then defaults will be used.

@return [Taric::Client]

@example

# With .configure! (preferred)
Taric.configure! do |config|
  config.api_key = 'your-rito-api-key'
end

client = Taric.client(region: :na)

# With arbitrary key.
client = Taric.client(region: :na, api_key: 'your-rito-key')
# File lib/taric.rb, line 32
def client(region: :na, api_key: nil, config: @configuration ||= Taric::Configuration.new)
  Taric::Client.new(api_key: api_key || config.api_key,
                    region: region.is_a?(String) ? region.to_sym : region,
                    config: config)
end
configure!() { |configuration| ... } click to toggle source

Sets global configuration. Should only be called once in a process (e.g. Rails initializer)

@see Taric::Configuration

@example

Taric.configure! do |config|
  config.api_key = 'your_api_key'
end
# File lib/taric.rb, line 46
def configure!
  reset!
  yield(configuration)
end
reset!() click to toggle source

Resets global configuration. @see Taric::Configuration

# File lib/taric.rb, line 53
def reset!
  @configuration = Taric::Configuration.new
end