Class: BlizzardApi::Starcraft::Profile

Inherits:
Request show all
Defined in:
lib/blizzard_api/starcraft/community/profile.rb

Overview

This class allows access to Starcraft II profile data

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

api_instance = BlizzardApi::Starcraft.profile

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 collapse

Methods inherited from Request

#initialize

Methods inherited from Request

#initialize

Constructor Details

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

Instance Method Details

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

Note:

This gem do not support nor will support China endpoints

Ladder 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.



69
70
71
72
73
# File 'lib/blizzard_api/starcraft/community/profile.rb', line 69

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

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

Note:

This gem do not support nor will support China endpoints

Ladder summary

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.



56
57
58
59
60
# File 'lib/blizzard_api/starcraft/community/profile.rb', line 56

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

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

Note:

This gem do not support nor will support China endpoints

Metadata

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.



30
31
32
33
34
# File 'lib/blizzard_api/starcraft/community/profile.rb', line 30

def (region_id, realm_id, profile_id, **options)
  reg = resolve_region(region_id)
  opts = { ttl: CACHE_DAY }.merge(options)
  api_request "#{base_url(:community)}/metadata/profile/#{reg}/#{realm_id}/#{profile_id}", **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.



43
44
45
46
47
# File 'lib/blizzard_api/starcraft/community/profile.rb', line 43

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)}/profile/#{reg}/#{realm_id}/#{profile_id}", **opts
end

#static(region_id, **options) ⇒ Object

Note:

This gem do not support nor will support China endpoints

Static profile 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.



18
19
20
21
# File 'lib/blizzard_api/starcraft/community/profile.rb', line 18

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