nba 0.1.1 → 0.2.0

data/lib/nba/cume_stats_team_total.rb

@@ -0,0 +1,267 @@
+require "equalizer"
+require "shale"
+
+module NBA
+  # Represents total cumulative team statistics
+  class CumeStatsTeamTotal < Shale::Mapper
+    include Equalizer.new(:team_id)
+
+    # @!attribute [rw] team_id
+    #   Returns the team ID
+    #   @api public
+    #   @example
+    #     total.team_id #=> 1610612744
+    #   @return [Integer] the team ID
+    attribute :team_id, Shale::Type::Integer
+
+    # @!attribute [rw] city
+    #   Returns the city name
+    #   @api public
+    #   @example
+    #     total.city #=> "Golden State"
+    #   @return [String] the city name
+    attribute :city, Shale::Type::String
+
+    # @!attribute [rw] nickname
+    #   Returns the team nickname
+    #   @api public
+    #   @example
+    #     total.nickname #=> "Warriors"
+    #   @return [String] the team nickname
+    attribute :nickname, Shale::Type::String
+
+    # @!attribute [rw] gp
+    #   Returns games played
+    #   @api public
+    #   @example
+    #     total.gp #=> 10
+    #   @return [Integer] games played
+    attribute :gp, Shale::Type::Integer
+
+    # @!attribute [rw] gs
+    #   Returns games started
+    #   @api public
+    #   @example
+    #     total.gs #=> 10
+    #   @return [Integer] games started
+    attribute :gs, Shale::Type::Integer
+
+    # @!attribute [rw] w
+    #   Returns wins
+    #   @api public
+    #   @example
+    #     total.w #=> 8
+    #   @return [Integer] wins
+    attribute :w, Shale::Type::Integer
+
+    # @!attribute [rw] l
+    #   Returns losses
+    #   @api public
+    #   @example
+    #     total.l #=> 2
+    #   @return [Integer] losses
+    attribute :l, Shale::Type::Integer
+
+    # @!attribute [rw] w_home
+    #   Returns home wins
+    #   @api public
+    #   @example
+    #     total.w_home #=> 5
+    #   @return [Integer] home wins
+    attribute :w_home, Shale::Type::Integer
+
+    # @!attribute [rw] l_home
+    #   Returns home losses
+    #   @api public
+    #   @example
+    #     total.l_home #=> 1
+    #   @return [Integer] home losses
+    attribute :l_home, Shale::Type::Integer
+
+    # @!attribute [rw] w_road
+    #   Returns road wins
+    #   @api public
+    #   @example
+    #     total.w_road #=> 3
+    #   @return [Integer] road wins
+    attribute :w_road, Shale::Type::Integer
+
+    # @!attribute [rw] l_road
+    #   Returns road losses
+    #   @api public
+    #   @example
+    #     total.l_road #=> 1
+    #   @return [Integer] road losses
+    attribute :l_road, Shale::Type::Integer
+
+    # @!attribute [rw] team_turnovers
+    #   Returns team turnovers
+    #   @api public
+    #   @example
+    #     total.team_turnovers #=> 120
+    #   @return [Integer] team turnovers
+    attribute :team_turnovers, Shale::Type::Integer
+
+    # @!attribute [rw] team_rebounds
+    #   Returns team rebounds
+    #   @api public
+    #   @example
+    #     total.team_rebounds #=> 450
+    #   @return [Integer] team rebounds
+    attribute :team_rebounds, Shale::Type::Integer
+
+    # @!attribute [rw] fgm
+    #   Returns field goals made
+    #   @api public
+    #   @example
+    #     total.fgm #=> 400
+    #   @return [Integer] field goals made
+    attribute :fgm, Shale::Type::Integer
+
+    # @!attribute [rw] fga
+    #   Returns field goals attempted
+    #   @api public
+    #   @example
+    #     total.fga #=> 850
+    #   @return [Integer] field goals attempted
+    attribute :fga, Shale::Type::Integer
+
+    # @!attribute [rw] fg_pct
+    #   Returns field goal percentage
+    #   @api public
+    #   @example
+    #     total.fg_pct #=> 0.471
+    #   @return [Float] field goal percentage
+    attribute :fg_pct, Shale::Type::Float
+
+    # @!attribute [rw] fg3m
+    #   Returns three point field goals made
+    #   @api public
+    #   @example
+    #     total.fg3m #=> 150
+    #   @return [Integer] three point field goals made
+    attribute :fg3m, Shale::Type::Integer
+
+    # @!attribute [rw] fg3a
+    #   Returns three point field goals attempted
+    #   @api public
+    #   @example
+    #     total.fg3a #=> 400
+    #   @return [Integer] three point field goals attempted
+    attribute :fg3a, Shale::Type::Integer
+
+    # @!attribute [rw] fg3_pct
+    #   Returns three point field goal percentage
+    #   @api public
+    #   @example
+    #     total.fg3_pct #=> 0.375
+    #   @return [Float] three point field goal percentage
+    attribute :fg3_pct, Shale::Type::Float
+
+    # @!attribute [rw] ftm
+    #   Returns free throws made
+    #   @api public
+    #   @example
+    #     total.ftm #=> 180
+    #   @return [Integer] free throws made
+    attribute :ftm, Shale::Type::Integer
+
+    # @!attribute [rw] fta
+    #   Returns free throws attempted
+    #   @api public
+    #   @example
+    #     total.fta #=> 220
+    #   @return [Integer] free throws attempted
+    attribute :fta, Shale::Type::Integer
+
+    # @!attribute [rw] ft_pct
+    #   Returns free throw percentage
+    #   @api public
+    #   @example
+    #     total.ft_pct #=> 0.818
+    #   @return [Float] free throw percentage
+    attribute :ft_pct, Shale::Type::Float
+
+    # @!attribute [rw] oreb
+    #   Returns offensive rebounds
+    #   @api public
+    #   @example
+    #     total.oreb #=> 100
+    #   @return [Integer] offensive rebounds
+    attribute :oreb, Shale::Type::Integer
+
+    # @!attribute [rw] dreb
+    #   Returns defensive rebounds
+    #   @api public
+    #   @example
+    #     total.dreb #=> 350
+    #   @return [Integer] defensive rebounds
+    attribute :dreb, Shale::Type::Integer
+
+    # @!attribute [rw] tot_reb
+    #   Returns total rebounds
+    #   @api public
+    #   @example
+    #     total.tot_reb #=> 450
+    #   @return [Integer] total rebounds
+    attribute :tot_reb, Shale::Type::Integer
+
+    # @!attribute [rw] ast
+    #   Returns assists
+    #   @api public
+    #   @example
+    #     total.ast #=> 250
+    #   @return [Integer] assists
+    attribute :ast, Shale::Type::Integer
+
+    # @!attribute [rw] pf
+    #   Returns personal fouls
+    #   @api public
+    #   @example
+    #     total.pf #=> 180
+    #   @return [Integer] personal fouls
+    attribute :pf, Shale::Type::Integer
+
+    # @!attribute [rw] stl
+    #   Returns steals
+    #   @api public
+    #   @example
+    #     total.stl #=> 80
+    #   @return [Integer] steals
+    attribute :stl, Shale::Type::Integer
+
+    # @!attribute [rw] tov
+    #   Returns turnovers
+    #   @api public
+    #   @example
+    #     total.tov #=> 120
+    #   @return [Integer] turnovers
+    attribute :tov, Shale::Type::Integer
+
+    # @!attribute [rw] blk
+    #   Returns blocks
+    #   @api public
+    #   @example
+    #     total.blk #=> 45
+    #   @return [Integer] blocks
+    attribute :blk, Shale::Type::Integer
+
+    # @!attribute [rw] pts
+    #   Returns points
+    #   @api public
+    #   @example
+    #     total.pts #=> 1130
+    #   @return [Integer] points
+    attribute :pts, Shale::Type::Integer
+
+    # Returns the team object
+    #
+    # @api public
+    # @example
+    #   total.team #=> #<NBA::Team>
+    # @return [Team, nil] the team object
+    def team
+      Teams.find(team_id)
+    end
+  end
+end

data/lib/nba/data.rb

@@ -0,0 +1,73 @@
+require "json"
+require_relative "client"
+require_relative "team"
+
+module NBA
+  # Provides static team data for all 30 NBA teams
+  module Data
+    # All NBA team data with complete information
+    # @return [Array<Hash>] array of team hashes
+    TEAMS = [
+      {id: Team::ATL, abbreviation: "ATL", name: "Atlanta Hawks", full_name: "Atlanta Hawks", nickname: "Hawks",
+       city: "Atlanta", state: "Georgia", year_founded: 1946},
+      {id: Team::BOS, abbreviation: "BOS", name: "Boston Celtics", full_name: "Boston Celtics", nickname: "Celtics",
+       city: "Boston", state: "Massachusetts", year_founded: 1946},
+      {id: Team::BKN, abbreviation: "BKN", name: "Brooklyn Nets", full_name: "Brooklyn Nets", nickname: "Nets",
+       city: "Brooklyn", state: "New York", year_founded: 1967},
+      {id: Team::CHA, abbreviation: "CHA", name: "Charlotte Hornets", full_name: "Charlotte Hornets", nickname: "Hornets",
+       city: "Charlotte", state: "North Carolina", year_founded: 1988},
+      {id: Team::CHI, abbreviation: "CHI", name: "Chicago Bulls", full_name: "Chicago Bulls", nickname: "Bulls",
+       city: "Chicago", state: "Illinois", year_founded: 1966},
+      {id: Team::CLE, abbreviation: "CLE", name: "Cleveland Cavaliers", full_name: "Cleveland Cavaliers", nickname: "Cavaliers",
+       city: "Cleveland", state: "Ohio", year_founded: 1970},
+      {id: Team::DAL, abbreviation: "DAL", name: "Dallas Mavericks", full_name: "Dallas Mavericks", nickname: "Mavericks",
+       city: "Dallas", state: "Texas", year_founded: 1980},
+      {id: Team::DEN, abbreviation: "DEN", name: "Denver Nuggets", full_name: "Denver Nuggets", nickname: "Nuggets",
+       city: "Denver", state: "Colorado", year_founded: 1967},
+      {id: Team::DET, abbreviation: "DET", name: "Detroit Pistons", full_name: "Detroit Pistons", nickname: "Pistons",
+       city: "Detroit", state: "Michigan", year_founded: 1941},
+      {id: Team::GSW, abbreviation: "GSW", name: "Golden State Warriors", full_name: "Golden State Warriors", nickname: "Warriors",
+       city: "San Francisco", state: "California", year_founded: 1946},
+      {id: Team::HOU, abbreviation: "HOU", name: "Houston Rockets", full_name: "Houston Rockets", nickname: "Rockets",
+       city: "Houston", state: "Texas", year_founded: 1967},
+      {id: Team::IND, abbreviation: "IND", name: "Indiana Pacers", full_name: "Indiana Pacers", nickname: "Pacers",
+       city: "Indianapolis", state: "Indiana", year_founded: 1967},
+      {id: Team::LAC, abbreviation: "LAC", name: "LA Clippers", full_name: "Los Angeles Clippers", nickname: "Clippers",
+       city: "Los Angeles", state: "California", year_founded: 1970},
+      {id: Team::LAL, abbreviation: "LAL", name: "Los Angeles Lakers", full_name: "Los Angeles Lakers", nickname: "Lakers",
+       city: "Los Angeles", state: "California", year_founded: 1947},
+      {id: Team::MEM, abbreviation: "MEM", name: "Memphis Grizzlies", full_name: "Memphis Grizzlies", nickname: "Grizzlies",
+       city: "Memphis", state: "Tennessee", year_founded: 1995},
+      {id: Team::MIA, abbreviation: "MIA", name: "Miami Heat", full_name: "Miami Heat", nickname: "Heat",
+       city: "Miami", state: "Florida", year_founded: 1988},
+      {id: Team::MIL, abbreviation: "MIL", name: "Milwaukee Bucks", full_name: "Milwaukee Bucks", nickname: "Bucks",
+       city: "Milwaukee", state: "Wisconsin", year_founded: 1968},
+      {id: Team::MIN, abbreviation: "MIN", name: "Minnesota Timberwolves", full_name: "Minnesota Timberwolves", nickname: "Timberwolves",
+       city: "Minneapolis", state: "Minnesota", year_founded: 1989},
+      {id: Team::NOP, abbreviation: "NOP", name: "New Orleans Pelicans", full_name: "New Orleans Pelicans", nickname: "Pelicans",
+       city: "New Orleans", state: "Louisiana", year_founded: 2002},
+      {id: Team::NYK, abbreviation: "NYK", name: "New York Knicks", full_name: "New York Knicks", nickname: "Knicks",
+       city: "New York", state: "New York", year_founded: 1946},
+      {id: Team::OKC, abbreviation: "OKC", name: "Oklahoma City Thunder", full_name: "Oklahoma City Thunder", nickname: "Thunder",
+       city: "Oklahoma City", state: "Oklahoma", year_founded: 1967},
+      {id: Team::ORL, abbreviation: "ORL", name: "Orlando Magic", full_name: "Orlando Magic", nickname: "Magic",
+       city: "Orlando", state: "Florida", year_founded: 1989},
+      {id: Team::PHI, abbreviation: "PHI", name: "Philadelphia 76ers", full_name: "Philadelphia 76ers", nickname: "76ers",
+       city: "Philadelphia", state: "Pennsylvania", year_founded: 1946},
+      {id: Team::PHX, abbreviation: "PHX", name: "Phoenix Suns", full_name: "Phoenix Suns", nickname: "Suns",
+       city: "Phoenix", state: "Arizona", year_founded: 1968},
+      {id: Team::POR, abbreviation: "POR", name: "Portland Trail Blazers", full_name: "Portland Trail Blazers", nickname: "Trail Blazers",
+       city: "Portland", state: "Oregon", year_founded: 1970},
+      {id: Team::SAC, abbreviation: "SAC", name: "Sacramento Kings", full_name: "Sacramento Kings", nickname: "Kings",
+       city: "Sacramento", state: "California", year_founded: 1945},
+      {id: Team::SAS, abbreviation: "SAS", name: "San Antonio Spurs", full_name: "San Antonio Spurs", nickname: "Spurs",
+       city: "San Antonio", state: "Texas", year_founded: 1967},
+      {id: Team::TOR, abbreviation: "TOR", name: "Toronto Raptors", full_name: "Toronto Raptors", nickname: "Raptors",
+       city: "Toronto", state: "Ontario", year_founded: 1995},
+      {id: Team::UTA, abbreviation: "UTA", name: "Utah Jazz", full_name: "Utah Jazz", nickname: "Jazz",
+       city: "Salt Lake City", state: "Utah", year_founded: 1974},
+      {id: Team::WAS, abbreviation: "WAS", name: "Washington Wizards", full_name: "Washington Wizards", nickname: "Wizards",
+       city: "Washington", state: "District of Columbia", year_founded: 1961}
+    ].freeze
+  end
+end

data/lib/nba/defense_hub.rb

@@ -0,0 +1,109 @@
+require "json"
+require_relative "client"
+require_relative "collection"
+require_relative "defense_hub_stat"
+require_relative "league"
+require_relative "response_parser"
+require_relative "utils"
+
+module NBA
+  # Provides methods to retrieve NBA defense hub statistics
+  module DefenseHub
+    # Stat categories available in the defense hub
+    STAT_CATEGORIES = {
+      dreb: "DefenseHubStat1",
+      stl: "DefenseHubStat2",
+      blk: "DefenseHubStat3",
+      def_rating: "DefenseHubStat4",
+      overall_pm: "DefenseHubStat5",
+      threep_dfg_pct: "DefenseHubStat6",
+      twop_dfg_pct: "DefenseHubStat7",
+      fifteenf_dfg_pct: "DefenseHubStat8",
+      def_rim_pct: "DefenseHubStat9"
+    }.freeze
+
+    # Retrieves defense hub statistics for a stat category
+    #
+    # @api public
+    # @example
+    #   stats = NBA::DefenseHub.all(stat_category: :dreb, season: 2023)
+    #   stats.each { |s| puts "#{s.rank}. #{s.team_abbreviation}: #{s.value}" }
+    # @param stat_category [Symbol] the stat category (:dreb, :stl, :blk, etc.)
+    # @param season [Integer] the season year (defaults to current season)
+    # @param season_type [String] the season type (Regular Season, Playoffs, etc.)
+    # @param game_scope [String] the game scope (Season, Yesterday, etc.)
+    # @param player_or_team [String] player or team stats (Player, Team)
+    # @param player_scope [String] the player scope (All Players, Rookies)
+    # @param league [String, League] the league ID or League object
+    # @param client [Client] the API client to use
+    # @return [Collection] a collection of defense hub stats
+    def self.all(stat_category:, season: Utils.current_season, season_type: "Regular Season",
+      game_scope: "Season", player_or_team: "Team", player_scope: "All Players",
+      league: League::NBA, client: CLIENT)
+      result_set = STAT_CATEGORIES.fetch(stat_category)
+      league_id = Utils.extract_league_id(league)
+      opts = {season: season, season_type: season_type, game_scope: game_scope,
+              player_or_team: player_or_team, player_scope: player_scope, league_id: league_id}
+      response = client.get(build_path(opts))
+      parse_response(response, result_set, stat_category)
+    end
+
+    # Builds the API request path
+    # @api private
+    # @return [String] the request path
+    def self.build_path(opts)
+      "defensehub?GameScope=#{opts[:game_scope]}&LeagueID=#{opts[:league_id]}" \
+        "&PlayerOrTeam=#{opts[:player_or_team]}&PlayerScope=#{opts[:player_scope]}" \
+        "&Season=#{Utils.format_season(opts[:season])}&SeasonType=#{opts[:season_type]}"
+    end
+    private_class_method :build_path
+
+    # Parses the API response
+    # @api private
+    # @param response [String, nil] the raw API response
+    # @param result_set [String] the result set name
+    # @param stat_category [Symbol] the stat category
+    # @return [Collection] parsed stats
+    def self.parse_response(response, result_set, stat_category)
+      ResponseParser.parse(response, result_set: result_set) do |data|
+        build_stat(data, stat_category)
+      end
+    end
+    private_class_method :parse_response
+
+    # Builds a DefenseHubStat object from raw data
+    # @api private
+    # @param data [Hash] the row data
+    # @param stat_category [Symbol] the stat category
+    # @return [DefenseHubStat] the stat object
+    def self.build_stat(data, stat_category)
+      DefenseHubStat.new(**stat_attributes(data, stat_category))
+    end
+    private_class_method :build_stat
+
+    # Extracts stat attributes from data
+    # @api private
+    # @param data [Hash] the row data
+    # @param stat_category [Symbol] the stat category name
+    # @return [Hash] stat attributes
+    def self.stat_attributes(data, stat_category)
+      {rank: data["RANK"], team_id: data["TEAM_ID"],
+       team_abbreviation: data["TEAM_ABBREVIATION"],
+       team_name: data["TEAM_NAME"],
+       value: extract_value(data), stat_name: stat_category}
+    end
+    private_class_method :stat_attributes
+
+    # Extracts the stat value from data (different keys per result set)
+    # @api private
+    # @param data [Hash] the row data
+    # @return [Float, nil] the stat value
+    def self.extract_value(data)
+      value_keys = %w[DREB STL BLK TM_DEF_RATING OVERALL_PM THREEP_DFGPCT
+        TWOP_DFGPCT FIFETEENF_DFGPCT DEF_RIM_PCT]
+      value_keys.each { |key| return data.fetch(key) if data.key?(key) }
+      nil
+    end
+    private_class_method :extract_value
+  end
+end

data/lib/nba/defense_hub_stat.rb

@@ -0,0 +1,57 @@
+require "equalizer"
+require "shale"
+
+module NBA
+  # Represents a defense hub statistic entry
+  #
+  # @api public
+  # @example
+  #   stat.rank #=> 1
+  #   stat.team_abbreviation #=> "BOS"
+  #   stat.value #=> 47.8
+  class DefenseHubStat < Shale::Mapper
+    include Equalizer.new(:rank, :team_id)
+
+    #   Returns the rank
+    #   @api public
+    #   @example
+    #     stat.rank #=> 1
+    #   @return [Integer, nil] the rank
+    attribute :rank, Shale::Type::Integer
+
+    #   Returns the team ID
+    #   @api public
+    #   @example
+    #     stat.team_id #=> 1610612738
+    #   @return [Integer, nil] the team ID
+    attribute :team_id, Shale::Type::Integer
+
+    #   Returns the team abbreviation
+    #   @api public
+    #   @example
+    #     stat.team_abbreviation #=> "BOS"
+    #   @return [String, nil] the team abbreviation
+    attribute :team_abbreviation, Shale::Type::String
+
+    #   Returns the team name
+    #   @api public
+    #   @example
+    #     stat.team_name #=> "Boston Celtics"
+    #   @return [String, nil] the team name
+    attribute :team_name, Shale::Type::String
+
+    #   Returns the statistic value
+    #   @api public
+    #   @example
+    #     stat.value #=> 47.8
+    #   @return [Float, nil] the statistic value
+    attribute :value, Shale::Type::Float
+
+    #   Returns the statistic name
+    #   @api public
+    #   @example
+    #     stat.stat_name #=> "dreb"
+    #   @return [String, nil] the statistic name
+    attribute :stat_name, Shale::Type::String
+  end
+end

data/lib/nba/defensive_shot_stat.rb

@@ -0,0 +1,102 @@
+require "equalizer"
+require "shale"
+require_relative "players"
+
+module NBA
+  # Represents a player's defensive shot statistics
+  #
+  # @api public
+  class DefensiveShotStat < Shale::Mapper
+    include Equalizer.new(:close_def_person_id, :defense_category, :g)
+
+    # @!attribute [rw] close_def_person_id
+    #   Returns the defender's player ID
+    #   @api public
+    #   @example
+    #     stat.close_def_person_id #=> 201939
+    #   @return [Integer, nil] the defender's player ID
+    attribute :close_def_person_id, Shale::Type::Integer
+
+    # @!attribute [rw] gp
+    #   Returns games played
+    #   @api public
+    #   @example
+    #     stat.gp #=> 74
+    #   @return [Integer, nil] games played
+    attribute :gp, Shale::Type::Integer
+
+    # @!attribute [rw] g
+    #   Returns number of games
+    #   @api public
+    #   @example
+    #     stat.g #=> 74
+    #   @return [Integer, nil] games
+    attribute :g, Shale::Type::Integer
+
+    # @!attribute [rw] defense_category
+    #   Returns the defensive category
+    #   @api public
+    #   @example
+    #     stat.defense_category #=> "3 Pointers"
+    #   @return [String, nil] the defensive category
+    attribute :defense_category, Shale::Type::String
+
+    # @!attribute [rw] freq
+    #   Returns the frequency
+    #   @api public
+    #   @example
+    #     stat.freq #=> 0.25
+    #   @return [Float, nil] frequency
+    attribute :freq, Shale::Type::Float
+
+    # @!attribute [rw] d_fgm
+    #   Returns defended field goals made
+    #   @api public
+    #   @example
+    #     stat.d_fgm #=> 2.1
+    #   @return [Float, nil] defended field goals made
+    attribute :d_fgm, Shale::Type::Float
+
+    # @!attribute [rw] d_fga
+    #   Returns defended field goals attempted
+    #   @api public
+    #   @example
+    #     stat.d_fga #=> 5.3
+    #   @return [Float, nil] defended field goals attempted
+    attribute :d_fga, Shale::Type::Float
+
+    # @!attribute [rw] d_fg_pct
+    #   Returns defended field goal percentage
+    #   @api public
+    #   @example
+    #     stat.d_fg_pct #=> 0.396
+    #   @return [Float, nil] defended field goal percentage
+    attribute :d_fg_pct, Shale::Type::Float
+
+    # @!attribute [rw] normal_fg_pct
+    #   Returns normal field goal percentage
+    #   @api public
+    #   @example
+    #     stat.normal_fg_pct #=> 0.401
+    #   @return [Float, nil] normal field goal percentage
+    attribute :normal_fg_pct, Shale::Type::Float
+
+    # @!attribute [rw] pct_plusminus
+    #   Returns percentage plus/minus
+    #   @api public
+    #   @example
+    #     stat.pct_plusminus #=> -0.005
+    #   @return [Float, nil] percentage plus/minus
+    attribute :pct_plusminus, Shale::Type::Float
+
+    # Returns the player who defended the shots
+    #
+    # @api public
+    # @example
+    #   stat.player #=> #<NBA::Player id=201939 ...>
+    # @return [Player, nil] the player object
+    def player
+      Players.find(close_def_person_id)
+    end
+  end
+end

data/lib/nba/division.rb

@@ -0,0 +1,49 @@
+require "equalizer"
+require "shale"
+require_relative "conference"
+
+module NBA
+  # Represents an NBA division
+  class Division < Shale::Mapper
+    include Equalizer.new(:id)
+
+    # @!attribute [rw] id
+    #   Returns the unique identifier for the division
+    #   @api public
+    #   @example
+    #     division.id #=> 5
+    #   @return [Integer] the unique identifier for the division
+    attribute :id, Shale::Type::Integer
+
+    # @!attribute [rw] name
+    #   Returns the division name
+    #   @api public
+    #   @example
+    #     division.name #=> "Atlantic"
+    #   @return [String] the division name
+    attribute :name, Shale::Type::String
+
+    # @!attribute [rw] link
+    #   Returns the API link for the division
+    #   @api public
+    #   @example
+    #     division.link #=> "/api/v1/divisions/5"
+    #   @return [String] the API link for the division
+    attribute :link, Shale::Type::String
+
+    # @!attribute [rw] conference
+    #   Returns the conference this division belongs to
+    #   @api public
+    #   @example
+    #     division.conference #=> #<NBA::Conference>
+    #   @return [Conference] the conference
+    attribute :conference, Conference
+
+    json do
+      map "id", to: :id
+      map "name", to: :name
+      map "link", to: :link
+      map "conference", to: :conference
+    end
+  end
+end