Class: MLB::Leagues

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

Overview

Collection of leagues from the MLB Stats API

Class Method Summary collapse

Class Method Details

.all(sport: Utils::DEFAULT_SPORT_ID) ⇒ Array<League>

Retrieves all leagues

Examples:

MLB::Leagues.all

Parameters:

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

    the sport ID or Sport object

Returns:

  • (Array<League>) —

    list of all leagues



16
17
18
19
20
 
# File 'lib/mlb/leagues.rb', line 16

def self.all(sport: Utils::DEFAULT_SPORT_ID)
  params = {sportId: Utils.extract_id(sport)}
  response = CLIENT.get("leagues?#{Utils.build_query(params)}")
  from_json(response).leagues.sort
end

.find(league, sport: Utils::DEFAULT_SPORT_ID) ⇒ League?

Finds a league by ID

Examples:

MLB::Leagues.find(103)

Parameters:

  • league (Integer, League) —

    the league ID or League object

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

    the sport ID or Sport object

Returns:

  • (League, nil) —

    the league if found



30
31
32
33
34
 
# File 'lib/mlb/leagues.rb', line 30

def self.find(league, sport: Utils::DEFAULT_SPORT_ID)
  params = {sportId: Utils.extract_id(sport)}
  response = CLIENT.get("leagues/#{Utils.extract_id(league)}?#{Utils.build_query(params)}")
  from_json(response).leagues.min_by { |l| l.sort_order || 0 }
end