api.py

"""
GitHub API interaction module.

This module provides functions for making requests to the GitHub API
and handling responses.
"""

import json
import requests
from printcolors import printcolors


def fetch_repo_endpoint(term, repo_url, headers):
    """
    Fetch a GitHub repository endpoint, print it, and return the data.

    Parameters
    ----------
    term : str
        The endpoint to fetch (e.g., "contributors", "languages").
    repo_url : str
        The repository in "owner/repo" format.
    headers : dict
        HTTP headers including authentication for GitHub API.

    Returns
    -------
    success : bool
        True if the request succeeded (status code 200), False otherwise.
    data : dict | None
        Parsed JSON response if successful, None otherwise.
    """
    term = term.strip("/")
    print(printcolors.BOLD + f"Fetching repository {term}" + printcolors.ENDC)

    r = requests.get(f'https://api.github.com/repos/{repo_url}/{term}', headers=headers)

    if r.status_code == 200:
        parsed = r.json()
        print(json.dumps(parsed, indent=4))
        return True, parsed
    else:
        print(printcolors.FAIL + f"ERR: Request failed with status code {r.status_code}" + printcolors.ENDC)
        return False, None

def fetch_profile_endpoint(term, accountid, headers):
    print(printcolors.BOLD + f"Fetching user {accountid}" + printcolors.ENDC)

    r = requests.get(f'https://api.github.com/users/{accountid}/{term}', headers=headers)
    if r.status_code == 200:
        parsed = r.json()
        print(json.dumps(parsed, indent=4))
        return True, parsed
    else:
        print(printcolors.FAIL + f"ERR: Request failed with status code {r.status_code}" + printcolors.ENDC)
        return False, None
    
def fetch_user_profile(user_id, term, headers):
    """
    Fetches a specific public attribute of a GitHub user and prints it.

    Args:
        user_id (str): The GitHub username of the target user.
        term (str): The specific user attribute to retrieve (e.g., 'location', 'bio').
        headers (dict): HTTP headers to include in the GET request (e.g., authentication token).

    Returns:
        tuple:
            - bool: False if the request failed, True otherwise.
            - str or None: The value of the requested attribute if found, None if not found or request failed.

    Behavior:
        - Sends a GET request to the GitHub Users API for the given `user_id`.
        - Prints the value of `term` if it exists in the user's public data.
        - Prints a warning if the attribute is not available.
        - Prints an error if the request fails.
    """
    r = requests.get(f"https://api.github.com/users/{user_id}", headers=headers)
    if r.status_code != 200:
        print(printcolors.FAIL + f"ERR: Request failed with status code {r.status_code}" + printcolors.ENDC)
        return False, None
    
    term_value = r.json().get(term)
    if term_value:
        print(printcolors.BOLD + f"{term}: " + printcolors.ENDC + term_value)
    else:
        print(printcolors.WARNING + f"No public {term} found for this user." + printcolors.ENDC)
    return True, term_value