y_fantasy 0.1.0

data/lib/y_fantasy/resources/pickem_team.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module YFantasy
+  # Represents a Yahoo Fantasy Pick'em Team in a NFL Survival Group
+  class PickemTeam < BaseResource
+    # --- REQUIRED ATTRIBUTES ------------------------------------------------------------------------------------------
+
+    # @!attribute [r] team_key
+    # @return [String] The unique key for this PickemTeam
+    option :team_key
+
+    # @!attribute [r] team_id
+    # @return [Integer] The ID for this PickemTeam
+    option :team_id, type: Types::Coercible::Integer
+
+    # @!attribute [r] name
+    # @return [String] The name of the PickemTeam
+    option :name
+
+    # @!attribute [r] total_strikes
+    # @return [Integer] The total number of strikes this team has
+    option :total_strikes, type: Types::Coercible::Integer
+
+    # @!attribute [r] elimination_week
+    # @return [Integer] The week number when this team was eliminated
+    option :elimination_week, type: Types::Coercible::Integer
+
+    # --- OPTIONAL ATTRIBUTES ------------------------------------------------------------------------------------------
+
+    # @!attribute [r] can_edit_current_week
+    # @return [Boolean, nil] whether picks are editable for the current week
+    option :can_edit_current_week, optional: true, type: Types::Params::Bool
+
+    # @!attribute [r] current_pick
+    # @return [String, nil] the current pick for this team
+    option :current_pick, optional: true
+
+    # @!attribute [r] current_picks
+    # @return [Array, nil] the current picks for this team
+    option :current_picks, optional: true
+
+    # @!attribute [r] eliminated
+    # @return [Boolean, nil] whether this team has been eliminated
+    option :eliminated, optional: true, type: Types::Params::Bool
+
+    # @!attribute [r] elimination_pick
+    # @return [String, nil] the pick that caused this team's elimination
+    option :elimination_pick, optional: true
+
+    # @!attribute [r] is_in_contest
+    # @return [Boolean, nil] whether this team is in a contest
+    option :is_in_contest, optional: true, type: Types::Params::Bool
+
+    # @!attribute [r] is_owned_by_current_login
+    # @return [Boolean, nil] whether this team is owned by the current user
+    option :is_owned_by_current_login, optional: true, type: Types::Params::Bool
+
+    # @!attribute [r] last_editable_week
+    # @return [String, nil] the last week number that can be edited
+    option :last_editable_week, optional: true
+
+    # @!attribute [r] manager
+    # @return [Team::Manager, nil] the manager of this PickemTeam
+    option :manager, optional: true, type: instance_of(Team::Manager)
+
+    # @!attribute [r] status
+    # @return [String, nil] the status of this PickemTeam
+    option :status, optional: true
+
+    # --- SUBRESOURCES -------------------------------------------------------------------------------------------------
+
+    # @!attribute [r] week_picks
+    # @return [Array<WeekPick>, nil] the weekly picks for this team
+    option :week_picks, optional: true, type: array_of(WeekPick)
+
+    has_subresource :week_picks, klass: WeekPick
+
+    # --- INSTANCE METHODS ---------------------------------------------------------------------------------------------
+
+    # Returns the key of this PickemTeam
+    # @return [String] the team key
+    def key
+      team_key
+    end
+
+    # Returns the group key for this PickemTeam
+    # @return [String] the group key
+    def group_key
+      @group_key ||= team_key.sub(/\.t\.\d+/, "")
+    end
+
+    # Returns the group this PickemTeam belongs to
+    # @return [Group] the group object
+    def group
+      @group ||= Group.find(group_key)
+    end
+  end
+end

data/lib/y_fantasy/resources/player/draft_analysis.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class Player
+    # Draft statistics for a player in Yahoo Fantasy Sports
+    class DraftAnalysis < BaseSubresource
+      # --- REQUIRED ATTRIBUTES ----------------------------------------------------------------------------------------
+
+      # @!attribute [r] average_cost
+      # @return [Float] the average cost of this player in auction drafts
+      option :average_cost, type: ->(v) { Transformations::T.floatize(v) }
+
+      # @!attribute [r] average_pick
+      # @return [Float] the average pick used to draft this player
+      option :average_pick, type: ->(v) { Transformations::T.floatize(v) }
+
+      # @!attribute [r] average_round
+      # @return [Float] the player's average draft round
+      option :average_round, type: ->(v) { Transformations::T.floatize(v) }
+
+      # @!attribute [r] percent_drafted
+      # @return [Float] the percentage of drafts in which this player was selected
+      option :percent_drafted, type: ->(v) { Transformations::T.floatize(v) * 100 }
+    end
+  end
+end

data/lib/y_fantasy/resources/player/ownership_percentage.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class Player
+    # Represents ownership percentage data for a player in Yahoo Fantasy Sports.
+    class OwnershipPercentage < BaseSubresource
+      # --- REQUIRED ATTRIBUTES ----------------------------------------------------------------------------------------
+
+      # @!attribute [r] coverage_type
+      # @return [String] the type of coverage (e.g., "week")
+      option :coverage_type
+
+      # @!attribute [r] delta
+      # @return [Integer] the change in ownership percentage
+      option :delta, type: Types::Coercible::Integer
+
+      # @!attribute [r] value
+      # @return [Integer] the ownership percentage, given as a whole number
+      option :value, type: Types::Coercible::Integer
+
+      # @!attribute [r] week
+      # @return [Integer] the week for which ownership percentage is reported
+      option :week, type: Types::Coercible::Integer
+    end
+  end
+end

data/lib/y_fantasy/resources/player/stat_collection.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class Player
+    # A collection of stats for a player, for a given time period (e.g., season, week).
+    class StatCollection < BaseSubresource
+      # --- REQUIRED ATTRIBUTES ----------------------------------------------------------------------------------------
+
+      # @!attribute [r] coverage_type
+      # @return [String] the type of coverage (e.g., "week", "season")
+      option :coverage_type
+
+      # @!attribute [r] standard_stats
+      # @return [Array<Stat>] standard stats for this player
+      option :standard_stats, type: array_of(Stat)
+
+      # --- OPTIONAL ATTRIBUTES ----------------------------------------------------------------------------------------
+
+      # @!attribute [r] advanced_stats
+      # @return [Array<Stat>] advanced stats for this player
+      option :advanced_stats, optional: true, type: array_of(Stat)
+
+      # @!attribute [r] season
+      # @return [Integer] the season for which stats are reported
+      option :season, optional: true, type: Types::Coercible::Integer
+
+      # @!attribute [r] week
+      # @return [Integer] the week for which stats are reported (nil if coverage_type is "season")
+      option :week, optional: true, type: Types::Coercible::Integer
+    end
+  end
+end

data/lib/y_fantasy/resources/player.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module YFantasy
+  # Represents a Yahoo Fantasy Player
+  class Player < BaseResource
+    # --- REQUIRED ATTRIBUTES ------------------------------------------------------------------------------------------
+
+    # @!attribute [r] player_key
+    # @return [String] the unique key for this player, within a Game
+    option :player_key
+
+    # @!attribute [r] player_id
+    # @return [Integer] the ID for this player
+    option :player_id, type: Types::Coercible::Integer
+
+    # @!attribute [r] display_position
+    # @return [String] the display position of the player
+    # @note When a player has more than one position, this will be a comma-separated string of positions
+    option :display_position
+
+    # @!attribute [r] editorial_player_key
+    # @return [String] the editorial key for this player
+    option :editorial_player_key
+
+    # @!attribute [r] editorial_team_abbr
+    # @return [String] the abbreviation of the player's real-life team
+    option :editorial_team_abbr
+
+    # @!attribute [r] editorial_team_full_name
+    # @return [String] the full name of the player's real-life team
+    option :editorial_team_full_name
+
+    # @!attribute [r] editorial_team_key
+    # @return [String] the key of the player's real-life team
+    option :editorial_team_key
+
+    # @!attribute [r] editorial_team_url
+    # @return [String] the URL to the player's real-life team page
+    option :editorial_team_url
+
+    # @!attribute [r] eligible_positions
+    # @return [String, Array<String>] the eligible positions for this player (e.g. "QB", ["RB", "WR"])
+    option :eligible_positions, type: ->(h) { h[:position] }
+
+    # @!attribute [r] headshot
+    # @return [Hash] hash containing headshot information (size, url)
+    option :headshot
+
+    # @!attribute [r] image_url
+    # @return [String] the player's image URL
+    option :image_url
+
+    # @!attribute [r] is_keeper
+    # @return [Hash] A hash containing the player's keeper status and cost
+    option :is_keeper
+
+    # @!attribute [r] is_undroppable
+    # @return [Boolean] whether this player is undroppable
+    option :is_undroppable, type: Types::Params::Bool
+
+    # @!attribute [r] name
+    # @return [Hash] hash containing the player's name (first, last, full, ascii_first, ascii_last)
+    option :name
+
+    # @!attribute [r] position_type
+    # @return [String] the type of position (e.g. "O" for offense)
+    option :position_type
+
+    # @!attribute [r] uniform_number
+    # @return [String] the player's uniform number
+    option :uniform_number
+
+    # @!attribute [r] url
+    # @return [String] the URL to the player's Yahoo Fantasy page
+    option :url
+
+    # --- OPTIONAL ATTRIBUTES ------------------------------------------------------------------------------------------
+
+    # @!attribute [r] bye_weeks
+    # @return [Array<String>, nil] the bye weeks for this player
+    option :bye_weeks, optional: true, type: ->(h) { h[:week] }
+
+    # @!attribute [r] has_player_notes
+    # @return [Boolean, nil] whether this player has notes
+    option :has_player_notes, optional: true, type: Types::Params::Bool
+
+    # @!attribute [r] has_recent_player_notes
+    # @return [Boolean, nil] whether this player has recent notes
+    option :has_recent_player_notes, optional: true, type: Types::Params::Bool
+
+    # @!attribute [r] player_notes_last_timestamp
+    # @return [Integer, nil] the timestamp of the last player note
+    option :player_notes_last_timestamp, optional: true, type: Types::Coercible::Integer
+
+    # @!attribute [r] player_points
+    # Hash containing details about the player's fantasy points. Includes: coverage_type, total, week.
+    # @note Only available when requesting a player within a team's roster
+    # @return [Hash, nil] the player's fantasy points information
+    option :player_points, optional: true do
+      option :coverage_type
+      option :total, type: Types::Coercible::Float
+      option :week, optional: true, type: Types::Coercible::Integer
+    end
+
+    # @!attribute [r] selected_position
+    # Hash containing details about the player's selected position. Includes: coverage_type, is_flex, positition, week.
+    # @note Only available when requesting a player within a team's roster
+    # @return [Hash, nil] the player's selected position information
+    option :selected_position, optional: true do
+      option :coverage_type
+      option :is_flex, optional: true, type: Types::Params::Bool
+      option :position
+      option :week, optional: true, type: Types::Coercible::Integer
+    end
+
+    # --- SUBRESOURCES -------------------------------------------------------------------------------------------------
+
+    # @!attribute [r] draft_analysis
+    # @return [DraftAnalysis, nil] the draft analysis for this player
+    option :draft_analysis, optional: true, type: instance_of(DraftAnalysis)
+
+    # @!attribute [r] ownership_percentage
+    # @return [OwnershipPercentage, nil] the ownership percentage information for this player
+    option :ownership_percentage, optional: true, type: instance_of(OwnershipPercentage)
+
+    # @!attribute [r] stats
+    # @return [StatCollection, nil] the stat collection for this player
+    option :stats, optional: true, type: instance_of(StatCollection)
+
+    has_subresource :draft_analysis, klass: DraftAnalysis
+    has_subresource :ownership_percentage, klass: OwnershipPercentage
+    has_subresource :stats, klass: StatCollection
+
+    # --- INSTANCE METHODS ---------------------------------------------------------------------------------------------
+
+    # :nocov:
+
+    # Returns the player's first name
+    # @return [String] the player's first name
+    def first_name
+      name[:first]
+    end
+
+    # Returns the player's last name
+    # @return [String] the player's last name
+    def last_name
+      name[:last]
+    end
+
+    # Returns the player's full name
+    # @return [String] the player's full name
+    def full_name
+      name[:full]
+    end
+    # :nocov:
+  end
+end

data/lib/y_fantasy/resources/shared_subresources/draft_result.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module YFantasy
+  # Represents a single draft result in a Yahoo Fantasy league
+  class DraftResult < BaseSubresource
+    # --- REQUIRED ATTRIBUTES ------------------------------------------------------------------------------------------
+
+    # @!attribute [r] pick
+    # @return [Integer] the pick number
+    option :pick, type: Types::Coercible::Integer
+
+    # @!attribute [r] round
+    # @return [Integer] the draft round
+    option :round, type: Types::Coercible::Integer
+
+    # @!attribute [r] player_key
+    # @return [String] the unique key for the player drafted
+    option :player_key
+
+    # @!attribute [r] team_key
+    # @return [String] the unique key for the drafting team
+    option :team_key
+
+    # :nocov:
+
+    # Retrieves the Player resource associated with this draft result
+    # @return [Player] the player drafted
+    def player
+      self.class.find(:player, player_key)
+    end
+
+    # Retrieves the Team resource associated with this draft result
+    # @return [Team] the drafting team
+    def team
+      self.class.find(:team, team_key)
+    end
+    # :nocov:
+  end
+end

data/lib/y_fantasy/resources/shared_subresources/matchup.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class Matchup < BaseSubresource
+    # Required attributes
+    option :is_consolation, type: Types::Params::Bool
+    option :is_playoffs, type: Types::Params::Bool
+    option :status
+    option :week, type: Types::Coercible::Integer
+    option :week_end, type: Types::Params::Date
+    option :week_start, type: Types::Params::Date
+
+    # Optional attributes
+    option :is_matchup_recap_available, optional: true, type: Types::Params::Bool
+    option :is_tied, optional: true, type: Types::Params::Bool
+    option :stat_winners, optional: true, type: array_of(StatWinner)
+    option :winner_team_key, optional: true
+
+    # Subresources
+    option :teams, type: array_of(Team)
+
+    def winning_team
+      return if is_tied
+
+      teams.find { |team| team.team_key == winner_team_key }
+    end
+
+    def losing_team
+      return if is_tied
+
+      teams.find { |team| team.team_key != winner_team_key }
+    end
+
+    def winner_total_points
+      winning_team&.stats&.team_points&.total
+    end
+
+    def winner_proj_points
+      winning_team&.stats&.team_projected_points&.total
+    end
+
+    def loser_total_points
+      losing_team&.stats&.team_points&.total
+    end
+
+    def loser_proj_points
+      losing_team&.stats&.team_projected_points&.total
+    end
+
+    def scores
+      teams.map do |team|
+        {
+          team_key: team.team_key,
+          team_name: team.name,
+          total: team.stats.team_points.total,
+          proj_total: team.stats.team_projected_points.total
+        }
+      end
+    end
+  end
+end

data/lib/y_fantasy/resources/shared_subresources/roster_position.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module YFantasy
+  # Reprsents a Yahoo Fantasy roster position
+  class RosterPosition < BaseSubresource
+    # --- REQUIRED ATTRIBUTES ------------------------------------------------------------------------------------------
+
+    # @!attribute [r] position
+    # @return [String] the position name (e.g., "QB")
+    option :position
+
+    # --- OPTIONAL ATTRIBUTES ------------------------------------------------------------------------------------------
+
+    # @!attribute [r] abbreviation
+    # @return [String] the position abbreviation
+    option :abbreviation, optional: true
+
+    # @!attribute [r] display_name
+    # @return [String] the position display name
+    option :display_name, optional: true
+
+    # @!attribute [r] position_type
+    # @return [String] the position type (e.g., "O", "DT", "K", "BN")
+    option :position_type, optional: true
+
+    # @!attribute [r] count
+    # @return [Integer] the number of this position type allowed on a roster
+    option :count, optional: true, type: Types::Coercible::Integer
+
+    # @!attribute [r] is_bench
+    # @return [Boolean] whether this position is a bench position
+    option :is_bench, optional: true, type: Types::Params::Bool
+
+    # @!attribute [r] is_starting_position
+    # @return [Boolean] whether this position is a starting position
+    option :is_starting_position, optional: true, type: Types::Params::Bool
+  end
+end

data/lib/y_fantasy/resources/shared_subresources/stat.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module YFantasy
+  # Represents
+  class Stat < BaseSubresource
+    # --- REQUIRED ATTRIBUTES ------------------------------------------------------------------------------------------
+
+    # @!attribute [r] stat_id
+    # @return [Integer] the Yahoo stat ID
+    option :stat_id, type: Types::Coercible::Integer
+
+    # @!attribute [r] value
+    # @return [String] the value for this stat
+    option :value
+  end
+end

data/lib/y_fantasy/resources/shared_subresources/stat_category.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class StatCategory < BaseSubresource
+    # Required attributes
+    option :stat_id, type: Types::Coercible::Integer
+
+    option :display_name
+    option :name
+    option :sort_order, type: Types::Coercible::Integer
+
+    # Optional attributes
+    option :abbr, optional: true
+    option :base_stats, optional: true, type: ->(h) { h.values.flatten }
+    option :enabled, optional: true, type: Types::Params::Bool
+    option :group, optional: true
+    option :is_composite_stat, optional: true, type: Types::Params::Bool
+    option :is_only_display_stat, optional: true, type: Types::Params::Bool
+    option :position_type, optional: true
+    option :position_types, optional: true, type: ->(h) { h.values.flatten }
+  end
+end

data/lib/y_fantasy/resources/shared_subresources/stat_modifier.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module YFantasy
+  # NOTE: StatModifiers are only included in settings for certain league scoring types.
+  class StatModifier < BaseSubresource
+    # Required attributes
+    option :stat_id, type: Types::Coercible::Integer
+    option :value, type: Types::Coercible::Float
+  end
+end

data/lib/y_fantasy/resources/shared_subresources/stat_winner.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class StatWinner < BaseSubresource
+    option :stat_id, type: Types::Coercible::Integer
+    option :winner_team_key, optional: true
+  end
+end

data/lib/y_fantasy/resources/team/manager.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class Team
+    class Manager < BaseSubresource
+      # Required attributes
+      option :manager_id, type: Types::Coercible::Integer
+      option :guid
+      option :nickname
+
+      # Optional attributes
+      option :email, optional: true
+      option :fantasy_profile_url, optional: true
+      option :felo_score, optional: true, type: Types::Coercible::Integer
+      option :felo_tier, optional: true
+      option :image_url, optional: true
+      option :is_comanager, optional: true, type: Types::Params::Bool
+      option :is_commissioner, optional: true, type: Types::Params::Bool
+      option :is_current_login, optional: true, type: Types::Params::Bool
+      option :profile_image_url, optional: true
+    end
+  end
+end

data/lib/y_fantasy/resources/team/roster.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class Team
+    class Roster < BaseSubresource
+      # Required attributes
+      option :coverage_type
+      option :is_editable, type: Types::Params::Bool
+      option :players, type: array_of(Player)
+
+      # Optional attributes
+      option :date, optional: true, type: Types::Params::Date
+      option :week, optional: true, type: Types::Coercible::Integer
+
+      has_subresource :players, klass: Player
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class Team
+    class Standings < BaseSubresource
+      # Required attributes
+      option :points_for, type: Types::Coercible::Float
+      option :rank, type: Types::Coercible::Integer
+
+      # Optional attributes
+      option :games_back, optional: true, type: Types::Coercible::Float
+      option :playoff_seed, optional: true, type: Types::Coercible::Integer
+      option :points_against, optional: true, type: Types::Coercible::Float
+      option :points_back, optional: true, type: Types::Coercible::Float
+      option :points_change, optional: true, type: Types::Coercible::Float
+      option :streak, optional: true do
+        option :type
+        option :value, type: Types::Coercible::Integer
+      end
+      option :divisional_wins, optional: true, type: Types::Coercible::Integer
+      option :divisional_losses, optional: true, type: Types::Coercible::Integer
+      option :divisional_ties, optional: true, type: Types::Coercible::Integer
+      option :total_wins, optional: true, type: Types::Coercible::Integer
+      option :total_losses, optional: true, type: Types::Coercible::Integer
+      option :total_ties, optional: true, type: Types::Coercible::Integer
+      option :win_percentage, optional: true, type: Types::Coercible::Float
+
+      alias_method :wins, :total_wins
+      alias_method :losses, :total_losses
+      alias_method :ties, :total_ties
+    end
+  end
+end

data/lib/y_fantasy/resources/team/stat_collection.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module YFantasy
+  class Team
+    class StatCollection < BaseSubresource
+      option :team_stats, optional: true, default: -> {} do
+        option :coverage_type, optional: true, default: -> {}
+        option :season, optional: true, default: -> {}
+        # Fully qualified class name needed because nested options create intermediate classes on the fly.
+        # At this level we have: YF::Team::StatCollection::TeamStats. TeamStats is created on-the-fly and does not
+        # inherit from BaseResource.
+        option :stats, optional: true, type: YFantasy::BaseResource.send(:array_of, Stat)
+      end
+
+      option :team_points, optional: true, default: -> {} do
+        option :coverage_type, optional: true, default: -> {}
+        option :season, optional: true, default: -> {}
+        option :total, optional: true, default: -> {}
+        option :week, optional: true, default: -> {}
+      end
+
+      option :team_projected_points, optional: true, default: -> {} do
+        option :coverage_type, optional: true, default: -> {}
+        option :season, optional: true, default: -> {}
+        option :total, optional: true, default: -> {}
+        option :week, optional: true, default: -> {}
+      end
+
+      option :team_remaining_games, optional: true, default: -> {} do
+        option :coverage_type, optional: true, default: -> {}
+        option :week, optional: true, default: -> {}
+        option :completed_games, optional: true, default: -> {}
+        option :live_games, optional: true, default: -> {}
+        option :remaining_games, optional: true, default: -> {}
+      end
+    end
+  end
+end