sports_data_api 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62aab7aee23b0a730d1134d17519b149c0094327
-  data.tar.gz: f95759783b3b4d34a87f79db7e6e5be0d0ed414c
+  metadata.gz: daa6b600a49f7cc130a5a54f361dbd390340c145
+  data.tar.gz: 52f55a92b4e598cbbce507f82e24c49b7e2de667
 SHA512:
-  metadata.gz: 9152043f7a7d85ef9245dd0466f83d7f970d23c60a3a0ecb2007edda75623f01b3b7ec4781d2e16fd38aa010dbd90f1b7d6ba898d3148d8bd393ad8d018512b5
-  data.tar.gz: a2f99223b3092b2639a04ad843fd12e60f55af1388a3d937e550922e49bc6ae24f7457c9396c5d72ab35359815bc6452b4d73da1e57e59f742623a84793c3939
+  metadata.gz: 21fc4f3db62ace35e8261ac078e73afedcaef5849b0e81726fdf8a3bdc42b7dcdc6b54cb8b18ac6aada7434b21f53b5d129845e2b018b2f5203d2c1817a4f8e4
+  data.tar.gz: a76ab1ccea8466ca38bb448896f0c380355512ca38b309bd51ba1bf41e3665577f50636c7ca8daeefffbcd038d4acae93479574b2e974c4a6afec72c14e9d325

data/README.md

@@ -24,9 +24,9 @@ log](https://github.com/rlovelett/sports_data_api/issues).
   * [NBA](http://developer.sportsdatallc.com/docs/NBA_API)
   * [MLB](http://developer.sportsdatallc.com/docs/MLB_API)
   * [NHL](http://developer.sportsdatallc.com/docs/NHL_API)
+  * [NCAAMB](http://developer.sportsdatallc.com/docs/NCAAMB_API)
   * TODO
-    2. [NCAA Basketball](http://developer.sportsdatallc.com/docs/NCAA_Mens_Basketball)
-    3. [NCAA Football](http://developer.sportsdatallc.com/docs/NCAA_Football_API)
+    2. [NCAA Football](http://developer.sportsdatallc.com/docs/NCAA_Football_API)
 
 ## Installation
 
@@ -48,6 +48,55 @@ The specs for this Gem should give you some idea of how to make use of
 the API. For now they will be the usage information. As always Pull
 Requests for better documentation are welcome.
 
+### Example if you want to get weekly stats for a player.
+
+```ruby
+SportsDataApi.set_access_level(:nfl, '<YOUR ACCESS LEVEL HERE>')
+SportsDataApi.set_key(:nfl, '<YOUR API KEY HERE>')
+game_stats = SportsDataApi::Nfl.game_statistics(2014, :REG, 9, 'HOU', 'PHI')
+foster_stats = game_stats.home_team.players.select { |player| player['name'] === 'Arian Foster' }.first
+
+# foster_stats should now be a `Hash` containing something that looks like this:
+# {"id"=>"d89d2aef-c383-4ddf-bed8-3761aed35b10",
+#   "name"=>"Arian Foster",
+#   "jersey"=>23,
+#   "position"=>"RB",
+#   "touchdowns"=>{"pass"=>1, "rush"=>0, "int"=>0, "fum_ret"=>0, "punt_ret"=>0, "kick_ret"=>0, "fg_ret"=>0, "other"=>0},
+#   "rushing"=>
+#    {"att"=>15,
+#     "yds"=>56,
+#     "avg"=>3.733,
+#     "lg"=>18,
+#     "td"=>0,
+#     "fd"=>3,
+#     "fd_pct"=>20.0,
+#     "sfty"=>0,
+#     "rz_att"=>0,
+#     "fum"=>0,
+#     "yds_10_pls"=>2,
+#     "yds_20_pls"=>0,
+#     "yds_30_pls"=>0,
+#     "yds_40_pls"=>0,
+#     "yds_50_pls"=>0},
+#   "receiving"=>
+#    {"tar"=>3,
+#     "rec"=>2,
+#     "yds"=>63,
+#     "yac"=>63,
+#     "fd"=>1,
+#     "avg"=>31.5,
+#     "td"=>1,
+#     "lg"=>56,
+#     "rz_tar"=>0,
+#     "fum"=>0,
+#     "yds_10_pls"=>0,
+#     "yds_20_pls"=>0,
+#     "yds_30_pls"=>0,
+#     "yds_40_pls"=>0,
+#     "yds_50_pls"=>1},
+#   "first_downs"=>{"num"=>4, "pass"=>1, "rush"=>3, "pen"=>0}}
+```
+
 ## Testing
 
 The tests for the API have been mocked using [VCR](https://github.com/vcr/vcr) and [WebMock](https://github.com/bblimke/webmock).
@@ -61,7 +110,7 @@ However, if you want to refresh the actual server API responses you will need to
 This can be achieved simply by performing the following two steps:
 
 1. Delete all the cassettes (`rm spec/cassettes/*.yml`)
-2. Run specs passing the API key as environment variable (`SPORTS_DATA_<NFL|NBA|MLB|NHL>_API_KEY=realapikey bundle exec rake spec`)
+2. Run specs passing the API key as environment variable (`SPORTS_DATA_<NFL|NBA|MLB|NHL|NCAAMB>_API_KEY=realapikey bundle exec rake spec`)
 
 ## Contributing
 

data/lib/sports_data_api.rb

@@ -51,5 +51,6 @@ module SportsDataApi
   autoload :Nba,         File.join(LIBRARY_PATH, 'nba')
   autoload :Mlb,         File.join(LIBRARY_PATH, 'mlb')
   autoload :Nhl,         File.join(LIBRARY_PATH, 'nhl')
+  autoload :Ncaamb,      File.join(LIBRARY_PATH, 'ncaamb')
   autoload :Exception,   File.join(LIBRARY_PATH, 'exception')
 end

data/lib/sports_data_api/ncaamb.rb

@@ -0,0 +1,93 @@
+module SportsDataApi
+  module Ncaamb
+
+    class Exception < ::Exception
+    end
+
+    DIR = File.join(File.dirname(__FILE__), 'ncaamb')
+    BASE_URL = 'http://api.sportsdatallc.org/ncaamb-%{access_level}%{version}'
+    DEFAULT_VERSION = 3
+    SPORT = :ncaamb
+
+    autoload :Team, File.join(DIR, 'team')
+    autoload :Teams, File.join(DIR, 'teams')
+    autoload :Player, File.join(DIR, 'player')
+    autoload :Game, File.join(DIR, 'game')
+    autoload :Games, File.join(DIR, 'games')
+    autoload :Season, File.join(DIR, 'season')
+    autoload :Venue, File.join(DIR, 'venue')
+    autoload :Broadcast, File.join(DIR, 'broadcast')
+    autoload :TournamentList, File.join(DIR, 'tournament_list')
+    autoload :Tournament, File.join(DIR, 'tournament')
+    autoload :TournamentSchedule, File.join(DIR, 'tournament_schedule')
+    autoload :TournamentGame, File.join(DIR, 'tournament_game')
+
+    ##
+    # Fetches NCAAAMB season schedule for a given year and season
+    def self.schedule(year, season, version = DEFAULT_VERSION)
+      season = season.to_s.upcase.to_sym
+      raise SportsDataApi::Ncaamb::Exception.new("#{season} is not a valid season") unless Season.valid?(season)
+
+      response = self.response_xml(version, "/games/#{year}/#{season}/schedule.xml")
+
+      return Season.new(response.xpath("/league/season-schedule"))
+    end
+
+    # ##
+    # # Fetches NCAAMB team roster
+    def self.team_roster(team, version = DEFAULT_VERSION)
+      response = self.response_xml(version, "/teams/#{team}/profile.xml")
+
+      return Team.new(response.xpath("team"))
+    end
+
+    # ##
+    # # Fetches NCAAMB game summary for a given game
+    def self.game_summary(game, version = DEFAULT_VERSION)
+      response = self.response_xml(version, "/games/#{game}/summary.xml")
+
+      return Game.new(xml: response.xpath("/game"))
+    end
+
+    # ##
+    # # Fetches all NCAAMB teams
+    def self.teams(version = DEFAULT_VERSION)
+      response = self.response_xml(version, "/league/hierarchy.xml")
+
+      return Teams.new(response.xpath('/league'))
+    end
+
+    # ##
+    # # Fetches NCAAMB daily schedule for a given date
+    def self.daily(year, month, day, version = DEFAULT_VERSION)
+      response = self.response_xml(version, "/games/#{year}/#{month}/#{day}/schedule.xml")
+
+      return Games.new(response.xpath('league/daily-schedule'))
+    end
+
+    # Fetches NCAAAMB tournaments for a given year and season
+    def self.tournament_list(year, season, version = DEFAULT_VERSION)
+      season = season.to_s.upcase.to_sym
+      raise SportsDataApi::Ncaamb::Exception.new("#{season} is not a valid season") unless TournamentList.valid?(season)
+
+      response = self.response_xml(version, "/tournaments/#{year}/#{season}/schedule.xml")
+
+      return TournamentList.new(response.xpath("/league/season-schedule"))
+    end
+
+    def self.tournament_schedule(year, season, tournament_id, version = DEFAULT_VERSION)
+      response = self.response_xml(version, "/tournaments/#{tournament_id}/schedule.xml")
+      raise SportsDataApi::Ncaamb::Exception.new("#{season} is not a valid season") unless TournamentSchedule.valid?(season)
+
+      return TournamentSchedule.new(year, season, response.xpath("/league/tournament-schedule"))
+    end
+
+    private
+
+    def self.response_xml(version, url)
+      base_url = BASE_URL % { access_level: SportsDataApi.access_level(SPORT), version: version }
+      response = SportsDataApi.generic_request("#{base_url}#{url}", SPORT)
+      Nokogiri::XML(response.to_s).remove_namespaces!
+    end
+  end
+end

data/lib/sports_data_api/ncaamb/broadcast.rb

@@ -0,0 +1,14 @@
+module SportsDataApi
+  module Ncaamb
+    class Broadcast
+      attr_reader :network, :satellite
+      def initialize(xml)
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        if xml.is_a? Nokogiri::XML::Element
+          @network = xml['network']
+          @satellite = xml['satellite']
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/ncaamb/game.rb

@@ -0,0 +1,51 @@
+module SportsDataApi
+  module Ncaamb
+    class Game
+      attr_reader :id, :scheduled, :home, :home_team, :away,
+        :away_team, :status, :venue, :broadcast, :year, :season,
+        :date, :half, :clock
+
+      def initialize(args={})
+        xml = args.fetch(:xml)
+        @year = args[:year] ? args[:year].to_i : nil
+        @season = args[:season] ? args[:season].to_sym : nil
+        @date = args[:date]
+
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        if xml.is_a? Nokogiri::XML::Element
+          @id = xml['id']
+          @scheduled = Time.parse xml['scheduled']
+          @home = xml['home_team']
+          @away = xml['away_team']
+          @status = xml['status']
+          @clock = xml['clock']
+          @half = xml['half'] ? xml['half'].to_i : nil
+
+          team_xml = xml.xpath('team')
+          @home_team = Team.new(team_xml.first)
+          @away_team = Team.new(team_xml.last)
+          @venue = Venue.new(xml.xpath('venue'))
+          @broadcast = Broadcast.new(xml.xpath('broadcast'))
+        end
+      end
+
+      def summary
+        Ncaamb.game_summary(@id)
+      end
+
+      ##
+      # Wrapper for NCAAMB.pbp (NCAAMB.play_by_play)
+      # TODO
+      def pbp
+        raise NotImplementedError
+      end
+
+      ##
+      # Wrapper for NCAAMB.boxscore
+      # TODO
+      def boxscore
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/sports_data_api/ncaamb/games.rb

@@ -0,0 +1,26 @@
+module SportsDataApi
+  module Ncaamb
+    class Games
+      include Enumerable
+      attr_reader :games, :date
+
+      def initialize(xml)
+        @date = xml.first['date']
+        
+        @games = xml.xpath("games/game").map do |game_xml|
+          Game.new(date: @date, xml: game_xml)
+        end
+      end
+
+      def each &block
+        @games.each do |game|
+          if block_given?
+            block.call game
+          else
+            yield game
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/ncaamb/player.rb

@@ -0,0 +1,22 @@
+module SportsDataApi
+  module Ncaamb
+    class Player
+      attr_reader :stats
+
+      def initialize(xml)
+        if xml.is_a? Nokogiri::XML::Element
+          player_ivar = self.instance_variable_set("@#{xml.name}", {})
+          self.class.class_eval { attr_reader :"#{xml.name}" }
+          xml.attributes.each do | attr_name, attr_value|
+            player_ivar[attr_name.to_sym] = attr_value.value
+          end
+
+          stats_xml = xml.xpath('statistics')
+          if stats_xml.is_a? Nokogiri::XML::NodeSet and stats_xml.count > 0
+            @stats = SportsDataApi::Stats.new(stats_xml.first)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/ncaamb/season.rb

@@ -0,0 +1,28 @@
+module SportsDataApi
+  module Ncaamb
+    class Season
+      attr_reader :id, :year, :type, :games
+
+      def initialize(xml)
+        if xml.is_a? Nokogiri::XML::NodeSet
+          @id = xml.first["id"]
+          @year = xml.first["year"].to_i
+          @type = xml.first["type"].to_sym
+
+          @games = xml.first.xpath("games/game").map do |game_xml|
+            Game.new(year: @year, season: @type, xml: game_xml)
+          end
+        end
+      end
+
+      ##
+      # Check if the requested season is a valid
+      # NCAAMB season type.
+      #
+      # The only valid types are: :reg, :pst, :ct
+      def self.valid?(season)
+        [:REG, :PST, :CT].include?(season)
+      end
+    end
+  end
+end

data/lib/sports_data_api/ncaamb/team.rb

@@ -0,0 +1,40 @@
+module SportsDataApi
+  module Ncaamb
+    class Team
+      attr_reader :id, :name, :market, :alias, :conference, :division,
+                  :stats, :players, :points
+
+      def initialize(xml, conference = nil, division = nil)
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        if xml.is_a? Nokogiri::XML::Element
+          @id = xml['id']
+          @name = xml['name']
+          @market = xml['market']
+          @alias = xml['alias']
+          @points = xml['points'] ? xml['points'].to_i : nil
+          @conference = conference
+          @division = division
+          @players = xml.xpath("players/player").map do |player_xml|
+            Player.new(player_xml)
+          end
+        end
+      end
+
+      ##
+      # Compare the Team with another team
+      def ==(other)
+        # Must have an id to compare
+        return false if self.id.nil?
+
+        if other.is_a? SportsDataApi::Ncaamb::Team
+          return false if other.id.nil?
+          self.id === other.id
+        elsif other.is_a? Symbol
+          self.id.to_sym === other
+        else
+          super(other)
+        end
+      end
+    end
+  end
+end

data/lib/sports_data_api/ncaamb/teams.rb

@@ -0,0 +1,83 @@
+module SportsDataApi
+  module Ncaamb
+    class Teams
+      include Enumerable
+
+      attr_reader :conferences, :divisions
+
+      ##
+      # Initialize by passing the raw XML returned from the API
+      def initialize(xml)
+        @teams = []
+        xml = xml.first if xml.is_a? Nokogiri::XML::NodeSet
+        if xml.is_a? Nokogiri::XML::Element
+          xml.xpath('division').each do |division|
+            # Division ID, e.g., D1 or D2
+            dname = division['alias']
+
+            division.xpath('conference').each do |conference|
+              # conference ID, e.g., ATLANTIC, PACIFIC
+              cname = conference['alias']
+
+              # Create a new team
+              @teams << conference.xpath('team').map { |team| Team.new(team, cname, dname) }
+            end
+          end
+        end
+
+        @teams.flatten!
+
+        uniq_conferences = @teams.map { |team| team.conference.upcase }.uniq
+        @allowed_conferences = uniq_conferences.map { |str| str.to_sym }.concat(uniq_conferences.map { |str| str.downcase.to_sym })
+        @conferences = uniq_conferences.map { |conf| conf.to_sym }
+
+        uniq_divisions = @teams.map { |team| team.division.upcase }.uniq
+        @divisions =  @teams.map { |team| team.division.to_sym }.uniq
+        @allowed_divisions = uniq_divisions.map { |str| str.to_sym }.concat(uniq_divisions.map { |str| str.downcase.to_sym })
+      end
+
+      def [](search_index)
+        found_index = @teams.index(search_index)
+        unless found_index.nil?
+          @teams[found_index]
+        end
+      end
+
+      ##
+      #
+      def respond_to?(method)
+        @allowed_conferences.include?(method) || @allowed_divisions.include?(method)
+      end
+
+      ##
+      #
+      def method_missing(method)
+        if @allowed_conferences.include?(method)
+          return @teams.select do |team|
+            up = team.conference.upcase.to_sym
+            dw = team.conference.downcase.to_sym
+            up === method || dw === method
+          end
+        elsif @allowed_divisions.include?(method)
+          return @teams.select do |team|
+            up = team.division.upcase.to_sym
+            dw = team.division.downcase.to_sym
+            up === method || dw === method
+          end
+        end
+      end
+
+      ##
+      # Make the class Enumerable
+      def each(&block)
+        @teams.each do |team|
+          if block_given?
+            block.call team
+          else
+            yield team
+          end
+        end
+      end
+    end
+  end
+end