nba 0.1.1 → 0.2.0

data/lib/nba/box_score_misc_player_stat.rb

@@ -0,0 +1,217 @@
+require "shale"
+require "equalizer"
+
+module NBA
+  # Represents a player's miscellaneous box score statistics for a game
+  class BoxScoreMiscPlayerStat < Shale::Mapper
+    include Equalizer.new(:game_id, :player_id)
+
+    # @!attribute [rw] game_id
+    #   Returns the game ID
+    #   @api public
+    #   @example
+    #     stat.game_id #=> "0022400565"
+    #   @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 #=> "35:24"
+    #   @return [String] the minutes played
+    attribute :min, Shale::Type::String
+
+    # @!attribute [rw] pts_off_tov
+    #   Returns points off turnovers
+    #   @api public
+    #   @example
+    #     stat.pts_off_tov #=> 12
+    #   @return [Integer] points off turnovers
+    attribute :pts_off_tov, Shale::Type::Integer
+
+    # @!attribute [rw] pts_2nd_chance
+    #   Returns second chance points
+    #   @api public
+    #   @example
+    #     stat.pts_2nd_chance #=> 8
+    #   @return [Integer] second chance points
+    attribute :pts_2nd_chance, Shale::Type::Integer
+
+    # @!attribute [rw] pts_fb
+    #   Returns fast break points
+    #   @api public
+    #   @example
+    #     stat.pts_fb #=> 15
+    #   @return [Integer] fast break points
+    attribute :pts_fb, Shale::Type::Integer
+
+    # @!attribute [rw] pts_paint
+    #   Returns points in the paint
+    #   @api public
+    #   @example
+    #     stat.pts_paint #=> 42
+    #   @return [Integer] points in the paint
+    attribute :pts_paint, Shale::Type::Integer
+
+    # @!attribute [rw] opp_pts_off_tov
+    #   Returns opponent points off turnovers
+    #   @api public
+    #   @example
+    #     stat.opp_pts_off_tov #=> 10
+    #   @return [Integer] opponent points off turnovers
+    attribute :opp_pts_off_tov, Shale::Type::Integer
+
+    # @!attribute [rw] opp_pts_2nd_chance
+    #   Returns opponent second chance points
+    #   @api public
+    #   @example
+    #     stat.opp_pts_2nd_chance #=> 6
+    #   @return [Integer] opponent second chance points
+    attribute :opp_pts_2nd_chance, Shale::Type::Integer
+
+    # @!attribute [rw] opp_pts_fb
+    #   Returns opponent fast break points
+    #   @api public
+    #   @example
+    #     stat.opp_pts_fb #=> 9
+    #   @return [Integer] opponent fast break points
+    attribute :opp_pts_fb, Shale::Type::Integer
+
+    # @!attribute [rw] opp_pts_paint
+    #   Returns opponent points in the paint
+    #   @api public
+    #   @example
+    #     stat.opp_pts_paint #=> 38
+    #   @return [Integer] opponent points in the paint
+    attribute :opp_pts_paint, Shale::Type::Integer
+
+    # @!attribute [rw] blk
+    #   Returns blocks
+    #   @api public
+    #   @example
+    #     stat.blk #=> 2
+    #   @return [Integer] blocks
+    attribute :blk, Shale::Type::Integer
+
+    # @!attribute [rw] blka
+    #   Returns blocked attempts
+    #   @api public
+    #   @example
+    #     stat.blka #=> 1
+    #   @return [Integer] blocked attempts
+    attribute :blka, Shale::Type::Integer
+
+    # @!attribute [rw] pf
+    #   Returns personal fouls
+    #   @api public
+    #   @example
+    #     stat.pf #=> 3
+    #   @return [Integer] personal fouls
+    attribute :pf, Shale::Type::Integer
+
+    # @!attribute [rw] pfd
+    #   Returns personal fouls drawn
+    #   @api public
+    #   @example
+    #     stat.pfd #=> 4
+    #   @return [Integer] personal fouls drawn
+    attribute :pfd, Shale::Type::Integer
+
+    # 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_misc_team_stat.rb

@@ -0,0 +1,173 @@
+require "shale"
+require "equalizer"
+
+module NBA
+  # Represents a team's miscellaneous box score statistics for a game
+  class BoxScoreMiscTeamStat < Shale::Mapper
+    include Equalizer.new(:game_id, :team_id)
+
+    # @!attribute [rw] game_id
+    #   Returns the game ID
+    #   @api public
+    #   @example
+    #     stat.game_id #=> "0022400565"
+    #   @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] pts_off_tov
+    #   Returns points off turnovers
+    #   @api public
+    #   @example
+    #     stat.pts_off_tov #=> 18
+    #   @return [Integer] points off turnovers
+    attribute :pts_off_tov, Shale::Type::Integer
+
+    # @!attribute [rw] pts_2nd_chance
+    #   Returns second chance points
+    #   @api public
+    #   @example
+    #     stat.pts_2nd_chance #=> 14
+    #   @return [Integer] second chance points
+    attribute :pts_2nd_chance, Shale::Type::Integer
+
+    # @!attribute [rw] pts_fb
+    #   Returns fast break points
+    #   @api public
+    #   @example
+    #     stat.pts_fb #=> 22
+    #   @return [Integer] fast break points
+    attribute :pts_fb, Shale::Type::Integer
+
+    # @!attribute [rw] pts_paint
+    #   Returns points in the paint
+    #   @api public
+    #   @example
+    #     stat.pts_paint #=> 54
+    #   @return [Integer] points in the paint
+    attribute :pts_paint, Shale::Type::Integer
+
+    # @!attribute [rw] opp_pts_off_tov
+    #   Returns opponent points off turnovers
+    #   @api public
+    #   @example
+    #     stat.opp_pts_off_tov #=> 15
+    #   @return [Integer] opponent points off turnovers
+    attribute :opp_pts_off_tov, Shale::Type::Integer
+
+    # @!attribute [rw] opp_pts_2nd_chance
+    #   Returns opponent second chance points
+    #   @api public
+    #   @example
+    #     stat.opp_pts_2nd_chance #=> 11
+    #   @return [Integer] opponent second chance points
+    attribute :opp_pts_2nd_chance, Shale::Type::Integer
+
+    # @!attribute [rw] opp_pts_fb
+    #   Returns opponent fast break points
+    #   @api public
+    #   @example
+    #     stat.opp_pts_fb #=> 16
+    #   @return [Integer] opponent fast break points
+    attribute :opp_pts_fb, Shale::Type::Integer
+
+    # @!attribute [rw] opp_pts_paint
+    #   Returns opponent points in the paint
+    #   @api public
+    #   @example
+    #     stat.opp_pts_paint #=> 48
+    #   @return [Integer] opponent points in the paint
+    attribute :opp_pts_paint, Shale::Type::Integer
+
+    # @!attribute [rw] blk
+    #   Returns blocks
+    #   @api public
+    #   @example
+    #     stat.blk #=> 7
+    #   @return [Integer] blocks
+    attribute :blk, Shale::Type::Integer
+
+    # @!attribute [rw] blka
+    #   Returns blocked attempts
+    #   @api public
+    #   @example
+    #     stat.blka #=> 5
+    #   @return [Integer] blocked attempts
+    attribute :blka, Shale::Type::Integer
+
+    # @!attribute [rw] pf
+    #   Returns personal fouls
+    #   @api public
+    #   @example
+    #     stat.pf #=> 21
+    #   @return [Integer] personal fouls
+    attribute :pf, Shale::Type::Integer
+
+    # @!attribute [rw] pfd
+    #   Returns personal fouls drawn
+    #   @api public
+    #   @example
+    #     stat.pfd #=> 19
+    #   @return [Integer] personal fouls drawn
+    attribute :pfd, Shale::Type::Integer
+
+    # 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_misc_v3.rb

@@ -0,0 +1,163 @@
+require "json"
+require_relative "client"
+require_relative "collection"
+require_relative "box_score_misc_player_stat"
+require_relative "box_score_misc_team_stat"
+require_relative "box_score_v3_helpers"
+require_relative "utils"
+
+module NBA
+  # Provides methods to retrieve miscellaneous box score statistics using V3 API
+  module BoxScoreMiscV3
+    # @return [String] JSON key for miscellaneous box score data
+    BOX_SCORE_KEY = "boxScoreMisc".freeze
+    # @return [String] JSON key for player statistics
+    PLAYER_STATS = "PlayerStats".freeze
+    # @return [String] JSON key for team statistics
+    TEAM_STATS = "TeamStats".freeze
+
+    # Retrieves misc player box score stats for a game
+    #
+    # @api public
+    # @example
+    #   stats = NBA::BoxScoreMiscV3.player_stats(game: "0022400001")
+    #   stats.each { |stat| puts "#{stat.player_name}: #{stat.pts_paint}" }
+    # @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 misc 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 misc team box score stats for a game
+    #
+    # @api public
+    # @example
+    #   stats = NBA::BoxScoreMiscV3.team_stats(game: "0022400001")
+    #   stats.each { |stat| puts "#{stat.team_abbreviation}: #{stat.pts_paint}" }
+    # @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 misc 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)
+      "boxscoremiscv3?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 [BoxScoreMiscPlayerStat] the player stat object
+    def self.build_player_stat(player, game_id)
+      stats = player.fetch("statistics", {})
+      BoxScoreMiscPlayerStat.new(
+        **BoxScoreV3Helpers.player_identity(player, game_id),
+        min: stats["minutes"],
+        **misc_stats(stats)
+      )
+    end
+    private_class_method :build_player_stat
+
+    # Builds a team stat object from raw data
+    # @api private
+    # @return [BoxScoreMiscTeamStat] the team stat object
+    def self.build_team_stat(team, game_id)
+      stats = team.fetch("statistics", {})
+      BoxScoreMiscTeamStat.new(
+        **BoxScoreV3Helpers.team_identity(team, game_id),
+        min: stats["minutes"],
+        **misc_stats(stats)
+      )
+    end
+    private_class_method :build_team_stat
+
+    # Extracts miscellaneous statistics from raw data
+    # @api private
+    # @return [Hash] miscellaneous statistics
+    def self.misc_stats(stats)
+      points_stats(stats).merge(opponent_stats(stats), block_foul_stats(stats))
+    end
+    private_class_method :misc_stats
+
+    # Extracts points statistics from raw data
+    # @api private
+    # @return [Hash] points statistics
+    def self.points_stats(stats)
+      {
+        pts_off_tov: stats["pointsOffTurnovers"],
+        pts_2nd_chance: stats["pointsSecondChance"],
+        pts_fb: stats["pointsFastBreak"],
+        pts_paint: stats["pointsPaint"]
+      }
+    end
+    private_class_method :points_stats
+
+    # Extracts opponent statistics from raw data
+    # @api private
+    # @return [Hash] opponent statistics
+    def self.opponent_stats(stats)
+      {
+        opp_pts_off_tov: stats["oppPointsOffTurnovers"],
+        opp_pts_2nd_chance: stats["oppPointsSecondChance"],
+        opp_pts_fb: stats["oppPointsFastBreak"],
+        opp_pts_paint: stats["oppPointsPaint"]
+      }
+    end
+    private_class_method :opponent_stats
+
+    # Extracts block and foul statistics from raw data
+    # @api private
+    # @return [Hash] block and foul statistics
+    def self.block_foul_stats(stats)
+      {
+        blk: stats["blocks"],
+        blka: stats["blocksAgainst"],
+        pf: stats["foulsPersonal"],
+        pfd: stats["foulsDrawn"]
+      }
+    end
+    private_class_method :block_foul_stats
+  end
+end