y_fantasy 0.1.0

data/lib/y_fantasy/resources/game.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module YFantasy
+  # Represents a Yahoo Fantasy Game (e.g. NFL, NBA, MLB).
+  # A game is the top-level sports resource and contains leagues, which contain teams.
+  #
+  # @example Get NFL game information with game weeks
+  #   games = YFantasy::Game.find_all_by_code('nfl', with: [:game_weeks])
+  #
+  # @see https://developer.yahoo.com/fantasysports/guide/#game-resource
+  class Game < BaseResource
+    # TODO: make constant of all valid yahoo game codes (nfl, nba, nfls, etc)
+
+    # --- REQUIRED ATTRIBUTES ------------------------------------------------------------------------------------------
+
+    # @!attribute [r] game_key
+    # @return [String] The unique key for this game
+    option :game_key
+
+    # @!attribute [r] game_id
+    # @return [String] The ID for this game (for Game resource, this is the same as game_key)
+    option :game_id
+
+    # @!attribute [r] name
+    # @return [String] The name of the game (eg. "Football", "Baseball")
+    option :name
+
+    # @!attribute [r] code
+    # @return [String] The general code for this game (eg. "nfl", "nba")
+    option :code
+
+    # @!attribute [r] type
+    # @return [String] The type of game (eg. "full")
+    option :type
+
+    # @!attribute [r] url
+    # @return [String] The URL to the game's home page
+    option :url
+
+    # @!attribute [r] season
+    # @return [Integer] The year of the season
+    option :season, type: Types::Coercible::Integer
+
+    # @!attribute [r] is_registration_over
+    # @return [Boolean] Whether registration for this game is over
+    option :is_registration_over, type: Types::Params::Bool
+
+    # @!attribute [r] is_game_over
+    # @return [Boolean] Whether this game's season is over
+    option :is_game_over, type: Types::Params::Bool
+
+    # @!attribute [r] is_offseason
+    # @return [Boolean] Whether this game is in the offseason
+    option :is_offseason, type: Types::Params::Bool
+
+    # --- OPTIONAL ATTRIBUTES ------------------------------------------------------------------------------------------
+
+    # @!attribute [r] current_week
+    # @return [Integer, nil] The current week number of the game
+    option :current_week, optional: true
+
+    # @!attribute [r] is_contest_reg_active
+    # @return [Boolean, nil] Whether contest registration is active
+    option :is_contest_reg_active, optional: true, type: Types::Params::Bool
+
+    # @!attribute [r] is_contest_over
+    # @return [Boolean, nil] Whether the contest is over
+    option :is_contest_over, optional: true, type: Types::Params::Bool
+
+    # @!attribute [r] has_schedule
+    # @return [Boolean, nil] Whether this game has a schedule
+    option :has_schedule, optional: true, type: Types::Params::Bool
+
+    # --- SUBRESOURCES -------------------------------------------------------------------------------------------------
+
+    # @!attribute [r] game_weeks
+    # @return [Array<GameWeek>, nil] Array of game weeks for this game
+    option :game_weeks, optional: true, type: array_of(GameWeek)
+
+    # @!attribute [r] position_types
+    # @return [Array<PositionType>, nil] Array of position types for this game
+    option :position_types, optional: true, type: array_of(PositionType)
+
+    # @!attribute [r] roster_positions
+    # @return [Array<RosterPosition>, nil] Array of roster positions for this game
+    option :roster_positions, optional: true, type: array_of(RosterPosition)
+
+    # @!attribute [r] stat_categories
+    # @return [Array<StatCategory>, nil] Array of stat categories for this game
+    option :stat_categories, optional: true, type: array_of(StatCategory)
+
+    # @!attribute [r] groups
+    # @return [Array<Group>, nil] Array of groups for this game (e.g. NFL Survival)
+    option :groups, optional: true, type: array_of(Group)
+
+    # @!attribute [r] leagues
+    # @return [Array<League>, nil] Array of leagues belonging to this game
+    option :leagues, optional: true, type: array_of(League)
+
+    # Define subresource associations
+    has_subresource :game_weeks, klass: GameWeek
+    has_subresource :position_types, klass: PositionType
+    has_subresource :roster_positions, klass: RosterPosition
+    has_subresource :stat_categories, klass: StatCategory
+
+    has_subresource :groups, klass: Group # NFL Survival
+    has_subresource :leagues, klass: League
+
+    # --- CLASS METHODS ------------------------------------------------------------------------------------------------
+
+    # Finds all games by their code(s)
+    #
+    # @param codes [String, Symbol, Array<String>, Array<Symbol>] The code(s) of the game(s) to find (e.g. 'nfl', 'nba')
+    # @param with [Symbol, Array<Symbol>] Optional subresources to include
+    # @param options [Hash] Additional options to pass to the API client
+    # @return [Array<Game>] Array of games matching the given code(s)
+    # @example Find all NFL games with game weeks
+    #   YFantasy::Game.find_all_by_code('nfl', with: :game_weeks)
+    # @example Find all NFL and NBA games
+    #   YFantasy::Game.find_all_by_code(['nfl', 'nba'])
+    def self.find_all_by_code(codes, with: [], **options)
+      subresources = Transformations::T.wrap_in_array(with)
+      SubresourceValidator.validate!(self, subresources)
+      data = YFantasy::Api::Client.get(:games, game_codes: codes, subresources: subresources, **options)
+      Transformations::CollectionTransformer.new(:games).call(data)
+    end
+
+    # Retrieves leagues associated with this game
+    #
+    # @param league_keys [Array<String>] Optional specific league keys to retrieve
+    # @return [Array<League>] Array of leagues
+    # def leagues(league_keys = [])
+    #   @leagues ||= League.find_all(Array(league_keys))
+    # end
+  end
+end

data/lib/y_fantasy/resources/group/settings.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class Group
+    # Settings for a Yahoo NFL Survival Group
+    class Settings < BaseSubresource
+      DEADLINE_1_DESC = "5 minutes before the first game of each week"
+      DEADLINE_2_DESC = "Sunday at 1:00 PM EST"
+
+      # --- REQUIRED ATTRIBUTES ----------------------------------------------------------------------------------------
+
+      # @!attribute [r] start_week
+      # @return [Integer] the group start week
+      option :start_week, type: Types::Coercible::Integer
+
+      # @!attribute [r] end_week
+      # @return [Integer] the group end week
+      option :end_week, type: Types::Coercible::Integer
+
+      # @!attribute [r] max_strikes
+      # @return [Integer] the total number of strikes (incorrect picks) allowed
+      option :max_strikes, type: Types::Coercible::Integer
+
+      # @!attribute [r] use_playoff_weeks
+      # @return [Boolean] whether or not the group uses playoff weeks
+      option :use_playoff_weeks, type: Types::Params::Bool
+
+      # @!attribute [r] deadline
+      # @return [Integer]
+      option :deadline, type: Types::Coercible::Integer
+
+      # @!attribute [r] two_pick_start_week
+      # @return [Integer]
+      option :two_pick_start_week, type: Types::Coercible::Integer
+
+      # @!attribute [r] commissioner_note
+      # @return [String]
+      option :commissioner_note
+
+      # --- INSTANCE METHODS -------------------------------------------------------------------------------------------
+
+      # :nocov:
+      def deadline_desc
+        if deadline == 1
+          DEADLINE_1_DESC
+        elsif deadline == 2
+          DEADLINE_2_DESC
+        end
+      end
+      # :nocov:
+    end
+  end
+end

data/lib/y_fantasy/resources/group/standings.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class Group
+    # Standings for a Yahoo Fantasy NFL Survival Group
+    class Standings < BaseSubresource
+      # --- REQUIRED ATTRIBUTES ----------------------------------------------------------------------------------------
+      option :teams, array_of(PickemTeam)
+    end
+  end
+end

data/lib/y_fantasy/resources/group.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module YFantasy
+  # Represents a Yahoo Fantasy NFL Survival Group
+  class Group < BaseResource
+    # --- REQUIRED ATTRIBUTES ------------------------------------------------------------------------------------------
+
+    # @!attribute [r] group_key
+    # @return [String] the unique key for this group
+    option :group_key
+
+    # @!attribute [r] group_id
+    # @return [String] the ID for this group
+    option :group_id
+
+    # @!attribute [r] name
+    # @return [String] the name of the group
+    option :name
+
+    # @!attribute [r] url
+    # @return [String] the URL to the group's Yahoo Fantasy page
+    option :url
+
+    # @!attribute [r] type
+    # @return [String] the type of group (e.g. "private")
+    option :type
+
+    # @!attribute [r] num_teams
+    # @return [Integer] the number of teams in the group
+    option :num_teams, type: Types::Coercible::Integer
+
+    # @!attribute [r] current_login_is_member
+    # @return [Boolean] whether the current user is a member of this group
+    option :current_login_is_member, type: Types::Params::Bool
+
+    # @!attribute [r] current_week
+    # @return [Integer] the current week number of the group
+    option :current_week, type: Types::Coercible::Integer
+
+    # @!attribute [r] has_group_started
+    # @return [Boolean] whether the group has started
+    option :has_group_started, type: Types::Params::Bool
+
+    # @!attribute [r] current_week_lock_time
+    # @return [Integer] the timestamp when the current week locks
+    option :current_week_lock_time, type: Types::Coercible::Integer
+
+    # --- OPTIONAL ATTRIBUTES ------------------------------------------------------------------------------------------
+
+    # @!attribute [r] commissioner_nickname
+    # @return [String, nil] the nickname of the commissioner
+    option :commissioner_nickname, optional: true
+
+    # @!attribute [r] is_commissioner
+    # @return [Boolean, nil] whether the current user is the commissioner
+    option :is_commissioner, optional: true, type: Types::Params::Bool
+
+    # --- SUBRESOURCES --------------------------------------------------------------------------------
+
+    # @!attribute [r] settings
+    # @return [Settings, nil] the settings for this group
+    option :settings, optional: true, type: instance_of(Settings)
+
+    # @!attribute [r] standings
+    # @return [Standings, nil] the standings for this group
+    option :standings, optional: true, type: instance_of(Standings)
+
+    # @!attribute [r] teams
+    # @return [Array<PickemTeam>, nil] the teams in this group
+    option :teams, optional: true, type: array_of(PickemTeam)
+
+    has_subresource :settings, klass: Settings
+    has_subresource :standings, klass: Standings
+    has_subresource :teams, klass: PickemTeam
+  end
+end

data/lib/y_fantasy/resources/league/scoreboard.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class League
+    # League scoreboard for a specific week
+    class Scoreboard < BaseSubresource
+      # --- REQUIRED ATTRIBUTES ----------------------------------------------------------------------------------------
+      option :week, type: Types::Coercible::Integer
+      option :matchups, type: array_of(Matchup)
+    end
+  end
+end

data/lib/y_fantasy/resources/league/settings.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class League
+    # Represents a league's settings
+    class Settings < BaseSubresource
+      # --- REQUIRED ATTRIBUTES ----------------------------------------------------------------------------------------
+      option :cant_cut_list
+      option :draft_together, type: Types::Params::Bool
+      option :draft_type
+      option :is_auction_draft, type: Types::Params::Bool
+      option :max_teams, type: Types::Coercible::Integer
+      option :player_pool
+      option :post_draft_players
+      option :scoring_type
+      option :trade_end_date, type: Types::Params::Date
+      option :trade_ratify_type
+      option :trade_reject_time, type: Types::Coercible::Integer
+      option :uses_faab, type: Types::Params::Bool
+      option :uses_playoff, type: Types::Params::Bool
+      option :waiver_rule
+      option :waiver_time, type: Types::Coercible::Integer
+      option :waiver_type
+
+      # --- OPTIONAL ATTRIBUTES ----------------------------------------------------------------------------------------
+      option :divisions, optional: true, type: ->(h) { h[:division] }
+      option :draft_pick_time, optional: true, type: Types::Coercible::Integer
+      option :draft_time, optional: true, type: Types::Coercible::Integer
+      option :has_multiweek_championship, optional: true, type: Types::Params::Bool
+      option :has_playoff_consolation_games, optional: true, type: Types::Params::Bool
+      option :max_games_played, optional: true, type: Types::Coercible::Integer
+      option :max_innings_pitched, optional: true, type: Types::Coercible::Integer
+      option :max_weekly_adds, optional: true, type: Types::Coercible::Integer
+      option :num_playoff_consolation_teams, optional: true, type: Types::Coercible::Integer
+      option :num_playoff_teams, optional: true, type: Types::Coercible::Integer
+      option :pickem_enabled, optional: true, type: Types::Params::Bool
+      option :playoff_start_week, optional: true, type: Types::Coercible::Integer
+      option :roster_import_deadline, optional: true, type: Types::Params::Date
+      option :roster_positions, optional: true, type: array_of(RosterPosition)
+      option :season_type, optional: true
+      option :stat_categories, optional: true, type: array_of(StatCategory)
+      option :stat_modifiers, optional: true, type: array_of(StatModifier)
+      option :uses_fractional_points, optional: true, type: Types::Params::Bool
+      option :uses_lock_eliminated_teams, optional: true, type: Types::Params::Bool
+      option :uses_negative_points, optional: true, type: Types::Params::Bool
+      option :uses_playoff_reseeding, optional: true, type: Types::Params::Bool
+      option :uses_roster_import, optional: true, type: Types::Params::Bool
+      option :waiver_days, optional: true, type: ->(h) { h.values.flatten }
+    end
+  end
+end

data/lib/y_fantasy/resources/league/standings.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class League
+    # Standings for a league
+    class Standings < BaseSubresource
+      # --- REQUIRED ATTRIBUTES ----------------------------------------------------------------------------------------
+      option :teams, array_of(Team)
+
+      # --- INSTANCE METHODS -------------------------------------------------------------------------------------------
+
+      # Returns an array of team hashes, sorted by rank.
+      # @return [Array<Hash>]
+      def final
+        teams.map(&:simple_standings).sort_by { |h| h[:rank] }
+      end
+
+      # Returns an array of team hashes, sorted by wins and points for.
+      # @return [Array<Hash>]
+      def regular_season
+        teams.map(&:simple_standings).sort_by { |h| [-h[:wins], -h[:points_for]] }
+      end
+    end
+  end
+end

data/lib/y_fantasy/resources/league.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+module YFantasy
+  # Represents a Yahoo Fantasy League.
+
+  class League < BaseResource
+    # --- REQUIRED ATTRIBUTES ------------------------------------------------------------------------------------------
+
+    # @!attribute [r] league_key
+    # @return [String] The unique key for this league
+    option :league_key
+
+    # @!attribute [r] league_id
+    # @return [String] The ID for this league
+    option :league_id
+
+    # @!attribute [r] allow_add_to_dl_extra_pos
+    # @return [Boolean] Whether the league allows adding extra positions to DL
+    option :allow_add_to_dl_extra_pos, Types::Params::Bool
+
+    # @!attribute [r] draft_status
+    # @return [String] The status of the draft
+    option :draft_status
+
+    # @!attribute [r] edit_key
+    # @return [String] The edit key for this league
+    option :edit_key
+
+    # @!attribute [r] end_date
+    # @return [Date] The end date of the league
+    option :end_date, type: Types::Params::Date
+
+    # @!attribute [r] felo_tier
+    # @return [String] The Fantasy ELO tier of the league
+    option :felo_tier
+
+    # @!attribute [r] game_code
+    # @return [String] The game code (e.g. "nfl", "nba")
+    option :game_code
+
+    # @!attribute [r] is_cash_league
+    # @return [Boolean] Whether this is a cash league
+    option :is_cash_league, Types::Params::Bool
+
+    # @!attribute [r] is_pro_league
+    # @return [Boolean] Whether this is a pro league
+    option :is_pro_league, Types::Params::Bool
+
+    # @!attribute [r] league_type
+    # @return [String] The type of league
+    option :league_type
+
+    # @!attribute [r] league_update_timestamp
+    # @return [Integer] The timestamp of the last league update
+    option :league_update_timestamp, Types::Coercible::Integer
+
+    # @!attribute [r] logo_url
+    # @return [String] The URL for the league logo
+    option :logo_url
+
+    # @!attribute [r] name
+    # @return [String] The name of the league
+    option :name
+
+    # @!attribute [r] num_teams
+    # @return [Integer] The number of teams in the league
+    option :num_teams, type: Types::Coercible::Integer
+
+    # @!attribute [r] renew
+    # @return [String] Previous league ID in the format "<game_id>_<league_id>"
+    # @example "123_111111"
+    option :renew
+
+    # @!attribute [r] renewed
+    # @return [String] Next league ID in the format "<game_id>_<league_id>"
+    # @example "789_222222"
+    option :renewed
+
+    # @!attribute [r] scoring_type
+    # @return [String] The scoring type of the league
+    option :scoring_type
+
+    # @!attribute [r] season
+    # @return [String] The season year of the league
+    option :season
+
+    # @!attribute [r] start_date
+    # @return [Date] The start date of the league
+    option :start_date, type: Types::Params::Date
+
+    # @!attribute [r] url
+    # @return [String] The URL to the league's Yahoo Fantasy page
+    option :url
+
+    # @!attribute [r] weekly_deadline
+    # @return [String] The weekly deadline type
+    option :weekly_deadline
+
+    # --- OPTIONAL ATTRIBUTES ------------------------------------------------------------------------------------------
+
+    # @!attribute [r] short_invitation_url
+    # @return [String, nil] The short URL for invitations to the league
+    option :short_invitation_url, optional: true
+
+    # @!attribute [r] current_week
+    # @return [Integer, nil] The current week number of the league
+    option :current_week, optional: true, type: Types::Coercible::Integer
+
+    # @!attribute [r] start_week
+    # @return [Integer, nil] The starting week of the league
+    option :start_week, optional: true, type: Types::Coercible::Integer
+
+    # @!attribute [r] end_week
+    # @return [Integer, nil] The final week of the league
+    option :end_week, optional: true, type: Types::Coercible::Integer
+
+    # @!attribute [r] is_finished
+    # @return [Boolean, nil] Whether the league has finished
+    option :is_finished, optional: true, type: Types::Params::Bool
+
+    # --- SUBRESOURCES -------------------------------------------------------------------------------------------------
+
+    # @!attribute [r] draft_results
+    # @return [Array<DraftResult>, nil] The draft results for the league
+    option :draft_results, optional: true, type: array_of(DraftResult)
+
+    # @!attribute [r] players
+    # @return [Array<Player>, nil] The players in the league. By default, only 25 players are returned.
+    option :players, optional: true, type: array_of(Player)
+
+    # @!attribute [r] scoreboard
+    # @return [Scoreboard, nil] The league scoreboard
+    option :scoreboard, optional: true, type: instance_of(Scoreboard)
+
+    # @!attribute [r] settings
+    # @return [Settings, nil] The league settings
+    option :settings, optional: true, type: instance_of(Settings)
+
+    # @!attribute [r] standings
+    # @return [Standings, nil] The league standings
+    option :standings, optional: true, type: instance_of(Standings)
+
+    # @!attribute [r] teams
+    # @return [Array<Team>, nil] The teams in this league
+    option :teams, optional: true, type: array_of(Team)
+
+    has_subresource :draft_results, klass: DraftResult
+    has_subresource :players, klass: Player
+    has_subresource :scoreboard, klass: Scoreboard
+    has_subresource :settings, klass: Settings
+    has_subresource :standings, klass: Standings
+    has_subresource :teams, klass: Team
+
+    # --- INSTANCE METHODS ---------------------------------------------------------------------------------------------
+
+    # Whether the league has started
+    # @return [Boolean] Whether the league has started based on the start date
+    def started?
+      Date.today >= start_date
+    end
+
+    # Whether the league has ended
+    # @return [Boolean] Whether the league has ended based on finished status or end date
+    def ended?
+      is_finished || Date.today > end_date
+    end
+
+    # Returns the key of the previous league
+    # @return [String, nil] The key of the previous league, if any
+    def previous_league_key
+      renew&.split("_")&.join(".l.")
+    end
+
+    # Returns the key of the next/renewed league
+    # @return [String, nil] The key of the next/renewed league, if any
+    def next_league_key
+      renewed&.split("_")&.join(".l.")
+    end
+
+    # Gets the scoreboard for a specific week
+    # @param week [Integer] The week number to get the scoreboard for
+    # @return [Scoreboard] The scoreboard for the specified week
+    def scoreboard_for_week(week)
+      @scoreboard = self.class.find(league_key, with: :scoreboard, week: week).scoreboard
+    end
+  end
+end

data/lib/y_fantasy/resources/pickem_team/pick.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class PickemTeam
+    # Represents a single team pick in a pickem fantasy contest
+    class Pick < BaseSubresource
+      # --- REQUIRED ATTRIBUTES ----------------------------------------------------------------------------------------
+
+      # @!attribute [r] team
+      # @return [String] the Yahoo team key (e.g., "nfl.t.1")
+      option :team
+
+      # @!attribute [r] result
+      # @return [Object] the result of the pick ("correct" or "strike")
+      option :result
+
+      # @!attribute [r] locked
+      # @return [Boolean] whether the pick is locked and cannot be changed
+      option :locked, type: Types::Params::Bool
+
+      # :nocov:
+
+      # @return [Hash] Team details (city, team name, abbreviation) for the pick
+      def team_details
+        Ref::Nfl.team(team)
+      end
+
+      # :nocov:
+    end
+  end
+end

data/lib/y_fantasy/resources/pickem_team/week_pick.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class PickemTeam
+    # Represents a single week of picks for a team in a Yahoo Fantasy NFL Survival Group.
+    # There may be multiple picks per week.
+    class WeekPick < BaseSubresource
+      # --- REQUIRED ATTRIBUTES ----------------------------------------------------------------------------------------
+
+      # @!attribute [r] week
+      # @return [Integer] the week number
+      option :week, type: Types::Coercible::Integer
+
+      # @!attribute [r] picks_completed
+      # @return [Integer] the number of picks completed for this week
+      option :picks_completed, type: Types::Coercible::Integer
+
+      # @!attribute [r] picks
+      # @return [Array<Pick>] the picks made for this week
+      option :picks, type: array_of(Pick)
+
+      # @return [Array<Hash>] team details for each pick
+      def pick_details
+        picks.compact.map(&:team_details)
+      end
+    end
+  end
+end