Module: HalcyonAPI

Defined in:

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

Overview

A Ruby libary wrapper for the Vainglory API

Author:

• Ethan Tang

Defined Under Namespace

Classes: Client, Region, RegionNameError

Constant Summary

VERSION =

Current gem version

'0.0.5'.freeze

RELEASE_DATE =

Release date of current version

'2018-02-05'.freeze

Class Method Summary

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

  Alias for VaingloryAPI::Client constructor.

Class Method Details

.new(api_key, region) ⇒ HalcyonAPI::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

Parameters:

• api_key (String) —

  your Vainglory API key

• region_identifier (String) —

  the name or short name for your specified Region shard

Returns:

• (HalcyonAPI::Client) —

  an instance of the client

See Also:

• VaingloryAPI::Client#initialize

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

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