fantasy_football_nerd 0.9.0

data/README.md

@@ -0,0 +1,171 @@
+Fantasy Football Nerd API
+==========================
+
+This is a Ruby Gem for the [Fantasy Football Nerd API](http://www.fantasyfootballnerd.com/api).
+
+[Fantasy Football Nerd](http://www.fantasyfootballnerd.com) "takes the 'wisdom of the crowd' to a new level by aggregating the fantasy football rankings of the best fantasy football sites... and weighting the rankings based upon past accuracy."
+
+Fantasy Football Nerd provides an API with access to this fantasy football data:
+
+* Players List
+* Player Details (including recent articles)
+* Weekly Projections
+* Injury Reports
+* Preseason Draft Rankings (not currently supported)
+* Season Schedule (not currently supported)
+
+
+Full API access costs $9 for a season subsciption, though if you are a developer with a modicum of interest in Fantasy Football, this is the best $9 you will spend all season.
+
+
+Cache your data!
+----------------
+Take heed to the warning on the [Fantasy Football Nerd API page](http://www.fantasyfootballnerd.com):
+
+>The data does not generally change more than once or twice per day, so it becomes unnecessary to continually make the same calls. Please store the results locally and reference the cached responses... Your account may be suspended or API access revoked if you are found to be making excessive data calls.
+
+Seriously, FFN is not a big operation. Don't abuse their servers.
+
+Setup
+=================
+Install the gem:
+
+        gem install fantasy-football-nerd
+
+In plain ol' ruby, require it:
+
+````ruby
+require 'rubygems'
+require 'fantasy-football-nerd'
+````
+
+In rails, add the gem to your gemfile:
+
+````ruby
+gem 'fantasy-football-nerd'
+````
+
+Set your FFN APIKey before making any calls:
+
+````ruby
+FFNerd.api_key = 123456789
+````
+
+API Resources
+===================
+
+Currently, this gem provides access to four feeds:
+
+* Player List
+* Player Detail
+* Weekly Projections
+* Injuries
+
+Player List
+--------------------------
+
+````ruby
+FFNerd.player_list
+````
+
+Returns an array of players with attributes:
+
+````ruby
+player.player_id
+player.name
+player.position
+player.team
+````
+
+Player Detail
+------------------------------
+
+````ruby
+player = FFNerd.player_detail(id)
+````
+
+Returns a single player with attributes:
+````ruby
+player.id
+player.first_name
+player.last_name
+player.team
+player.position
+player.articles
+````
+
+<tt>player.articles</tt> is an array of articles:
+
+````ruby
+article = player.articles.first
+article.title
+article.source
+article.published
+````
+
+Projections
+---------------
+
+````ruby
+projections = FFNerd.projections(week)
+````
+
+Returns an array of players with attributes:
+````ruby
+player = projections.first
+player.id
+player.name
+player.team
+player.position
+player.rank
+player.projected_points #equivalent to player.projection.standard
+player.projection.week
+player.projection.standard
+player.projection.standard_low
+player.projection.standard_high
+player.projection.ppr
+player.projection.ppr_low
+player.projection.ppr_high
+````
+
+Injuries
+---------------------
+
+````ruby
+injuries = FFNerd.injuries(week)
+````
+
+Returns an array of players with attributes:
+
+````ruby
+player = injuries.first
+player.id
+player.name
+player.team
+player.position
+player.injury.week
+player.injury.injury_desc
+player.injury.practice_status_desc
+player.injury.game_status_desc
+player.injury.last_update
+````
+
+Still To Come
+------------------
+I'll be adding this in the near future:
+
+* Better error reporting
+* Schedule
+* Draft Rankings
+
+Tests
+------------------
+The gem includes extensive RSpec tests.
+
+Contributors
+-----------------
+This gem was created by:
+
+Greg Baugues ([greg@baugues.com](mailto:greg@baugues.com))
+
+

data/lib/fantasy_football_nerd.rb

@@ -0,0 +1,237 @@
+require 'nokogiri'
+require 'open-uri'
+require 'hashie'
+
+class FFNerd
+
+  BASE_URL = "http://api.fantasyfootballnerd.com"
+
+  #############################################################################
+  # URL Generators
+  # These methods generate the URLs that will be used for the API calls
+  # feed_url() does most of the heavy lifting
+  # the others are to make things easier on the developer
+  #############################################################################
+
+  def self.api_key
+    @@api_key
+  end
+
+  def self.api_key=(api_key)
+    @@api_key = api_key
+  end
+
+  def self.feed_url(feed, params = {} )
+    raise "api_key not set" if @@api_key.nil?
+    middle =
+      case feed
+      when :schedule        then 'ffnScheduleXML.php'
+      when :projections     then 'ffnSitStartXML.php'
+      when :injuries        then 'ffnInjuriesXML.php'
+      when :all_players     then 'ffnPlayersXML.php'
+      when :player          then 'ffnPlayerDetailsXML.php'
+      end
+    url = "#{BASE_URL}/#{middle}?apiKey=#{@@api_key}"
+    params.each { |key, value| url += "&#{key}=#{value}" }
+    url
+  end
+
+  def self.player_url(player_id)
+    feed_url(:player, 'playerId' => 13)
+  end
+
+  def self.projections_url(position, week)
+    position = position.to_s.upcase
+    feed_url(:projections, 'week' => week, 'position' => position)
+  end
+
+  def self.injuries_url(week)
+    feed_url(:injuries, 'week' => week)
+  end
+
+  def self.player_list_url
+    feed_url(:all_players)
+  end
+
+
+  #############################################################################
+  # Resource retreiver
+  # Connect to the API resource using the Url builders and Nokogiri
+  #############################################################################
+
+  def self.get_resource(url)
+    Nokogiri::HTML(open(url))
+  end
+
+  #############################################################################
+  # Player List
+  # Grabs a list of all players
+  #############################################################################
+
+
+  def self.player_list
+    players = []
+    url     = player_list_url
+    doc     = get_resource(url)
+    doc.css('player').each do |data|
+      player = Hashie::Mash.new
+      player.id = data.attr('playerid').to_i
+      player.name = data.attr('name')
+      player.position = data.attr('position')
+      player.team = data.attr('team')
+      players << player
+    end
+    players
+  end
+
+  #############################################################################
+  # Player Detail
+  # grabs player detail and related news articles
+  #############################################################################
+
+
+  def self.player_detail(player_id)
+    player = Hashie::Mash.new
+    url = player_url(player_id)
+    doc = get_resource(url)
+    player.first_name = doc.css('playerdetails firstname').text
+    player.last_name  = doc.css('playerdetails lastname').text
+    player.team       = doc.css('playerdetails team').text
+    player.position   = doc.css('playerdetails position').text
+    player.articles   = []
+    parse_articles(doc).each { |article| player.articles << article }
+    player
+  end
+
+  #used by self.player to get articles
+  def self.parse_articles(doc)
+    articles = []
+    doc.css('article').each do |data|
+      article = Hashie::Mash.new
+      article.title     = data.css('title').text
+      article.source    = data.css('source').text
+      article.published = Date.parse(data.css('published').text)
+      articles << article
+    end
+    articles
+  end
+
+  #############################################################################
+  # Projections
+  # retrieves weekly projections
+  #############################################################################
+
+  def self.projections(week, position = :all)
+    projections = []
+    position    = position.to_s.upcase
+    url         = projections_url(position, week)
+    doc         = get_resource(url)
+    doc.css('player').each do |data|
+      player = Hashie::Mash.new
+      player.name             = data.attr('name')
+      player.projected_points = data.attr('projectedpoints').to_f
+      player.team             = data.attr('team')
+      player.position         = data.attr('position')
+      player.id               = data.attr('playerid').to_i
+      player.rank             = data.attr('rank').to_i
+
+      #create and population player.projection
+      player.projection       = Hashie::Mash.new
+      player.projection.week  = data.attr('week').to_i
+      projections_map.each do |attribute, xml|
+        player.projection[attribute] = data.css("projections #{xml}").text.to_f
+      end
+
+      projections << player
+    end
+    projections
+  end
+
+  def self.projections_map
+    {
+      standard: 'standard',
+      standard_low: 'standardlow',
+      standard_high: 'standardhigh',
+      ppr: 'ppr',
+      ppr_low: 'pprlow',
+      ppr_high: 'pprhigh'
+    }
+  end
+
+  #############################################################################
+  # Injuries
+  # retrieves weekly injuries
+  #############################################################################
+
+
+  def self.injuries(week)
+    players = []
+    url = injuries_url(week)
+    doc = get_resource(url)
+    #puts doc.css('injury')
+    doc.css('injury').each do |data|
+      player = Hashie::Mash.new
+
+      injury_player_data_map.each do |attribute, xml|
+        player[attribute] = data.css(xml).text
+      end
+
+      player.injury = Hashie::Mash.new
+      injury_data_map.each do |attribute, xml|
+        player.injury[attribute] = data.css(xml).text
+      end
+
+      #convert to more appropriate data types
+      player.id  = player.id.to_i
+      player.injury.week  = player.injury.week.to_i
+      player.injury.last_update = Date.parse(player.injury.last_update)
+
+      players << player
+    end
+    players
+  end
+
+
+  def self.injury_data_map
+    {
+      week: 'week',
+      injury_desc: 'injurydesc',
+      practice_status_desc: 'practicestatusdesc',
+      game_status_desc: 'gamestatusdesc',
+      last_update: 'lastupdate'
+    }
+  end
+
+  def self.injury_player_data_map
+    {
+      id: 'playerid',
+      name: 'playername',
+      team: 'team',
+      position: 'position'
+    }
+  end
+
+  #############################################################################
+  # players
+  # The one method to rule them all
+  #############################################################################
+
+  def self.players(week, position = :all)
+    players = {}
+
+    FFNerd.projections(week).each do |player|
+      player.injured = false
+      players[player.id] = player
+    end
+
+    FFNerd.injuries(week).each do |player|
+      raise if players[player.id].nil?
+      players[player.id].injured = true
+      players[player.id].injury = player.injury
+    end
+
+    players.values
+  end
+
+
+end

data/spec/fantasy_football_nerd_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper.rb'
+require_relative '../lib/fantasy_football_nerd.rb'
+
+describe 'Fantasy Football Nerd Gem' do
+  before (:each) do
+    FFNerd.api_key = '123456789'
+  end
+
+  describe 'feed_url' do
+    it 'should generate a url for feeds with an api key' do
+      FFNerd.feed_url(:schedule).should       =~ /ffnScheduleXML.php/
+      FFNerd.feed_url(:projections).should    =~ /ffnSitStartXML.php/
+      FFNerd.feed_url(:injuries).should       =~ /ffnInjuriesXML.php/
+      FFNerd.feed_url(:all_players).should    =~ /ffnPlayersXML.php/
+      FFNerd.feed_url(:player).should         =~ /ffnPlayerDetailsXML.php/
+      FFNerd.feed_url(:schedule).should       =~ /apiKey=\d+/
+    end
+
+    it 'should take parameters' do
+      url = FFNerd.feed_url(:schedule, week: 12)
+      url.should =~ /&week=12/
+    end
+  end
+
+  #############################################################################
+  # Resource Retrieval Helpers
+  #############################################################################
+
+  describe 'url builders' do
+    it 'should get a url for details on a specific player' do
+      url = FFNerd.player_url(13)
+      url.should =~ /ffnPlayerDetailsXML.php\?apiKey=\d+&playerId=13/
+    end
+
+    it 'should get a url for a week\'s projections' do
+      url = FFNerd.projections_url(:all, 1)
+      url.should =~ /ffnSitStartXML.php\?apiKey=\d+&week=1&position=ALL/
+    end
+
+    it 'should get an injury url' do
+      url = FFNerd.injuries_url(1)
+      url.should =~ /ffnInjuriesXML.php\?apiKey=\d+&week=1/
+    end
+
+    it 'should get a list of all players' do
+      url = FFNerd.player_list_url
+      url.should =~ /ffnPlayersXML.php\?apiKey=\d+/
+    end
+  end
+
+
+  it 'should return a resource' do
+    VCR.use_cassette('player_list') do
+      url = FFNerd.player_list_url
+      FFNerd.get_resource(url).should be_true
+    end
+  end
+  #############################################################################
+  # Player Detail
+  #############################################################################
+
+  it 'should get player detail' do
+    VCR.use_cassette('player_detail') do
+      player = FFNerd.player_detail(13)
+      player.first_name.should == "Tom"
+      player.last_name.should  == "Brady"
+      player.team.should       == "NE"
+      player.position.should   == "QB"
+      player.articles.first.published.should == Date.new(2012, 8, 10)
+    end
+  end
+
+  it 'should get player articles' do
+    VCR.use_cassette('player_detail') do
+      url = FFNerd.player_url(13)
+      player_doc = FFNerd.get_resource(url)
+      articles = FFNerd.parse_articles(player_doc)
+      articles.should be_a Array
+      articles.first.title.should == "New England Patriots best New Orleans Saints, 7-6"
+      articles.first.source.should == "http://www.nfl.com/goto?id=0ap2000000048294"
+      articles.first.published.should == Date.new(2012, 8, 10)
+    end
+  end
+
+#############################################################################
+# Injuries
+#############################################################################
+
+  it 'should get player data from the injury feed' do
+    VCR.use_cassette('injuries') do
+      player = FFNerd.injuries(1).first
+      test_values(player,
+        id: 1242,
+        name: 'Alfonso Smith',
+        team: 'ARI',
+        position: 'RB'
+      )
+    end
+  end
+
+  it 'should get injury data from the injury feed' do
+    VCR.use_cassette('injuries') do
+      player = FFNerd.injuries(1).first
+      test_values(player.injury,
+        week: 1,
+        injury_desc: 'Hamstring',
+        practice_status_desc: 'Full Practice',
+        game_status_desc: 'Good chance to play',
+        last_update: Date.parse('2011-09-12')
+      )
+    end
+  end
+
+#############################################################################
+# Player List
+#############################################################################
+
+  it 'player_list should return player data' do
+    VCR.use_cassette('player_list') do
+      players = FFNerd.player_list
+      players.size.should == 1170
+      test_values(players.first,
+        name: "Derek Anderson",
+        position: "QB",
+        team: "CAR",
+        id: 2
+      )
+    end
+  end
+
+#############################################################################
+# Projections
+#############################################################################
+
+  it 'should retrieve player data from the projection feed' do
+    VCR.use_cassette('projections') do
+      projections = FFNerd.projections(3, :all)
+      player = projections.first
+      test_values(player,
+        name:             "Ray Rice",
+        projected_points: 19.60,
+        team:             "BAL",
+        position:         "RB",
+        id:               269,
+        rank:             1
+      )
+    end
+  end
+
+  it 'should retrieve projection data from the projection feed' do
+    VCR.use_cassette('projections') do
+      player = FFNerd.projections(3).first
+      test_values(player.projection,
+        week:             3,
+        standard:         19.60,
+        standard_low:     15.60,
+        standard_high:    27.20,
+        ppr:              22.10,
+        ppr_low:          18.25,
+        ppr_high:         31.20
+      )
+    end
+  end
+
+#############################################################################
+# Master Player Method
+# Combines injury and projection data into a single call
+#############################################################################
+
+  describe 'Master Player Method' do
+
+    it 'should combine injury and projection data' do
+      with_stub_feeds do
+        player = FFNerd.players(1).first
+        player.position.should == 'RB'
+        player.injured.should be_true
+        player.projection.standard.should == 26
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: fantasy_football_nerd
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Greg Baugues
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fantasy Football Nerd API wrapper
+email: greg@baugues.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/fantasy_football_nerd.rb
+- spec/fantasy_football_nerd_spec.rb
+homepage: http://www.baugues.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: fantasy_football_nerd
+rubygems_version: 1.8.18
+signing_key: 
+specification_version: 3
+summary: Fantasy Football Nerd API wrapper
+test_files: []