sleeper_rb 0.2.0

data/lib/sleeper_rb/resources/league/roster/settings.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module SleeperRb
+  module Resources
+    class League
+      class Roster
+        ##
+        # Settings for a specific roster in a league, including W/L/D, scoring_data, and waiver info.
+        class Settings
+          include SleeperRb::Utilities::Cache
+
+          ##
+          # :attr_reader: wins
+
+          ##
+          # :attr_reader: waiver_position
+
+          ##
+          # :attr_reader: waiver_budget_used
+
+          ##
+          # :attr_reader: total_moves
+
+          ##
+          # :attr_reader: ties
+
+          ##
+          # :attr_reader: losses
+
+          ##
+          # :attr_reader: fpts_decimal
+
+          ##
+          # :attr_reader: fpts_against_decimal
+
+          ##
+          # :attr_reader: fpts_against
+
+          ##
+          # :attr_reader: fpts
+
+          cached_attr :wins, :waiver_position, :waiver_budget_used, :total_moves, :ties, :losses, :fpts_decimal,
+                      :fpts_against_decimal, :fpts_against, :fpts
+
+          skip_refresh :all
+
+          ##
+          # @return [Float] All points scored by the roster
+          def total_points
+            (fpts.to_f + (fpts_decimal.to_f * 0.01)).round(2)
+          end
+
+          ##
+          # @return [Float] All points scored against the roster
+          def total_points_against
+            (fpts_against.to_f + (fpts_against_decimal.to_f * 0.01)).round(2)
+          end
+
+          ##
+          # @return [Float] Percentage of games won by the roster
+          def win_pct
+            return 0.0 unless [wins, ties, losses].any?(&:positive?)
+
+            ((wins.to_f / (wins + ties + losses)) * 100.0).round(2)
+          end
+
+          ##
+          # @return [String] Record for the roster in W - L - T format
+          def record_string
+            "#{wins} - #{losses} - #{ties}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sleeper_rb/resources/league/roster.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "roster/settings"
+
+module SleeperRb
+  module Resources
+    class League
+      ##
+      # A roster belonging to a specific user in a specific league.
+      class Roster
+        include SleeperRb::Utilities::Cache
+
+        PLAYER_LAMBDA = ->(array) { PlayerArray.new(array&.map { |player_id| Player.new(player_id: player_id) }) }
+
+        ##
+        # :attr_reader: roster_id
+
+        ##
+        # :attr_reader: owner_id
+
+        ##
+        # :attr_reader: league_id
+
+        ##
+        # :method: league
+        # The league to which the roster belongs
+        #
+        # @return [{SleeperRb::Resources::League}[rdoc-ref:SleeperRb::Resources::League]]
+
+        ##
+        # :method: settings
+        #
+        # @return [{SleeperRb::Resources::League::Roster::Settings}[rdoc-ref:SleeperRb::Resources::League::Roster::Settings]]
+
+        ##
+        # :method: starters
+        # The players currently starting for this roster.
+        #
+        # @return [{SleeperRb::Resources::PlayerArray}[rdoc-ref:SleeperRb::Resources::PlayerArray]]
+
+        ##
+        # :method: players
+        # The players currently currently on the roster.
+        #
+        # @return [{SleeperRb::Resources::PlayerArray}[rdoc-ref:SleeperRb::Resources::PlayerArray]]
+
+        ##
+        # :method: reserve
+        # The players currently on the reserve for this roster.
+        #
+        # @return [{SleeperRb::Resources::PlayerArray}[rdoc-ref:SleeperRb::Resources::PlayerArray]]
+
+        cached_attr :roster_id, :owner_id, :league_id, :league,
+                    settings: ->(settings) { Settings.new(settings) },
+                    starters: PLAYER_LAMBDA,
+                    players: PLAYER_LAMBDA,
+                    reserve: PLAYER_LAMBDA
+
+        delegate(*Settings.cached_attrs.keys, to: :settings)
+
+        skip_refresh :all
+
+        ##
+        # :method: owner
+        #
+        # @return [{SleeperRb::Resources::User}[rdoc-ref:SleeperRb::Resources::User]]
+        cached_association :owner do
+          User.new(user_id: owner_id)
+        end
+      end
+    end
+  end
+end

data/lib/sleeper_rb/resources/league/roster_array.rb

@@ -0,0 +1,11 @@
+# frozen-string-literal: true
+
+module SleeperRb
+  module Resources
+    class League
+      ##
+      # Implements {SleeperRb::Utilities::ArrayProxy} and wraps Roster objects.
+      class RosterArray < SleeperRb::Utilities::ArrayProxy; end
+    end
+  end
+end

data/lib/sleeper_rb/resources/league/scoring_settings.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module SleeperRb
+  module Resources
+    class League
+      ##
+      # Scoring settings for a League instance
+      class ScoringSettings
+        include SleeperRb::Utilities::Cache
+
+        ##
+        # :attr_reader: pass_2pt
+
+        ##
+        # :attr_reader: pass_int
+
+        ##
+        # :attr_reader: fgmiss
+
+        ##
+        # :attr_reader: rec_yd
+
+        ##
+        # :attr_reader: xpmiss
+
+        ##
+        # :attr_reader: blk_kick
+
+        ##
+        # :attr_reader: pts_allow_7_13
+
+        ##
+        # :attr_reader: ff
+
+        ##
+        # :attr_reader: fgm_20_29
+
+        ##
+        # :attr_reader: fgm_30_39
+
+        ##
+        # :attr_reader: fgm_40_49
+
+        ##
+        # :attr_reader: pts_allow_1_6
+
+        ##
+        # :attr_reader: st_fum_rec
+
+        ##
+        # :attr_reader: def_st_ff
+
+        ##
+        # :attr_reader: st_ff
+
+        ##
+        # :attr_reader: pts_allow_28_34
+
+        ##
+        # :attr_reader: fgm_50p
+
+        ##
+        # :attr_reader: fum_rec
+
+        ##
+        # :attr_reader: def_td
+
+        ##
+        # :attr_reader: fgm_0_19
+
+        ##
+        # :attr_reader: int
+
+        ##
+        # :attr_reader: pts_allow_0
+
+        ##
+        # :attr_reader: pts_allow_21_27
+
+        ##
+        # :attr_reader: rec_2pt
+
+        ##
+        # :attr_reader: rec
+
+        ##
+        # :attr_reader: xpm
+
+        ##
+        # :attr_reader: st_d
+
+        ##
+        # :attr_reader: def_st_fum_rec
+
+        ##
+        # :attr_reader: def_st_td
+
+        ##
+        # :attr_reader: sack
+
+        ##
+        # :attr_reader: fum_rec_td
+
+        ##
+        # :attr_reader: rush_2pt
+
+        ##
+        # :attr_reader: rec_td
+
+        ##
+        # :attr_reader: pts_allow_35p
+
+        ##
+        # :attr_reader: pts_allow_14_20
+
+        ##
+        # :attr_reader: rush_yd
+
+        ##
+        # :attr_reader: pass_yd
+
+        ##
+        # :attr_reader: pass_td
+
+        ##
+        # :attr_reader: rush_td
+
+        ##
+        # :attr_reader: fum_lost
+
+        ##
+        # :attr_reader: fum
+
+        ##
+        # :attr_reader: safe
+
+        # rubocop:disable Naming/VariableNumber
+        FIELDS = %i[
+          pass_2pt pass_int fgmiss rec_yd xpmiss blk_kick pts_allow_7_13 ff fgm_20_29 fgm_30_39 fgm_40_49 pts_allow_1_6
+          st_fum_rec def_st_ff st_ff pts_allow_28_34 fgm_50p fum_rec def_td fgm_0_19 int pts_allow_0 pts_allow_21_27
+          rec_2pt rec xpm st_td def_st_fum_rec def_st_td sack fum_rec_td rush_2pt rec_td pts_allow_35p pts_allow_14_20
+          rush_yd pass_yd pass_td rush_td fum_lost fum safe
+        ].freeze
+        # rubocop:enable Naming/VariableNumber
+
+        FIELDS.each do |field|
+          cached_attr field => :float
+        end
+
+        skip_refresh :all
+
+        ##
+        # @return [Boolean] If league uses PPR scoring
+        def ppr?
+          rec.to_i == 1
+        end
+
+        ##
+        # @return [Boolean] If league uses Half-PPR scoring
+        def half_ppr?
+          rec > 0.0 && rec < 1.0
+        end
+
+        ##
+        # @return [Boolean] If league uses Standard (0 PPR) scoring
+        def standard?
+          rec.zero?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module SleeperRb
+  module Resources
+    class League
+      ##
+      # Non-scoring settings for a League instance
+      class Settings
+        include SleeperRb::Utilities::Cache
+
+        ##
+        # :attr_reader: max_keepers
+
+        ##
+        # :attr_reader: draft_rounds
+
+        ##
+        # :attr_reader: trade_review_days
+
+        ##
+        # :attr_reader: reserve_allow_dnr
+
+        ##
+        # :attr_reader: capacity_override
+
+        ##
+        # :attr_reader: pick_trading
+
+        ##
+        # :attr_reader: disable_trades
+
+        ##
+        # :attr_reader: taxi_years
+
+        ##
+        # :attr_reader: taxi_allow_vets
+
+        ##
+        # :attr_reader: best_ball
+
+        ##
+        # :attr_reader: disable_adds
+
+        ##
+        # :attr_reader: waiver_type
+
+        ##
+        # :attr_reader: bench_lock
+
+        ##
+        # :attr_reader: reserve_allow_sus
+
+        ##
+        # :attr_reader: type
+
+        ##
+        # :attr_reader: reserve_allow_cov
+
+        ##
+        # :attr_reader: waiver_clear_days
+
+        ##
+        # :attr_reader: daily_waivers_last_ran
+
+        ##
+        # :attr_reader: waiver_day_of_week
+
+        ##
+        # :attr_reader: start_week
+
+        ##
+        # :attr_reader: playoff_teams
+
+        ##
+        # :attr_reader: num_teams
+
+        ##
+        # :attr_reader: reserve_slots
+
+        ##
+        # :attr_reader: playoff_round_type
+
+        ##
+        # :attr_reader: daily_waivers_hours
+
+        ##
+        # :attr_reader: waiver_budget
+
+        ##
+        # :attr_reader: reserve_allow_out
+
+        ##
+        # :attr_reader: offseason_adds
+
+        ##
+        # :attr_reader: playoff_seed_type
+
+        ##
+        # :attr_reader: daily_waivers
+
+        ##
+        # :attr_reader: playoff_week_start
+
+        ##
+        # :attr_reader: daily_waivers_days
+
+        ##
+        # :attr_reader: league_average_match
+
+        ##
+        # :attr_reader: leg
+
+        ##
+        # :attr_reader: trade_deadline
+
+        ##
+        # :attr_reader: reserve_allow_doubtful
+
+        ##
+        # :attr_reader: taxi_deadline
+
+        ##
+        # :attr_reader: reserve_allow_na
+
+        ##
+        # :attr_reader: taxi_slots
+
+        ##
+        # :attr_reader: playoff_type
+
+        FIELDS = %i[
+          max_keepers draft_rounds trade_review_days reserve_allow_dnr capacity_override taxi_years waiver_type
+          bench_lock type waiver_clear_days daily_waivers_last_ran waiver_day_of_week start_week playoff_teams
+          num_teams reserve_slots playoff_round_type daily_waivers_hour waiver_budget playoff_type taxi_slots
+          reserve_allow_out playoff_seed_type daily_waivers playoff_week_start daily_waivers_days taxi_deadline
+          league_average_match leg trade_deadline
+        ].freeze
+
+        cached_attr(*FIELDS, best_ball: :int_to_bool, pick_trading: :int_to_bool, disable_trades: :int_to_bool,
+                             taxi_allow_vets: :int_to_bool, disable_adds: :int_to_bool, reserve_allow_sus: :int_to_bool,
+                             reserve_allow_cov: :int_to_bool, offseason_adds: :int_to_bool, reserve_allow_doubtful: :int_to_bool,
+                             reserve_allow_na: :int_to_bool)
+
+        skip_refresh :all
+      end
+    end
+  end
+end

data/lib/sleeper_rb/resources/league/transaction/metadata.rb

@@ -0,0 +1,22 @@
+# frozen-string-literal: true
+
+module SleeperRb
+  module Resources
+    class League
+      class Transaction
+        ##
+        # Miscellaneous information about the transaction, for example notes about why a waiver bid did not go through.
+        class Metadata
+          include SleeperRb::Utilities::Cache
+
+          # The Sleeper documentation lists this field for transactions but none of the examples show the actual
+          # structure of the object. This is left here for now as a placeholder to be filled in once I come across
+          # a transaction where the metadata is not null.
+          cached_attr
+
+          skip_refresh :all
+        end
+      end
+    end
+  end
+end

data/lib/sleeper_rb/resources/league/transaction/settings.rb

@@ -0,0 +1,22 @@
+# frozen-string-literal: true
+
+module SleeperRb
+  module Resources
+    class League
+      class Transaction
+        ##
+        # Settings for a transaction, includes information like FAAB bid amount.
+        class Settings
+          include SleeperRb::Utilities::Cache
+
+          ##
+          # :attr_reader: waiver_bid
+
+          cached_attr :waiver_bid
+
+          skip_refresh :all
+        end
+      end
+    end
+  end
+end

data/lib/sleeper_rb/resources/league/transaction/waiver_budget.rb

@@ -0,0 +1,52 @@
+# frozen-string-literal: true
+
+module SleeperRb
+  module Resources
+    class League
+      class Transaction
+        ##
+        # Represents data about a waiver budget exchange in a transaction (trade).
+        class WaiverBudget
+          include SleeperRb::Utilities::Cache
+
+          ##
+          # :attr_reader: sender
+
+          ##
+          # :attr_reader: receiver
+
+          ##
+          # :attr_reader: amount
+
+          ##
+          # :method: transaction
+          # The transaction to which this belongs.
+          #
+          # @return [{SleeperRb::Resources::League::Transaction}[rdoc-ref:SleeperRb::Resources::League::Transaction]]
+
+          cached_attr :sender, :receiver, :amount, :transaction
+
+          skip_refresh :all
+
+          ##
+          # :method: sending_roster
+          # Returns the roster object that sent the WaiverBudget in this transaction.
+          #
+          # @return [{SleeperRb::Resources::League::Roster}[rdoc-ref:SleeperRb::Resources::League::Roster]]
+          cached_association :sending_roster do
+            transaction.league.rosters.detect { |roster| roster.roster_id == sender }
+          end
+
+          ##
+          # :method: receiving_roster
+          # Returns the roster object that received the WaiverBudget in this transaction.
+          #
+          # @return [{SleeperRb::Resources::League::Roster}[rdoc-ref:SleeperRb::Resources::League::Roster]]
+          cached_association :receiving_roster do
+            transaction.league.rosters.detect { |roster| roster.roster_id == receiver }
+          end
+        end
+      end
+    end
+  end
+end