class CLIENT

The CLIENT class makes requests to api.swgoh.api

Attributes

access_token[RW]

requester[RW]

Public Class Methods

new() click to toggle source

# File lib/SWGOH/API/CLIENT/client.rb, line 10
def initialize
  @access_token = nil
  @requester = REQUESTER.new
end

Public Instance Methods

abilities(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 82
def abilities(params = {})
  data_collection_request(SWGOH::API::COLLECTION::ABILITY, params)
end

authorize(username, password) click to toggle source

@param [String] username @param [String] password @return [String | nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 23
def authorize(username, password)
  response = @requester.auth_request(username, password)
  @access_token = response['access_token'] unless response.nil?
end

authorized?() click to toggle source

@return [Boolean]

# File lib/SWGOH/API/CLIENT/client.rb, line 16
def authorized?
  !@access_token.nil?
end

battle_environments(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 88
def battle_environments(params = {})
  data_collection_request(SWGOH::API::COLLECTION::BATTLE_ENVIRONMENT, params)
end

battle_targeting_rules(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 94
def battle_targeting_rules(params = {})
  data_collection_request(SWGOH::API::COLLECTION::BATTLE_TARGETING_RULE, params)
end

battles(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 76
def battles(params = {})
  request(SWGOH::API::PATH::BATTLES, params)
end

categories(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 100
def categories(params = {})
  data_collection_request(SWGOH::API::COLLECTION::CATEGORY, params)
end

challenge_styles(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 112
def challenge_styles(params = {})
  data_collection_request(SWGOH::API::COLLECTION::CHALLENGE_STYLE, params)
end

challenges(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 106
def challenges(params = {})
  data_collection_request(SWGOH::API::COLLECTION::CHALLENGE, params)
end

effects(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 118
def effects(params = {})
  data_collection_request(SWGOH::API::COLLECTION::EFFECT, params)
end

environment_collections(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 124
def environment_collections(params = {})
  data_collection_request(SWGOH::API::COLLECTION::ENVIRONMENT_COLLECTION, params)
end

equipment(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 130
def equipment(params = {})
  data_collection_request(SWGOH::API::COLLECTION::EQUIPMENT, params)
end

event_samples(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 136
def event_samples(params = {})
  data_collection_request(SWGOH::API::COLLECTION::EVENT_SAMPLING, params)
end

events(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 70
def events(params = {})
  request(SWGOH::API::PATH::EVENTS, params)
end

guild_exchange_items(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 142
def guild_exchange_items(params = {})
  data_collection_request(SWGOH::API::COLLECTION::GUILD_EXCHANGE_ITEM, params)
end

guild_raids(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 148
def guild_raids(params = {})
  data_collection_request(SWGOH::API::COLLECTION::GUILD_RAID, params)
end

guilds(ally_codes, params = {}) click to toggle source

@param [Array] ally_codes @param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 38
def guilds(ally_codes, params = {})
  ally_codes_request(SWGOH::API::PATH::GUILD, ally_codes, params)
end

help_entries(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 154
def help_entries(params = {})
  data_collection_request(SWGOH::API::COLLECTION::HELP_ENTRY, params)
end

materials(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 160
def materials(params = {})
  data_collection_request(SWGOH::API::COLLECTION::MATERIAL, params)
end

player_titles(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 166
def player_titles(params = {})
  data_collection_request(SWGOH::API::COLLECTION::PLAYER_TITLE, params)
end

players(ally_codes, params = {}) click to toggle source

@param [Array] ally_codes @param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 31
def players(ally_codes, params = {})
  ally_codes_request(SWGOH::API::PATH::PLAYER, ally_codes, params)
end

power_up_bundles(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 172
def power_up_bundles(params = {})
  data_collection_request(SWGOH::API::COLLECTION::POWER_UP_BUNDLE, params)
end

raid_configs(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 178
def raid_configs(params = {})
  data_collection_request(SWGOH::API::COLLECTION::RAID_CONFIG, params)
end

recipes(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 184
def recipes(params = {})
  data_collection_request(SWGOH::API::COLLECTION::RECIPE, params)
end

requirements(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 190
def requirements(params = {})
  data_collection_request(SWGOH::API::COLLECTION::REQUIREMENT, params)
end

rosters(ally_codes, params = {}) click to toggle source

@param [Array] ally_codes @param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 45
def rosters(ally_codes, params = {})
  ally_codes_request(SWGOH::API::PATH::ROSTER, ally_codes, params)
end

skills(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 196
def skills(params = {})
  data_collection_request(SWGOH::API::COLLECTION::SKILL, params)
end

squads(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 64
def squads(params = {})
  request(SWGOH::API::PATH::SQUADS, params)
end

starter_guilds(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 202
def starter_guilds(params = {})
  data_collection_request(SWGOH::API::COLLECTION::STARTER_GUILD, params)
end

stat_mod_sets(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 214
def stat_mod_sets(params = {})
  data_collection_request(SWGOH::API::COLLECTION::STAT_MOD_SET, params)
end

stat_mods(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 208
def stat_mods(params = {})
  data_collection_request(SWGOH::API::COLLECTION::STAT_MOD, params)
end

stat_progressions(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 220
def stat_progressions(params = {})
  data_collection_request(SWGOH::API::COLLECTION::STAT_PROGRESSION, params)
end

tables(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 226
def tables(params = {})
  data_collection_request(SWGOH::API::COLLECTION::TABLE, params)
end

targeting_sets(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 232
def targeting_sets(params = {})
  data_collection_request(SWGOH::API::COLLECTION::TARGETING_SET, params)
end

territory_battle_definitions(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 238
def territory_battle_definitions(params = {})
  data_collection_request(SWGOH::API::COLLECTION::TERRITORY_BATTLE_DEFINITION, params)
end

territory_war_definitions(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 244
def territory_war_definitions(params = {})
  data_collection_request(SWGOH::API::COLLECTION::TERRITORY_WAR_DEFINITION, params)
end

units(ally_codes, params = {}) click to toggle source

@param [Array] ally_codes @param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 52
def units(ally_codes, params = {})
  ally_codes_request(SWGOH::API::PATH::UNITS, ally_codes, params)
end

units_list(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 250
def units_list(params = {})
  data_collection_request(SWGOH::API::COLLECTION::UNIT, params)
end

unlock_announcement_defs(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 256
def unlock_announcement_defs(params = {})
  data_collection_request(SWGOH::API::COLLECTION::UNLOCK_ANNOUNCEMENT_DEFINITION, params)
end

war_definitions(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 262
def war_definitions(params = {})
  data_collection_request(SWGOH::API::COLLECTION::WAR_DEFINITION, params)
end

xp_tables(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 268
def xp_tables(params = {})
  data_collection_request(SWGOH::API::COLLECTION::XP_TABLE, params)
end

zetas(params = {}) click to toggle source

@param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 58
def zetas(params = {})
  request(SWGOH::API::PATH::ZETAS, params)
end

Private Instance Methods

ally_codes_request(path, ally_codes, params = {}) click to toggle source

@param [PATH] path @param [Array] ally_codes @param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 289
def ally_codes_request(path, ally_codes, params = {})
  request(path, params.merge({ allyCodes: ally_codes }))
end

data_collection_request(collection, params = {}) click to toggle source

@param [SWGOH::API::PATH::COLLECTION] collection @param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 296
def data_collection_request(collection, params = {})
  request(SWGOH::API::PATH::DATA, params.merge({ collection: collection }))
end

request(path, params = {}) click to toggle source

@param [PATH] path @param [Hash] params @return [JSON || nil]

# File lib/SWGOH/API/CLIENT/client.rb, line 279
def request(path, params = {})
  return unless authorized?

  @requester.request(@access_token, path, params)
end