fix: Tests fixed for proper renaming of methods.

Endpoint enum integration into all API calls

Author: coreyjs

.gitignore

@@ -24,4 +24,7 @@ archive.zip
 *~
 .*.sw?
 
-*/.DS_Store
+*/.DS_Store
+
+CLAUDE.md
+v3.md

README.md

@@ -51,6 +51,26 @@ client = NHLClient(verbose=True)
 # OR Other available configurations:
 client = NHLClient(verbose={bool}, timeout={int}, ssl_verify={bool}, follow_redirects={bool})
 ```
+
+## Endpoint Modules
+
+This project is organized into several sub modules, each representing a different endpoint of the NHL API.  
+They are group by function to make the library easier to navigate and use.  The main modules are:
+
+- `stats`: Contains endpoints related to player and team statistics. This will have your basic stats, summary stats and
+  more advanced stats using the new query builder.  Which allows for more complex queries to be built up programmatically.
+- `schedule`: Contains endpoints related to the NHL schedule, including game dates, weekly schedules, and team schedules.
+- `standings`: Contains endpoints related to NHL standings, including current standings and historical standings.
+- `teams`: Contains endpoints related to NHL teams, including team information and rosters.  You can find team_id(s) here along with franchise_id(s) needed for some of the stats queries.
+- `game_center`: Contains endpoints related to game center data, including box scores, play-by-play data, and game summaries.
+- `misc`: Contains miscellaneous endpoints that don't fit into the other categories, such as glossary terms, configuration data, and country information.
+
+
+- `helpers`: Contains helper functions and utilities for working with the NHL API, such as getting game IDs by season or calculating player statistics.
+These are experimental and often times make many requests, can return DFs or do calculations. Stuff I find myself doing over and over I tend to move into helpers for convenience.  They are often
+cross domain, involve many sub requests, may integrate more machine learning techniques, or just make it easier to get the data you want.  These will have built in sleeping to avoid hitting the API too hard, but you can override this by setting the `sleep` parameter to `False` in the function call.
+
+
 ---
 ## Stats with QueryBuilder
 

nhlpy/api/game_center.py

@@ -1,5 +1,5 @@
 from typing import Optional, List
-from nhlpy.http_client import HttpClient
+from nhlpy.http_client import HttpClient, Endpoint
 
 
 class GameCenter:
@@ -18,7 +18,7 @@ def boxscore(self, game_id: str) -> dict:
         Returns:
            dict: Game boxscore data
         """
-        return self.client.get(resource=f"gamecenter/{game_id}/boxscore").json()
+        return self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"gamecenter/{game_id}/boxscore").json()
 
     def play_by_play(self, game_id: str) -> dict:
         """Get play-by-play data for a specific NHL game. GameIds can be retrieved from the schedule endpoint.
@@ -29,7 +29,7 @@ def play_by_play(self, game_id: str) -> dict:
         Returns:
            dict: Play-by-play game data
         """
-        return self.client.get(resource=f"gamecenter/{game_id}/play-by-play").json()
+        return self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"gamecenter/{game_id}/play-by-play").json()
 
     def landing(self, game_id: str) -> dict:
         """Get detailed match up information for a specific NHL game. GameIds can be retrieved
@@ -41,19 +41,19 @@ def landing(self, game_id: str) -> dict:
         Returns:
            dict: Detailed game matchup data
         """
-        return self.client.get(resource=f"gamecenter/{game_id}/landing").json()
+        return self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"gamecenter/{game_id}/landing").json()
 
     def daily_scores(self, date: Optional[str] = None) -> dict:
         """Get scores for NHL games on a specific date or current day.
 
         Args:
-           date (str, optional): Date to check scores in YYYY-MM-DD format. 
+           date (str, optional): Date to check scores in YYYY-MM-DD format.
                                 If not provided, returns current day's scores.
 
         Returns:
            dict: Game scores and status information
         """
-        return self.client.get(resource=f"score/{date if date else 'now'}").json()
+        return self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"score/{date if date else 'now'}").json()
 
     def shift_chart_data(self, game_id: str, excludes: List[str] = None) -> dict:
         """Gets shift chart data for a specific game.
@@ -66,13 +66,14 @@ def shift_chart_data(self, game_id: str, excludes: List[str] = None) -> dict:
         Returns:
            Dict containing the shift chart data.
         """
-        if not excludes:
+        if excludes is None:
             excludes = ["eventDetails"]
 
-        base_url: str = "https://api.nhle.com/stats/rest/en/shiftcharts"
         exclude_p: str = ",".join(excludes)
         expr_p: str = f"gameId={game_id} and ((duration != '00:00' and typeCode = 517) or typeCode != 517 )"
-        return self.client.get_by_url(full_resource=f"{base_url}?cayenneExp={expr_p}&exclude={exclude_p}").json()
+        return self.client.get(
+            endpoint=Endpoint.API_STATS, resource=f"en/shiftcharts?cayenneExp={expr_p}&exclude={exclude_p}"
+        ).json()
 
     def right_rail(self, game_id: str) -> dict:
         """Gets game stats and season series information for a specific game.
@@ -84,7 +85,7 @@ def right_rail(self, game_id: str) -> dict:
         Returns:
            Dict containing game stats and season series data.
         """
-        return self.client.get(resource=f"gamecenter/{game_id}/right-rail").json()
+        return self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"gamecenter/{game_id}/right-rail").json()
 
     def game_story(self, game_id: str) -> dict:
         """Gets game story information for a specific game.
@@ -96,4 +97,4 @@ def game_story(self, game_id: str) -> dict:
         Returns:
            Dict containing game story data.
         """
-        return self.client.get(resource=f"wsc/game-story/{game_id}").json()
+        return self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"wsc/game-story/{game_id}").json()

nhlpy/api/players.py

@@ -1,4 +1,3 @@
-import json
 from typing import Dict, Any
 
 from nhlpy.http_client import Endpoint, HttpClient
@@ -33,4 +32,4 @@ def players_by_team(self, team_abbr: str, season: str) -> Dict[str, Any]:
         Returns:
             Dict[str, Any]: Dictionary containing roster information for the specified team and season.
         """
-        return self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"roster/{team_abbr}/{season}").json()
+        return self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"roster/{team_abbr}/{season}").json()

nhlpy/api/schedule.py

@@ -1,7 +1,7 @@
 from datetime import datetime
 from typing import Optional, List
 
-from nhlpy.http_client import HttpClient
+from nhlpy.http_client import HttpClient, Endpoint
 
 
 class Schedule:
@@ -23,7 +23,7 @@ def daily_schedule(self, date: str = None) -> dict:
         except ValueError:
             raise ValueError("Invalid date format. Please use YYYY-MM-DD.")
 
-        schedule_data: dict = self.client.get(resource=f"schedule/{date}").json()
+        schedule_data: dict = self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"schedule/{date}").json()
         response_payload = {
             "nextStartDate": schedule_data.get("nextStartDate", None),
             "previousStartDate": schedule_data.get("previousStartDate", None),
@@ -53,7 +53,7 @@ def weekly_schedule(self, date: Optional[str] = None) -> dict:
         """
         res = date if date else "now"
 
-        return self.client.get(resource=f"schedule/{res}").json()
+        return self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"schedule/{res}").json()
 
     def team_monthly_schedule(self, team_abbr: str, month: Optional[str] = None) -> List[dict]:
         """Gets monthly schedule for specified team or the given month.  If no month is supplied it will default to now.
@@ -66,7 +66,7 @@ def team_monthly_schedule(self, team_abbr: str, month: Optional[str] = None) ->
             List[dict]: List of games in the monthly schedule.
         """
         resource = f"club-schedule/{team_abbr}/month/{month if month else 'now'}"
-        response = self.client.get(resource=resource).json()
+        response = self.client.get(endpoint=Endpoint.API_WEB_V1, resource=resource).json()
         return response.get("games", [])
 
     def team_weekly_schedule(self, team_abbr: str, date: Optional[str] = None) -> List[dict]:
@@ -81,7 +81,7 @@ def team_weekly_schedule(self, team_abbr: str, date: Optional[str] = None) -> Li
             List[dict]: List of games in the weekly schedule.
         """
         resource = f"club-schedule/{team_abbr}/week/{date if date else 'now'}"
-        response = self.client.get(resource=resource).json()
+        response = self.client.get(endpoint=Endpoint.API_WEB_V1, resource=resource).json()
         return response.get("games", [])
 
     def team_season_schedule(self, team_abbr: str, season: str) -> dict:
@@ -94,7 +94,7 @@ def team_season_schedule(self, team_abbr: str, season: str) -> dict:
         Returns:
             dict: Complete season schedule data including metadata.
         """
-        request = self.client.get(resource=f"club-schedule-season/{team_abbr}/{season}")
+        request = self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"club-schedule-season/{team_abbr}/{season}")
 
         return request.json()
 
@@ -111,8 +111,7 @@ def calendar_schedule(self, date: str) -> dict:
            Example:
                API endpoint: https://api-web.nhle.com/v1/schedule-calendar/2023-11-08
         """
-        return self.client.get(resource=f"schedule-calendar/{date}").json()
-    
+        return self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"schedule-calendar/{date}").json()
 
     def playoff_carousel(self, season: str) -> dict:
         """Gets list of all series games up to current playoff round.
@@ -126,8 +125,8 @@ def playoff_carousel(self, season: str) -> dict:
         Example:
            API endpoint: https://api-web.nhle.com/v1/playoff-series/carousel/20232024/
         """
-        return self.client.get(resource=f"playoff-series/carousel/{season}").json()
-    
+        return self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"playoff-series/carousel/{season}").json()
+
     def playoff_series_schedule(self, season: str, series: str) -> dict:
         """Returns the schedule for a specified playoff series.
 
@@ -142,7 +141,9 @@ def playoff_series_schedule(self, season: str, series: str) -> dict:
            API endpoint: https://api-web.nhle.com/v1/schedule/playoff-series/20232024/a/
         """
 
-        return self.client.get(resource=f"schedule/playoff-series/{season}/{series}").json()
+        return self.client.get(
+            endpoint=Endpoint.API_WEB_V1, resource=f"schedule/playoff-series/{season}/{series}"
+        ).json()
 
     def playoff_bracket(self, year: str) -> dict:
         """Returns the playoff bracket.
@@ -157,4 +158,4 @@ def playoff_bracket(self, year: str) -> dict:
            API endpoint: https://api-web.nhle.com/v1/playoff-bracket/2024
         """
 
-        return self.client.get(resource=f"playoff-bracket/{year}").json()
+        return self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"playoff-bracket/{year}").json()

nhlpy/api/standings.py

@@ -1,11 +1,13 @@
 from typing import List, Optional
 
+from nhlpy.http_client import Endpoint
+
 
 class Standings:
     def __init__(self, http_client):
         self.client = http_client
 
-    def get_standings(self, date: Optional[str] = None, season: Optional[str] = None) -> dict:
+    def league_standings(self, date: Optional[str] = None, season: Optional[str] = None) -> dict:
         """Gets league standings for a specified season or date.
 
         Retrieves NHL standings either for a specific date or for the end of a season.
@@ -32,7 +34,7 @@ def get_standings(self, date: Optional[str] = None, season: Optional[str] = None
 
         res = date if date else "now"
 
-        return self.client.get(resource=f"standings/{res}").json()
+        return self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"standings/{res}").json()
 
     def season_standing_manifest(self) -> List[dict]:
         """Gets metadata for all NHL seasons.
@@ -59,5 +61,5 @@ def season_standing_manifest(self) -> List[dict]:
                "wildcardInUse": true
            }]
         """
-        response = self.client.get(resource="standings-season").json()
+        response = self.client.get(endpoint=Endpoint.API_WEB_V1, resource="standings-season").json()
         return response.get("seasons", [])

nhlpy/api/stats.py

@@ -4,7 +4,7 @@
 from nhlpy.api.query.builder import QueryContext
 from nhlpy.api.query.filters import _goalie_stats_sorts
 from nhlpy.api.query.sorting.sorting_options import SortingOptions
-from nhlpy.http_client import HttpClient
+from nhlpy.http_client import HttpClient, Endpoint
 
 
 class Stats:
@@ -34,7 +34,7 @@ def gametypes_per_season_directory_by_team(self, team_abbr: str) -> dict:
              ]
 
         """
-        return self.client.get(resource=f"club-stats-season/{team_abbr}").json()
+        return self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"club-stats-season/{team_abbr}").json()
 
     def player_career_stats(self, player_id: str) -> dict:
         """Gets a player's career statistics and biographical information.
@@ -68,7 +68,7 @@ def player_career_stats(self, player_id: str) -> dict:
              'sweaterNumber': 97,
              'position': 'C',
         """
-        return self.client.get(resource=f"player/{player_id}/landing").json()
+        return self.client.get(endpoint=Endpoint.API_WEB_V1, resource=f"player/{player_id}/landing").json()
 
     def player_game_log(self, player_id: str, season_id: str, game_type: int) -> List[dict]:
         """Gets a player's game log for a specific season and game type.
@@ -113,7 +113,9 @@ def player_game_log(self, player_id: str, season_id: str, game_type: int) -> Lis
               ...
               ]
         """
-        data = self.client.get(resource=f"player/{player_id}/game-log/{season_id}/{game_type}").json()
+        data = self.client.get(
+            endpoint=Endpoint.API_WEB_V1, resource=f"player/{player_id}/game-log/{season_id}/{game_type}"
+        ).json()
         return data.get("gameLog", [])
 
     def team_summary(
@@ -211,7 +213,7 @@ def team_summary(
             default_cayenne_exp = f"gameTypeId={game_type_id} and seasonId<={end_season} and seasonId>={start_season}"
         q_params["cayenneExp"] = default_cayenne_exp
 
-        return self.client.get_by_url("https://api.nhle.com/stats/rest/en/team/summary", query_params=q_params).json()[
+        return self.client.get(endpoint=Endpoint.API_STATS, resource="en/team/summary", query_params=q_params).json()[
             "data"
         ]
 
@@ -314,7 +316,7 @@ def skater_stats_summary_simple(
                 default_cayenne_exp = f"franchiseId={franchise_id} and {default_cayenne_exp}"
         q_params["cayenneExp"] = default_cayenne_exp
 
-        return self.client.get_by_url("https://api.nhle.com/stats/rest/en/skater/summary", query_params=q_params).json()[
+        return self.client.get(endpoint=Endpoint.API_STATS, resource="en/skater/summary", query_params=q_params).json()[
             "data"
         ]
 
@@ -413,8 +415,8 @@ def skater_stats_with_query_context(
 
         q_params["sort"] = json.dumps(sort_expr)
         q_params["cayenneExp"] = query_context.query_str
-        return self.client.get_by_url(
-            f"https://api.nhle.com/stats/rest/en/skater/{report_type}", query_params=q_params
+        return self.client.get(
+            endpoint=Endpoint.API_STATS, resource=f"en/skater/{report_type}", query_params=q_params
         ).json()
 
     def goalie_stats_summary_simple(
@@ -510,7 +512,7 @@ def goalie_stats_summary_simple(
 
         q_params["cayenneExp"] = default_cayenne_exp
 
-        response = self.client.get_by_url(
-            f"https://api.nhle.com/stats/rest/en/goalie/{stats_type}", query_params=q_params
+        response = self.client.get(
+            endpoint=Endpoint.API_STATS, resource=f"en/goalie/{stats_type}", query_params=q_params
         ).json()
         return response.get("data", [])