GitHubUserDataExtractor/src/core/utils.py at 5f87b015ff25a6c7260ebcbd40d4a8bc20b91f59 · QuantumByteStudios/GitHubUserDataExtractor · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
"""Shared helpers for fetching GitHub data and rendering the HTML report."""
import base64
import os
import platform
import requests
from colorama import Fore, Style
from requests.exceptions import HTTPError, RequestException


class colors:  # pylint: disable=invalid-name,too-few-public-methods  # noqa: D203,D211
    """ANSI color constants used for terminal output."""

    HEADER = Fore.MAGENTA
    BLUE = Fore.BLUE
    CYAN = Fore.CYAN
    GREEN = Fore.GREEN
    WARNING = Fore.YELLOW
    FAIL = Fore.RED
    RED = Fore.RED
    ENDC = Style.RESET_ALL
    BOLD = Style.BRIGHT


def clear():
    """Clear the terminal screen without spawning a shell."""
    if platform.system() == "Windows":
        print("\033[2J\033[H", end="")
    else:
        print("\033c", end="")


def get_auth_headers():
    """Return the Authorization header dict if a GitHub token is set."""
    token = os.environ.get("GITHUB_TOKEN", "").strip()
    if token:
        return {"Authorization": f"Bearer {token}"}
    return {}


def fetch_as_data_uri(url):  # noqa: D212,D213
    """Fetch a remote image and return it as a base64 data URI.

    Embeds the image directly in the HTML file (needed when the page is served
    via file:// and WebKit would otherwise block external requests).
    """
    try:
        resp = requests.get(url, timeout=15)
        resp.raise_for_status()
        content_type = resp.headers.get("Content-Type", "image/svg+xml").split(";")[0].strip()
        encoded = base64.b64encode(resp.content).decode("ascii")
        return f"data:{content_type};base64,{encoded}"
    except (RequestException, ValueError, TypeError):
        return url  # fall back to original URL on any failure


def fetch_and_print_data(username):
    """Fetch the GitHub user profile and print each field to the terminal."""
    print(f"Fetching data for user: {colors.FAIL}{username}{colors.ENDC}")
    url = f"https://api.github.com/users/{username}"
    try:
        response = requests.get(url, headers=get_auth_headers(), timeout=10)
        response.raise_for_status()
        data = response.json()
        print(f"\n{colors.WARNING}User Data:{colors.ENDC}")
        for key, value in data.items():
            key = key.replace("_", " ").capitalize()
            print(f"{colors.CYAN}{key}:{colors.ENDC} {value}")

    except HTTPError as http_err:
        print(f"{colors.FAIL}HTTP error occurred: {http_err}{colors.ENDC}")
    except (RequestException, ValueError) as err:
        print(f"{colors.FAIL}Unexpected error: {err}{colors.ENDC}")


def show_events_and_graphs():
    """Print a confirmation that graphs are available in the report."""
    print(
        f"\nGraphs available in Received Events [{colors.GREEN}✓{colors.ENDC}]"
    )


def generate_html_event_row(  # pylint: disable=too-many-arguments,too-many-positional-arguments
    avatar, login, repo_name, repo_url, badge_class, action_text):
    """Return the HTML markup for a single received-event row."""
    return f"""
    <div class="event-row d-flex align-items-center shadow-sm">
        <img src="{avatar}" class="profile-picture me-3" alt="Avatar of {login}">
        <div>
            <a href="https://github.com/{login}" class="text-light fw-semibold">{login}</a>
            <p class="mb-1 {badge_class} small">{action_text}</p>
            <a class="repo-link" target="_blank" href="{repo_url}">{repo_name}</a>
        </div>
    </div>"""


HTML_REPORT_TEMPLATE = """<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>GitHubUserDataExtractor - Dashboard</title>
    <link rel="icon" href="https://quantumbytestudios.in/src/images/ClassicWhiteVeryBig.png" type="image/x-icon">
    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css" rel="stylesheet">
    <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;600;700&display=swap" rel="stylesheet">
    <style>
        body {{
            background: linear-gradient(to bottom right, #0d1117, #1f2937);
            font-family: 'Inter', sans-serif;
            color: #e5e7eb;
            margin: 0;
            padding: 0;
        }}

        h1,
        h4 {{
            font-weight: 700;
        }}

        .event-row {{
            background: rgba(255, 255, 255, 0.05);
            border-radius: 12px;
            padding: 1.2rem;
            margin-bottom: 1.2rem;
            backdrop-filter: blur(8px);
            transition: transform 0.2s ease;
        }}

        .event-row:hover {{
            transform: scale(1.02);
        }}

        .profile-picture {{
            border-radius: 50%;
            width: 128px;
            height: 128px;
            object-fit: cover;
        }}

        .repo-link {{
            color: #58a6ff;
            font-weight: 500;
        }}

        .repo-link:hover {{
            text-decoration: underline;
        }}

        .text-warning {{
            color: #facc15 !important;
        }}

        .text-success {{
            color: #34d399 !important;
        }}

        .dashboard-header {{
            text-align: center;
            margin-bottom: 3rem;
        }}

        .dashboard-header h1 {{
            font-size: 2.5rem;
            margin-bottom: 0.5rem;
        }}

        .dashboard-header p {{
            color: #9ca3af;
        }}

        .graph-container img {{
            border-radius: 10px;
            margin-top: 1rem;
            box-shadow: 0 4px 20px rgba(0, 0, 0, 0.3);
        }}

        .container {{
            max-width: 900px;
        }}

        a {{
            text-decoration: none;
        }}

        hr {{
            border-color: #374151;
        }}
    </style>
</head>
<body class="container py-5">
    <div class="dashboard-header">
        <h1>GitHub Activity Dashboard</h1>
        <p class="lead">Visual summary of recent contributions</p>
        <hr>
    </div>
    <div class="row">
    <div class="col-sm-12 col-md-12 col-lg-12">
        <h4 class="mb-4">User Profile</h4>
        <div class="row d-flex justify-content-center align-items-left my-5">
            <div class="col-2">
                <img src="{avatar_url}" class="profile-picture mb-3" alt="Avatar of {login}">
            </div>
            <div class="col-10">
                <h2 class="fw-bold">{name}</h2>
                <p class="text-white">
                    Username: {login} <br>
                    About: {bio} <br>
                    Followers: {followers}, Following: {following} <br>
                    Location: {location}
                </p>
                <a href="{html_url}" class="btn btn-light" target="_blank">View Profile</a>
            </div>
        </div>
    </div>
    <div class="col-sm-12 col-md-8 col-lg-8">
    <h4 class="mb-4">Received Events</h4>
{events_html}
</div>
    <div class="col-sm-12 col-md-4 col-lg-4">
        <h4 class="mb-4">Contribution Insights</h4>
        <div class="row justify-content-center align-items-left graph-container">
            <div class="col-12">
                <img class="img-fluid w-100" src="{langs_src}" alt="Top Languages">
                <img class="img-fluid w-100" src="{stats_src}" alt="GitHub Stats">
                <img class="img-fluid w-100" src="{streak_src}" alt="Streak Stats">
            </div>
        </div>
    </div>
    </div>
</body>
</html>
"""


EVENT_ACTIONS = {
    "WatchEvent": ("text-warning", "Watch/Starred a repository", None),
    "CreateEvent": ("text-success", "Created a repository", None),
    "PublicEvent": ("text-primary", "Published a repository", None),
    "ForkEvent": ("text-danger", "Forked a repository", "forkee"),
    "ReleaseEvent": ("text-primary", "Released a repository", "release"),
}


def _resolve_event_action(event_type, payload, repo_url):
    """Return badge/action text and final URL for a GitHub event."""
    action = EVENT_ACTIONS.get(event_type)
    if not action:
        return "", "", repo_url

    badge_class, action_text, payload_key = action
    if payload_key:
        repo_url = payload.get(payload_key, {}).get("html_url", "#")

    return badge_class, action_text, repo_url


def _build_events_html(events):
    """Return HTML rows for supported received event types."""
    rows = []
    for event in events:
        event_type = event.get("type")
        actor = event.get("actor", {})
        payload = event.get("payload", {})
        repo = event.get("repo", {})
        login = actor.get("login", "")
        avatar = actor.get("avatar_url", "")
        repo_name = repo.get("name", "")
        repo_url = f"https://github.com/{repo_name}"
        badge_class, action_text, repo_url = _resolve_event_action(event_type, payload, repo_url)
        if not action_text:
            continue
        rows.append(generate_html_event_row(
            avatar,
            login,
            repo_name,
            repo_url,
            badge_class,
            action_text,
        ))
    return "".join(rows)


def _build_report_html(user_data, events_html, urls):
    """Render the final HTML report document as a single string."""
    return HTML_REPORT_TEMPLATE.format(
        login=user_data.get("login", ""),
        name=user_data.get("name", ""),
        location=user_data.get("location", ""),
        html_url=user_data.get("html_url", ""),
        avatar_url=user_data.get("avatar_url", ""),
        bio=user_data.get("bio", ""),
        followers=user_data.get("followers", 0),
        following=user_data.get("following", 0),
        events_html=events_html,
        langs_src=fetch_as_data_uri(urls["mostUsedLanguages"]),
        stats_src=fetch_as_data_uri(urls["githubStats"]),
        streak_src=fetch_as_data_uri(urls["streakContributionsLS"]),
    )


def _fetch_json(url):
    """Fetch JSON from a URL and return parsed data, or None on failure."""
    try:
        response = requests.get(url, headers=get_auth_headers(), timeout=10)
        response.raise_for_status()
        return response.json()
    except HTTPError as http_err:
        print(f"{colors.FAIL}HTTP error occurred: {http_err}{colors.ENDC}")
    except (RequestException, ValueError) as err:
        print(f"{colors.FAIL}Unexpected error: {err}{colors.ENDC}")
    return None


def _prepare_output_path(html_path):
    """Create output directory and remove any existing report file."""
    os.makedirs(os.path.dirname(html_path), exist_ok=True)
    if os.path.exists(html_path):
        os.remove(html_path)


def _write_report_file(html_path, report_html):
    """Write report HTML to disk, returning True on success."""
    try:
        with open(html_path, "w", encoding="utf_8") as file_obj:
            file_obj.write(report_html)
        return True
    except OSError as err:
        print(f"{colors.FAIL}Unexpected error: {err}{colors.ENDC}")
    return False


def create_and_display_html_user_events(username, urls):
    """Build the user's HTML report from profile data and received events."""
    user_url = f"https://api.github.com/users/{username}"
    events_url = f"{user_url}/received_events"
    html_path = ".temp/index.html"

    print(f"Generating HTML report... [{colors.GREEN}✓{colors.ENDC}]\n")

    user_data = _fetch_json(user_url)
    if user_data is None:
        return

    events = _fetch_json(events_url)
    if events is None:
        return

    _prepare_output_path(html_path)

    events_html = _build_events_html(events)
    report_html = _build_report_html(user_data, events_html, urls)
    _write_report_file(html_path, report_html)