Class: MLB::Awards

Inherits:

Shale::Mapper

• Object
• Shale::Mapper
• MLB::Awards

Defined in:

lib/mlb/awards.rb

Overview

Provides methods for fetching MLB awards from the API

Class Method Summary

• .all ⇒ Array<Award>

  Retrieves all awards.

• .find(award) ⇒ Award^?

  Finds a single award by ID or Award object.

Class Method Details

.all ⇒ Array<Award>

Retrieves all awards

Examples:

MLB::Awards.all #=> [#<MLB::Award>, ...]

Returns:

• (Array<Award>) —

  the sorted list of awards

# File 'lib/mlb/awards.rb', line 15

def self.all
  response = CLIENT.get("awards")
  from_json(response).awards.sort
end

.find(award) ⇒ Award^?

Finds a single award by ID or Award object

Examples:

MLB::Awards.find("MLBHOF") #=> #<MLB::Award>

Parameters:

• award (Award, String) —

  the award or award ID

Returns:

• (Award, nil) —

  the found award or nil

# File 'lib/mlb/awards.rb', line 27

def self.find(award)
  target_id = Utils.extract_id(award)
  all.find { |a| a.id.eql?(target_id) }
end