swop/github-webhook

Library which deals with incoming GitHub web hooks requests (signature validation & payload parsing)

Github WebHook

, _(*1)

This library offers a set of tools which could become handy when dealing with GitHub web hook requests., _(*2)

Installation

The recommended way to install this library is through Composer:, _(*3)

composer require "swop/github-webhook"

Usage

Payload signature checking

The SignatureValidator will verify if the incoming GitHub web hook request is correctly signed., _(*4)

```php use Swop\GitHubWebHook\Security\SignatureValidator;, <sub>(*5)</sub>

$validator = new SignatureValidator();, <sub>(*6)</sub>

/** @var \Psr\Http\Message\ServerRequestInterface $request */ if ($validator->validate($request, 'secret')) { // Request is correctly signed }, <sub>(*7)</sub>

### GitHub event object creation
The `GitHubEventFactory` can build GitHubEvent objects representing the GitHub event.

```php
use Swop\GitHubWebHook\Event\GitHubEventFactory;

$factory = new GitHubEventFactory();

/** @var \Psr\Http\Message\ServerRequestInterface $request */
$gitHubEvent = $factory->buildFromRequest(RequestInterface $request);

$gitHubEvent->getType(); // Event type
$gitHubEvent->getPayload(); // Event deserialized payload

Contributing

See CONTRIBUTING file., <sub>(*8)</sub>

Original Credits

• Sylvain MAUDUIT (@Swop) as main author.

License

This library is released under the MIT license. See the complete license in the bundled LICENSE file., <sub>(*9)</sub>