nba 0.1.1 → 0.2.0

data/lib/nba/box_score_advanced_player_stat.rb

@@ -0,0 +1,297 @@
+require "equalizer"
+require "shale"
+
+module NBA
+  # Represents a player's advanced box score statistics for a game
+  class BoxScoreAdvancedPlayerStat < Shale::Mapper
+    include Equalizer.new(:game_id, :player_id)
+
+    # @!attribute [rw] game_id
+    #   Returns the game ID
+    #   @api public
+    #   @example
+    #     stat.game_id #=> "0022400350"
+    #   @return [String] the game ID
+    attribute :game_id, 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_city
+    #   Returns the team city
+    #   @api public
+    #   @example
+    #     stat.team_city #=> "Golden State"
+    #   @return [String] the team city
+    attribute :team_city, Shale::Type::String
+
+    # @!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] start_position
+    #   Returns the starting position
+    #   @api public
+    #   @example
+    #     stat.start_position #=> "G"
+    #   @return [String] the starting position
+    attribute :start_position, Shale::Type::String
+
+    # @!attribute [rw] comment
+    #   Returns any comment (e.g., "DNP - Rest")
+    #   @api public
+    #   @example
+    #     stat.comment #=> "DNP - Rest"
+    #   @return [String] the comment
+    attribute :comment, Shale::Type::String
+
+    # @!attribute [rw] min
+    #   Returns minutes played
+    #   @api public
+    #   @example
+    #     stat.min #=> "32:45"
+    #   @return [String] the minutes played
+    attribute :min, Shale::Type::String
+
+    # @!attribute [rw] e_off_rating
+    #   Returns estimated offensive rating
+    #   @api public
+    #   @example
+    #     stat.e_off_rating #=> 118.5
+    #   @return [Float] the estimated offensive rating
+    attribute :e_off_rating, Shale::Type::Float
+
+    # @!attribute [rw] off_rating
+    #   Returns offensive rating
+    #   @api public
+    #   @example
+    #     stat.off_rating #=> 120.3
+    #   @return [Float] the offensive rating
+    attribute :off_rating, Shale::Type::Float
+
+    # @!attribute [rw] e_def_rating
+    #   Returns estimated defensive rating
+    #   @api public
+    #   @example
+    #     stat.e_def_rating #=> 108.2
+    #   @return [Float] the estimated defensive rating
+    attribute :e_def_rating, Shale::Type::Float
+
+    # @!attribute [rw] def_rating
+    #   Returns defensive rating
+    #   @api public
+    #   @example
+    #     stat.def_rating #=> 106.8
+    #   @return [Float] the defensive rating
+    attribute :def_rating, Shale::Type::Float
+
+    # @!attribute [rw] e_net_rating
+    #   Returns estimated net rating
+    #   @api public
+    #   @example
+    #     stat.e_net_rating #=> 10.3
+    #   @return [Float] the estimated net rating
+    attribute :e_net_rating, Shale::Type::Float
+
+    # @!attribute [rw] net_rating
+    #   Returns net rating
+    #   @api public
+    #   @example
+    #     stat.net_rating #=> 13.5
+    #   @return [Float] the net rating
+    attribute :net_rating, Shale::Type::Float
+
+    # @!attribute [rw] ast_pct
+    #   Returns assist percentage
+    #   @api public
+    #   @example
+    #     stat.ast_pct #=> 45.2
+    #   @return [Float] the assist percentage
+    attribute :ast_pct, Shale::Type::Float
+
+    # @!attribute [rw] ast_tov
+    #   Returns assist to turnover ratio
+    #   @api public
+    #   @example
+    #     stat.ast_tov #=> 2.75
+    #   @return [Float] the assist to turnover ratio
+    attribute :ast_tov, Shale::Type::Float
+
+    # @!attribute [rw] ast_ratio
+    #   Returns assist ratio
+    #   @api public
+    #   @example
+    #     stat.ast_ratio #=> 28.5
+    #   @return [Float] the assist ratio
+    attribute :ast_ratio, Shale::Type::Float
+
+    # @!attribute [rw] oreb_pct
+    #   Returns offensive rebound percentage
+    #   @api public
+    #   @example
+    #     stat.oreb_pct #=> 3.2
+    #   @return [Float] the offensive rebound percentage
+    attribute :oreb_pct, Shale::Type::Float
+
+    # @!attribute [rw] dreb_pct
+    #   Returns defensive rebound percentage
+    #   @api public
+    #   @example
+    #     stat.dreb_pct #=> 18.6
+    #   @return [Float] the defensive rebound percentage
+    attribute :dreb_pct, Shale::Type::Float
+
+    # @!attribute [rw] reb_pct
+    #   Returns total rebound percentage
+    #   @api public
+    #   @example
+    #     stat.reb_pct #=> 10.9
+    #   @return [Float] the total rebound percentage
+    attribute :reb_pct, Shale::Type::Float
+
+    # @!attribute [rw] tov_pct
+    #   Returns turnover percentage
+    #   @api public
+    #   @example
+    #     stat.tov_pct #=> 12.3
+    #   @return [Float] the turnover percentage
+    attribute :tov_pct, Shale::Type::Float
+
+    # @!attribute [rw] efg_pct
+    #   Returns effective field goal percentage
+    #   @api public
+    #   @example
+    #     stat.efg_pct #=> 0.625
+    #   @return [Float] the effective field goal percentage
+    attribute :efg_pct, Shale::Type::Float
+
+    # @!attribute [rw] ts_pct
+    #   Returns true shooting percentage
+    #   @api public
+    #   @example
+    #     stat.ts_pct #=> 0.658
+    #   @return [Float] the true shooting percentage
+    attribute :ts_pct, Shale::Type::Float
+
+    # @!attribute [rw] usg_pct
+    #   Returns usage percentage
+    #   @api public
+    #   @example
+    #     stat.usg_pct #=> 32.4
+    #   @return [Float] the usage percentage
+    attribute :usg_pct, Shale::Type::Float
+
+    # @!attribute [rw] e_usg_pct
+    #   Returns estimated usage percentage
+    #   @api public
+    #   @example
+    #     stat.e_usg_pct #=> 31.8
+    #   @return [Float] the estimated usage percentage
+    attribute :e_usg_pct, Shale::Type::Float
+
+    # @!attribute [rw] e_pace
+    #   Returns estimated pace
+    #   @api public
+    #   @example
+    #     stat.e_pace #=> 100.5
+    #   @return [Float] the estimated pace
+    attribute :e_pace, Shale::Type::Float
+
+    # @!attribute [rw] pace
+    #   Returns pace
+    #   @api public
+    #   @example
+    #     stat.pace #=> 102.3
+    #   @return [Float] the pace
+    attribute :pace, Shale::Type::Float
+
+    # @!attribute [rw] pace_per40
+    #   Returns pace per 40 minutes
+    #   @api public
+    #   @example
+    #     stat.pace_per40 #=> 101.8
+    #   @return [Float] the pace per 40 minutes
+    attribute :pace_per40, Shale::Type::Float
+
+    # @!attribute [rw] poss
+    #   Returns possessions
+    #   @api public
+    #   @example
+    #     stat.poss #=> 65
+    #   @return [Integer] the possessions
+    attribute :poss, Shale::Type::Integer
+
+    # @!attribute [rw] pie
+    #   Returns player impact estimate
+    #   @api public
+    #   @example
+    #     stat.pie #=> 18.4
+    #   @return [Float] the player impact estimate
+    attribute :pie, Shale::Type::Float
+
+    # 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
+
+    # Returns whether the player started the game
+    #
+    # @api public
+    # @example
+    #   stat.starter? #=> true
+    # @return [Boolean] true if the player started
+    def starter?
+      !start_position.nil? && !start_position.empty?
+    end
+
+    # Returns the game object for this box score
+    #
+    # @api public
+    # @example
+    #   stat.game #=> #<NBA::Game>
+    # @return [Game, nil] the game object
+    def game
+      Games.find(game_id)
+    end
+  end
+end

data/lib/nba/box_score_advanced_team_stat.rb

@@ -0,0 +1,237 @@
+require "equalizer"
+require "shale"
+
+module NBA
+  # Represents a team's advanced box score statistics for a game
+  class BoxScoreAdvancedTeamStat < Shale::Mapper
+    include Equalizer.new(:game_id, :team_id)
+
+    # @!attribute [rw] game_id
+    #   Returns the game ID
+    #   @api public
+    #   @example
+    #     stat.game_id #=> "0022400350"
+    #   @return [String] the game ID
+    attribute :game_id, 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_name
+    #   Returns the team name
+    #   @api public
+    #   @example
+    #     stat.team_name #=> "Warriors"
+    #   @return [String] the team name
+    attribute :team_name, Shale::Type::String
+
+    # @!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_city
+    #   Returns the team city
+    #   @api public
+    #   @example
+    #     stat.team_city #=> "Golden State"
+    #   @return [String] the team city
+    attribute :team_city, Shale::Type::String
+
+    # @!attribute [rw] min
+    #   Returns total minutes played
+    #   @api public
+    #   @example
+    #     stat.min #=> "240:00"
+    #   @return [String] the minutes
+    attribute :min, Shale::Type::String
+
+    # @!attribute [rw] e_off_rating
+    #   Returns estimated offensive rating
+    #   @api public
+    #   @example
+    #     stat.e_off_rating #=> 115.2
+    #   @return [Float] the estimated offensive rating
+    attribute :e_off_rating, Shale::Type::Float
+
+    # @!attribute [rw] off_rating
+    #   Returns offensive rating
+    #   @api public
+    #   @example
+    #     stat.off_rating #=> 117.5
+    #   @return [Float] the offensive rating
+    attribute :off_rating, Shale::Type::Float
+
+    # @!attribute [rw] e_def_rating
+    #   Returns estimated defensive rating
+    #   @api public
+    #   @example
+    #     stat.e_def_rating #=> 110.3
+    #   @return [Float] the estimated defensive rating
+    attribute :e_def_rating, Shale::Type::Float
+
+    # @!attribute [rw] def_rating
+    #   Returns defensive rating
+    #   @api public
+    #   @example
+    #     stat.def_rating #=> 108.9
+    #   @return [Float] the defensive rating
+    attribute :def_rating, Shale::Type::Float
+
+    # @!attribute [rw] e_net_rating
+    #   Returns estimated net rating
+    #   @api public
+    #   @example
+    #     stat.e_net_rating #=> 4.9
+    #   @return [Float] the estimated net rating
+    attribute :e_net_rating, Shale::Type::Float
+
+    # @!attribute [rw] net_rating
+    #   Returns net rating
+    #   @api public
+    #   @example
+    #     stat.net_rating #=> 8.6
+    #   @return [Float] the net rating
+    attribute :net_rating, Shale::Type::Float
+
+    # @!attribute [rw] ast_pct
+    #   Returns assist percentage
+    #   @api public
+    #   @example
+    #     stat.ast_pct #=> 66.7
+    #   @return [Float] the assist percentage
+    attribute :ast_pct, Shale::Type::Float
+
+    # @!attribute [rw] ast_tov
+    #   Returns assist to turnover ratio
+    #   @api public
+    #   @example
+    #     stat.ast_tov #=> 2.0
+    #   @return [Float] the assist to turnover ratio
+    attribute :ast_tov, Shale::Type::Float
+
+    # @!attribute [rw] ast_ratio
+    #   Returns assist ratio
+    #   @api public
+    #   @example
+    #     stat.ast_ratio #=> 19.8
+    #   @return [Float] the assist ratio
+    attribute :ast_ratio, Shale::Type::Float
+
+    # @!attribute [rw] oreb_pct
+    #   Returns offensive rebound percentage
+    #   @api public
+    #   @example
+    #     stat.oreb_pct #=> 22.2
+    #   @return [Float] the offensive rebound percentage
+    attribute :oreb_pct, Shale::Type::Float
+
+    # @!attribute [rw] dreb_pct
+    #   Returns defensive rebound percentage
+    #   @api public
+    #   @example
+    #     stat.dreb_pct #=> 77.8
+    #   @return [Float] the defensive rebound percentage
+    attribute :dreb_pct, Shale::Type::Float
+
+    # @!attribute [rw] reb_pct
+    #   Returns total rebound percentage
+    #   @api public
+    #   @example
+    #     stat.reb_pct #=> 50.0
+    #   @return [Float] the total rebound percentage
+    attribute :reb_pct, Shale::Type::Float
+
+    # @!attribute [rw] tov_pct
+    #   Returns turnover percentage
+    #   @api public
+    #   @example
+    #     stat.tov_pct #=> 14.5
+    #   @return [Float] the turnover percentage
+    attribute :tov_pct, Shale::Type::Float
+
+    # @!attribute [rw] efg_pct
+    #   Returns effective field goal percentage
+    #   @api public
+    #   @example
+    #     stat.efg_pct #=> 0.562
+    #   @return [Float] the effective field goal percentage
+    attribute :efg_pct, Shale::Type::Float
+
+    # @!attribute [rw] ts_pct
+    #   Returns true shooting percentage
+    #   @api public
+    #   @example
+    #     stat.ts_pct #=> 0.590
+    #   @return [Float] the true shooting percentage
+    attribute :ts_pct, Shale::Type::Float
+
+    # @!attribute [rw] e_pace
+    #   Returns estimated pace
+    #   @api public
+    #   @example
+    #     stat.e_pace #=> 99.5
+    #   @return [Float] the estimated pace
+    attribute :e_pace, Shale::Type::Float
+
+    # @!attribute [rw] pace
+    #   Returns pace
+    #   @api public
+    #   @example
+    #     stat.pace #=> 101.2
+    #   @return [Float] the pace
+    attribute :pace, Shale::Type::Float
+
+    # @!attribute [rw] pace_per40
+    #   Returns pace per 40 minutes
+    #   @api public
+    #   @example
+    #     stat.pace_per40 #=> 100.8
+    #   @return [Float] the pace per 40 minutes
+    attribute :pace_per40, Shale::Type::Float
+
+    # @!attribute [rw] poss
+    #   Returns possessions
+    #   @api public
+    #   @example
+    #     stat.poss #=> 98
+    #   @return [Integer] the possessions
+    attribute :poss, Shale::Type::Integer
+
+    # @!attribute [rw] pie
+    #   Returns player impact estimate
+    #   @api public
+    #   @example
+    #     stat.pie #=> 52.3
+    #   @return [Float] the player impact estimate
+    attribute :pie, Shale::Type::Float
+
+    # 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 the game object for this box score
+    #
+    # @api public
+    # @example
+    #   stat.game #=> #<NBA::Game>
+    # @return [Game, nil] the game object
+    def game
+      Games.find(game_id)
+    end
+  end
+end

data/lib/nba/box_score_advanced_v3.rb

@@ -0,0 +1,124 @@
+require "json"
+require_relative "client"
+require_relative "collection"
+require_relative "box_score_advanced_player_stat"
+require_relative "box_score_advanced_team_stat"
+require_relative "box_score_v3_helpers"
+require_relative "utils"
+
+module NBA
+  # Provides methods to retrieve advanced box score statistics using V3 API
+  module BoxScoreAdvancedV3
+    # @return [String] JSON key for advanced box score data
+    BOX_SCORE_KEY = "boxScoreAdvanced".freeze
+    # @return [String] JSON key for player statistics
+    PLAYER_STATS = "PlayerStats".freeze
+    # @return [String] JSON key for team statistics
+    TEAM_STATS = "TeamStats".freeze
+
+    # Retrieves advanced player box score stats for a game
+    #
+    # @api public
+    # @example
+    #   stats = NBA::BoxScoreAdvancedV3.player_stats(game: "0022400001")
+    #   stats.each { |stat| puts "#{stat.player_name}: #{stat.off_rating}" }
+    # @param game [String, Integer] the game ID
+    # @param start_period [Integer] the starting period
+    # @param end_period [Integer] the ending period
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of player advanced stats
+    def self.player_stats(game:, start_period: 0, end_period: 0, client: CLIENT)
+      game_id = Utils.extract_id(game)
+      response = client.get(build_path(game_id, start_period, end_period))
+      parse_player_response(response, game_id)
+    end
+
+    # Retrieves advanced team box score stats for a game
+    #
+    # @api public
+    # @example
+    #   stats = NBA::BoxScoreAdvancedV3.team_stats(game: "0022400001")
+    #   stats.each { |stat| puts "#{stat.team_abbreviation}: #{stat.off_rating}" }
+    # @param game [String, Integer] the game ID
+    # @param start_period [Integer] the starting period
+    # @param end_period [Integer] the ending period
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of team advanced stats
+    def self.team_stats(game:, start_period: 0, end_period: 0, client: CLIENT)
+      game_id = Utils.extract_id(game)
+      response = client.get(build_path(game_id, start_period, end_period))
+      parse_team_response(response, game_id)
+    end
+
+    # Builds the API request path
+    # @api private
+    # @return [String] the request path
+    def self.build_path(game_id, start_period, end_period)
+      "boxscoreadvancedv3?GameID=#{game_id}&StartPeriod=#{start_period}" \
+        "&EndPeriod=#{end_period}&StartRange=0&EndRange=0&RangeType=0"
+    end
+    private_class_method :build_path
+
+    # Parses the API response into player stat objects
+    # @api private
+    # @return [Collection] collection of player stats
+    def self.parse_player_response(response, game_id)
+      return Collection.new unless response
+
+      data = JSON.parse(response)
+      players = BoxScoreV3Helpers.extract_players(data, BOX_SCORE_KEY)
+      return Collection.new unless players
+
+      Collection.new(players.map { |p| build_player_stat(p, game_id) })
+    end
+    private_class_method :parse_player_response
+
+    # Parses the API response into team stat objects
+    # @api private
+    # @return [Collection] collection of team stats
+    def self.parse_team_response(response, game_id)
+      return Collection.new unless response
+
+      data = JSON.parse(response)
+      teams = BoxScoreV3Helpers.extract_teams(data, BOX_SCORE_KEY)
+      return Collection.new unless teams
+
+      Collection.new(teams.map { |t| build_team_stat(t, game_id) })
+    end
+    private_class_method :parse_team_response
+
+    # Builds a player stat object from raw data
+    # @api private
+    # @return [BoxScoreAdvancedPlayerStat] the player stat object
+    def self.build_player_stat(player, game_id)
+      stats = player.fetch("statistics", {})
+      BoxScoreAdvancedPlayerStat.new(
+        **BoxScoreV3Helpers.player_identity(player, game_id), min: stats["minutes"],
+        **BoxScoreV3Helpers.advanced_rating_stats(stats), **BoxScoreV3Helpers.advanced_efficiency_stats(stats),
+        **BoxScoreV3Helpers.advanced_tempo_stats(stats), **player_usage_stats(stats)
+      )
+    end
+    private_class_method :build_player_stat
+
+    # Builds a team stat object from raw data
+    # @api private
+    # @return [BoxScoreAdvancedTeamStat] the team stat object
+    def self.build_team_stat(team, game_id)
+      stats = team.fetch("statistics", {})
+      BoxScoreAdvancedTeamStat.new(
+        **BoxScoreV3Helpers.team_identity(team, game_id), min: stats["minutes"],
+        **BoxScoreV3Helpers.advanced_rating_stats(stats), **BoxScoreV3Helpers.advanced_efficiency_stats(stats),
+        **BoxScoreV3Helpers.advanced_tempo_stats(stats)
+      )
+    end
+    private_class_method :build_team_stat
+
+    # Extracts player usage statistics from raw data
+    # @api private
+    # @return [Hash] usage statistics
+    def self.player_usage_stats(stats)
+      {usg_pct: stats["usagePercentage"], e_usg_pct: stats["estimatedUsagePercentage"]}
+    end
+    private_class_method :player_usage_stats
+  end
+end