nba 0.1.1 → 0.2.0

data/lib/nba/infographic_fan_duel_player_stat.rb

@@ -0,0 +1,311 @@
+require "equalizer"
+require "shale"
+
+module NBA
+  # Represents FanDuel infographic statistics for a player in a game
+  class InfographicFanDuelPlayerStat < Shale::Mapper
+    include Equalizer.new(:game_id, :player_id)
+
+    # @!attribute [rw] game_id
+    #   Returns the game ID
+    #   @api public
+    #   @example
+    #     stat.game_id #=> "0022400001"
+    #   @return [String] the game ID
+    attribute :game_id, 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] 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] jersey_num
+    #   Returns the jersey number
+    #   @api public
+    #   @example
+    #     stat.jersey_num #=> "30"
+    #   @return [String] the jersey number
+    attribute :jersey_num, Shale::Type::String
+
+    # @!attribute [rw] player_position
+    #   Returns the player position
+    #   @api public
+    #   @example
+    #     stat.player_position #=> "G"
+    #   @return [String] the player position
+    attribute :player_position, Shale::Type::String
+
+    # @!attribute [rw] location
+    #   Returns the location (home/away)
+    #   @api public
+    #   @example
+    #     stat.location #=> "Home"
+    #   @return [String] the location
+    attribute :location, Shale::Type::String
+
+    # @!attribute [rw] fan_duel_pts
+    #   Returns the FanDuel fantasy points
+    #   @api public
+    #   @example
+    #     stat.fan_duel_pts #=> 52.3
+    #   @return [Float] FanDuel points
+    attribute :fan_duel_pts, Shale::Type::Float
+
+    # @!attribute [rw] nba_fantasy_pts
+    #   Returns the NBA fantasy points
+    #   @api public
+    #   @example
+    #     stat.nba_fantasy_pts #=> 48.5
+    #   @return [Float] NBA fantasy points
+    attribute :nba_fantasy_pts, Shale::Type::Float
+
+    # @!attribute [rw] usg_pct
+    #   Returns the usage percentage
+    #   @api public
+    #   @example
+    #     stat.usg_pct #=> 0.312
+    #   @return [Float] usage percentage
+    attribute :usg_pct, Shale::Type::Float
+
+    # @!attribute [rw] min
+    #   Returns the minutes played
+    #   @api public
+    #   @example
+    #     stat.min #=> 34.5
+    #   @return [Float] minutes
+    attribute :min, Shale::Type::Float
+
+    # @!attribute [rw] fgm
+    #   Returns the field goals made
+    #   @api public
+    #   @example
+    #     stat.fgm #=> 10
+    #   @return [Integer] field goals made
+    attribute :fgm, Shale::Type::Integer
+
+    # @!attribute [rw] fga
+    #   Returns the field goals attempted
+    #   @api public
+    #   @example
+    #     stat.fga #=> 20
+    #   @return [Integer] field goals attempted
+    attribute :fga, Shale::Type::Integer
+
+    # @!attribute [rw] fg_pct
+    #   Returns the field goal percentage
+    #   @api public
+    #   @example
+    #     stat.fg_pct #=> 0.500
+    #   @return [Float] field goal percentage
+    attribute :fg_pct, Shale::Type::Float
+
+    # @!attribute [rw] fg3m
+    #   Returns the three-pointers made
+    #   @api public
+    #   @example
+    #     stat.fg3m #=> 5
+    #   @return [Integer] three-pointers made
+    attribute :fg3m, Shale::Type::Integer
+
+    # @!attribute [rw] fg3a
+    #   Returns the three-pointers attempted
+    #   @api public
+    #   @example
+    #     stat.fg3a #=> 11
+    #   @return [Integer] three-pointers attempted
+    attribute :fg3a, Shale::Type::Integer
+
+    # @!attribute [rw] fg3_pct
+    #   Returns the three-point percentage
+    #   @api public
+    #   @example
+    #     stat.fg3_pct #=> 0.455
+    #   @return [Float] three-point percentage
+    attribute :fg3_pct, Shale::Type::Float
+
+    # @!attribute [rw] ftm
+    #   Returns the free throws made
+    #   @api public
+    #   @example
+    #     stat.ftm #=> 5
+    #   @return [Integer] free throws made
+    attribute :ftm, Shale::Type::Integer
+
+    # @!attribute [rw] fta
+    #   Returns the free throws attempted
+    #   @api public
+    #   @example
+    #     stat.fta #=> 6
+    #   @return [Integer] free throws attempted
+    attribute :fta, Shale::Type::Integer
+
+    # @!attribute [rw] ft_pct
+    #   Returns the free throw percentage
+    #   @api public
+    #   @example
+    #     stat.ft_pct #=> 0.833
+    #   @return [Float] free throw percentage
+    attribute :ft_pct, Shale::Type::Float
+
+    # @!attribute [rw] oreb
+    #   Returns the offensive rebounds
+    #   @api public
+    #   @example
+    #     stat.oreb #=> 1
+    #   @return [Integer] offensive rebounds
+    attribute :oreb, Shale::Type::Integer
+
+    # @!attribute [rw] dreb
+    #   Returns the defensive rebounds
+    #   @api public
+    #   @example
+    #     stat.dreb #=> 5
+    #   @return [Integer] defensive rebounds
+    attribute :dreb, Shale::Type::Integer
+
+    # @!attribute [rw] reb
+    #   Returns the total rebounds
+    #   @api public
+    #   @example
+    #     stat.reb #=> 6
+    #   @return [Integer] total rebounds
+    attribute :reb, Shale::Type::Integer
+
+    # @!attribute [rw] ast
+    #   Returns the assists
+    #   @api public
+    #   @example
+    #     stat.ast #=> 8
+    #   @return [Integer] assists
+    attribute :ast, Shale::Type::Integer
+
+    # @!attribute [rw] tov
+    #   Returns the turnovers
+    #   @api public
+    #   @example
+    #     stat.tov #=> 3
+    #   @return [Integer] turnovers
+    attribute :tov, Shale::Type::Integer
+
+    # @!attribute [rw] stl
+    #   Returns the steals
+    #   @api public
+    #   @example
+    #     stat.stl #=> 2
+    #   @return [Integer] steals
+    attribute :stl, Shale::Type::Integer
+
+    # @!attribute [rw] blk
+    #   Returns the blocks
+    #   @api public
+    #   @example
+    #     stat.blk #=> 0
+    #   @return [Integer] blocks
+    attribute :blk, Shale::Type::Integer
+
+    # @!attribute [rw] blka
+    #   Returns the blocked attempts
+    #   @api public
+    #   @example
+    #     stat.blka #=> 1
+    #   @return [Integer] blocked attempts
+    attribute :blka, Shale::Type::Integer
+
+    # @!attribute [rw] pf
+    #   Returns the personal fouls
+    #   @api public
+    #   @example
+    #     stat.pf #=> 2
+    #   @return [Integer] personal fouls
+    attribute :pf, Shale::Type::Integer
+
+    # @!attribute [rw] pfd
+    #   Returns the personal fouls drawn
+    #   @api public
+    #   @example
+    #     stat.pfd #=> 4
+    #   @return [Integer] personal fouls drawn
+    attribute :pfd, Shale::Type::Integer
+
+    # @!attribute [rw] pts
+    #   Returns the points scored
+    #   @api public
+    #   @example
+    #     stat.pts #=> 30
+    #   @return [Integer] points
+    attribute :pts, Shale::Type::Integer
+
+    # @!attribute [rw] plus_minus
+    #   Returns the plus/minus
+    #   @api public
+    #   @example
+    #     stat.plus_minus #=> 15
+    #   @return [Integer] plus/minus
+    attribute :plus_minus, 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 the game object
+    #
+    # @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/ist_standing.rb

@@ -0,0 +1,167 @@
+require "equalizer"
+require "shale"
+require_relative "teams"
+
+module NBA
+  # Represents an In-Season Tournament standing entry
+  class IstStanding < Shale::Mapper
+    include Equalizer.new(:team_id, :season_id)
+
+    # @!attribute [rw] season_id
+    #   Returns the season ID
+    #   @api public
+    #   @example
+    #     standing.season_id #=> "2023-24"
+    #   @return [String] the season ID
+    attribute :season_id, Shale::Type::String
+
+    # @!attribute [rw] team_id
+    #   Returns the team ID
+    #   @api public
+    #   @example
+    #     standing.team_id #=> 1610612747
+    #   @return [Integer] the team ID
+    attribute :team_id, Shale::Type::Integer
+
+    # @!attribute [rw] team_city
+    #   Returns the team city
+    #   @api public
+    #   @example
+    #     standing.team_city #=> "Los Angeles"
+    #   @return [String] the team city
+    attribute :team_city, Shale::Type::String
+
+    # @!attribute [rw] team_name
+    #   Returns the team name
+    #   @api public
+    #   @example
+    #     standing.team_name #=> "Lakers"
+    #   @return [String] the team name
+    attribute :team_name, Shale::Type::String
+
+    # @!attribute [rw] team_abbreviation
+    #   Returns the team abbreviation
+    #   @api public
+    #   @example
+    #     standing.team_abbreviation #=> "LAL"
+    #   @return [String] the team abbreviation
+    attribute :team_abbreviation, Shale::Type::String
+
+    # @!attribute [rw] team_slug
+    #   Returns the team slug
+    #   @api public
+    #   @example
+    #     standing.team_slug #=> "lakers"
+    #   @return [String] the team slug
+    attribute :team_slug, Shale::Type::String
+
+    # @!attribute [rw] conference
+    #   Returns the conference
+    #   @api public
+    #   @example
+    #     standing.conference #=> "West"
+    #   @return [String] the conference
+    attribute :conference, Shale::Type::String
+
+    # @!attribute [rw] ist_group
+    #   Returns the IST group
+    #   @api public
+    #   @example
+    #     standing.ist_group #=> "West Group A"
+    #   @return [String] the IST group
+    attribute :ist_group, Shale::Type::String
+
+    # @!attribute [rw] ist_group_rank
+    #   Returns the rank within IST group
+    #   @api public
+    #   @example
+    #     standing.ist_group_rank #=> 1
+    #   @return [Integer] the IST group rank
+    attribute :ist_group_rank, Shale::Type::Integer
+
+    # @!attribute [rw] wins
+    #   Returns the number of wins
+    #   @api public
+    #   @example
+    #     standing.wins #=> 3
+    #   @return [Integer] the number of wins
+    attribute :wins, Shale::Type::Integer
+
+    # @!attribute [rw] losses
+    #   Returns the number of losses
+    #   @api public
+    #   @example
+    #     standing.losses #=> 1
+    #   @return [Integer] the number of losses
+    attribute :losses, Shale::Type::Integer
+
+    # @!attribute [rw] win_pct
+    #   Returns the win percentage
+    #   @api public
+    #   @example
+    #     standing.win_pct #=> 0.750
+    #   @return [Float] the win percentage
+    attribute :win_pct, Shale::Type::Float
+
+    # @!attribute [rw] pts_for
+    #   Returns total points scored
+    #   @api public
+    #   @example
+    #     standing.pts_for #=> 450
+    #   @return [Integer] points scored
+    attribute :pts_for, Shale::Type::Integer
+
+    # @!attribute [rw] pts_against
+    #   Returns total points allowed
+    #   @api public
+    #   @example
+    #     standing.pts_against #=> 420
+    #   @return [Integer] points allowed
+    attribute :pts_against, Shale::Type::Integer
+
+    # @!attribute [rw] pts_diff
+    #   Returns the point differential
+    #   @api public
+    #   @example
+    #     standing.pts_diff #=> 30
+    #   @return [Integer] the point differential
+    attribute :pts_diff, Shale::Type::Integer
+
+    # @!attribute [rw] clinch_indicator
+    #   Returns the clinch indicator
+    #   @api public
+    #   @example
+    #     standing.clinch_indicator #=> "z"
+    #   @return [String] the clinch indicator
+    attribute :clinch_indicator, Shale::Type::String
+
+    # Returns the team object
+    #
+    # @api public
+    # @example
+    #   standing.team #=> #<NBA::Team>
+    # @return [Team, nil] the team object
+    def team
+      Teams.find(team_id)
+    end
+
+    json do
+      map "season_id", to: :season_id
+      map "team_id", to: :team_id
+      map "team_city", to: :team_city
+      map "team_name", to: :team_name
+      map "team_abbreviation", to: :team_abbreviation
+      map "team_slug", to: :team_slug
+      map "conference", to: :conference
+      map "ist_group", to: :ist_group
+      map "ist_group_rank", to: :ist_group_rank
+      map "wins", to: :wins
+      map "losses", to: :losses
+      map "win_pct", to: :win_pct
+      map "pts_for", to: :pts_for
+      map "pts_against", to: :pts_against
+      map "pts_diff", to: :pts_diff
+      map "clinch_indicator", to: :clinch_indicator
+    end
+  end
+end

data/lib/nba/ist_standings.rb

@@ -0,0 +1,81 @@
+require "json"
+require_relative "client"
+require_relative "collection"
+require_relative "ist_standing"
+require_relative "response_parser"
+require_relative "utils"
+
+module NBA
+  # Provides methods to retrieve NBA In-Season Tournament standings
+  module IstStandings
+    # Result set name for IST standings
+    # @return [String] the result set name
+    RESULT_SET = "Standings".freeze
+
+    # Retrieves In-Season Tournament standings for a season
+    #
+    # @api public
+    # @example
+    #   standings = NBA::IstStandings.all(season: 2023)
+    #   standings.each { |s| puts "#{s.team_name}: #{s.wins}-#{s.losses}" }
+    # @param season [Integer] the season year (defaults to current season)
+    # @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 IST standings
+    def self.all(season: Utils.current_season, league: League::NBA, client: CLIENT)
+      league_id = Utils.extract_league_id(league)
+      path = build_path(season, league_id)
+      ResponseParser.parse(client.get(path), result_set: RESULT_SET) { |data| build_standing(data) }
+    end
+
+    # Builds the API request path
+    # @api private
+    # @return [String] the request path
+    def self.build_path(season, league_id)
+      "iststandings?LeagueID=#{league_id}&Season=#{Utils.format_season(season)}"
+    end
+    private_class_method :build_path
+
+    # Builds an IstStanding object from raw data
+    # @api private
+    # @param data [Hash] the row data
+    # @return [IstStanding] the standing object
+    def self.build_standing(data)
+      IstStanding.new(**team_attrs(data), **record_attrs(data), **pts_attrs(data))
+    end
+    private_class_method :build_standing
+
+    # Extracts team attributes from data
+    # @api private
+    # @param data [Hash] the row data
+    # @return [Hash] team attributes
+    def self.team_attrs(data)
+      {season_id: data["SEASON_ID"], team_id: data["TEAM_ID"],
+       team_city: data["TEAM_CITY"], team_name: data["TEAM_NAME"],
+       team_abbreviation: data["TEAM_ABBREVIATION"], team_slug: data["TEAM_SLUG"],
+       conference: data["CONFERENCE"], ist_group: data["IST_GROUP"]}
+    end
+    private_class_method :team_attrs
+
+    # Extracts record attributes from data
+    # @api private
+    # @param data [Hash] the row data
+    # @return [Hash] record attributes
+    def self.record_attrs(data)
+      {ist_group_rank: data["IST_GROUP_RANK"], wins: data["WINS"],
+       losses: data["LOSSES"], win_pct: data["WIN_PCT"],
+       clinch_indicator: data["CLINCH_INDICATOR"]}
+    end
+    private_class_method :record_attrs
+
+    # Extracts point attributes from data
+    # @api private
+    # @param data [Hash] the row data
+    # @return [Hash] point attributes
+    def self.pts_attrs(data)
+      {pts_for: data["PTS_FOR"], pts_against: data["PTS_AGAINST"],
+       pts_diff: data["PTS_DIFF"]}
+    end
+    private_class_method :pts_attrs
+  end
+end

data/lib/nba/leader.rb

@@ -0,0 +1,103 @@
+require "equalizer"
+require "shale"
+require_relative "players"
+require_relative "teams"
+
+module NBA
+  # Represents a statistical leader entry
+  class Leader < Shale::Mapper
+    include Equalizer.new(:player_id, :category)
+
+    # @!attribute [rw] player_id
+    #   Returns the player ID
+    #   @api public
+    #   @example
+    #     leader.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
+    #     leader.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
+    #     leader.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
+    #     leader.team_abbreviation #=> "GSW"
+    #   @return [String] the team abbreviation
+    attribute :team_abbreviation, Shale::Type::String
+
+    # @!attribute [rw] category
+    #   Returns the statistical category
+    #   @api public
+    #   @example
+    #     leader.category #=> "PTS"
+    #   @return [String] the statistical category
+    attribute :category, Shale::Type::String
+
+    # @!attribute [rw] rank
+    #   Returns the rank in the category
+    #   @api public
+    #   @example
+    #     leader.rank #=> 1
+    #   @return [Integer] the rank
+    attribute :rank, Shale::Type::Integer
+
+    # @!attribute [rw] value
+    #   Returns the statistical value
+    #   @api public
+    #   @example
+    #     leader.value #=> 32.4
+    #   @return [Float] the statistical value
+    attribute :value, Shale::Type::Float
+
+    # Returns the player object for this leader
+    #
+    # @api public
+    # @example
+    #   leader.player #=> #<NBA::Player>
+    #   leader.player.college #=> "Davidson"
+    # @return [Player, nil] the hydrated player object
+    def player
+      Players.find(player_id)
+    end
+
+    # Returns the team object for this leader
+    #
+    # @api public
+    # @example
+    #   leader.team #=> #<NBA::Team>
+    #   leader.team.name #=> "Golden State Warriors"
+    # @return [Team, nil] the team object
+    def team
+      Teams.find(team_id)
+    end
+
+    json do
+      map "player_id", to: :player_id
+      map "playerId", to: :player_id
+      map "player_name", to: :player_name
+      map "playerName", to: :player_name
+      map "team_id", to: :team_id
+      map "teamId", to: :team_id
+      map "team_abbreviation", to: :team_abbreviation
+      map "teamAbbreviation", to: :team_abbreviation
+      map "category", to: :category
+      map "rank", to: :rank
+      map "value", to: :value
+    end
+  end
+end