nba 0.1.1 → 0.2.0

data/lib/nba/league_dash_player_stat.rb

@@ -0,0 +1,306 @@
+module NBA
+  # Represents a player's league dashboard statistics
+  class LeagueDashPlayerStat < Shale::Mapper
+    include Equalizer.new(:player_id, :season_id)
+
+    # @!attribute [rw] player_id
+    #   Returns the player ID
+    #   @api public
+    #   @example
+    #     stat.player_id #=> 201939
+    #   @return [Integer] the player ID
+    attribute :player_id, Shale::Type::Integer
+
+    # @!attribute [rw] player_name
+    #   Returns the player name
+    #   @api public
+    #   @example
+    #     stat.player_name #=> "Stephen Curry"
+    #   @return [String] the player name
+    attribute :player_name, 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] age
+    #   Returns the player's age
+    #   @api public
+    #   @example
+    #     stat.age #=> 36
+    #   @return [Integer] the age
+    attribute :age, Shale::Type::Integer
+
+    # @!attribute [rw] gp
+    #   Returns games played
+    #   @api public
+    #   @example
+    #     stat.gp #=> 72
+    #   @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 #=> 26
+    #   @return [Integer] losses
+    attribute :l, Shale::Type::Integer
+
+    # @!attribute [rw] w_pct
+    #   Returns win percentage
+    #   @api public
+    #   @example
+    #     stat.w_pct #=> 0.639
+    #   @return [Float] win percentage
+    attribute :w_pct, Shale::Type::Float
+
+    # @!attribute [rw] min
+    #   Returns minutes per game
+    #   @api public
+    #   @example
+    #     stat.min #=> 34.7
+    #   @return [Float] minutes per game
+    attribute :min, Shale::Type::Float
+
+    # @!attribute [rw] fgm
+    #   Returns field goals made per game
+    #   @api public
+    #   @example
+    #     stat.fgm #=> 9.2
+    #   @return [Float] field goals made
+    attribute :fgm, Shale::Type::Float
+
+    # @!attribute [rw] fga
+    #   Returns field goals attempted per game
+    #   @api public
+    #   @example
+    #     stat.fga #=> 19.4
+    #   @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.474
+    #   @return [Float] field goal percentage
+    attribute :fg_pct, Shale::Type::Float
+
+    # @!attribute [rw] fg3m
+    #   Returns three-pointers made per game
+    #   @api public
+    #   @example
+    #     stat.fg3m #=> 4.8
+    #   @return [Float] three-pointers made
+    attribute :fg3m, Shale::Type::Float
+
+    # @!attribute [rw] fg3a
+    #   Returns three-pointers attempted per game
+    #   @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.410
+    #   @return [Float] three-point percentage
+    attribute :fg3_pct, Shale::Type::Float
+
+    # @!attribute [rw] ftm
+    #   Returns free throws made per game
+    #   @api public
+    #   @example
+    #     stat.ftm #=> 5.1
+    #   @return [Float] free throws made
+    attribute :ftm, Shale::Type::Float
+
+    # @!attribute [rw] fta
+    #   Returns free throws attempted per game
+    #   @api public
+    #   @example
+    #     stat.fta #=> 5.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.911
+    #   @return [Float] free throw percentage
+    attribute :ft_pct, Shale::Type::Float
+
+    # @!attribute [rw] oreb
+    #   Returns offensive rebounds per game
+    #   @api public
+    #   @example
+    #     stat.oreb #=> 0.7
+    #   @return [Float] offensive rebounds
+    attribute :oreb, Shale::Type::Float
+
+    # @!attribute [rw] dreb
+    #   Returns defensive rebounds per game
+    #   @api public
+    #   @example
+    #     stat.dreb #=> 4.9
+    #   @return [Float] defensive rebounds
+    attribute :dreb, Shale::Type::Float
+
+    # @!attribute [rw] reb
+    #   Returns total rebounds per game
+    #   @api public
+    #   @example
+    #     stat.reb #=> 5.6
+    #   @return [Float] total rebounds
+    attribute :reb, Shale::Type::Float
+
+    # @!attribute [rw] ast
+    #   Returns assists per game
+    #   @api public
+    #   @example
+    #     stat.ast #=> 6.3
+    #   @return [Float] assists
+    attribute :ast, Shale::Type::Float
+
+    # @!attribute [rw] tov
+    #   Returns turnovers per game
+    #   @api public
+    #   @example
+    #     stat.tov #=> 2.8
+    #   @return [Float] turnovers
+    attribute :tov, Shale::Type::Float
+
+    # @!attribute [rw] stl
+    #   Returns steals per game
+    #   @api public
+    #   @example
+    #     stat.stl #=> 1.3
+    #   @return [Float] steals
+    attribute :stl, Shale::Type::Float
+
+    # @!attribute [rw] blk
+    #   Returns blocks per game
+    #   @api public
+    #   @example
+    #     stat.blk #=> 0.4
+    #   @return [Float] blocks
+    attribute :blk, Shale::Type::Float
+
+    # @!attribute [rw] blka
+    #   Returns blocked attempts per game
+    #   @api public
+    #   @example
+    #     stat.blka #=> 0.2
+    #   @return [Float] blocked attempts
+    attribute :blka, Shale::Type::Float
+
+    # @!attribute [rw] pf
+    #   Returns personal fouls per game
+    #   @api public
+    #   @example
+    #     stat.pf #=> 1.8
+    #   @return [Float] personal fouls
+    attribute :pf, Shale::Type::Float
+
+    # @!attribute [rw] pfd
+    #   Returns personal fouls drawn per game
+    #   @api public
+    #   @example
+    #     stat.pfd #=> 2.7
+    #   @return [Float] personal fouls drawn
+    attribute :pfd, Shale::Type::Float
+
+    # @!attribute [rw] pts
+    #   Returns points per game
+    #   @api public
+    #   @example
+    #     stat.pts #=> 28.4
+    #   @return [Float] points
+    attribute :pts, Shale::Type::Float
+
+    # @!attribute [rw] plus_minus
+    #   Returns plus/minus per game
+    #   @api public
+    #   @example
+    #     stat.plus_minus #=> 7.1
+    #   @return [Float] plus/minus
+    attribute :plus_minus, Shale::Type::Float
+
+    # @!attribute [rw] nba_fantasy_pts
+    #   Returns fantasy points per game
+    #   @api public
+    #   @example
+    #     stat.nba_fantasy_pts #=> 52.3
+    #   @return [Float] fantasy points
+    attribute :nba_fantasy_pts, Shale::Type::Float
+
+    # @!attribute [rw] dd2
+    #   Returns double-doubles
+    #   @api public
+    #   @example
+    #     stat.dd2 #=> 15
+    #   @return [Integer] double-doubles
+    attribute :dd2, Shale::Type::Integer
+
+    # @!attribute [rw] td3
+    #   Returns triple-doubles
+    #   @api public
+    #   @example
+    #     stat.td3 #=> 3
+    #   @return [Integer] triple-doubles
+    attribute :td3, Shale::Type::Integer
+
+    # @!attribute [rw] season_id
+    #   Returns the season ID
+    #   @api public
+    #   @example
+    #     stat.season_id #=> "2024-25"
+    #   @return [String] the season ID
+    attribute :season_id, Shale::Type::String
+
+    # Returns the player object
+    #
+    # @api public
+    # @example
+    #   stat.player #=> #<NBA::Player>
+    # @return [Player, nil] the player object
+    def player
+      Players.find(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
+  end
+end

data/lib/nba/league_dash_player_stats.rb

@@ -0,0 +1,176 @@
+require "json"
+require_relative "client"
+require_relative "collection"
+require_relative "utils"
+
+require_relative "league_dash_player_stat"
+
+module NBA
+  # Provides methods to retrieve league-wide player statistics
+  module LeagueDashPlayerStats
+    # Result set name for league dash player stats
+    # @return [String] the result set name
+    LEAGUE_DASH_PLAYER_STATS = "LeagueDashPlayerStats".freeze
+
+    # Season type constant for regular season
+    # @return [String] the season type
+    REGULAR_SEASON = "Regular Season".freeze
+
+    # Season type constant for playoffs
+    # @return [String] the season type
+    PLAYOFFS = "Playoffs".freeze
+
+    # Per mode constant for per game stats
+    # @return [String] the per mode
+    PER_GAME = "PerGame".freeze
+
+    # Per mode constant for totals
+    # @return [String] the per mode
+    TOTALS = "Totals".freeze
+
+    # Per mode constant for per 36 minutes
+    # @return [String] the per mode
+    PER_36 = "Per36".freeze
+
+    # Retrieves league-wide player statistics
+    #
+    # @api public
+    # @example
+    #   stats = NBA::LeagueDashPlayerStats.all(season: 2024)
+    #   stats.each { |s| puts "#{s.player_name}: #{s.pts} ppg" }
+    # @param season [Integer] the season year
+    # @param season_type [String] the season type
+    # @param per_mode [String] the per mode
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of player stats
+    def self.all(season: Utils.current_season, season_type: REGULAR_SEASON, per_mode: PER_GAME, client: CLIENT)
+      path = build_path(season, season_type, per_mode)
+      response = client.get(path)
+      parse_response(response, season)
+    end
+
+    # Builds the API path
+    #
+    # @api private
+    # @param season [Integer] the season year
+    # @param season_type [String] the season type
+    # @param per_mode [String] the per mode
+    # @return [String] the API path
+    def self.build_path(season, season_type, per_mode)
+      season_str = Utils.format_season(season)
+      encoded_type = season_type
+      "leaguedashplayerstats?LeagueID=00&Season=#{season_str}&SeasonType=#{encoded_type}&PerMode=#{per_mode}" \
+        "&MeasureType=Base&Pace=N&PlusMinus=N&Rank=N"
+    end
+    private_class_method :build_path
+
+    # Parses the API response
+    #
+    # @api private
+    # @param response [String] the JSON response body
+    # @param season [Integer] the season year
+    # @return [Collection] a collection of player stats
+    def self.parse_response(response, season)
+      return Collection.new unless response
+
+      data = JSON.parse(response)
+      result_set = find_result_set(data)
+      return Collection.new unless result_set
+
+      headers = result_set["headers"]
+      rows = result_set["rowSet"]
+      return Collection.new unless headers && rows
+
+      season_id = Utils.format_season(season)
+      stats = rows.map { |row| build_player_stat(headers, row, season_id) }
+      Collection.new(stats)
+    end
+    private_class_method :parse_response
+
+    # Finds the result set
+    #
+    # @api private
+    # @param data [Hash] the parsed JSON data
+    # @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["name"].eql?(LEAGUE_DASH_PLAYER_STATS) }
+    end
+    private_class_method :find_result_set
+
+    # Builds a player stat from a row
+    #
+    # @api private
+    # @param headers [Array<String>] the column headers
+    # @param row [Array] the row data
+    # @param season_id [String] the season ID
+    # @return [LeagueDashPlayerStat] the player stat object
+    def self.build_player_stat(headers, row, season_id)
+      data = headers.zip(row).to_h
+      LeagueDashPlayerStat.new(**player_stat_attributes(data, season_id))
+    end
+    private_class_method :build_player_stat
+
+    # Extracts player stat attributes from row data
+    #
+    # @api private
+    # @param data [Hash] the player stat row data
+    # @param season_id [String] the season ID
+    # @return [Hash] the player stat attributes
+    def self.player_stat_attributes(data, season_id)
+      identity_attributes(data, season_id).merge(shooting_attributes(data), counting_attributes(data), advanced_attributes(data))
+    end
+    private_class_method :player_stat_attributes
+
+    # Extracts identity attributes
+    #
+    # @api private
+    # @param data [Hash] the player stat data
+    # @param season_id [String] the season ID
+    # @return [Hash] the identity attributes
+    def self.identity_attributes(data, season_id)
+      {player_id: data["PLAYER_ID"], player_name: data["PLAYER_NAME"],
+       team_id: data["TEAM_ID"], team_abbreviation: data["TEAM_ABBREVIATION"],
+       age: data["AGE"], gp: data["GP"], w: data["W"], l: data["L"],
+       w_pct: data["W_PCT"], min: data["MIN"], season_id: season_id}
+    end
+    private_class_method :identity_attributes
+
+    # Extracts shooting attributes
+    #
+    # @api private
+    # @param data [Hash] the player stat data
+    # @return [Hash] the shooting attributes
+    def self.shooting_attributes(data)
+      {fgm: data["FGM"], fga: data["FGA"], fg_pct: data["FG_PCT"],
+       fg3m: data["FG3M"], fg3a: data["FG3A"], fg3_pct: data["FG3_PCT"],
+       ftm: data["FTM"], fta: data["FTA"], ft_pct: data["FT_PCT"]}
+    end
+    private_class_method :shooting_attributes
+
+    # Extracts counting stats attributes
+    #
+    # @api private
+    # @param data [Hash] the player stat data
+    # @return [Hash] the counting stats attributes
+    def self.counting_attributes(data)
+      {oreb: data["OREB"], dreb: data["DREB"], reb: data["REB"],
+       ast: data["AST"], tov: data["TOV"], stl: data["STL"], blk: data["BLK"],
+       blka: data["BLKA"], pf: data["PF"], pfd: data["PFD"], pts: data["PTS"]}
+    end
+    private_class_method :counting_attributes
+
+    # Extracts advanced attributes
+    #
+    # @api private
+    # @param data [Hash] the player stat data
+    # @return [Hash] the advanced attributes
+    def self.advanced_attributes(data)
+      {plus_minus: data["PLUS_MINUS"], nba_fantasy_pts: data["NBA_FANTASY_PTS"],
+       dd2: data["DD2"], td3: data["TD3"]}
+    end
+    private_class_method :advanced_attributes
+  end
+end

data/lib/nba/league_dash_pt_defend.rb

@@ -0,0 +1,160 @@
+require "json"
+require_relative "client"
+require_relative "collection"
+require_relative "league_dash_pt_defend_stat"
+require_relative "utils"
+
+module NBA
+  # Provides methods to retrieve league-wide player defensive tracking statistics
+  #
+  # @api public
+  module LeagueDashPtDefend
+    # Result set name for league dash PT defend
+    # @return [String] the result set name
+    LEAGUE_DASH_PT_DEFEND = "LeagueDashPTDefend".freeze
+
+    # Regular season type constant
+    # @return [String] the season type
+    REGULAR_SEASON = "Regular Season".freeze
+
+    # Playoffs season type constant
+    # @return [String] the season type
+    PLAYOFFS = "Playoffs".freeze
+
+    # Per game mode constant
+    # @return [String] the per mode
+    PER_GAME = "PerGame".freeze
+
+    # Totals mode constant
+    # @return [String] the per mode
+    TOTALS = "Totals".freeze
+
+    # Overall defense category constant
+    # @return [String] the defense category
+    OVERALL = "Overall".freeze
+
+    # 3 Pointers defense category constant
+    # @return [String] the defense category
+    THREE_POINTERS = "3 Pointers".freeze
+
+    # 2 Pointers defense category constant
+    # @return [String] the defense category
+    TWO_POINTERS = "2 Pointers".freeze
+
+    # Less than 6ft defense category constant
+    # @return [String] the defense category
+    LESS_THAN_6FT = "Less Than 6Ft".freeze
+
+    # Less than 10ft defense category constant
+    # @return [String] the defense category
+    LESS_THAN_10FT = "Less Than 10Ft".freeze
+
+    # Greater than 15ft defense category constant
+    # @return [String] the defense category
+    GREATER_THAN_15FT = "Greater Than 15Ft".freeze
+
+    # Retrieves all league-wide player defensive tracking statistics
+    #
+    # @api public
+    # @example
+    #   stats = NBA::LeagueDashPtDefend.all(season: 2024)
+    #   stats.first.d_fg_pct #=> 0.421
+    # @param season [Integer] the season year
+    # @param season_type [String] the season type
+    # @param per_mode [String] the per mode
+    # @param defense_category [String] the defense category
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of player defensive statistics
+    def self.all(season: Utils.current_season, season_type: REGULAR_SEASON, per_mode: PER_GAME,
+      defense_category: OVERALL, client: CLIENT)
+      path = build_path(season, season_type: season_type, per_mode: per_mode, defense_category: defense_category)
+      response = client.get(path)
+      parse_response(response)
+    end
+
+    # Builds the API request path
+    #
+    # @api private
+    # @return [String] the request path
+    def self.build_path(season, opts)
+      season_str = Utils.format_season(season)
+      "leaguedashptdefend?LeagueID=00&Season=#{season_str}" \
+        "&SeasonType=#{opts.fetch(:season_type)}" \
+        "&PerMode=#{opts.fetch(:per_mode)}&DefenseCategory=#{opts.fetch(:defense_category)}"
+    end
+    private_class_method :build_path
+
+    # Parses the API response into stat objects
+    #
+    # @api private
+    # @return [Collection] collection of PT defend stats
+    def self.parse_response(response)
+      return Collection.new if response.nil? || response.empty?
+
+      data = JSON.parse(response)
+      result_set = find_result_set(data)
+      build_stats(result_set)
+    end
+    private_class_method :parse_response
+
+    # Finds the result set by name
+    #
+    # @api private
+    # @return [Hash, nil] the result set hash or nil if not found
+    def self.find_result_set(data)
+      result_sets = data["resultSets"]
+      return unless result_sets
+
+      result_sets.find { |rs| rs["name"].eql?(LEAGUE_DASH_PT_DEFEND) }
+    end
+    private_class_method :find_result_set
+
+    # Builds stats collection from result set
+    #
+    # @api private
+    # @return [Collection] the stats collection
+    def self.build_stats(result_set)
+      return Collection.new unless result_set
+
+      headers = result_set["headers"]
+      rows = result_set["rowSet"]
+      return Collection.new unless headers && rows
+
+      Collection.new(rows.map { |row| build_stat(headers.zip(row).to_h) })
+    end
+    private_class_method :build_stats
+
+    # Builds a single stat object from API data
+    #
+    # @api private
+    # @return [LeagueDashPtDefendStat] the stat object
+    def self.build_stat(data)
+      LeagueDashPtDefendStat.new(**identity_info(data), **defensive_info(data))
+    end
+    private_class_method :build_stat
+
+    # Extracts identity information from data
+    #
+    # @api private
+    # @return [Hash] the identity information hash
+    def self.identity_info(data)
+      {player_id: data["CLOSE_DEF_PERSON_ID"], player_name: data["PLAYER_NAME"],
+       team_id: data["PLAYER_LAST_TEAM_ID"],
+       team_abbreviation: data["PLAYER_LAST_TEAM_ABBREVIATION"],
+       player_position: data["PLAYER_POSITION"], age: data["AGE"],
+       gp: data["GP"], g: data["G"]}
+    end
+    private_class_method :identity_info
+
+    # Extracts defensive statistics information from data
+    #
+    # @api private
+    # @return [Hash] the defensive statistics hash
+    def self.defensive_info(data)
+      {freq: data["FREQ"], d_fgm: data["D_FGM"], d_fga: data["D_FGA"],
+       d_fg_pct: data["D_FG_PCT"], normal_fg_pct: data["NORMAL_FG_PCT"],
+       pct_plusminus: data["PCT_PLUSMINUS"]}
+    end
+    private_class_method :defensive_info
+  end
+end