Merge pull request #57 from ArielMAJ/feat/#52

[UPT/ADD][#52] Checks if gh api key was provided in the environment a…

Author: ArielMAJ

api/.env-sample

@@ -4,3 +4,5 @@ APPLICATION_HOST=127.0.0.1
 APPLICATION_PORT=3000
 
 APPLICATION_ROOT=
+
+GITHUB_TOKEN=

api/src/config.py

@@ -17,6 +17,7 @@ class Config:
     PORT = int(os.getenv("APPLICATION_PORT", "3000"))
 
     APPLICATION_ROOT = os.getenv("APPLICATION_ROOT", "")
+    GITHUB_TOKEN = os.getenv("GITHUB_TOKEN", "")
 
 
 class TestConfig(Config):

api/src/constants.py

@@ -11,7 +11,8 @@
 from fastapi_cache.decorator import cache
 from loguru import logger
 from src.config import get_settings
-from src.constants import GH_REPOSITORIES, USER_DATA
+from src.constants import GITHUB_API_HEADERS
+from src.mocks import GH_REPOSITORIES, USER_DATA
 
 app = FastAPI()
 app.add_middleware(
@@ -24,7 +25,7 @@
 FastAPICache.init(InMemoryBackend())
 
 
-@app.get("/{username}")
+@app.get("/users/{username}")
 @cache(expire=60 * 60 * 24)
 async def user_data(username: str):
     if get_settings().ENVIRONMENT == "DEV":
@@ -33,10 +34,7 @@ async def user_data(username: str):
         return USER_DATA
     return requests.get(
         f"https://api.github.com/users/{username}",
-        headers={
-            "Accept": "application/vnd.github+json",
-            "X-GitHub-Api-Version": "2022-11-28",
-        },
+        headers=GITHUB_API_HEADERS,
     ).json()
 
 
@@ -93,10 +91,7 @@ def parse_data(data):
         response = requests.get(
             url,
             params={"per_page": 25},
-            headers={
-                "Accept": "application/vnd.github+json",
-                "X-GitHub-Api-Version": "2022-11-28",
-            },
+            headers=GITHUB_API_HEADERS,
         )
         logger.debug(f"GitHub response: {response}")
         # response.raise_for_status()
@@ -112,6 +107,14 @@ def parse_data(data):
     return data
 
 
+@app.get("/rate_limit")
+async def rate_limit():
+    return requests.get(
+        "https://api.github.com/rate_limit",
+        headers=GITHUB_API_HEADERS,
+    ).json()
+
+
 if __name__ == "__main__":
     uvicorn.run(
         "src.main:app", host=get_settings().HOST, port=get_settings().PORT, reload=True