Module: VaingloryAPI

Defined in:

lib/vainglory_api.rb,
lib/vainglory_api/client.rb,
lib/vainglory_api/region.rb,
lib/vainglory_api/version.rb

Overview

A Ruby libary wrapper for the Vainglory API

Author:

• Chet Bortz

Defined Under Namespace

Classes: Client, Region, RegionNameError

Constant Summary

VERSION =

Current gem version

'0.1.0'.freeze

RELEASE_DATE =

Release date of current version

'2017-06-16'.freeze

Class Method Summary

• .new(api_key, region) ⇒ VaingloryAPI::Client

  Alias for VaingloryAPI::Client constructor.

Class Method Details

.new(api_key, region) ⇒ VaingloryAPI::Client

Alias for VaingloryAPI::Client constructor

Examples:

Initialize a new client

client = VaingloryAPI.new('API_KEY', 'na')

Parameters:

• api_key (String) —

  your Vainglory API key

• region (String) —

  the short name for your specified Region shard

Returns:

• (VaingloryAPI::Client) —

  an instance of the client

See Also:

• VaingloryAPI::Client#initialize

# File 'lib/vainglory_api.rb', line 17

def new(*args)
  Client.new(*args)
end