Module: NBA::FranchiseLeaders

Defined in:
lib/nba/franchise_leaders.rb

Overview

Provides methods to retrieve franchise leaders

Constant Summary collapse

RESULTS =

Result set name for franchise leaders

Returns:

  • (String) —

    the result set name

"FranchiseLeaders".freeze

Class Method Summary collapse

Class Method Details

.find(team:, league: League::NBA, client: CLIENT) ⇒ FranchiseLeader?

Retrieves franchise leaders for a team

Examples:

leader = NBA::FranchiseLeaders.find(team: NBA::Team::GSW)
puts "Points: #{leader.pts_player_name} (#{leader.pts})"

Parameters:

  • team (Integer, Team) —

    the team ID or Team object

  • league (String, League) (defaults to: League::NBA) —

    the league ID or League object (default NBA)

  • client (Client) (defaults to: CLIENT) —

    the API client to use

Returns:



22
23
24
25
26
27
28
 
# File 'lib/nba/franchise_leaders.rb', line 22

def self.find(team:, league: League::NBA, client: CLIENT)
  team_id = extract_team_id(team)
  league_id = Utils.extract_league_id(league)
  path = "franchiseleaders?TeamID=#{team_id}&LeagueID=#{league_id}"
  response = client.get(path)
  parse_response(response)
end