Source code for swh.web.save_origin_webhooks.github

# Copyright (C) 2022  The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution
# License: GNU Affero General Public License version 3, or any later version
# See top-level LICENSE file for more information

from typing import Tuple

from rest_framework.request import Request

from swh.web.save_origin_webhooks.generic_receiver import OriginSaveWebhookReceiver


[docs] class GitHubOriginSaveWebhookReceiver(OriginSaveWebhookReceiver): FORGE_TYPE = "GitHub" WEBHOOK_GUIDE_URL = ( "https://docs.github.com/en/developers/webhooks-and-events/" "webhooks/creating-webhooks#setting-up-a-webhook" ) REPO_TYPES = "git"
[docs] def is_forge_request(self, request: Request) -> bool: return ( request.headers.get("User-Agent", "").startswith( f"{self.FORGE_TYPE}-Hookshot/" ) and f"X-{self.FORGE_TYPE}-Event" in request.headers )
[docs] def is_ping_event(self, request: Request) -> bool: return request.headers[f"X-{self.FORGE_TYPE}-Event"] == "ping"
[docs] def is_push_event(self, request: Request) -> bool: return request.headers[f"X-{self.FORGE_TYPE}-Event"] == "push"
[docs] def extract_repo_info(self, request: Request) -> Tuple[str, str, bool]: repo_url = request.data.get("repository", {}).get("html_url", "") private = request.data.get("repository", {}).get("private", False) return repo_url, "git", private
api_origin_save_webhook_github = GitHubOriginSaveWebhookReceiver()