nba 0.1.1 → 0.2.0

data/lib/nba/video_events.rb

@@ -0,0 +1,106 @@
+require "json"
+require_relative "client"
+require_relative "collection"
+require_relative "video_event"
+
+module NBA
+  # Provides methods to retrieve video events
+  module VideoEvents
+    # Result set name
+    # @return [String] the result set name
+    RESULTS = "resultSets".freeze
+
+    # Retrieves video events for a game
+    #
+    # @api public
+    # @example
+    #   events = NBA::VideoEvents.all(game: "0022300001")
+    #   events.each { |e| puts "#{e.title}: #{e.video_available?}" }
+    # @param game [String, Game] the game ID or Game object
+    # @param game_event_id [Integer] the game event ID (default 0)
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of video events
+    def self.all(game:, game_event_id: 0, client: CLIENT)
+      game_id = Utils.extract_id(game)
+      path = build_path(game_id, game_event_id)
+      response = client.get(path)
+      parse_response(response)
+    end
+
+    # Builds the API request path
+    # @api private
+    # @return [String] the request path
+    def self.build_path(game_id, game_event_id)
+      "videoevents?GameID=#{game_id}&GameEventID=#{game_event_id}"
+    end
+    private_class_method :build_path
+
+    # Parses the API response into event objects
+    # @api private
+    # @return [Collection] collection of events
+    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
+
+      headers = result_set["headers"]
+      rows = result_set["rowSet"]
+      return Collection.new unless headers && rows
+
+      events = rows.map { |row| build_event(headers, row) }
+      Collection.new(events)
+    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[RESULTS]
+      return unless result_sets
+
+      result_sets.first
+    end
+    private_class_method :find_result_set
+
+    # Builds a VideoEvent object from raw data
+    # @api private
+    # @return [VideoEvent] the event object
+    def self.build_event(headers, row)
+      data = headers.zip(row).to_h
+      VideoEvent.new(**event_attributes(data))
+    end
+    private_class_method :build_event
+
+    # Extracts event attributes from data
+    # @api private
+    # @return [Hash] the event attributes
+    def self.event_attributes(data)
+      game_attributes(data).merge(video_attributes(data))
+    end
+    private_class_method :event_attributes
+
+    # Extracts game attributes
+    # @api private
+    # @return [Hash] the game attributes
+    def self.game_attributes(data)
+      {game_id: data["GAME_ID"], game_event_id: data["GAME_EVENT_ID"]}
+    end
+    private_class_method :game_attributes
+
+    # Extracts video attributes
+    # @api private
+    # @return [Hash] the video attributes
+    def self.video_attributes(data)
+      {video_available: data["VIDEO_AVAILABLE_FLAG"],
+       video_url: data["VIDEO_URL"],
+       video_description: data["DESCRIPTION"],
+       video_category: data["CATEGORY"],
+       uuid: data["UUID"],
+       title: data["TITLE"]}
+    end
+    private_class_method :video_attributes
+  end
+end

data/lib/nba/video_events_asset.rb

@@ -0,0 +1,107 @@
+require "json"
+require_relative "client"
+require_relative "collection"
+require_relative "video_event_asset"
+
+module NBA
+  # Provides methods to retrieve video events with asset information
+  module VideoEventsAsset
+    # Result set name
+    # @return [String] the result set name
+    RESULTS = "resultSets".freeze
+
+    # Retrieves video event assets for a game
+    #
+    # @api public
+    # @example
+    #   assets = NBA::VideoEventsAsset.all(game: "0022300001")
+    #   assets.each { |a| puts "#{a.video_description}: #{a.video_available?}" }
+    # @param game [String, Game] the game ID or Game object
+    # @param game_event_id [Integer] the game event ID (default 0)
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of video event assets
+    def self.all(game:, game_event_id: 0, client: CLIENT)
+      game_id = Utils.extract_id(game)
+      path = build_path(game_id, game_event_id)
+      response = client.get(path)
+      parse_response(response)
+    end
+
+    # Builds the API request path
+    # @api private
+    # @return [String] the request path
+    def self.build_path(game_id, game_event_id)
+      "videoeventsasset?GameID=#{game_id}&GameEventID=#{game_event_id}"
+    end
+    private_class_method :build_path
+
+    # Parses the API response into asset objects
+    # @api private
+    # @return [Collection] collection of assets
+    def self.parse_response(response)
+      return Collection.new if response.nil? || response.empty?
+
+      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
+
+      assets = rows.map { |row| build_asset(headers, row) }
+      Collection.new(assets)
+    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[RESULTS]
+      return unless result_sets
+
+      result_sets.first
+    end
+    private_class_method :find_result_set
+
+    # Builds a VideoEventAsset object from raw data
+    # @api private
+    # @return [VideoEventAsset] the asset object
+    def self.build_asset(headers, row)
+      data = headers.zip(row).to_h
+      VideoEventAsset.new(**asset_attributes(data))
+    end
+    private_class_method :build_asset
+
+    # Extracts asset attributes from data
+    # @api private
+    # @return [Hash] the asset attributes
+    def self.asset_attributes(data)
+      game_attributes(data).merge(video_attributes(data))
+    end
+    private_class_method :asset_attributes
+
+    # Extracts game attributes
+    # @api private
+    # @return [Hash] the game attributes
+    def self.game_attributes(data)
+      {game_id: data["GAME_ID"], game_event_id: data["GAME_EVENT_ID"],
+       uuid: data["UUID"]}
+    end
+    private_class_method :game_attributes
+
+    # Extracts video attributes
+    # @api private
+    # @return [Hash] the video attributes
+    def self.video_attributes(data)
+      {video_available: data["VIDEO_AVAILABLE_FLAG"],
+       video_url: data["VIDEO_URL"],
+       video_description: data["DESCRIPTION"],
+       file_size: data["FILE_SIZE"],
+       aspect_ratio: data["ASPECT_RATIO"],
+       video_duration: data["VIDEO_DURATION"]}
+    end
+    private_class_method :video_attributes
+  end
+end

data/lib/nba/video_status.rb

@@ -0,0 +1,129 @@
+require "json"
+require_relative "client"
+require_relative "collection"
+require_relative "video_status_entry"
+
+module NBA
+  # Provides methods to retrieve video status data
+  module VideoStatus
+    # Result set name
+    # @return [String] the result set name
+    RESULTS = "VideoStatus".freeze
+
+    # Retrieves video status for a game date
+    #
+    # @api public
+    # @example
+    #   entries = NBA::VideoStatus.all(game_date: "2023-10-24")
+    #   entries.each { |e| puts "#{e.home_team_name} vs #{e.visitor_team_name}: #{e.available?}" }
+    # @param game_date [String] the game date (format: YYYY-MM-DD)
+    # @param league [String, League] the league ID or League object (default NBA)
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of video status entries
+    def self.all(game_date:, league: League::NBA, client: CLIENT)
+      league_id = Utils.extract_league_id(league)
+      path = build_path(game_date, league_id)
+      response = client.get(path)
+      parse_response(response)
+    end
+
+    # Builds the API request path
+    # @api private
+    # @return [String] the request path
+    def self.build_path(game_date, league_id)
+      "videostatus?GameDate=#{game_date}&LeagueID=#{league_id}"
+    end
+    private_class_method :build_path
+
+    # Parses the API response into entry objects
+    # @api private
+    # @return [Collection] collection of entries
+    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
+
+      headers = result_set["headers"]
+      rows = result_set["rowSet"]
+      return Collection.new unless headers && rows
+
+      entries = rows.map { |row| build_entry(headers, row) }
+      Collection.new(entries)
+    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?(RESULTS) }
+    end
+    private_class_method :find_result_set
+
+    # Builds a VideoStatusEntry object from raw data
+    # @api private
+    # @return [VideoStatusEntry] the entry object
+    def self.build_entry(headers, row)
+      data = headers.zip(row).to_h
+      VideoStatusEntry.new(**entry_attributes(data))
+    end
+    private_class_method :build_entry
+
+    # Extracts entry attributes from data
+    # @api private
+    # @return [Hash] the entry attributes
+    def self.entry_attributes(data)
+      game_attributes(data).merge(team_attributes(data), availability_attributes(data))
+    end
+    private_class_method :entry_attributes
+
+    # Extracts game attributes
+    # @api private
+    # @return [Hash] the game attributes
+    def self.game_attributes(data)
+      {game_id: data["GAME_ID"], game_date: data["GAME_DATE"],
+       game_status: data["GAME_STATUS"], game_status_text: data["GAME_STATUS_TEXT"]}
+    end
+    private_class_method :game_attributes
+
+    # Extracts team attributes
+    # @api private
+    # @return [Hash] the team attributes
+    def self.team_attributes(data)
+      visitor_team_attributes(data).merge(home_team_attributes(data))
+    end
+    private_class_method :team_attributes
+
+    # Extracts visitor team attributes
+    # @api private
+    # @return [Hash] the visitor team attributes
+    def self.visitor_team_attributes(data)
+      {visitor_team_id: data["VISITOR_TEAM_ID"], visitor_team_city: data["VISITOR_TEAM_CITY"],
+       visitor_team_name: data["VISITOR_TEAM_NAME"],
+       visitor_team_abbreviation: data["VISITOR_TEAM_ABBREVIATION"]}
+    end
+    private_class_method :visitor_team_attributes
+
+    # Extracts home team attributes
+    # @api private
+    # @return [Hash] the home team attributes
+    def self.home_team_attributes(data)
+      {home_team_id: data["HOME_TEAM_ID"], home_team_city: data["HOME_TEAM_CITY"],
+       home_team_name: data["HOME_TEAM_NAME"], home_team_abbreviation: data["HOME_TEAM_ABBREVIATION"]}
+    end
+    private_class_method :home_team_attributes
+
+    # Extracts availability attributes
+    # @api private
+    # @return [Hash] the availability attributes
+    def self.availability_attributes(data)
+      {is_available: data["IS_AVAILABLE"], pt_xyz_available: data["PT_XYZ_AVAILABLE"]}
+    end
+    private_class_method :availability_attributes
+  end
+end

data/lib/nba/video_status_entry.rb

@@ -0,0 +1,161 @@
+require "equalizer"
+require "shale"
+
+module NBA
+  # Represents a video status entry
+  class VideoStatusEntry < Shale::Mapper
+    include Equalizer.new(:game_id)
+
+    # @!attribute [rw] game_id
+    #   Returns the game ID
+    #   @api public
+    #   @example
+    #     entry.game_id #=> "0022300001"
+    #   @return [String] the game ID
+    attribute :game_id, Shale::Type::String
+
+    # @!attribute [rw] game_date
+    #   Returns the game date
+    #   @api public
+    #   @example
+    #     entry.game_date #=> "2023-10-24"
+    #   @return [String] the game date
+    attribute :game_date, Shale::Type::String
+
+    # @!attribute [rw] visitor_team_id
+    #   Returns the visiting team ID
+    #   @api public
+    #   @example
+    #     entry.visitor_team_id #=> 1610612744
+    #   @return [Integer] the visiting team ID
+    attribute :visitor_team_id, Shale::Type::Integer
+
+    # @!attribute [rw] visitor_team_city
+    #   Returns the visiting team city
+    #   @api public
+    #   @example
+    #     entry.visitor_team_city #=> "Golden State"
+    #   @return [String] the visiting team city
+    attribute :visitor_team_city, Shale::Type::String
+
+    # @!attribute [rw] visitor_team_name
+    #   Returns the visiting team name
+    #   @api public
+    #   @example
+    #     entry.visitor_team_name #=> "Warriors"
+    #   @return [String] the visiting team name
+    attribute :visitor_team_name, Shale::Type::String
+
+    # @!attribute [rw] visitor_team_abbreviation
+    #   Returns the visiting team abbreviation
+    #   @api public
+    #   @example
+    #     entry.visitor_team_abbreviation #=> "GSW"
+    #   @return [String] the visiting team abbreviation
+    attribute :visitor_team_abbreviation, Shale::Type::String
+
+    # @!attribute [rw] home_team_id
+    #   Returns the home team ID
+    #   @api public
+    #   @example
+    #     entry.home_team_id #=> 1610612747
+    #   @return [Integer] the home team ID
+    attribute :home_team_id, Shale::Type::Integer
+
+    # @!attribute [rw] home_team_city
+    #   Returns the home team city
+    #   @api public
+    #   @example
+    #     entry.home_team_city #=> "Los Angeles"
+    #   @return [String] the home team city
+    attribute :home_team_city, Shale::Type::String
+
+    # @!attribute [rw] home_team_name
+    #   Returns the home team name
+    #   @api public
+    #   @example
+    #     entry.home_team_name #=> "Lakers"
+    #   @return [String] the home team name
+    attribute :home_team_name, Shale::Type::String
+
+    # @!attribute [rw] home_team_abbreviation
+    #   Returns the home team abbreviation
+    #   @api public
+    #   @example
+    #     entry.home_team_abbreviation #=> "LAL"
+    #   @return [String] the home team abbreviation
+    attribute :home_team_abbreviation, Shale::Type::String
+
+    # @!attribute [rw] game_status
+    #   Returns the game status code
+    #   @api public
+    #   @example
+    #     entry.game_status #=> 3
+    #   @return [Integer] the game status code
+    attribute :game_status, Shale::Type::Integer
+
+    # @!attribute [rw] game_status_text
+    #   Returns the game status text
+    #   @api public
+    #   @example
+    #     entry.game_status_text #=> "Final"
+    #   @return [String] the game status text
+    attribute :game_status_text, Shale::Type::String
+
+    # @!attribute [rw] is_available
+    #   Returns the video availability flag
+    #   @api public
+    #   @example
+    #     entry.is_available #=> 1
+    #   @return [Integer] the video availability flag
+    attribute :is_available, Shale::Type::Integer
+
+    # @!attribute [rw] pt_xyz_available
+    #   Returns the PT XYZ availability flag
+    #   @api public
+    #   @example
+    #     entry.pt_xyz_available #=> 1
+    #   @return [Integer] the PT XYZ availability flag
+    attribute :pt_xyz_available, Shale::Type::Integer
+
+    # Returns whether video is available
+    #
+    # @api public
+    # @example
+    #   entry.available? #=> true
+    # @return [Boolean] true if video is available
+    def available?
+      is_available.eql?(1)
+    end
+
+    # Returns whether PT XYZ data is available
+    #
+    # @api public
+    # @example
+    #   entry.pt_xyz_available? #=> true
+    # @return [Boolean] true if PT XYZ is available
+    def pt_xyz_available?
+      pt_xyz_available.eql?(1)
+    end
+
+    # Returns the home team object
+    #
+    # @api public
+    # @example
+    #   entry.home_team #=> #<NBA::Team>
+    # @return [Team, nil] the home team object
+    def home_team
+      Teams.find(home_team_id)
+    end
+
+    # Returns the visiting team object
+    #
+    # @api public
+    # @example
+    #   entry.visitor_team #=> #<NBA::Team>
+    # @return [Team, nil] the visiting team object
+    def visitor_team
+      Teams.find(visitor_team_id)
+    end
+  end
+end

data/lib/nba/vs_player_stat.rb

@@ -0,0 +1,156 @@
+require "equalizer"
+require "shale"
+require_relative "players"
+
+module NBA
+  # Represents player vs player comparison statistics
+  #
+  # @api public
+  class VsPlayerStat < Shale::Mapper
+    include Equalizer.new(:player_id, :vs_player_id)
+
+    # @!attribute [rw] player_id
+    #   Returns the player ID
+    #   @api public
+    #   @example
+    #     stat.player_id #=> 201939
+    #   @return [Integer, nil] the player's ID
+    attribute :player_id, Shale::Type::Integer
+
+    # @!attribute [rw] vs_player_id
+    #   Returns the vs player ID
+    #   @api public
+    #   @example
+    #     stat.vs_player_id #=> 201566
+    #   @return [Integer, nil] the vs player's ID
+    attribute :vs_player_id, Shale::Type::Integer
+
+    # @!attribute [rw] court_status
+    #   Returns the on/off court status
+    #   @api public
+    #   @example
+    #     stat.court_status #=> "On"
+    #   @return [String, nil] on/off court status
+    attribute :court_status, Shale::Type::String
+
+    # @!attribute [rw] gp
+    #   Returns games played
+    #   @api public
+    #   @example
+    #     stat.gp #=> 24
+    #   @return [Integer, nil] games played
+    attribute :gp, Shale::Type::Integer
+
+    # @!attribute [rw] min
+    #   Returns minutes played
+    #   @api public
+    #   @example
+    #     stat.min #=> 32.5
+    #   @return [Float, nil] minutes played
+    attribute :min, Shale::Type::Float
+
+    # @!attribute [rw] pts
+    #   Returns points
+    #   @api public
+    #   @example
+    #     stat.pts #=> 26.4
+    #   @return [Float, nil] points
+    attribute :pts, Shale::Type::Float
+
+    # @!attribute [rw] reb
+    #   Returns rebounds
+    #   @api public
+    #   @example
+    #     stat.reb #=> 5.7
+    #   @return [Float, nil] rebounds
+    attribute :reb, Shale::Type::Float
+
+    # @!attribute [rw] ast
+    #   Returns assists
+    #   @api public
+    #   @example
+    #     stat.ast #=> 6.1
+    #   @return [Float, nil] assists
+    attribute :ast, Shale::Type::Float
+
+    # @!attribute [rw] stl
+    #   Returns steals
+    #   @api public
+    #   @example
+    #     stat.stl #=> 1.2
+    #   @return [Float, nil] steals
+    attribute :stl, Shale::Type::Float
+
+    # @!attribute [rw] blk
+    #   Returns blocks
+    #   @api public
+    #   @example
+    #     stat.blk #=> 0.3
+    #   @return [Float, nil] blocks
+    attribute :blk, Shale::Type::Float
+
+    # @!attribute [rw] tov
+    #   Returns turnovers
+    #   @api public
+    #   @example
+    #     stat.tov #=> 3.1
+    #   @return [Float, nil] turnovers
+    attribute :tov, Shale::Type::Float
+
+    # @!attribute [rw] fg_pct
+    #   Returns field goal percentage
+    #   @api public
+    #   @example
+    #     stat.fg_pct #=> 0.467
+    #   @return [Float, nil] field goal percentage
+    attribute :fg_pct, Shale::Type::Float
+
+    # @!attribute [rw] plus_minus
+    #   Returns plus/minus
+    #   @api public
+    #   @example
+    #     stat.plus_minus #=> 8.5
+    #   @return [Float, nil] plus/minus
+    attribute :plus_minus, Shale::Type::Float
+
+    # Returns the player
+    #
+    # @api public
+    # @example
+    #   stat.player #=> #<NBA::Player id=201939 ...>
+    # @return [Player, nil] the player object
+    def player
+      Players.find(player_id)
+    end
+
+    # Returns the vs player
+    #
+    # @api public
+    # @example
+    #   stat.vs_player #=> #<NBA::Player id=201566 ...>
+    # @return [Player, nil] the vs player object
+    def vs_player
+      Players.find(vs_player_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