This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.
This package is abandoned and no longer maintained. The author suggests using the bit3/github-payload package instead.

Parse the github API payload from a webhook.

dev-develop / 1.1.x-dev 2014-11-11 11:53 UTC

This package is not auto-updated.

Last update: 2019-02-20 18:10:57 UTC


README

Version ![Stable Build Status](http://img.shields.io/travis/contao-community-alliance/github-payload/master.svg?style=flat-square&label=stable build) ![Upstream Build Status](http://img.shields.io/travis/contao-community-alliance/github-payload/develop.svg?style=flat-square&label=dev build) License Downloads

github webhook payload

This project contains a set of classes to validate, deserialize and serialize the github webhook payload. The parser use the jms/serializer internally, that means you can deserialize and serialize the payload as you like.

Requirements

Annotations are used to define the serialisation settings. Depending on your environment, you may need to register an annotation class loader. A very simple way is to register the class_exists function as loader, if you have a global autoloader available.

use Doctrine\Common\Annotations\AnnotationRegistry;
AnnotationRegistry::registerLoader('class_exists');

Usage examples

... in plain php

<?php
require 'vendor/autoload.php';

$parser = new ContaoCommunityAlliance\GithubPayload\GithubPayloadParser();

// if you have set a secret in the webhook, set it to the parser to validate the signature
$parser->setSecret('...');

$event  = $parser->parsePhp();

... in symfony / http-foundation

namespace MyBundle\Controller;

class MyController
{
    public function myAction(\Symfony\Component\HttpFoundation\Request $request)
    {
        $parser = new \ContaoCommunityAlliance\GithubPayload\GithubPayloadParser();

        // if you have set a secret in the webhook, set it to the parser to validate the signature
        $parser->setSecret('...');

        $event  = $parser->parseRequest($request);
    }
}

... in any other environment

$eventName = '...'; // The event name, usually the X-Github-Event header.
$payload   = '...'; // The github payload, usually the POST body.
$signature = '...'; // The payload signature, usually the X-Hub-Signature header.

$parser = new ContaoCommunityAlliance\GithubPayload\GithubPayloadParser();

// if you have set a secret in the webhook, set it to the parser to validate the signature
$parser->setSecret('...');

$event  = $parser->parse($eventName, $payload, $signature);