Service: Analyze Github User

[leeduckgo]

ENDPOINT:

https://bewater-github-analyzer.deno.dev/analyze_user?username=leeduckgo

/analyze_user Endpoint Documentation

Overview

This endpoint analyzes a GitHub user's profile and returns detailed information about their activity, repositories, and social presence.

Request

• Method: GET
• URL: /analyze_user?username={github_username}
• Required Query Parameters:
  • username: GitHub username to analyze

Authentication

• Requires a GitHub API token set in environment variable GITHUB_TOKEN
• Uses token authentication for all GitHub API requests

Response

Success Response (200 OK)

{
  "analysis": {
    "followersBiggerThanOne": boolean,
    "hasGithubPages": boolean,
    "sourcePublicRepos": boolean,
    "hasSocialAccounts": boolean,
    "hasPublicEmail": boolean,
    "lastCommitInLastMonth": boolean
  },
  "raw_data": {
    "username": string,
    "name": string,
    "bio": string,
    "publicRepos": number,
    "followers": number,
    "following": number,
    "createdAt": string,
    "socialAccounts": Array,
    "userEmail": string,
    "lastCommitTime": string | null,
    "topLanguages": string[],
    "topTenRepos": [
      {
        "name": string,
        "stars": number,
        "about": string,
        "topics": string[],
        "contributorsCount": number
      }
    ]
  }
}

Error Responses

• 400 Bad Request

  • When username parameter is missing

  { "error": "Username parameter is required" }

• 500 Internal Server Error

  • When GitHub token is missing

  { "error": "GitHub API key not found" }

  • When GitHub API requests fail

  { "error": "Failed to analyze user" }

API Calls Made

1. User profile data (/users/{username})
2. Social accounts (/users/{username}/social_accounts)
3. User events (/users/{username}/events)
4. Repository search (/search/repositories)
5. Contributors for each top repository

Rate Limiting

• Authenticated requests count towards the GitHub API rate limit:
  • Personal access token: 5,000 requests/hour
  • GitHub App (Enterprise Cloud org): 15,000 requests/hour
  • OAuth app (Enterprise Cloud org): 15,000 requests/hour

Analysis Criteria

• followersBiggerThanOne: User has at least 1 follower
• hasGithubPages: (TODO: Implementation pending)
• sourcePublicRepos: User has at least 3 source (non-fork) repositories
• hasSocialAccounts: User has linked social accounts
• hasPublicEmail: User has a public email address
• lastCommitInLastMonth: User has made a commit within the last 30 days