nba 0.1.1 → 0.2.0

data/lib/nba/league_lineup_viz_stat.rb

@@ -0,0 +1,214 @@
+require "equalizer"
+require "shale"
+require_relative "teams"
+
+module NBA
+  # Represents a lineup visualization statistic
+  #
+  # @api public
+  class LeagueLineupVizStat < Shale::Mapper
+    include Equalizer.new(:group_id, :team_id)
+
+    # @!attribute [rw] group_id
+    #   Returns the lineup group ID
+    #   @api public
+    #   @example
+    #     stat.group_id #=> "201939-203110-1628369"
+    #   @return [String, nil] the group ID
+    attribute :group_id, Shale::Type::String
+
+    # @!attribute [rw] group_name
+    #   Returns the lineup group name (player names)
+    #   @api public
+    #   @example
+    #     stat.group_name #=> "S. Curry - K. Thompson - A. Wiggins"
+    #   @return [String, nil] the group name
+    attribute :group_name, Shale::Type::String
+
+    # @!attribute [rw] team_id
+    #   Returns the team ID
+    #   @api public
+    #   @example
+    #     stat.team_id #=> 1610612744
+    #   @return [Integer, nil] the team ID
+    attribute :team_id, Shale::Type::Integer
+
+    # @!attribute [rw] team_abbreviation
+    #   Returns the team abbreviation
+    #   @api public
+    #   @example
+    #     stat.team_abbreviation #=> "GSW"
+    #   @return [String, nil] the team abbreviation
+    attribute :team_abbreviation, Shale::Type::String
+
+    # @!attribute [rw] min
+    #   Returns minutes played
+    #   @api public
+    #   @example
+    #     stat.min #=> 245.5
+    #   @return [Float, nil] minutes played
+    attribute :min, Shale::Type::Float
+
+    # @!attribute [rw] off_rating
+    #   Returns offensive rating
+    #   @api public
+    #   @example
+    #     stat.off_rating #=> 115.3
+    #   @return [Float, nil] offensive rating
+    attribute :off_rating, Shale::Type::Float
+
+    # @!attribute [rw] def_rating
+    #   Returns defensive rating
+    #   @api public
+    #   @example
+    #     stat.def_rating #=> 108.5
+    #   @return [Float, nil] defensive rating
+    attribute :def_rating, Shale::Type::Float
+
+    # @!attribute [rw] net_rating
+    #   Returns net rating
+    #   @api public
+    #   @example
+    #     stat.net_rating #=> 6.8
+    #   @return [Float, nil] net rating
+    attribute :net_rating, Shale::Type::Float
+
+    # @!attribute [rw] pace
+    #   Returns pace
+    #   @api public
+    #   @example
+    #     stat.pace #=> 101.2
+    #   @return [Float, nil] pace
+    attribute :pace, Shale::Type::Float
+
+    # @!attribute [rw] ts_pct
+    #   Returns true shooting percentage
+    #   @api public
+    #   @example
+    #     stat.ts_pct #=> 0.612
+    #   @return [Float, nil] true shooting percentage
+    attribute :ts_pct, Shale::Type::Float
+
+    # @!attribute [rw] fta_rate
+    #   Returns free throw attempt rate
+    #   @api public
+    #   @example
+    #     stat.fta_rate #=> 0.285
+    #   @return [Float, nil] free throw attempt rate
+    attribute :fta_rate, Shale::Type::Float
+
+    # @!attribute [rw] tm_ast_pct
+    #   Returns team assist percentage
+    #   @api public
+    #   @example
+    #     stat.tm_ast_pct #=> 0.652
+    #   @return [Float, nil] team assist percentage
+    attribute :tm_ast_pct, Shale::Type::Float
+
+    # @!attribute [rw] pct_fga_2pt
+    #   Returns percentage of FGA that are 2-pointers
+    #   @api public
+    #   @example
+    #     stat.pct_fga_2pt #=> 0.545
+    #   @return [Float, nil] percentage of FGA that are 2-pointers
+    attribute :pct_fga_2pt, Shale::Type::Float
+
+    # @!attribute [rw] pct_fga_3pt
+    #   Returns percentage of FGA that are 3-pointers
+    #   @api public
+    #   @example
+    #     stat.pct_fga_3pt #=> 0.455
+    #   @return [Float, nil] percentage of FGA that are 3-pointers
+    attribute :pct_fga_3pt, Shale::Type::Float
+
+    # @!attribute [rw] pct_pts_2pt_mr
+    #   Returns percentage of points from mid-range 2s
+    #   @api public
+    #   @example
+    #     stat.pct_pts_2pt_mr #=> 0.125
+    #   @return [Float, nil] percentage of points from mid-range 2s
+    attribute :pct_pts_2pt_mr, Shale::Type::Float
+
+    # @!attribute [rw] pct_pts_fb
+    #   Returns percentage of points from fast breaks
+    #   @api public
+    #   @example
+    #     stat.pct_pts_fb #=> 0.152
+    #   @return [Float, nil] percentage of points from fast breaks
+    attribute :pct_pts_fb, Shale::Type::Float
+
+    # @!attribute [rw] pct_pts_ft
+    #   Returns percentage of points from free throws
+    #   @api public
+    #   @example
+    #     stat.pct_pts_ft #=> 0.185
+    #   @return [Float, nil] percentage of points from free throws
+    attribute :pct_pts_ft, Shale::Type::Float
+
+    # @!attribute [rw] pct_pts_paint
+    #   Returns percentage of points in paint
+    #   @api public
+    #   @example
+    #     stat.pct_pts_paint #=> 0.425
+    #   @return [Float, nil] percentage of points in paint
+    attribute :pct_pts_paint, Shale::Type::Float
+
+    # @!attribute [rw] pct_ast_fgm
+    #   Returns percentage of FGM that were assisted
+    #   @api public
+    #   @example
+    #     stat.pct_ast_fgm #=> 0.652
+    #   @return [Float, nil] percentage of FGM that were assisted
+    attribute :pct_ast_fgm, Shale::Type::Float
+
+    # @!attribute [rw] pct_uast_fgm
+    #   Returns percentage of FGM that were unassisted
+    #   @api public
+    #   @example
+    #     stat.pct_uast_fgm #=> 0.348
+    #   @return [Float, nil] percentage of FGM that were unassisted
+    attribute :pct_uast_fgm, Shale::Type::Float
+
+    # @!attribute [rw] opp_fg3_pct
+    #   Returns opponent 3-point percentage
+    #   @api public
+    #   @example
+    #     stat.opp_fg3_pct #=> 0.352
+    #   @return [Float, nil] opponent 3-point percentage
+    attribute :opp_fg3_pct, Shale::Type::Float
+
+    # @!attribute [rw] opp_efg_pct
+    #   Returns opponent effective FG percentage
+    #   @api public
+    #   @example
+    #     stat.opp_efg_pct #=> 0.512
+    #   @return [Float, nil] opponent effective FG percentage
+    attribute :opp_efg_pct, Shale::Type::Float
+
+    # @!attribute [rw] opp_fta_rate
+    #   Returns opponent FTA rate
+    #   @api public
+    #   @example
+    #     stat.opp_fta_rate #=> 0.275
+    #   @return [Float, nil] opponent FTA rate
+    attribute :opp_fta_rate, Shale::Type::Float
+
+    # @!attribute [rw] opp_tov_pct
+    #   Returns opponent turnover percentage
+    #   @api public
+    #   @example
+    #     stat.opp_tov_pct #=> 0.132
+    #   @return [Float, nil] opponent turnover percentage
+    attribute :opp_tov_pct, Shale::Type::Float
+
+    # Returns the team
+    #
+    # @api public
+    # @example
+    #   stat.team #=> #<NBA::Team id=1610612744 ...>
+    # @return [Team, nil] the team object
+    def team
+      Teams.find(team_id)
+    end
+  end
+end

data/lib/nba/league_player_on_details.rb

@@ -0,0 +1,175 @@
+require "json"
+require_relative "client"
+require_relative "collection"
+require_relative "league_player_on_details_stat"
+require_relative "utils"
+
+module NBA
+  # Provides methods to retrieve league-wide player on court details
+  module LeaguePlayerOnDetails
+    # Result set name for players on court stats
+    # @return [String] the result set name
+    PLAYERS_ON_COURT = "PlayersOnCourtLeaguePlayerDetails".freeze
+
+    # Regular season type
+    # @return [String] the season type
+    REGULAR_SEASON = "Regular Season".freeze
+
+    # Playoffs season type
+    # @return [String] the season type
+    PLAYOFFS = "Playoffs".freeze
+
+    # Per game mode
+    # @return [String] the per mode
+    PER_GAME = "PerGame".freeze
+
+    # Totals mode
+    # @return [String] the per mode
+    TOTALS = "Totals".freeze
+
+    # Base measure type
+    # @return [String] the measure type
+    BASE = "Base".freeze
+
+    # Retrieves league-wide player on court details for a team
+    #
+    # @api public
+    # @example
+    #   stats = NBA::LeaguePlayerOnDetails.all(team: NBA::Team::GSW)
+    #   stats.each { |s| puts "#{s.vs_player_name}: #{s.pts} pts" }
+    # @param team [Integer, Team] the team ID or Team object
+    # @param season [Integer] the season year (defaults to current season)
+    # @param season_type [String] the season type (Regular Season, Playoffs)
+    # @param per_mode [String] the per mode (PerGame, Totals)
+    # @param measure_type [String] the measure type (Base)
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of player on court stats
+    def self.all(team:, season: Utils.current_season, season_type: REGULAR_SEASON, per_mode: PER_GAME, measure_type: BASE, client: CLIENT)
+      team_id = Utils.extract_id(team)
+      path = build_path(team_id, season, season_type, per_mode, measure_type)
+      response = client.get(path)
+      parse_response(response)
+    end
+
+    # Builds the API path
+    # @api private
+    # @param team_id [Integer] the team ID
+    # @param season [Integer] the season
+    # @param season_type [String] the season type
+    # @param per_mode [String] the per mode
+    # @param measure_type [String] the measure type
+    # @return [String] the path
+    def self.build_path(team_id, season, season_type, per_mode, measure_type)
+      "leagueplayerondetails?LeagueID=00&Season=#{Utils.format_season(season)}&SeasonType=#{season_type}&" \
+        "PerMode=#{per_mode}&MeasureType=#{measure_type}&TeamID=#{team_id}&PaceAdjust=N&PlusMinus=N&Rank=N&" \
+        "LastNGames=0&Month=0&OpponentTeamID=0&Period=0"
+    end
+    private_class_method :build_path
+
+    # Parses the API response
+    # @api private
+    # @param response [String, nil] the JSON response
+    # @return [Collection] collection of player on court stats
+    def self.parse_response(response)
+      return Collection.new unless response
+
+      data = JSON.parse(response)
+      result_set = find_result_set(data)
+      return Collection.new unless result_set
+
+      build_stats(result_set)
+    end
+    private_class_method :parse_response
+
+    # Finds the result set
+    # @api private
+    # @param data [Hash] the parsed JSON
+    # @return [Hash, nil] the result set
+    def self.find_result_set(data)
+      result_sets = data["resultSets"]
+      return unless result_sets
+
+      result_sets.find { |rs| rs.fetch("name").eql?(PLAYERS_ON_COURT) }
+    end
+    private_class_method :find_result_set
+
+    # Builds stats collection
+    # @api private
+    # @param result_set [Hash] the result set
+    # @return [Collection] collection of player on court stats
+    def self.build_stats(result_set)
+      headers = result_set["headers"]
+      rows = result_set["rowSet"]
+      return Collection.new unless headers && rows
+
+      stats = rows.map { |row| build_stat(headers, row) }
+      Collection.new(stats)
+    end
+    private_class_method :build_stats
+
+    # Builds a single stat
+    # @api private
+    # @param headers [Array<String>] the headers
+    # @param row [Array] the row data
+    # @return [LeaguePlayerOnDetailsStat] the stat
+    def self.build_stat(headers, row)
+      data = headers.zip(row).to_h
+      LeaguePlayerOnDetailsStat.new(**stat_attributes(data))
+    end
+    private_class_method :build_stat
+
+    # Combines all stat attributes
+    # @api private
+    # @param data [Hash] the raw data
+    # @return [Hash] the combined attributes
+    def self.stat_attributes(data)
+      identity_info(data).merge(record_info(data), shooting_info(data), counting_info(data))
+    end
+    private_class_method :stat_attributes
+
+    # Extracts identity attributes
+    # @api private
+    # @param data [Hash] the raw data
+    # @return [Hash] identity attributes
+    def self.identity_info(data)
+      {group_set: data.fetch("GROUP_SET"), team_id: data.fetch("TEAM_ID"),
+       team_abbreviation: data.fetch("TEAM_ABBREVIATION"), team_name: data.fetch("TEAM_NAME"),
+       vs_player_id: data.fetch("VS_PLAYER_ID"), vs_player_name: data.fetch("VS_PLAYER_NAME"),
+       court_status: data.fetch("COURT_STATUS")}
+    end
+    private_class_method :identity_info
+
+    # Extracts record attributes
+    # @api private
+    # @param data [Hash] the raw data
+    # @return [Hash] record attributes
+    def self.record_info(data)
+      {gp: data.fetch("GP"), w: data.fetch("W"), l: data.fetch("L"),
+       w_pct: data.fetch("W_PCT"), min: data.fetch("MIN")}
+    end
+    private_class_method :record_info
+
+    # Extracts shooting attributes
+    # @api private
+    # @param data [Hash] the raw data
+    # @return [Hash] shooting attributes
+    def self.shooting_info(data)
+      {fgm: data.fetch("FGM"), fga: data.fetch("FGA"), fg_pct: data.fetch("FG_PCT"),
+       fg3m: data.fetch("FG3M"), fg3a: data.fetch("FG3A"), fg3_pct: data.fetch("FG3_PCT"),
+       ftm: data.fetch("FTM"), fta: data.fetch("FTA"), ft_pct: data.fetch("FT_PCT")}
+    end
+    private_class_method :shooting_info
+
+    # Extracts counting attributes
+    # @api private
+    # @param data [Hash] the raw data
+    # @return [Hash] counting attributes
+    def self.counting_info(data)
+      {oreb: data.fetch("OREB"), dreb: data.fetch("DREB"), reb: data.fetch("REB"),
+       ast: data.fetch("AST"), tov: data.fetch("TOV"), stl: data.fetch("STL"),
+       blk: data.fetch("BLK"), blka: data.fetch("BLKA"), pf: data.fetch("PF"),
+       pfd: data.fetch("PFD"), pts: data.fetch("PTS"), plus_minus: data.fetch("PLUS_MINUS")}
+    end
+    private_class_method :counting_info
+  end
+end

data/lib/nba/league_player_on_details_stat.rb

@@ -0,0 +1,313 @@
+require "equalizer"
+require "shale"
+
+module NBA
+  # Represents league-wide player on/off court statistics
+  class LeaguePlayerOnDetailsStat < Shale::Mapper
+    include Equalizer.new(:team_id, :vs_player_id)
+
+    # @!attribute [rw] group_set
+    #   Returns the group set
+    #   @api public
+    #   @example
+    #     stat.group_set #=> "Overall"
+    #   @return [String] the group set
+    attribute :group_set, Shale::Type::String
+
+    # @!attribute [rw] team_id
+    #   Returns the team ID
+    #   @api public
+    #   @example
+    #     stat.team_id #=> 1610612744
+    #   @return [Integer] the team ID
+    attribute :team_id, Shale::Type::Integer
+
+    # @!attribute [rw] team_abbreviation
+    #   Returns the team abbreviation
+    #   @api public
+    #   @example
+    #     stat.team_abbreviation #=> "GSW"
+    #   @return [String] the team abbreviation
+    attribute :team_abbreviation, Shale::Type::String
+
+    # @!attribute [rw] team_name
+    #   Returns the team name
+    #   @api public
+    #   @example
+    #     stat.team_name #=> "Golden State Warriors"
+    #   @return [String] the team name
+    attribute :team_name, Shale::Type::String
+
+    # @!attribute [rw] vs_player_id
+    #   Returns the player ID
+    #   @api public
+    #   @example
+    #     stat.vs_player_id #=> 201939
+    #   @return [Integer] the player ID
+    attribute :vs_player_id, Shale::Type::Integer
+
+    # @!attribute [rw] vs_player_name
+    #   Returns the player name
+    #   @api public
+    #   @example
+    #     stat.vs_player_name #=> "Stephen Curry"
+    #   @return [String] the player name
+    attribute :vs_player_name, Shale::Type::String
+
+    # @!attribute [rw] court_status
+    #   Returns the court status (On or Off)
+    #   @api public
+    #   @example
+    #     stat.court_status #=> "On"
+    #   @return [String] the court status
+    attribute :court_status, Shale::Type::String
+
+    # @!attribute [rw] gp
+    #   Returns games played
+    #   @api public
+    #   @example
+    #     stat.gp #=> 74
+    #   @return [Integer] games played
+    attribute :gp, Shale::Type::Integer
+
+    # @!attribute [rw] w
+    #   Returns wins
+    #   @api public
+    #   @example
+    #     stat.w #=> 46
+    #   @return [Integer] wins
+    attribute :w, Shale::Type::Integer
+
+    # @!attribute [rw] l
+    #   Returns losses
+    #   @api public
+    #   @example
+    #     stat.l #=> 28
+    #   @return [Integer] losses
+    attribute :l, Shale::Type::Integer
+
+    # @!attribute [rw] w_pct
+    #   Returns win percentage
+    #   @api public
+    #   @example
+    #     stat.w_pct #=> 0.622
+    #   @return [Float] win percentage
+    attribute :w_pct, Shale::Type::Float
+
+    # @!attribute [rw] min
+    #   Returns minutes
+    #   @api public
+    #   @example
+    #     stat.min #=> 32.5
+    #   @return [Float] minutes
+    attribute :min, Shale::Type::Float
+
+    # @!attribute [rw] fgm
+    #   Returns field goals made
+    #   @api public
+    #   @example
+    #     stat.fgm #=> 9.8
+    #   @return [Float] field goals made
+    attribute :fgm, Shale::Type::Float
+
+    # @!attribute [rw] fga
+    #   Returns field goals attempted
+    #   @api public
+    #   @example
+    #     stat.fga #=> 20.2
+    #   @return [Float] field goals attempted
+    attribute :fga, Shale::Type::Float
+
+    # @!attribute [rw] fg_pct
+    #   Returns field goal percentage
+    #   @api public
+    #   @example
+    #     stat.fg_pct #=> 0.485
+    #   @return [Float] field goal percentage
+    attribute :fg_pct, Shale::Type::Float
+
+    # @!attribute [rw] fg3m
+    #   Returns three pointers made
+    #   @api public
+    #   @example
+    #     stat.fg3m #=> 4.8
+    #   @return [Float] three pointers made
+    attribute :fg3m, Shale::Type::Float
+
+    # @!attribute [rw] fg3a
+    #   Returns three pointers attempted
+    #   @api public
+    #   @example
+    #     stat.fg3a #=> 11.7
+    #   @return [Float] three pointers attempted
+    attribute :fg3a, Shale::Type::Float
+
+    # @!attribute [rw] fg3_pct
+    #   Returns three point percentage
+    #   @api public
+    #   @example
+    #     stat.fg3_pct #=> 0.411
+    #   @return [Float] three point percentage
+    attribute :fg3_pct, Shale::Type::Float
+
+    # @!attribute [rw] ftm
+    #   Returns free throws made
+    #   @api public
+    #   @example
+    #     stat.ftm #=> 4.2
+    #   @return [Float] free throws made
+    attribute :ftm, Shale::Type::Float
+
+    # @!attribute [rw] fta
+    #   Returns free throws attempted
+    #   @api public
+    #   @example
+    #     stat.fta #=> 4.6
+    #   @return [Float] free throws attempted
+    attribute :fta, Shale::Type::Float
+
+    # @!attribute [rw] ft_pct
+    #   Returns free throw percentage
+    #   @api public
+    #   @example
+    #     stat.ft_pct #=> 0.913
+    #   @return [Float] free throw percentage
+    attribute :ft_pct, Shale::Type::Float
+
+    # @!attribute [rw] oreb
+    #   Returns offensive rebounds
+    #   @api public
+    #   @example
+    #     stat.oreb #=> 0.7
+    #   @return [Float] offensive rebounds
+    attribute :oreb, Shale::Type::Float
+
+    # @!attribute [rw] dreb
+    #   Returns defensive rebounds
+    #   @api public
+    #   @example
+    #     stat.dreb #=> 5.4
+    #   @return [Float] defensive rebounds
+    attribute :dreb, Shale::Type::Float
+
+    # @!attribute [rw] reb
+    #   Returns total rebounds
+    #   @api public
+    #   @example
+    #     stat.reb #=> 6.1
+    #   @return [Float] total rebounds
+    attribute :reb, Shale::Type::Float
+
+    # @!attribute [rw] ast
+    #   Returns assists
+    #   @api public
+    #   @example
+    #     stat.ast #=> 6.3
+    #   @return [Float] assists
+    attribute :ast, Shale::Type::Float
+
+    # @!attribute [rw] tov
+    #   Returns turnovers
+    #   @api public
+    #   @example
+    #     stat.tov #=> 3.2
+    #   @return [Float] turnovers
+    attribute :tov, Shale::Type::Float
+
+    # @!attribute [rw] stl
+    #   Returns steals
+    #   @api public
+    #   @example
+    #     stat.stl #=> 0.9
+    #   @return [Float] steals
+    attribute :stl, Shale::Type::Float
+
+    # @!attribute [rw] blk
+    #   Returns blocks
+    #   @api public
+    #   @example
+    #     stat.blk #=> 0.4
+    #   @return [Float] blocks
+    attribute :blk, Shale::Type::Float
+
+    # @!attribute [rw] blka
+    #   Returns blocked attempts
+    #   @api public
+    #   @example
+    #     stat.blka #=> 0.3
+    #   @return [Float] blocked attempts
+    attribute :blka, Shale::Type::Float
+
+    # @!attribute [rw] pf
+    #   Returns personal fouls
+    #   @api public
+    #   @example
+    #     stat.pf #=> 2.0
+    #   @return [Float] personal fouls
+    attribute :pf, Shale::Type::Float
+
+    # @!attribute [rw] pfd
+    #   Returns personal fouls drawn
+    #   @api public
+    #   @example
+    #     stat.pfd #=> 3.8
+    #   @return [Float] personal fouls drawn
+    attribute :pfd, Shale::Type::Float
+
+    # @!attribute [rw] pts
+    #   Returns points
+    #   @api public
+    #   @example
+    #     stat.pts #=> 28.6
+    #   @return [Float] points
+    attribute :pts, Shale::Type::Float
+
+    # @!attribute [rw] plus_minus
+    #   Returns plus/minus
+    #   @api public
+    #   @example
+    #     stat.plus_minus #=> 7.4
+    #   @return [Float] plus/minus
+    attribute :plus_minus, Shale::Type::Float
+
+    # Returns the player object
+    #
+    # @api public
+    # @example
+    #   stat.player #=> #<NBA::Player>
+    # @return [Player, nil] the player object
+    def player
+      Players.find(vs_player_id)
+    end
+
+    # Returns the team object
+    #
+    # @api public
+    # @example
+    #   stat.team #=> #<NBA::Team>
+    # @return [Team, nil] the team object
+    def team
+      Teams.find(team_id)
+    end
+
+    # Returns whether the player is on court
+    #
+    # @api public
+    # @example
+    #   stat.on_court? #=> true
+    # @return [Boolean] true if player is on court
+    def on_court?
+      court_status.eql?("On")
+    end
+
+    # Returns whether the player is off court
+    #
+    # @api public
+    # @example
+    #   stat.off_court? #=> true
+    # @return [Boolean] true if player is off court
+    def off_court?
+      court_status.eql?("Off")
+    end
+  end
+end