Class: BlizzardApi::Wow::GenericDataEndpoint

Inherits:

Request

• Object
• Request
• Request
• BlizzardApi::Wow::GenericDataEndpoint

Defined in:

lib/blizzard_api_rb/wow/game_data/generic_data_endpoint.rb

Overview

Generic endpoint to support most data requests with minor configurations

Direct Known Subclasses

Achievement, AzeriteEssence, ConnectedRealm, Covenant, Creature, GuildCrest, Heirloom, Item, Journal, Media, ModifiedCrafting, Mount, MythicKeystone, MythicKeystoneAffix, Pet, PlayableClass, PlayableRace, PlayableSpecialization, PowerType, Profession, PvpRegion, PvpSeason, PvpTier, Quest, Realm, Region, Reputation, Spell, Talent, TechTalent, Title, Toy, WowToken

Constant Summary

Constants inherited from Request

Request::CACHE_DAY, Request::CACHE_HOUR, Request::CACHE_TRIMESTER

Constants included from ApiStandards

ApiStandards::BASE_URLS

Class Attribute Summary

• .endpoint ⇒ Object

  Returns the value of attribute endpoint.

• .namespace ⇒ Object

  Returns the value of attribute namespace.

• .ttl ⇒ Object

  Returns the value of attribute ttl.

Attributes inherited from Request

#mode, #region

Class Method Summary

• .setup(endpoint, namespace, ttl) ⇒ Object

Instance Method Summary

• #get(id, **options) ⇒ Hash

  Fetch all possible data for one of the items listed by the #index using its id.

• #index(**options) ⇒ Hash

  Fetch a list of all resources available for this endpoint.

Methods inherited from Request

#initialize

Methods inherited from Request

#initialize

Constructor Details

This class inherits a constructor from BlizzardApi::Wow::Request

Class Attribute Details

.endpoint ⇒ Object

Returns the value of attribute endpoint.

# File 'lib/blizzard_api_rb/wow/game_data/generic_data_endpoint.rb', line 9

def endpoint
  @endpoint
end

.namespace ⇒ Object

Returns the value of attribute namespace.

# File 'lib/blizzard_api_rb/wow/game_data/generic_data_endpoint.rb', line 9

def namespace
  @namespace
end

.ttl ⇒ Object

Returns the value of attribute ttl.

# File 'lib/blizzard_api_rb/wow/game_data/generic_data_endpoint.rb', line 9

def ttl
  @ttl
end

Class Method Details

.setup(endpoint, namespace, ttl) ⇒ Object

# File 'lib/blizzard_api_rb/wow/game_data/generic_data_endpoint.rb', line 11

def setup(endpoint, namespace, ttl)
  self.endpoint = endpoint
  self.namespace = namespace
  self.ttl = ttl
end

Instance Method Details

#get(id, **options) ⇒ Hash

Fetch all possible data for one of the items listed by the #index using its id

in the configuration module

Parameters:

• id (Integer) —

  One of the IDs returned by the #index

• options (Hash) —

  a customizable set of options

Options Hash (**options):

• :completed (Boolean) —

  Should return completed quests

Returns:

• (Hash) —

  API Response. The actual type of the returned object depends on the format option

# File 'lib/blizzard_api_rb/wow/game_data/generic_data_endpoint.rb', line 34

def get(id, **options)
  api_request "#{endpoint_uri}/#{id}", **default_options.merge(options)
end

#index(**options) ⇒ Hash

Fetch a list of all resources available for this endpoint

in the configuration module

Parameters:

• options (Hash) —

  a customizable set of options

Options Hash (**options):

• :completed (Boolean) —

  Should return completed quests

Returns:

• (Hash) —

  API Response. The actual type of the returned object depends on the format option

# File 'lib/blizzard_api_rb/wow/game_data/generic_data_endpoint.rb', line 23

def index(**options)
  api_request "#{endpoint_uri}/index", **default_options.merge(options)
end