sjtipton / pro_football_api

API containing datapoints for NFL Teams, schedules, stats and more

Pro Football API

Getting Started

Install the dependencies outlined in the Gemfile

bundle install

Setup the database in one step from the schema and seed with 32 teams

bundle exec rake db:setup

Or, if you like to do things step-by-step...

# Create the database
bundle exec rake db:create

# Run migrations on development and test
bundle exec rake db:migrate
bundle exec rake db:migrate RACK_ENV=test

# Seed the database with 32 teams
bundle exec rake db:seed

Create a User with an API token for accessing the API

u = User.new(email: "[e-mail]")
u.skip_confirmation!
u.save

u.authentication_token
# => "your_api_token"

# Use this token to access the API via the auth_token query param

Run the rake task that will build 256 matchups (an undated schedule).

bundle exec rake db:game:build_all_matchups

This will get the Game resource setup such that you can update each game with the played_at and week attribute values when the official schedule is released. The data that is utilized in this task is a JSON-formatted array of hashes containing the home opponents for each team, as well as the home stadium name. This is designed so that each season when the next season's opponents for each team are released, the JSON opponents array can be updated for each team and rake task re-run.

Updating matchups with dates and times

The below mentioned rake task provides a way to update each Game with :week and :played_at attribute values.

It may be important to update each development environment with the following, as some data has been corrected in the text file that generates the JSON file:

# Open a Rails Console session
rails console

# Delete all existing Games and reset sequences
Game.delete_all
ActiveRecord::Base.connection.reset_pk_sequence!('games')

# Close the console session and return to the command line to run both rake tasks
bundle exec rake db:game:build_all_matchups
bundle exec rake db:game:update_matchups_with_dates_and_times

Writing future schedules

This has already been created for the current rake task

The data for the schedule has been built with a text file containing an array of hashes. Future schedules can use this format to generate the schedule. The file is located in /lib/tasks/nfl_schedule.txt. To generate future JSON files based off future schedules, do the following:

# Open interactive editor within a Rails Console session and set the data hash in the text file to a `@data` instance variable, then write and quit

# Generate the JSON file
file = File.open("#{Rails.root}/lib/tasks/schedule_dates_and_times.json", "w")
file.write @data.to_json
file.close

Example: Output an opponents list grouped by team (unordered, undated schedule)

The following code example will output a list of games grouped by team in an unordered state (assuming the schedule is yet to be released for the given season.

@team_ids = (1..32).to_a
@team_ids.each do |id|
  @games = Game.where("away_team_id = ? or home_team_id = ?", id, id)
  @games.each do |g|
    ap "#{g.label}, #{g.stadium}"
  end
end