nba 0.1.1 → 0.2.0

data/lib/nba/win_probability.rb

@@ -0,0 +1,117 @@
+require "json"
+require_relative "client"
+require_relative "collection"
+require_relative "utils"
+
+require_relative "win_probability_point"
+
+module NBA
+  # Provides methods to retrieve win probability data
+  module WinProbability
+    # Result set name for win probability
+    # @return [String] the result set name
+    WIN_PROB_PBP = "WinProbPBP".freeze
+
+    # Retrieves win probability data for a game
+    #
+    # @api public
+    # @example
+    #   points = NBA::WinProbability.find(game: "0022400001")
+    #   points.each { |p| puts "Period #{p.period}: Home #{(p.home_pct * 100).round}%" }
+    # @param game [String, Game] the game ID or Game object
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of win probability points
+    def self.find(game:, client: CLIENT)
+      game_id = Utils.extract_id(game)
+      path = "winprobabilitypbp?GameID=#{game_id}&LeagueID=00"
+      response = client.get(path)
+      parse_response(response, game_id)
+    end
+
+    # Parses the API response into win probability point objects
+    #
+    # @api private
+    # @return [Collection] collection of win probability points
+    def self.parse_response(response, game_id)
+      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
+
+      points = rows.map { |row| build_win_prob_point(headers, row, game_id) }
+      Collection.new(points)
+    end
+    private_class_method :parse_response
+
+    # Finds the result set in the response
+    #
+    # @api private
+    # @return [Hash, nil] the result set hash
+    def self.find_result_set(data)
+      result_sets = data["resultSets"]
+      return unless result_sets
+
+      result_sets.find { |rs| rs["name"].eql?(WIN_PROB_PBP) }
+    end
+    private_class_method :find_result_set
+
+    # Builds a WinProbabilityPoint object from raw data
+    #
+    # @api private
+    # @return [WinProbabilityPoint] the win probability point object
+    def self.build_win_prob_point(headers, row, game_id)
+      data = headers.zip(row).to_h
+      WinProbabilityPoint.new(**win_prob_attributes(data, game_id))
+    end
+    private_class_method :build_win_prob_point
+
+    # Combines all win probability attributes
+    #
+    # @api private
+    # @return [Hash] the combined attributes
+    def self.win_prob_attributes(data, game_id)
+      event_attributes(data, game_id)
+        .merge(score_attributes(data))
+        .merge(description_attributes(data))
+    end
+    private_class_method :win_prob_attributes
+
+    # Extracts event attributes from data
+    #
+    # @api private
+    # @return [Hash] event attributes
+    def self.event_attributes(data, game_id)
+      {game_id: game_id, event_num: data["EVENT_NUM"],
+       period: data["PERIOD"], seconds_remaining: data["SECONDS_REMAINING"],
+       location: data["LOCATION"]}
+    end
+    private_class_method :event_attributes
+
+    # Extracts score attributes from data
+    #
+    # @api private
+    # @return [Hash] score attributes
+    def self.score_attributes(data)
+      {home_pct: data["HOME_PCT"], visitor_pct: data["VISITOR_PCT"],
+       home_pts: data["HOME_PTS"], visitor_pts: data["VISITOR_PTS"],
+       home_score_by: data["HOME_SCORE_BY"], visitor_score_by: data["VISITOR_SCORE_BY"]}
+    end
+    private_class_method :score_attributes
+
+    # Extracts description attributes from data
+    #
+    # @api private
+    # @return [Hash] description attributes
+    def self.description_attributes(data)
+      {home_description: data["HOME_DESCRIPTION"],
+       neutral_description: data["NEUTRAL_DESCRIPTION"],
+       visitor_description: data["VISITOR_DESCRIPTION"]}
+    end
+    private_class_method :description_attributes
+  end
+end

data/lib/nba/win_probability_point.rb

@@ -0,0 +1,140 @@
+module NBA
+  # Represents a win probability data point
+  class WinProbabilityPoint < Shale::Mapper
+    include Equalizer.new(:game_id, :event_num)
+
+    # @!attribute [rw] game_id
+    #   Returns the game ID
+    #   @api public
+    #   @example
+    #     point.game_id #=> "0022400001"
+    #   @return [String] the game ID
+    attribute :game_id, Shale::Type::String
+
+    # @!attribute [rw] event_num
+    #   Returns the event number
+    #   @api public
+    #   @example
+    #     point.event_num #=> 1
+    #   @return [Integer] the event number
+    attribute :event_num, Shale::Type::Integer
+
+    # @!attribute [rw] home_pct
+    #   Returns the home team win probability
+    #   @api public
+    #   @example
+    #     point.home_pct #=> 0.52
+    #   @return [Float] home win probability (0.0 to 1.0)
+    attribute :home_pct, Shale::Type::Float
+
+    # @!attribute [rw] visitor_pct
+    #   Returns the visitor team win probability
+    #   @api public
+    #   @example
+    #     point.visitor_pct #=> 0.48
+    #   @return [Float] visitor win probability (0.0 to 1.0)
+    attribute :visitor_pct, Shale::Type::Float
+
+    # @!attribute [rw] home_pts
+    #   Returns the home team points at this event
+    #   @api public
+    #   @example
+    #     point.home_pts #=> 25
+    #   @return [Integer] home team points
+    attribute :home_pts, Shale::Type::Integer
+
+    # @!attribute [rw] visitor_pts
+    #   Returns the visitor team points at this event
+    #   @api public
+    #   @example
+    #     point.visitor_pts #=> 23
+    #   @return [Integer] visitor team points
+    attribute :visitor_pts, Shale::Type::Integer
+
+    # @!attribute [rw] home_score_by
+    #   Returns points scored by home team on this event
+    #   @api public
+    #   @example
+    #     point.home_score_by #=> 2
+    #   @return [Integer] points scored
+    attribute :home_score_by, Shale::Type::Integer
+
+    # @!attribute [rw] visitor_score_by
+    #   Returns points scored by visitor team on this event
+    #   @api public
+    #   @example
+    #     point.visitor_score_by #=> 0
+    #   @return [Integer] points scored
+    attribute :visitor_score_by, Shale::Type::Integer
+
+    # @!attribute [rw] period
+    #   Returns the period
+    #   @api public
+    #   @example
+    #     point.period #=> 1
+    #   @return [Integer] the period number
+    attribute :period, Shale::Type::Integer
+
+    # @!attribute [rw] seconds_remaining
+    #   Returns seconds remaining in the period
+    #   @api public
+    #   @example
+    #     point.seconds_remaining #=> 420
+    #   @return [Integer] seconds remaining
+    attribute :seconds_remaining, Shale::Type::Integer
+
+    # @!attribute [rw] home_description
+    #   Returns the home team play description
+    #   @api public
+    #   @example
+    #     point.home_description #=> "Curry 3PT Shot"
+    #   @return [String] the description
+    attribute :home_description, Shale::Type::String
+
+    # @!attribute [rw] neutral_description
+    #   Returns the neutral play description
+    #   @api public
+    #   @example
+    #     point.neutral_description #=> "Jump Ball"
+    #   @return [String] the description
+    attribute :neutral_description, Shale::Type::String
+
+    # @!attribute [rw] visitor_description
+    #   Returns the visitor team play description
+    #   @api public
+    #   @example
+    #     point.visitor_description #=> "James Layup"
+    #   @return [String] the description
+    attribute :visitor_description, Shale::Type::String
+
+    # @!attribute [rw] location
+    #   Returns the event location
+    #   @api public
+    #   @example
+    #     point.location #=> "H"
+    #   @return [String] the location
+    attribute :location, Shale::Type::String
+
+    # Returns the description for this event
+    #
+    # @api public
+    # @example
+    #   point.description #=> "Curry 3PT Shot"
+    # @return [String, nil] the description
+    def description
+      home_description || neutral_description || visitor_description
+    end
+
+    # Returns the score margin (positive = home leading)
+    #
+    # @api public
+    # @example
+    #   point.margin #=> 5
+    # @return [Integer, nil] the score margin, or nil if either score is missing
+    def margin
+      return nil unless home_pts && visitor_pts
+
+      home_pts - visitor_pts
+    end
+  end
+end

data/lib/nba.rb

@@ -1,5 +1,249 @@
-require 'nba/request'
-require 'nba/team'
-require 'nba/player'
-require 'nba/game'
-require 'nba/cli'
+# NBA Stats API client library
+#
+# @api public
+module NBA
+end
+
+require_relative "nba/version"
+require_relative "nba/utils"
+require_relative "nba/connection"
+require_relative "nba/client"
+require_relative "nba/collection"
+require_relative "nba/response_parser"
+require_relative "nba/conference"
+require_relative "nba/division"
+require_relative "nba/position"
+require_relative "nba/team"
+require_relative "nba/player"
+require_relative "nba/game"
+require_relative "nba/league"
+require_relative "nba/games"
+require_relative "nba/leader"
+require_relative "nba/standing"
+require_relative "nba/game_log"
+require_relative "nba/career_stats"
+require_relative "nba/data"
+require_relative "nba/teams"
+require_relative "nba/players"
+require_relative "nba/roster"
+require_relative "nba/scoreboard"
+require_relative "nba/leaders"
+require_relative "nba/standings"
+require_relative "nba/player_game_log"
+require_relative "nba/player_game_logs"
+require_relative "nba/upcoming_game"
+require_relative "nba/player_next_n_games"
+require_relative "nba/player_profile_v2"
+require_relative "nba/player_career_stats"
+require_relative "nba/team_game_log"
+require_relative "nba/franchise"
+require_relative "nba/franchise_history"
+require_relative "nba/franchise_leader"
+require_relative "nba/franchise_leaders"
+require_relative "nba/franchise_player"
+require_relative "nba/franchise_players"
+require_relative "nba/box_score"
+require_relative "nba/box_score_traditional"
+require_relative "nba/play"
+require_relative "nba/play_by_play"
+require_relative "nba/shot"
+require_relative "nba/shot_chart"
+require_relative "nba/box_score_advanced"
+require_relative "nba/box_score_scoring"
+require_relative "nba/box_score_misc"
+require_relative "nba/box_score_usage"
+require_relative "nba/box_score_four_factors"
+require_relative "nba/player_awards"
+require_relative "nba/player_compare"
+require_relative "nba/draft_history"
+require_relative "nba/draft_combine_spot_shooting_result"
+require_relative "nba/draft_combine_spot_shooting"
+require_relative "nba/draft_combine_stat"
+require_relative "nba/draft_combine_stats"
+require_relative "nba/draft_board_pick"
+require_relative "nba/draft_board"
+require_relative "nba/draft_combine_drill_result"
+require_relative "nba/draft_combine_drill_results"
+require_relative "nba/draft_combine_non_stationary_shooting_result"
+require_relative "nba/draft_combine_non_stationary_shooting"
+require_relative "nba/draft_combine_anthro_measurement"
+require_relative "nba/draft_combine_player_anthro"
+require_relative "nba/game_rotation"
+require_relative "nba/league_game_log"
+require_relative "nba/league_standings"
+require_relative "nba/league_dash_player_stats"
+require_relative "nba/team_details"
+require_relative "nba/team_year_by_year_stats"
+require_relative "nba/common_playoff_series"
+require_relative "nba/schedule"
+require_relative "nba/player_info"
+require_relative "nba/common_player_info"
+require_relative "nba/all_time_leader"
+require_relative "nba/all_time_leaders"
+require_relative "nba/league_dash_team_stat"
+require_relative "nba/league_dash_team_stats"
+require_relative "nba/box_score_hustle_player_stat"
+require_relative "nba/box_score_hustle_team_stat"
+require_relative "nba/box_score_hustle"
+require_relative "nba/box_score_defensive_player_stat"
+require_relative "nba/box_score_defensive_team_stat"
+require_relative "nba/box_score_defensive_v2"
+require_relative "nba/box_score_player_track_stat"
+require_relative "nba/box_score_player_track_team_stat"
+require_relative "nba/box_score_player_track"
+require_relative "nba/box_score_summary"
+require_relative "nba/box_score_summary_v2"
+require_relative "nba/box_score_summary_v3_data"
+require_relative "nba/box_score_summary_v3"
+require_relative "nba/team_year"
+require_relative "nba/common_team_years"
+require_relative "nba/cume_stats_player_game"
+require_relative "nba/cume_stats_player_total"
+require_relative "nba/cume_stats_player"
+require_relative "nba/cume_stats_player_games_entry"
+require_relative "nba/cume_stats_player_games"
+require_relative "nba/cume_stats_team_games_entry"
+require_relative "nba/cume_stats_team_games"
+require_relative "nba/cume_stats_team_player"
+require_relative "nba/cume_stats_team_total"
+require_relative "nba/cume_stats_team"
+require_relative "nba/live_connection"
+require_relative "nba/live_game"
+require_relative "nba/live_scoreboard"
+require_relative "nba/live_box_score"
+require_relative "nba/live_play_by_play"
+require_relative "nba/league_game_finder"
+require_relative "nba/player_dashboard"
+require_relative "nba/team_dashboard"
+require_relative "nba/synergy_play_types"
+require_relative "nba/win_probability"
+require_relative "nba/shot_chart_league_wide"
+require_relative "nba/box_score_starter_bench_stat"
+require_relative "nba/box_score_traditional_v3"
+require_relative "nba/box_score_advanced_v3"
+require_relative "nba/box_score_scoring_v3"
+require_relative "nba/box_score_misc_v3"
+require_relative "nba/box_score_four_factors_v3"
+require_relative "nba/box_score_usage_v3"
+require_relative "nba/box_score_matchup_stat"
+require_relative "nba/box_score_matchups_v3"
+require_relative "nba/player_index"
+require_relative "nba/player_career_by_college"
+require_relative "nba/player_career_by_college_rollup"
+require_relative "nba/player_estimated_metrics"
+require_relative "nba/game_streak"
+require_relative "nba/player_game_streak_finder"
+require_relative "nba/pass_stat"
+require_relative "nba/player_dash_pt_pass"
+require_relative "nba/rebound_stat"
+require_relative "nba/player_dash_pt_reb"
+require_relative "nba/defensive_shot_stat"
+require_relative "nba/player_dash_pt_shot_defend"
+require_relative "nba/shot_stat"
+require_relative "nba/player_dash_pt_shots"
+require_relative "nba/fantasy_profile_stat"
+require_relative "nba/player_fantasy_profile_bar_graph"
+require_relative "nba/vs_player_stat"
+require_relative "nba/player_vs_player"
+require_relative "nba/team_info"
+require_relative "nba/team_season_rank"
+require_relative "nba/team_info_common"
+require_relative "nba/team_estimated_metrics"
+require_relative "nba/team_historical_leader"
+require_relative "nba/team_historical_leaders"
+require_relative "nba/team_game_streak"
+require_relative "nba/team_game_streak_finder"
+require_relative "nba/team_pass_stat"
+require_relative "nba/team_dash_pt_pass"
+require_relative "nba/team_rebound_stat"
+require_relative "nba/team_dash_pt_reb"
+require_relative "nba/team_shot_stat"
+require_relative "nba/team_dash_pt_shots"
+require_relative "nba/team_player_stat"
+require_relative "nba/team_player_dashboard"
+require_relative "nba/team_on_off_overall_stat"
+require_relative "nba/team_on_off_player_stat"
+require_relative "nba/team_player_on_off_details"
+require_relative "nba/team_on_off_player_summary"
+require_relative "nba/team_player_on_off_summary"
+require_relative "nba/team_vs_player_stat"
+require_relative "nba/team_vs_player"
+require_relative "nba/team_and_players_vs_players_stat"
+require_relative "nba/team_and_players_vs_players"
+require_relative "nba/league_dash_player_clutch_stat"
+require_relative "nba/league_dash_player_clutch"
+require_relative "nba/league_dash_team_clutch_stat"
+require_relative "nba/league_dash_team_clutch"
+require_relative "nba/league_dash_player_pt_shot_stat"
+require_relative "nba/league_dash_player_pt_shot"
+require_relative "nba/league_dash_team_pt_shot_stat"
+require_relative "nba/league_dash_team_pt_shot"
+require_relative "nba/league_dash_opp_pt_shot"
+require_relative "nba/league_dash_player_bio_stat"
+require_relative "nba/league_dash_player_bio_stats"
+require_relative "nba/league_dash_lineup_stat"
+require_relative "nba/league_dash_lineups"
+require_relative "nba/league_dash_player_shot_location_stat"
+require_relative "nba/league_dash_player_shot_locations"
+require_relative "nba/league_dash_team_shot_location_stat"
+require_relative "nba/league_dash_team_shot_locations"
+require_relative "nba/league_dash_pt_defend_stat"
+require_relative "nba/league_dash_pt_defend"
+require_relative "nba/league_dash_pt_team_defend_stat"
+require_relative "nba/league_dash_pt_team_defend"
+require_relative "nba/league_dash_pt_stats_stat"
+require_relative "nba/league_dash_pt_stats"
+require_relative "nba/league_lineup_viz_stat"
+require_relative "nba/league_lineup_viz"
+require_relative "nba/league_player_on_details_stat"
+require_relative "nba/league_player_on_details"
+require_relative "nba/league_season_matchup_stat"
+require_relative "nba/league_season_matchups"
+require_relative "nba/video_detail"
+require_relative "nba/video_details_asset_entry"
+require_relative "nba/video_details_asset"
+require_relative "nba/video_details"
+require_relative "nba/video_event"
+require_relative "nba/video_events"
+require_relative "nba/video_status_entry"
+require_relative "nba/video_status"
+require_relative "nba/assist_leader"
+require_relative "nba/assist_leaders"
+require_relative "nba/assist_tracker_entry"
+require_relative "nba/assist_tracker"
+require_relative "nba/ist_standing"
+require_relative "nba/ist_standings"
+require_relative "nba/play_by_play_v3"
+require_relative "nba/scoreboard_v3"
+require_relative "nba/playoff_matchup"
+require_relative "nba/playoff_picture"
+require_relative "nba/home_page_leader"
+require_relative "nba/home_page_leaders"
+require_relative "nba/defense_hub_stat"
+require_relative "nba/defense_hub"
+require_relative "nba/fantasy_widget_player"
+require_relative "nba/fantasy_widget"
+require_relative "nba/home_page_stat"
+require_relative "nba/home_page_v2"
+require_relative "nba/leaders_tile"
+require_relative "nba/leaders_tiles"
+require_relative "nba/matchup_rollup"
+require_relative "nba/matchups_rollup"
+require_relative "nba/shot_chart_lineup_detail"
+require_relative "nba/box_score_similarity_score"
+require_relative "nba/static"
+require_relative "nba/league_hustle_stats_player_stat"
+require_relative "nba/league_hustle_stats_player"
+require_relative "nba/league_hustle_stats_team_stat"
+require_relative "nba/league_hustle_stats_team"
+require_relative "nba/hustle_stats_box_score"
+require_relative "nba/team_game_log_stat"
+require_relative "nba/team_game_logs"
+require_relative "nba/infographic_fan_duel_player_stat"
+require_relative "nba/infographic_fan_duel_player"
+require_relative "nba/dunk_score_leader"
+require_relative "nba/dunk_score_leaders"
+require_relative "nba/video_event_asset"
+require_relative "nba/video_events_asset"
+require_relative "nba/schedule_international"
+require_relative "nba/cli"

data/sig/equalizer.rbs

@@ -0,0 +1,3 @@
+class Equalizer < Module
+  def self.new: (*Symbol) -> Module
+end