Module: NbaStats::HomePageLeaders

Included in:
Client
Defined in:
lib/nba_stats/stats/home_page_leaders.rb

Constant Summary collapse

HOME_PAGE_LEADERS_PATH =

The path of the homepageleaders API

'/stats/homepageleaders'

Instance Method Summary collapse

Instance Method Details

#home_page_leaders(season, game_scope = NbaStats::Constants::GAME_SCOPE_SEASON, stat_category = NbaStats::Constants::STAT_CATEGORY_POINTS, player_scope = NbaStats::Constants::PLAYER_SCOPE_ALL_PLAYERS, player_or_team = NbaStats::Constants::PLAYER_OR_TEAM_PLAYER, season_type = NbaStats::Constants::SEASON_TYPE_REGULAR, league_id = NbaStats::Constants::LEAGUE_ID_NBA) ⇒ NbaStats::Resources::HomePageLeaders

Calls the homepageleaders API and returns a HomePageLeaders resource.

Parameters:

  • season (String)
  • season_type (String) (defaults to: NbaStats::Constants::SEASON_TYPE_REGULAR)
  • league_id (String) (defaults to: NbaStats::Constants::LEAGUE_ID_NBA)
  • game_scope (String) (defaults to: NbaStats::Constants::GAME_SCOPE_SEASON)
  • stat_category (String) (defaults to: NbaStats::Constants::STAT_CATEGORY_POINTS)
  • player_scope (String) (defaults to: NbaStats::Constants::PLAYER_SCOPE_ALL_PLAYERS)
  • player_or_team (String) (defaults to: NbaStats::Constants::PLAYER_OR_TEAM_PLAYER)

Returns:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/nba_stats/stats/home_page_leaders.rb', line 20

def home_page_leaders(
    season,
    game_scope=NbaStats::Constants::GAME_SCOPE_SEASON,
    stat_category=NbaStats::Constants::STAT_CATEGORY_POINTS,
    player_scope=NbaStats::Constants::PLAYER_SCOPE_ALL_PLAYERS,
    player_or_team=NbaStats::Constants::PLAYER_OR_TEAM_PLAYER,
    season_type=NbaStats::Constants::SEASON_TYPE_REGULAR,
    league_id=NbaStats::Constants::LEAGUE_ID_NBA
)
  NbaStats::Resources::HomePageLeaders.new(
    get(HOME_PAGE_LEADERS_PATH, {
        :Season => season,
        :SeasonType => season_type,
        :LeagueID => league_id,
        :GameScope => game_scope,
        :StatCategory => stat_category,
        :PlayerScope => player_scope,
        :PlayerOrTeam => player_or_team
    })
  )
end