sleeper_api 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e64262b5b1ec981daba5a470cdaed3857b5b334b4b5b974b36369bb71d10fe6
-  data.tar.gz: 6e292f1ff2de695f2385736316d1d0329373cdfb8d944d399e42ffcda7014d2d
+  metadata.gz: 49f189b10709caa46c846f8733372cfd50d1dff0f66548aba5cb7ce0d32508f5
+  data.tar.gz: a0670835fa5f56541d041292b498722d0597a0599c724e95f9e3ed193151872c
 SHA512:
-  metadata.gz: fcad44e534d0f99daa36897d56b228e432e5374d9e829915fed7cc71612588b9576a96147cedb07cc658cd0a590769161ccd74ef82f48ed7d1b0c2d7dc210e88
-  data.tar.gz: ca0a00e724c6b35182add239a7a80c9b8129c3a1af2805f216f21b50971842fa968a1c902ab97686819c676390ef89e3fa0fb4635013d9f3f8f7c5aec565d7e6
+  metadata.gz: dd18ff49145f5c1848857f7af5e9b15f02a8aac6f7940fe85517d333a213707f524d3f54d5d211ce94de28be9e955e6e366a3db66101ce329d39264f6eabf983
+  data.tar.gz: 0b254fa2078732333ee53f3f1074f3700c85c28733478234cd3c303b6b2698967889ad2db33d9802b1a93d00d7dee378387bfdb1d18403f55d0104daedc934b1

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [1.2.0] - 2026-08-23
+
+### Added
+
+- `Client#schedule(season, season_type:, sport:)` — a season's game list, each entry `{status, date, home, away, week, game_id}`. A team's bye week is the week it appears in no game, which derives exactly: checked against 2024, 2025 and 2026, every one gives exactly one bye per team. Note `pre` (weeks 1-3) and `post` (weeks 1-4) restart week numbering, so games from different season types must never be pooled, and a season Sleeper has not scheduled yet answers 200 with `[]` rather than 404.
+
+### Changed
+
+- **`base_uri` is now the bare host, `https://api.sleeper.app`, and every path carries its own `/v1`.** The schedule endpoint is served from the host root, so while the version lived in `base_uri` it was unreachable at any path a caller could pass to `make_request`. Moving the version into the paths means one mechanism for every endpoint rather than an escape hatch for the exceptions.
+
+  **This changes the text of `SleeperApi::Error`**, which quotes the path it failed on: `"Failed to fetch /user/x: 404"` is now `"Failed to fetch /v1/user/x: 404"`. Anything matching on that string needs updating — though matching on it was never sound, since the same error covers a missing user, a 5xx and a timeout alike.
+
 ## [1.1.0] - 2026-08-22
 
 ### Fixed

data/CLAUDE.md

@@ -26,7 +26,9 @@ CI (`.github/workflows/ci.yml`) runs `bundle exec rake ci` on Ruby 3.2 only. The
 Four layers, with a deliberate split between HTTP and modeling:
 
 - **`SleeperApi`** (`lib/sleeper_api.rb`) — module-level config + memoized global `SleeperApi.client`. `Configuration` validates `timeout` (10–60) and `retries` (0–5), raising `SleeperApi::Error` outside those bounds.
-- **`Client`** — the only thing that talks HTTP. `include HTTParty` with `base_uri "https://api.sleeper.app/v1"`. Every call funnels through the private `make_request`, which handles retry-on-timeout, logging, and converts non-2xx into `SleeperApi::Error`. It also owns the 24-hour in-memory player cache.
+- **`Client`** — the only thing that talks HTTP. `include HTTParty` with `base_uri "https://api.sleeper.app"` — **the bare host; the `/v1` lives in each path**. That is deliberate and load-bearing: not every Sleeper endpoint is versioned. `/schedule/{sport}/{season_type}/{season}` is served from the host root, and while `base_uri` carried the version that endpoint was unreachable at any path a caller could pass in. A new endpoint spells out where it lives; do not move the version back into `base_uri` to shorten the paths.
+
+  Every call funnels through the private `make_request`, which handles retry-on-timeout, logging, and converts non-2xx into `SleeperApi::Error`. **That error quotes the path**, so the path prefix is part of a public string — v1.2.0 changed it from `"Failed to fetch /user/x: 404"` to `"Failed to fetch /v1/user/x: 404"`. `Client` also owns the 24-hour in-memory player cache.
 - **`League` / `User` / `Draft`** — resource objects. Each takes `(id, client)`, fetches eagerly in the constructor, memoizes into ivars, and exposes formatted hashes.
 - **`Helpers`** — mixed into all four. `deep_symbolize_keys` plus `player_details`, which reaches through `@client` — so any class including it must define `@client`.
 

data/lib/sleeper_api/client.rb

@@ -15,7 +15,11 @@ module SleeperApi
     include Helpers
     include HTTParty
 
-    base_uri "https://api.sleeper.app/v1"
+    # The host only. The API version belongs in the paths because not every
+    # endpoint has one: /schedule is served from the root, and while base_uri
+    # carried "/v1" that endpoint was unreachable at any path a caller could
+    # pass to make_request.
+    base_uri "https://api.sleeper.app"
 
     # @param config [SleeperApi::Configuration] Client configuration
     def initialize(config)
@@ -57,7 +61,7 @@ module SleeperApi
     # @return [Hash] Raw user data
     # @see https://docs.sleeper.com/#user
     def get_user(identifier)
-      make_request("/user/#{identifier}")
+      make_request("/v1/user/#{identifier}")
     end
 
     # Get leagues for a user in a specific season.
@@ -68,7 +72,7 @@ module SleeperApi
     # @return [Array<Hash>] League data
     # @see https://docs.sleeper.com/#get-all-leagues-for-user
     def get_user_leagues(user_id, sport: "nfl", season: Time.now.year)
-      make_request("/user/#{user_id}/leagues/#{sport}/#{season}")
+      make_request("/v1/user/#{user_id}/leagues/#{sport}/#{season}")
     end
 
     # Get drafts for a user in a specific season.
@@ -79,7 +83,7 @@ module SleeperApi
     # @return [Array<Hash>] Draft data
     # @see https://docs.sleeper.com/#get-all-drafts-for-user
     def get_user_drafts(user_id, sport: "nfl", season: Time.now.year)
-      make_request("/user/#{user_id}/drafts/#{sport}/#{season}")
+      make_request("/v1/user/#{user_id}/drafts/#{sport}/#{season}")
     end
 
     # Fetch league details.
@@ -88,7 +92,7 @@ module SleeperApi
     # @return [Hash] League metadata
     # @see https://docs.sleeper.com/#get-a-specific-league
     def get_league(league_id)
-      make_request("/league/#{league_id}")
+      make_request("/v1/league/#{league_id}")
     end
 
     # Get all rosters in a league.
@@ -97,7 +101,7 @@ module SleeperApi
     # @return [Array<Hash>] Roster data
     # @see https://docs.sleeper.com/#getting-rosters-in-a-league
     def get_league_rosters(league_id)
-      make_request("/league/#{league_id}/rosters")
+      make_request("/v1/league/#{league_id}/rosters")
     end
 
     # Get all users in a league.
@@ -106,7 +110,7 @@ module SleeperApi
     # @return [Array<Hash>] User data
     # @see https://docs.sleeper.com/#getting-users-in-a-league
     def get_league_users(league_id)
-      make_request("/league/#{league_id}/users")
+      make_request("/v1/league/#{league_id}/users")
     end
 
     # Get matchups for a specific week.
@@ -116,7 +120,7 @@ module SleeperApi
     # @return [Array<Hash>] Matchup data
     # @see https://docs.sleeper.com/#getting-matchups-in-a-league
     def get_league_matchups(league_id, week)
-      make_request("/league/#{league_id}/matchups/#{week}")
+      make_request("/v1/league/#{league_id}/matchups/#{week}")
     end
 
     # Get playoff winners bracket.
@@ -125,7 +129,7 @@ module SleeperApi
     # @return [Array<Hash>] Bracket matchups
     # @see https://docs.sleeper.com/#getting-the-playoff-bracket
     def get_playoff_bracket(league_id)
-      make_request("/league/#{league_id}/winners_bracket")
+      make_request("/v1/league/#{league_id}/winners_bracket")
     end
 
     # Get toilet bowl (losers bracket).
@@ -134,7 +138,7 @@ module SleeperApi
     # @return [Array<Hash>] Bracket matchups
     # @see https://docs.sleeper.com/#getting-the-playoff-bracket
     def get_toilet_bowl(league_id)
-      make_request("/league/#{league_id}/losers_bracket")
+      make_request("/v1/league/#{league_id}/losers_bracket")
     end
 
     # Get transactions for a specific week.
@@ -144,7 +148,7 @@ module SleeperApi
     # @return [Array<Hash>] Transaction data
     # @see https://docs.sleeper.com/#get-transactions
     def get_transactions(league_id, week)
-      make_request("/league/#{league_id}/transactions/#{week}")
+      make_request("/v1/league/#{league_id}/transactions/#{week}")
     end
 
     # Get league drafts.
@@ -153,7 +157,7 @@ module SleeperApi
     # @return [Array<Hash>] Draft data
     # @see https://docs.sleeper.com/#get-all-drafts-for-a-league
     def get_league_drafts(league_id)
-      make_request("/league/#{league_id}/drafts")
+      make_request("/v1/league/#{league_id}/drafts")
     end
 
     # Get traded draft picks for a league.
@@ -162,7 +166,7 @@ module SleeperApi
     # @return [Array<Hash>] Traded picks
     # @see https://docs.sleeper.com/#get-traded-picks-in-a-draft
     def get_league_traded_picks(league_id)
-      make_request("/league/#{league_id}/traded_picks")
+      make_request("/v1/league/#{league_id}/traded_picks")
     end
 
     # Fetch draft details.
@@ -171,7 +175,7 @@ module SleeperApi
     # @return [Hash] Draft metadata
     # @see https://docs.sleeper.com/#get-a-specific-draft
     def get_draft(draft_id)
-      make_request("/draft/#{draft_id}")
+      make_request("/v1/draft/#{draft_id}")
     end
 
     # Get draft picks.
@@ -180,7 +184,7 @@ module SleeperApi
     # @return [Array<Hash>] Pick data
     # @see https://docs.sleeper.com/#get-all-picks-in-a-draft
     def get_draft_picks(draft_id)
-      make_request("/draft/#{draft_id}/picks")
+      make_request("/v1/draft/#{draft_id}/picks")
     end
 
     # Get traded draft picks for a draft.
@@ -189,7 +193,7 @@ module SleeperApi
     # @return [Array<Hash>] Traded picks
     # @see https://docs.sleeper.com/#get-traded-picks-in-a-draft
     def get_draft_traded_picks(draft_id)
-      make_request("/draft/#{draft_id}/traded_picks")
+      make_request("/v1/draft/#{draft_id}/traded_picks")
     end
 
     # Get NFL state (week, season status).
@@ -198,13 +202,36 @@ module SleeperApi
     # @return [Hash] State data
     # @see https://docs.sleeper.com/#get-nfl-state
     def get_nfl_state(sport = "nfl")
-      nfl_state = make_request("/state/#{sport}")
+      nfl_state = make_request("/v1/state/#{sport}")
       nfl_state.each_with_object({}) do |(k, v), result|
         key = k.is_a?(String) ? k.to_sym : k
         result[key] = v
       end
     end
 
+    # Get a season's game schedule.
+    #
+    # Undocumented, and served from the host root rather than /v1 — hence the
+    # version living in the paths rather than in base_uri.
+    #
+    # Returns a flat array of games, each `{status, date, home, away, week,
+    # game_id}`. A team's bye week is the week it appears in no game; that
+    # derives exactly, but only within one season type — `pre` (weeks 1-3) and
+    # `post` (weeks 1-4) restart week numbering, so games from different season
+    # types must never be pooled.
+    #
+    # A season Sleeper has not scheduled yet answers 200 with an empty array
+    # rather than 404, so an empty result is a legitimate answer and not an
+    # error.
+    #
+    # @param season [Integer, String] Season year, e.g. 2026
+    # @param season_type [String] "regular" (default), "pre", or "post"
+    # @param sport [String] Sport code (default: "nfl")
+    # @return [HTTParty::Response] Array of games
+    def schedule(season, season_type: "regular", sport: "nfl")
+      make_request("/schedule/#{sport}/#{season_type}/#{season}")
+    end
+
     # Get trending players.
     #
     # @param sport [String] Sport code (default: "nfl")
@@ -214,7 +241,7 @@ module SleeperApi
     # @return [Array<Hash>] Trending players
     # @see https://docs.sleeper.com/#trending-players
     def trending_players(sport = "nfl", type: "add", lookback_hours: 24, limit: 25)
-      make_request("/players/#{sport}/trending/#{type}?lookback_hours=#{lookback_hours}&limit=#{limit}")
+      make_request("/v1/players/#{sport}/trending/#{type}?lookback_hours=#{lookback_hours}&limit=#{limit}")
     end
 
     # Get all player data (cached for 24 hours).
@@ -225,7 +252,7 @@ module SleeperApi
     def get_players(sport = "nfl")
       return @players_cache if @players_cache && @cache_timestamp && (Time.now - @cache_timestamp) < (3600 * 24)
 
-      response = make_request("/players/#{sport}")
+      response = make_request("/v1/players/#{sport}")
       @players_cache = response.parsed_response
       @cache_timestamp = Time.now
 

data/lib/sleeper_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SleeperApi
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sleeper_api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Eruity1