API's to Fetch and Integrate the updated Projects and the Contributors

[Uttkarsh-raj]

PR Desc :

This PR is regarding the Projects and Contributors section. We currently don't have the feature to show the updated contributors list until it is updated in the json file, so the api's will help in doing so. This pr :

• Provides a POST api to add a new project
  • the api also fetches the data like the logo and stores it locally for easy retrieval
  • Request :

     {
        "name": "BLT",
        "description": "OWASP BLT is a bug logging tool to report issues.",
        "github_url": "https://github.com/OWASP-BLT/BLT",
        "wiki_url": "",
        "homepage_url": "",
         "logo": null
    }
    

  • name , description and github_url are the required fields if the logo is not provided it fetches the owners logo
  • Response :

    {
           "id": 1,
           "name": "BLT",
           "slug": "blt",
           "description": "OWASP BLT is a bug logging tool to report issues",
           "github_url": "https://github.com/OWASP-BLT/BLT",
           "wiki_url": "",
           "homepage_url": "",
           "logo": "/media/project_logos/blt_YiVF2cg.png",
           "created": "2024-07-17T11:13:55.325994Z",
           "modified": "2024-07-18T08:06:55.216088Z",
           "contributors": [
           1622482,
           1622483
           ]
    }
    

  • the contributors are pulled from the GitHub repo using the github api and stored in the database.
  
  
• Provides a GET api to get the data of the contributors and the project
  • Request :

     curl http://localhost:8000/api/v1/projects/
    

  • Response :

    {
    "count": 1,
    "projects": [
       {
           "id": 17,
           "name": "BLT",
           "slug": "blt",
           "description": "OWASP BLT is a bug logging tool to report issues ",
           "github_url": "https://github.com/OWASP-BLT/BLT",
           "wiki_url": "",
           "homepage_url": "",
           "logo": "/media/project_logos/blt_YiVF2cg.png",
           "created": "2024-07-17T11:13:55.325994Z",
           "modified": "2024-07-18T08:06:55.216088Z",
           "contributors": [
               {
                   "id": 1622482,
                   "name": "A",
                   "github_id": 68425016,
                   "github_url": "https://github.com/A",
                   "avatar": "https://avatars.githubusercontent.com/u/asda344?v=24",
                   "contributor_type": "User",
                   "contributions": 10
               },
               {
                   "id": 1622483,
                   "name": "C",
                   "github_id": 16963976,
                   "github_url": "https://github.com/C",
                   "avatar": "https://avatars.githubusercontent.com/u/eq1231?v=4",
                   "contributor_type": "User",
                   "contributions": 1
               },
            ]
         }
    

• Provides a Patch api to update the contributors
  • the api fetches the data of the contributors from the github api's
  • Request :

    curl --request PATCH http://localhost:8000/api/v1/projects/
    

  • Response :

    {
           "id": 1,
           "name": "BLT",
           "slug": "blt",
           "description": "OWASP BLT is a bug logging tool to report issues",
           "github_url": "https://github.com/OWASP-BLT/BLT",
           "wiki_url": "",
           "homepage_url": "",
           "logo": "/media/project_logos/blt_YiVF2cg.png",
           "created": "2024-07-17T11:13:55.325994Z",
           "modified": "2024-07-18T08:06:55.216088Z",
           "contributors": [
           1622482,
           1622483,
           1534793,
           3482642,
           ]
    }
    

This pr addresses the following issues :

• fixes Create Api's to get the updated info of the projects and the contributors using the GitHub Api's #2460
• fixes Replicate the data to the database to prevent making calls to the GitHub Api frequently #2461

Demo :

Project.Django.REST.framework.-.Brave.2024-07-18.15-53-24.mp4

[Uttkarsh-raj]

@arkid15r , @AtmegaBuzz any changes/optimizations you would recommend?

[arkid15r]

Thanks for the PR, @Uttkarsh-raj !

@arkid15r , @AtmegaBuzz any changes/optimizations you would recommend?

Sure, here you can find something to start from if you'd like:

[arkid15r]

Thanks for updating the code, Uttkarsh!

[DonnieBLT]

Lgtm

[sentry-io]

Suspect Issues

This pull request was deployed and Sentry observed the following issues:

• ‼️ ProgrammingError: relation "website_contributor" does not exist /api/v1/projects/ View Issue

_{Did you find this useful? React with a 👍 or 👎}