stattleship-ruby 0.1.19

data/bin/total_team_stat

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'stattleship'
+
+params = Stattleship::Params::BasketballTotalTeamStatParams.new
+params.stat = 'free_throws_attempted'
+params.team_id = 'nba-gs'
+
+puts Stattleship::BasketballTotalTeamStat.fetch(params: params).to_sentence
+
+params = Stattleship::Params::FootballTotalTeamStatParams.new
+params.stat = 'passing_touchdowns'
+params.team_id = 'nfl-ne'
+
+puts Stattleship::FootballTotalTeamStat.fetch(params: params).to_sentence
+
+params = Stattleship::Params::HockeyTotalTeamStatParams.new
+params.stat = 'shots'
+params.team_id = 'nhl-bos'
+
+puts Stattleship::HockeyTotalTeamStat.fetch(params: params).to_sentence

data/examples/README.md

@@ -0,0 +1,118 @@
+# Examples
+
+Making Stattleship API calls is dead simple.
+
+* Build and set parameters
+* Use that to fetch data
+* Use fully populated PORO's
+
+The pattern is pretty much as follows:
+
+```
+query_params = Stattleship::Params::BasketballGameLogsParams.new
+query_params.player_id = 'nba-stephen-curry'
+query_params.since = '1 week ago'
+game_logs = Stattleship::BasketballGameLogs.fetch(params: query_params)
+pp game_logs.first
+```
+
+**That's it.**
+
+Just repeat for other sports (ie, `HockeyGameLogsParams` and `HockeyGameLogs`) or other endpoints (`FootballPlayersParams` and `FootballPlayers`) etc.
+
+The `fetch` call will automatically traverse the paginated response and you'll get easy to use PORO's of data specific to that model.
+
+There's validation, too, on the params to make sure you set just the ones it accepts. Ie, you can't make a call to `FootballPlayers` with a player that whose slug doesn't start with `nfl-` and things like that.
+
+## Prerequisites
+
+You'll need
+
+* Stattleship API Access Token from https://www.stattleship.com
+* Set that in your `.env` file as `STATTLESHIP_ACCESS_TOKEN=your_token`
+* To run examples, that .env file should be the the `/examples` dir.
+* Copy the `sample.env` file, insert your token and save as `examples/.env`
+* The `cd` to the `/examples` directory and `ruby <example>.rb` such that the .env loads
+
+## Code
+
+* [Basketball Game Logs](basketball_game_logs.rb)
+  * Uses `BasketballGameLogsParams` and makes a `BasketballGameLogs` request
+  * Use the `player_id` and `since` parameters to get Stephen Curry's game logs for the past week
+
+* [Football Game Logs](basketball_game_logs.rb)
+  * Uses `FootballGameLogsParams` and makes a `FootballGameLogs` request
+  * Use the `player_id`, `inteval_type` and `since` parameters to get Cam Newton's game logs for the past weeks by specifying the interval type (divisionplayoffs, conferencechampionships, etc)
+
+* [Hockey Games](hockey_games.rb)
+  * Uses `HockeyGamesParams` and makes a `HockeyGames` request
+  * Uses the `status` and `since` parameters to return ended Chicago Blackhawk games
+  * Demonstrates `started_at` is a proper DateTime and renders `scoreline`s
+
+* [Football Feats](football_feats.rb)
+  * Uses `FootballFeatsParams` and makes a `FootballFeats` request
+  * Uses `player_id` and `level_up` parameters to return Cam Newton regular season accomplishments
+
+* [Basketball Injuries](basketball_injuries.rb)
+  * Uses `BasketballInjuriesParams` and makes a `BasketballInjuries` request
+  * Use the `team_id` and `since` to get Spurs injuries and show the injury note and its injury location (knee, back, etc)
+
+* [Hockey Penalties](hockey_penalties.rb)
+  * Uses `HockeyPenaltiesParams` and makes a `HockeyPenalties` request
+  * Uses the `status` and `since` parameters to return penalties for ended Buffalo Sabres games in last 2 weeks
+  * Demonstrates `minutes` is a proper Integer and renders a friendly-readable sentence describing the penalty
+
+* [Football Players](football_players.rb)
+  * Uses `FootballPlayersParams` and makes a `FootballPlayers` request
+  * Uses `team_id` and `level_up` parameters to return Denver Broncos players
+  * Demonstrates ability to filter and sort on a numeric `salary` to get list of players making more than $5M and where they went to `school`
+
+* [Hockey Scoring Plays](hockey_scoring_plays.rb)
+  * Uses `HockeyScoringPlaysParams` and makes a `HockeyScoringPlays` request
+  * Uses the `status` and `since` parameters to return scoring plays for ended Dallas Stars games in last month
+  * Demonstrates can access an array of players who assisted on each goal
+
+* [Basketball Injuries](basketball_injuries.rb)
+  * Uses `BasketballStatLeadersParams` and makes a `BasketballStatLeaders` request
+  * Use the `type`, `stat` and `place` parameters get the top 5 three point leaders (with ties)
+
+* [Football Stats](football_stats.rb)
+  * Uses `FootballStatsParams` and makes a `FootballStats` request
+  * Use the `type`, `stat` and `player_id` parameters get Aaron Rodgers TDs thrown in each game
+  * Demonstrates ability to get `game`-specific data per stat, such as `weather_conditions`
+
+* [Basketball Team Game Logs](basketball_team_game_logs.rb)
+  * Uses `BasketballTeamGameLogsParams` and makes a `BasketballTeamGameLogs` request
+  * Use the `team_id` and `since` parameters to get Cavaliers team game logs for the past week
+
+* [Football Total Player Stats](football_total_player_stat.rb)
+  * Uses `FootballTotalPlayerStatParams` and makes a `FootballTotalPlayerStat` request
+  * Use the `player_id`, `type` and `stat` parameters to Adrian Peterson's total number of rushing attempts in the regular season
+  * Demonstrates a fully populated player, so can access his `weight` etc
+
+* [Hockey Total Team Stats](hockey_total_team_stat.rb)
+  * Uses `HockeyTotalTeamStatParams` and makes a `HockeyTotalTeamStat` request
+  * Use the `team_id` and `stat` parameters to the total number of third period goals the Canadiens has scored
+
+* [Basketball Top Stats](basketball_top_stats.rb)
+  * Uses `BasketballTopStatsParams` and makes a `BasketballTopStats` request
+  * Use the `type`, `stat`, and `place` parameters to return the 3 best (highest) offensive rebounding performances in NBA
+  * Demonstrates a fully populated game, so know when this was accomplished
+
+* [Basketball Winning Streaks](basketball_winning_streaks.rb)
+  * Uses `BasketballTeamOutcomeStreaksParams` and makes a `BasketballTeamOutcomeStreaks` request
+  * Use the `outcome` and `current` parameters to return winning streaks that filters to those more than 2 games in length
+  * Demonstrates a fully populated streak
+
+* [Hockey Ranked Streaks](hockey_team_ranked_streaks.rb)
+  * Uses `HockeyTeamOutcomeStreaksParams` and makes a `HockeyTeamOutcomeStreaks` request
+  * Use the `team_id` and `ranked` parameters to the top 3 ranked streaks in length
+  * Demonstrates a fully populated streak with season and league
+
+* [Game Officials](officials.rb)
+  * Uses games params and request for each sport
+  * Demonstrates a fully populated list of officials for each game
+
+* [Game Log Officials](officials.rb)
+  * Uses game_log and team_game_log params and request for Hockey
+  * Demonstrates a fully populated list of officials for each game on the game_log

data/examples/baseball_feats.rb

@@ -0,0 +1,35 @@
+# Set your STATTLESHIP_ACCESS_TOKEN from https://www.stattleship.com in the examples/.env file
+
+require 'dotenv'
+Dotenv.load
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'stattleship')
+require 'pp'
+
+# Construct params for the fetch
+query_params = Stattleship::Params::BaseballFeatsParams.new
+
+# use a slug, typically 'league-firstname-lastname'
+query_params.interval_type = 'preseason'
+query_params.season_id = 'mlb-2016'
+query_params.level_up = 3
+query_params.since = '1 week ago'
+
+# fetch will automatically traverse the paginated response links
+feats = Stattleship::BaseballFeats.fetch(params: query_params)
+
+# the populated object
+pp feats.first
+
+# can access friendly helpers
+pp feats.first.to_sentence
+
+# ""
+
+# or, individual attributes
+feats.each do |feat|
+  pp "#{feat.actual.to_i} #{feat.name} #{feat.humanized_stat_type} #{feat.vs}"
+end
+
+# ...

data/examples/baseball_games.rb

@@ -0,0 +1,32 @@
+# Set your STATTLESHIP_ACCESS_TOKEN from https://www.stattleship.com in the examples/.env file
+
+require 'dotenv'
+Dotenv.load
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'stattleship')
+require 'pp'
+
+# Construct params for the fetch
+query_params = Stattleship::Params::BaseballGamesParams.new
+
+# use a slug, typically 'league-team_abbreviation'
+query_params.team_id = 'mlb-bos'
+
+# may need to adjust this depending on time of year
+query_params.season_id = 'mlb-2016'
+query_params.status = 'upcoming'
+
+# fetch will automatically traverse the paginated response links
+games = Stattleship::BaseballGames.fetch(params: query_params)
+
+# the populated object
+pp games.first
+
+# can access friendly helpers
+pp games.first.started_at.strftime('%b %e, %l:%M %p')
+
+# or, individual attributes
+games.each do |game|
+  pp game.scoreline
+end

data/examples/baseball_player_game_logs.rb

@@ -0,0 +1,33 @@
+# Set your STATTLESHIP_ACCESS_TOKEN from https://www.stattleship.com in the examples/.env file
+
+require 'dotenv'
+Dotenv.load
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'stattleship')
+require 'pp'
+
+# Construct params for the fetch
+query_params = Stattleship::Params::BaseballGameLogsParams.new
+
+# use a slug
+
+query_params.player_id = 'mlb-pablo-sandoval'
+query_params.season_id = 'mlb-2015'
+query_params.interval_type = 'regularseason'
+query_params.since = '1 year ago'
+
+# fetch will automatically traverse the paginated response links
+game_logs = Stattleship::BaseballGameLogs.fetch(params: query_params)
+
+# the populated object
+pp game_logs.first
+
+# can access friendly helpers
+pp game_logs.first.to_sentence
+
+# or, individual attributes
+game_logs.each do |game_log|
+  pp game_log.to_sentence
+end
+

data/examples/baseball_stat_leaders.rb

@@ -0,0 +1,30 @@
+# Set your STATTLESHIP_ACCESS_TOKEN from https://www.stattleship.com in the examples/.env file
+
+require 'dotenv'
+Dotenv.load
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'stattleship')
+require 'pp'
+
+# Construct params for the fetch
+query_params = Stattleship::Params::BaseballStatLeadersParams.new
+
+query_params.type = 'baseball_hitter_stat'
+query_params.stat = 'home_runs'
+query_params.place = 3
+
+# fetch will automatically traverse the paginated response links
+stat_leaders = Stattleship::BaseballStatLeaders.fetch(params: query_params)
+
+# the populated object
+pp stat_leaders.first
+
+# can access friendly helpers
+pp stat_leaders.first.to_sentence
+
+
+# or, individual attributes
+stat_leaders.each do |stat_leader|
+  pp "#{stat_leader.place} - #{stat_leader.player_name} with #{stat_leader.stat.to_i} HR"
+end

data/examples/basketball_game_logs.rb

@@ -0,0 +1,33 @@
+# Set your STATTLESHIP_ACCESS_TOKEN from https://www.stattleship.com in the examples/.env file
+
+require 'dotenv'
+Dotenv.load
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'stattleship')
+require 'pp'
+
+# Construct params for the fetch
+query_params = Stattleship::Params::BasketballGameLogsParams.new
+
+# use a slug, typically 'league-firstname-lastname'
+query_params.player_id = 'nba-stephen-curry'
+
+# may need to adjust this depending on time of year/NBA season
+query_params.since = '1 week ago'
+
+# fetch will automatically traverse the paginated response links
+game_logs = Stattleship::BasketballGameLogs.fetch(params: query_params)
+
+# the populated object
+pp game_logs.first
+
+# can access friendly helpers
+pp game_logs.first.to_sentence
+
+# "Stephen Curry 8 FGM, 44.4 FG%, 25 PTS, 7 RBD, 11 A, 2 STL, 1 BLK (Warriors vs Bulls January 20, 2016 at  7:00pm)"
+
+# or, individual attributes
+game_logs.each do |game_log|
+  pp game_log.three_pointers_made
+end

data/examples/basketball_injuries.rb

@@ -0,0 +1,36 @@
+# Set your STATTLESHIP_ACCESS_TOKEN from https://www.stattleship.com in the examples/.env file
+
+require 'dotenv'
+Dotenv.load
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'stattleship')
+require 'pp'
+
+# Construct params for the fetch
+query_params = Stattleship::Params::BasketballInjuriesParams.new
+
+# use a slug, typically 'league-team_abbreviation'
+query_params.team_id = 'nba-sa'
+
+# fetch will automatically traverse the paginated response links
+injuries = Stattleship::BasketballInjuries.fetch(params: query_params)
+
+# the populated object
+pp injuries.first
+
+# or, individual attributes
+pp injuries.first.note
+
+# "Duncan missed last game due to soreness in his right knee and will not suit up against the Rockets on Wednesday."
+
+injuries.each do |injury|
+  pp injury.location_name
+end
+
+# "Knee"
+# "Back"
+# "Hip"
+# "Hip"
+# "Rest"
+# ...

data/examples/basketball_season_player_performance_rankings.rb

@@ -0,0 +1,31 @@
+# Set your STATTLESHIP_ACCESS_TOKEN from https://www.stattleship.com in the examples/.env file
+
+require 'dotenv'
+Dotenv.load
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'stattleship')
+require 'pp'
+
+# Construct params for the fetch
+query_params = Stattleship::Params::RankingsParams.new
+
+# use a slug
+
+query_params.ranking = 'basketball_season_player_performance_ranking'
+query_params.place = 10
+
+# fetch will automatically traverse the paginated response links
+rankings = Stattleship::Rankings.fetch(params: query_params)
+
+# the populated object
+pp rankings.first
+
+# can access friendly helpers
+pp rankings.first.player_name
+
+# or, individual attributes
+rankings.each do |ranking|
+  pp ranking.to_sentence
+end
+

data/examples/basketball_stat_leaders.rb

@@ -0,0 +1,40 @@
+# Set your STATTLESHIP_ACCESS_TOKEN from https://www.stattleship.com in the examples/.env file
+
+require 'dotenv'
+Dotenv.load
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'stattleship')
+require 'pp'
+
+# Construct params for the fetch
+query_params = Stattleship::Params::BasketballStatLeadersParams.new
+
+# the stat must belong to the type, see: http://playbook.stattleship.com/#basketball-stats for a list
+query_params.type = 'basketball_offensive_stat'
+query_params.stat = 'three_pointers_made'
+query_params.place = 5
+
+# fetch will automatically traverse the paginated response links
+stat_leaders = Stattleship::BasketballStatLeaders.fetch(params: query_params)
+
+# the populated object
+pp stat_leaders.first
+
+# can access friendly helpers
+pp stat_leaders.first.to_sentence
+
+# "Stephen Curry is in first place with 210 three_pointers_made"
+
+# or, individual attributes
+stat_leaders.each do |stat_leader|
+  pp "#{stat_leader.place} - #{stat_leader.player_name} with #{stat_leader.stat.to_i} threes"
+end
+
+# "1 - Stephen Curry with 210 threes"
+# "2 - Klay Thompson with 133 threes"
+# "3 - Paul George with 128 threes"
+# "3 - James Harden with 128 threes"
+# "4 - Kyle Lowry with 125 threes"
+# "5 - Damian Lillard with 121 threes"
+# ...

data/examples/basketball_team_game_logs.rb

@@ -0,0 +1,38 @@
+# Set your STATTLESHIP_ACCESS_TOKEN from https://www.stattleship.com in the examples/.env file
+
+require 'dotenv'
+Dotenv.load
+
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'stattleship')
+require 'pp'
+
+# Construct params for the fetch
+query_params = Stattleship::Params::BasketballTeamGameLogsParams.new
+
+# use a slug, typically 'league-team_abbreviation'
+query_params.team_id = 'nba-cle'
+
+# may need to adjust this depending on time of year/NBA season
+query_params.since = '1 week ago'
+
+# fetch will automatically traverse the paginated response links
+game_logs = Stattleship::BasketballTeamGameLogs.fetch(params: query_params)
+
+# the populated object
+pp game_logs.first
+
+# can access friendly helpers
+pp game_logs.first.to_sentence
+
+# "Cleveland 42 FGM, 50.6 FG%, 115 PTS, 33 DRB, 14 ORB, 47 REB (Clippers vs Cavaliers January 21, 2016 at  8:00pm)"
+
+# or, individual attributes
+game_logs.each do |game_log|
+  pp game_log.three_pointers_made
+end
+
+# 13
+# 11
+# 4
+# 5