module ESPN::Client::Athletes

Public: The mapping to the ATHLETES API of the ESPN developer API.

Examples

class Client
  include ESPN::Client::Athletes
end

Public Instance Methods

athlete(id, *args) click to toggle source

Public: Get a specific athlete from the ESPN API.

id - An id of an athlete. sport - A Symbol or String of the sport (optional). league - A Symbol or String of the league. If a league is passed, but

not a sport, an attempt will be made to map the league to a
sport (required).

opts - Hash options used to refine the selection. If sport and/or

league are passed in, they will override the mapped values
You can find a full list of options on the ESPN developer API
website (default: {}).

Returns a Hashie::Mash.

# File lib/espn/client/athletes.rb, line 26
def athlete(id, *args)
  arguments = ESPN::Arguments.new(args, {}, [:league])
  pattern = "sports/:sport/:league/athletes/#{id}"
  get(pattern, arguments.options).sports.first.leagues.first.athletes.first
end
athletes(*args) click to toggle source

Public: Get athlete stats and information from the ESPN API.

sport - A Symbol or String of the sport (optional). league - A Symbol or String of the league. If a league is passed, but

not a sport, an attempt will be made to map the league to a
sport (required).

opts - Hash options used to refine the selection. If sport and/or

league are passed in, they will override the mapped values
You can find a full list of options on the ESPN developer API
website (default: {}).

Returns an Array of Hashie::Mash.

# File lib/espn/client/athletes.rb, line 44
def athletes(*args)
  arguments = ESPN::Arguments.new(args, {}, [:league])
  pattern = "sports/:sport/:league/athletes"
  get(pattern, arguments.options).sports.first.leagues.first.athletes
end