Class: MLB::SportPlayers

Inherits:
Shale::Mapper
  • Object
show all
Defined in:
lib/mlb/sport_players.rb

Overview

Provides methods for fetching players for a sport from the API

Class Method Summary collapse

Class Method Details

.all(season: nil, sport: Utils::DEFAULT_SPORT_ID) ⇒ Array<Player>

Retrieves all players for a sport

Examples:

Get all MLB players for a season

MLB::SportPlayers.all(season: 2024)

Get all players with a sport object

MLB::SportPlayers.all(season: 2024, sport: Sport.new(id: 1))

Parameters:

  • season (Integer, nil) (defaults to: nil) —

    the season year (defaults to current year)

  • sport (Integer, Sport) (defaults to: Utils::DEFAULT_SPORT_ID) —

    the sport ID or Sport object

Returns:

  • (Array<Player>) —

    the players



23
24
25
26
27
28
 
# File 'lib/mlb/sport_players.rb', line 23

def self.all(season: nil, sport: Utils::DEFAULT_SPORT_ID)
  season ||= Utils.current_season
  sport_id = Utils.extract_id(sport)
  response = CLIENT.get("sports/#{sport_id}/players?#{Utils.build_query(season:)}")
  from_json(response).people
end