Merge pull request #200 from GeekMasher/octokit-errors

feat(octo): Improve error handling in Octokit

Author: GeekMasher

src/ghastoolkit/octokit/octokit.py

@@ -2,7 +2,7 @@
 import inspect
 import logging
 from string import Template
-from typing import Any, Optional, Union
+from typing import Any, Callable, Optional, Union
 from dataclasses import field, is_dataclass
 
 from requests import Session
@@ -178,6 +178,7 @@ def get(
         expected: Optional[int] = 200,
         authenticated: bool = False,
         display_errors: bool = True,
+        error_handler: Optional[Callable[[int, dict], Any]] = None,
     ) -> Union[dict, list[dict]]:
         """Get Request.
 
@@ -208,6 +209,7 @@ def get(
             params["page"] = page
 
             response = self.session.get(url, params=params)
+            # Every response should be a JSON (including errors)
             response_json = response.json()
 
             if expected and response.status_code != expected:
@@ -218,11 +220,16 @@ def get(
                 known_error = __OCTOKIT_ERRORS__.get(response.status_code)
                 if known_error:
                     raise Exception(known_error)
-                raise Exception("REST Request failed :: non-expected server error")
 
+            # Handle errors in the response
             if isinstance(response_json, dict) and response_json.get("errors"):
+                # Custom error handler callback
+                if error_handler:
+                    return error_handler(response.status_code, response_json)
+
+                # Default error handling
                 logger.error(response_json.get("message"))
-                raise Exception("REST Request failed :: error from server")
+                raise Exception("REST Request failed :: non-expected server error")
 
             if isinstance(response_json, dict):
                 return response_json