Module: ESPN::Mapper

Included in:
Arguments
Defined in:
lib/espn/mapper.rb

Overview

Public: A module that handles mapping to make the ESPN API a little easier to digest.

Examples

class Client
  include ESPN::Mapper
end

Constant Summary collapse

LEAGUE_MAP =

Public: Map all common leagues to sports.

{
  baseball: %w(mlb college-baseball),
  basketball: %w(nba wnba mens-college-basketball womens-college-basketball),
  football: %w(nfl college-football),
  golf: %w(eur lpga pga sga web),
  hockey: %w(nhl mens-college-hockey womens-college-hockey),
  mma: %w(affliction bamma bfc ifl k1 lfc m1 mfc pancrase pride ringside
          sharkfights shooto shootobrazil shootojapan shoxc sfl strikeforce
          tpf ufc wec),
  racing: %w(irl sprint nationwide truck f1 nhra),
  soccer: %w(arg.1 uefa.champions fifa.world aut.1 bel.1 den.1 fra.1 ger.1
             ned.1 ita.1 nor.1 por.1 esp.1 swe.1 sui.1 tur.1 usa.1 usa.w.1
             mex.1 eng.1 eng.2 eng.3 eng.4 eng.5 eng.fa eng.worthington
             eng.trophy eng.charity uefa.uefa sco.1 sco.2 sco.3 sco.4
             sco.tennents sco.cis sco.challenge uefa.intertoto fifa.friendly
             uefa.worldq uefa.euroq fifa.confederations
             conmebol.libertadores concacaf.gold fifa.wwc fifa.worldq
             fifa.worldq.afc fifa.worldq.caf fifa.worldq.concacaf
             fifa.worldq.conmebol fifa.worldq.ofc fifa.worldq.uefa friendly
             usa.open fifa.friendly.w fifa.olympics fifa.olympicsq fifa.wyc
             uefa.euro intercontinental caf.nations fifa.w.olympicsq
             fifa.w.algarve esp.copa_del_rey conmebol.america
             fifa.w.olympics bra.1 chi.1 fra.2 ger.2 gre.1 ita.2 ned.2
             rus.1 esp.2 wal.1 irl.1 fra.coupe_de_la_ligue
             fra.coupe_de_france esp.super_cup nir.1 usa.misl
             conmebol.sudamericana uefa.super_cup aus.1 col.1 uru.1 per.1
             par.1 usa.ncaa.1 usa.ncaa.w.1 fifa.cwc ecu.1 ven.1 bol.1
             arg.urba ger.dfb_pokal ita.coppa_italia ned.cup rsa.1 rsa.2
             jpn.1 afc.champions afc.cup slv.1 crc.1 afc.cupq hon.1 gua.1
             aff.championship conmebol.sudamericano_sub20
             concacaf.champions_cup uefa.euro_u21 fifa.world.u20
             usa.world_series concacaf.superliga fifa.world.u17 concacaf.u23
             usa.usl.1 arg.2 col.2 uefa.euro.u19 concacaf.champions bra.2
             uru.2 arg.4 par.2 ven.2 arg.5 per.2 mex.2 chi.2 arg.3
             mex.interliga uefa.europa ecu.2 global.world_football_challenge
             uefa.carling eng.w.1 ger.super_cup ita.super_cup rug.irb.world
             panam.m panam.w arg.copa),
  tennis: %w(atp wta),
  boxing: %w(),
  olympics: %w(),
  :'horse-racing' => %w()
}

Instance Method Summary collapse

Instance Method Details

#extract_sport_and_league(args, opts = {}) ⇒ Object

Public: Get league and sport from args array. If sport or league is passed in the opts hash, they will override any mappings from the args Array.

args - The Array to extract the league and sport from. opts - The Hash that will override all mappings if possible.

Examples

extract_sport_and_league([:mlb])
# => 'baseball', 'mlb'

extract_sport_and_league(['horse-racing'])
# => 'horse-racing', ''

extract_sport_and_league(['baseball', 'mlb'], sport: 'basketball')
# => 'basketball', 'mlb'

Returns two Strings.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/espn/mapper.rb', line 120

def extract_sport_and_league(args, opts={})
  sport, league = opts[:sport], opts[:league]

  if args.size == 1 && league?(args[0])
    map = map_league_to_sport(args[0])
    sport ||= map[:sport].to_s
    league ||= map[:league].to_s
  elsif args.size == 1 && sport?(args[0])
    sport ||= args[0].to_s
    league ||= ''
  elsif !opts[:league].to_s.empty?
    map = map_league_to_sport(opts[:league])
    sport ||= map[:sport].to_s
  else
    sport ||= args[0].to_s || ''
    league ||= args[1].to_s || ''
  end

  return sport, league
end

#league?(test) ⇒ Boolean

Public: Determine if the test value is a valid league.

test - The String or Symbol to test.

Returns a Boolean.

Returns:

  • (Boolean) 


98
99
100
 
# File 'lib/espn/mapper.rb', line 98

def league?(test)
  LEAGUE_MAP.values.flatten.include?(test.to_s)
end

#map_league_to_sport(league) ⇒ Object

Public: Map a league to a sport.

league - The league (String or Symbol) to map to a sport.

Examples

map_league_to_sport(:nhl)
# => { league: 'nhl', sport: 'hockey' }
map_league_to_sport('mlb')
# => { league: 'mlb', sport: 'baseball' }
map_league_to_sport('some-random-league')
# => { league: 'some-random-league', sport: '' }

Returns a Hash.



71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/espn/mapper.rb', line 71

def map_league_to_sport(league)
  result = { league: league.to_s, sport: nil }

  LEAGUE_MAP.each do |sport, leagues|
    if leagues.include? result[:league]
      result[:sport] = sport.to_s
      break
    end
  end

  result
end

#sport?(test) ⇒ Boolean

Public: Determine if the value is a valid sport.

test - The String or Symbol to test.

Returns a Boolean.

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/espn/mapper.rb', line 89

def sport?(test)
  LEAGUE_MAP.keys.include?(test.to_sym)
end