Module: ArmoryApi::Client::Character

Included in:

ArmoryApi::Client

Defined in:

lib/armory_api/client/character.rb

Instance Method Summary

• #character(name, realm = nil, fields = []) ⇒ Hash

  Retrieves a character from the Armory.

Instance Method Details

#character(name, realm = nil, fields = []) ⇒ Hash

Retrieves a character from the Armory

Parameters:

• name (String)
• realm (String) (defaults to: nil)
• fields (Array) (defaults to: []) —

  optional fields, a list can be found on the [official page](blizzard.github.com/api-wow-docs/#character-profile-api)

Returns:

• (Hash) —

  the character hash

Raises:

• (ArmoryApi::RealmNotFound)

# File 'lib/armory_api/client/character.rb', line 14

def character(name, realm=nil, fields=[])
  if realm.class == Array
    fields = realm
    realm = nil
  end
  realm ||= @realm
  raise ArmoryApi::RealmNotFound if realm.nil?
  fields ||= []
  params = { fields: fields.join(',') } unless fields.empty?
  get("/api/wow/character/#{realm}/#{URI.escape(name)}", params)
end