GitHubGateController.php
View Options

	<?php

	namespace Nasqueron\Notifications\Http\Controllers\Gate;

	use Event;
	use Log;
	use Request;

	use Nasqueron\Notifications\Events\GitHubPayloadEvent;
	use Keruald\GitHub\XHubSignature;

	class GitHubGateController extends GateController {

	///
	/// Private members
	///

	/**
	* The request signature, allowing to determine if the payload is legit
	*
	* @var string
	*/
	private $signature;

	/**
	* The GitHub event triggering this request
	*
	* @var string
	*/
	private $event;

	/**
	* The request delivery GUID
	*
	* @var string
	*/
	private $delivery;

	/**
	* The request content, as a structured data
	*
	* @var stdClass
	*/
	private $payload;

	/**
	* The request content
	*
	* @var string
	*/
	private $rawRequestContent;

	///
	/// Constants
	///

	const SERVICE_NAME = 'GitHub';

	///
	/// Request processing
	///

	/**
	* Handles POST requests
	*
	* @param Request $request the HTTP request
	* @return Illuminate\Http\Response
	*/
	public function onPost ($door) {
	// Parses the request and check if it's legit

	$this->door = $door;
	$this->extractHeaders();
	$this->extractPayload();

	if (!$this->isLegitRequest()) {
	abort(403, 'Unauthorized action.');
	return;
	}

	// Process the request

	$this->logRequest();
	$this->onPayload();

	// Output

	return parent::renderReport();
	}

	/**
	* Extracts headers from the request
	*/
	protected function extractHeaders () {
	$this->signature = $this->getSignature();
	$this->event = Request::header('X-Github-Event');
	$this->delivery = Request::header('X-Github-Delivery');
	}

	/**
	* Gets the signature from an X-Hub-Signature header
	*
	* @param string the signature part of the header
	*/
	private function getSignature () {
	$headerSignature = Request::header('X-Hub-Signature');
	return XHubSignature::parseSignature($headerSignature);
	}

	/**
	* Extracts payload from the request
	*/
	protected function extractPayload () {
	$request = Request::instance();
	$this->rawRequestContent = $request->getContent();
	$this->payload = json_decode($this->rawRequestContent);
	}

	/**
	* Determines if the request is legit.
	*
	* @return bool true if the request looks legit; otherwise, false.
	*/
	protected function isLegitRequest () {
	$secret = $this->getSecret();

	// If the secret is not defined, request legitimation is bypassed
	if (empty($secret)) {
	return true;
	}

	return XHubSignature::validatePayload(
	$secret,
	$this->rawRequestContent,
	$this->signature
	);
	}

	/**
	* Logs the request
	*/
	protected function logRequest () {
	Log::info('[Gate] New payload.', [
	'service' => static::SERVICE_NAME,
	'door' => $this->door,
	'delivery' => $this->delivery,
	'event' => $this->event,
	]);
	}

	///
	/// Payload processing
	///

	protected function onPayload () {
	$this->initializeReport();

	Event::fire(new GitHubPayloadEvent(
	$this->door,
	$this->event,
	$this->payload
	));
	}
	}

File Metadata

Mime Type: text/x-php
Expires: Fri, Feb 28, 21:39 (1 d, 7 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 2442628
Default Alt Text: GitHubGateController.php (3 KB)

GitHubGateController.php
No OneTemporary
Actions

GitHubGateController.php
View Options

File Metadata

Event Timeline

GitHubGateController.phpNo OneTemporaryActions

GitHubGateController.phpView Options

File Metadata

Event Timeline

GitHubGateController.php
No OneTemporary
Actions

GitHubGateController.php
View Options