Class: BlizzardApi::Starcraft::Legacy

Inherits:

Request

• Object
• Request
• Request
• BlizzardApi::Starcraft::Legacy

Defined in:

lib/blizzard_api_rb/starcraft/community/legacy.rb

Overview

This class allows access to Starcraft II legacy data

You can get an instance of this class using the default region as follows:

api_instance = BlizzardApi::Starcraft.legacy

See Also:

• https://develop.battle.net/documentation/api-reference/starcraft-2-game-data-api

Constant Summary

Constants inherited from Request

Request::SC_REGION

Constants inherited from Request

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

Constants included from ApiStandards

ApiStandards::BASE_URLS

Instance Attribute Summary

Attributes inherited from Request

#mode, #region

Instance Method Summary

• #achievements(region_id, **options) ⇒ Object

  Achievement data.

• #ladder(region_id, ladder_id, **options) ⇒ Object

  Ladder.

• #ladders(region_id, realm_id, profile_id, **options) ⇒ Object

  Ladders.

• #match(region_id, realm_id, profile_id, **options) ⇒ Object

  Match History.

• #profile(region_id, realm_id, profile_id, **options) ⇒ Object

  Profile data.

• #rewards(region_id, **options) ⇒ Object

  Rewards data.

Methods inherited from Request

#initialize

Methods inherited from Request

#initialize

Constructor Details

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

Instance Method Details

#achievements(region_id, **options) ⇒ Object

Note:

This gem do not support nor will support China endpoints

Achievement data

Parameters:

• region_id (Symbol) —

  One of the valid Starcraft II regions :US, :EU, :KO, and :TW

• options (Hash) —

  You can specify some options

Options Hash (**options):

• :locale (String) —

  Overrides the default locale for a single call

• :namespace (String) —

  Overrides the default namespace for a single call

• :access_token (String) —

  Overrides the access_token for a single call

• :ignore_cache (Boolean) —

  If set to true the request will not use the cache

• :ttl (Integer) —

  Override the default time (in seconds) a request should be cached

• :since (DateTime) —

  Adds the If-modified-since headers. Will always ignore cache when set.

# File 'lib/blizzard_api_rb/starcraft/community/legacy.rb', line 69

def achievements(region_id, **options)
  reg = resolve_region(region_id)
  opts = { ttl: CACHE_DAY }.merge(options)
  api_request "#{base_url(:community)}/legacy/data/achievements/#{reg}", **opts
end

#ladder(region_id, ladder_id, **options) ⇒ Object

Note:

This gem do not support nor will support China endpoints

Ladder

Parameters:

• region_id (Symbol) —

  One of the valid Starcraft II regions :US, :EU, :KO, and :TW

• ladder_id (Integer) —

  Ladder ID

• options (Hash) —

  You can specify some options

Options Hash (**options):

• :locale (String) —

  Overrides the default locale for a single call

• :namespace (String) —

  Overrides the default namespace for a single call

• :access_token (String) —

  Overrides the access_token for a single call

• :ignore_cache (Boolean) —

  If set to true the request will not use the cache

• :ttl (Integer) —

  Override the default time (in seconds) a request should be cached

• :since (DateTime) —

  Adds the If-modified-since headers. Will always ignore cache when set.

# File 'lib/blizzard_api_rb/starcraft/community/legacy.rb', line 58

def ladder(region_id, ladder_id, **options)
  reg = resolve_region(region_id)
  opts = { ttl: CACHE_DAY }.merge(options)
  api_request "#{base_url(:community)}/legacy/ladder/#{reg}/#{ladder_id}", **opts
end

#ladders(region_id, realm_id, profile_id, **options) ⇒ Object

Note:

This gem do not support nor will support China endpoints

Ladders

Parameters:

• region_id (Symbol) —

  One of the valid Starcraft II regions :US, :EU, :KO, and :TW

• realm_id (Integer) —

  Realm ID

• profile_id (Integer) —

  Profile ID

• options (Hash) —

  You can specify some options

Options Hash (**options):

• :locale (String) —

  Overrides the default locale for a single call

• :namespace (String) —

  Overrides the default namespace for a single call

• :access_token (String) —

  Overrides the access_token for a single call

• :ignore_cache (Boolean) —

  If set to true the request will not use the cache

• :ttl (Integer) —

  Override the default time (in seconds) a request should be cached

• :since (DateTime) —

  Adds the If-modified-since headers. Will always ignore cache when set.

# File 'lib/blizzard_api_rb/starcraft/community/legacy.rb', line 33

def ladders(region_id, realm_id, profile_id, **options)
  reg = resolve_region(region_id)
  opts = { ttl: CACHE_DAY }.merge(options)
  api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}/ladder ", **opts
end

#match(region_id, realm_id, profile_id, **options) ⇒ Object

Note:

This gem do not support nor will support China endpoints

Match History

Parameters:

• region_id (Symbol) —

  One of the valid Starcraft II regions :US, :EU, :KO, and :TW

• realm_id (Integer) —

  Realm ID

• profile_id (Integer) —

  Profile ID

• options (Hash) —

  You can specify some options

Options Hash (**options):

• :locale (String) —

  Overrides the default locale for a single call

• :namespace (String) —

  Overrides the default namespace for a single call

• :access_token (String) —

  Overrides the access_token for a single call

• :ignore_cache (Boolean) —

  If set to true the request will not use the cache

• :ttl (Integer) —

  Override the default time (in seconds) a request should be cached

• :since (DateTime) —

  Adds the If-modified-since headers. Will always ignore cache when set.

# File 'lib/blizzard_api_rb/starcraft/community/legacy.rb', line 46

def match(region_id, realm_id, profile_id, **options)
  reg = resolve_region(region_id)
  opts = { ttl: CACHE_DAY }.merge(options)
  api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}/matches", **opts
end

#profile(region_id, realm_id, profile_id, **options) ⇒ Object

Note:

This gem do not support nor will support China endpoints

Profile data

Parameters:

• region_id (Symbol) —

  One of the valid Starcraft II regions :US, :EU, :KO, and :TW

• realm_id (Integer) —

  Realm ID

• profile_id (Integer) —

  Profile ID

• options (Hash) —

  You can specify some options

Options Hash (**options):

• :locale (String) —

  Overrides the default locale for a single call

• :namespace (String) —

  Overrides the default namespace for a single call

• :access_token (String) —

  Overrides the access_token for a single call

• :ignore_cache (Boolean) —

  If set to true the request will not use the cache

• :ttl (Integer) —

  Override the default time (in seconds) a request should be cached

• :since (DateTime) —

  Adds the If-modified-since headers. Will always ignore cache when set.

# File 'lib/blizzard_api_rb/starcraft/community/legacy.rb', line 20

def profile(region_id, realm_id, profile_id, **options)
  reg = resolve_region(region_id)
  opts = { ttl: CACHE_DAY }.merge(options)
  api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}", **opts
end

#rewards(region_id, **options) ⇒ Object

Note:

This gem do not support nor will support China endpoints

Rewards data

Parameters:

• region_id (Symbol) —

  One of the valid Starcraft II regions :US, :EU, :KO, and :TW

• options (Hash) —

  You can specify some options

Options Hash (**options):

• :locale (String) —

  Overrides the default locale for a single call

• :namespace (String) —

  Overrides the default namespace for a single call

• :access_token (String) —

  Overrides the access_token for a single call

• :ignore_cache (Boolean) —

  If set to true the request will not use the cache

• :ttl (Integer) —

  Override the default time (in seconds) a request should be cached

• :since (DateTime) —

  Adds the If-modified-since headers. Will always ignore cache when set.

# File 'lib/blizzard_api_rb/starcraft/community/legacy.rb', line 80

def rewards(region_id, **options)
  reg = resolve_region(region_id)
  opts = { ttl: CACHE_DAY }.merge(options)
  api_request "#{base_url(:community)}/legacy/data/rewards/#{reg}", **opts
end