FlexyProject / GitHubAPI

lib/GitHub/Receiver/PullRequests.php

Indentation +162 added lines, -162 removed lines

@@ -14,176 +14,176 @@
 class PullRequests extends AbstractReceiver
 {
 
-    /** Available sub-Receiver */
-    const REVIEW_COMMENTS = 'ReviewComments';
+	/** Available sub-Receiver */
+	const REVIEW_COMMENTS = 'ReviewComments';
 
-    /**
-     * List pull requests
-     *
-     * @link https://developer.github.com/v3/pulls/#list-pull-requests
-     *
-     * @param string $state
-     * @param string $head
-     * @param string $base
-     * @param string $sort
-     * @param string $direction
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function listPullRequests(string $state = AbstractApi::STATE_OPEN, string $head = null, string $base = null,
-                                     string $sort = AbstractApi::SORT_CREATED,
-                                     string $direction = AbstractApi::DIRECTION_ASC): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/pulls?:args', $this->getOwner(),
-            $this->getRepo(), http_build_query([
-                'state'     => $state,
-                'head'      => $head,
-                'base'      => $base,
-                'sort'      => $sort,
-                'direction' => $direction
-            ])));
-    }
+	/**
+	 * List pull requests
+	 *
+	 * @link https://developer.github.com/v3/pulls/#list-pull-requests
+	 *
+	 * @param string $state
+	 * @param string $head
+	 * @param string $base
+	 * @param string $sort
+	 * @param string $direction
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function listPullRequests(string $state = AbstractApi::STATE_OPEN, string $head = null, string $base = null,
+									 string $sort = AbstractApi::SORT_CREATED,
+									 string $direction = AbstractApi::DIRECTION_ASC): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/pulls?:args', $this->getOwner(),
+			$this->getRepo(), http_build_query([
+				'state'     => $state,
+				'head'      => $head,
+				'base'      => $base,
+				'sort'      => $sort,
+				'direction' => $direction
+			])));
+	}
 
-    /**
-     * Get a single pull request
-     *
-     * @link https://developer.github.com/v3/pulls/#get-a-single-pull-request
-     *
-     * @param int $number
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function getSinglePullRequest(int $number): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/pulls/:number', $this->getOwner(),
-            $this->getRepo(), $number));
-    }
+	/**
+	 * Get a single pull request
+	 *
+	 * @link https://developer.github.com/v3/pulls/#get-a-single-pull-request
+	 *
+	 * @param int $number
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function getSinglePullRequest(int $number): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/pulls/:number', $this->getOwner(),
+			$this->getRepo(), $number));
+	}
 
-    /**
-     * Create a pull request
-     *
-     * @link https://developer.github.com/v3/pulls/#create-a-pull-request
-     *
-     * @param string $title
-     * @param string $head
-     * @param string $base
-     * @param string $body
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function createPullrequest(string $title, string $head, string $base, string $body): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/pulls', $this->getOwner(),
-            $this->getRepo()), Request::METHOD_POST, [
-                'title' => $title,
-                'head'  => $head,
-                'base'  => $base,
-                'body'  => $body
-            ]);
-    }
+	/**
+	 * Create a pull request
+	 *
+	 * @link https://developer.github.com/v3/pulls/#create-a-pull-request
+	 *
+	 * @param string $title
+	 * @param string $head
+	 * @param string $base
+	 * @param string $body
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function createPullrequest(string $title, string $head, string $base, string $body): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/pulls', $this->getOwner(),
+			$this->getRepo()), Request::METHOD_POST, [
+				'title' => $title,
+				'head'  => $head,
+				'base'  => $base,
+				'body'  => $body
+			]);
+	}
 
-    /**
-     * Update a pull request
-     *
-     * @link https://developer.github.com/v3/pulls/#update-a-pull-request
-     *
-     * @param int    $number
-     * @param string $title
-     * @param string $body
-     * @param string $state
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function updatePullRequest(int $number, string $title = null, string $body = null,
-                                      string $state = null): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/pulls/:number', $this->getOwner(),
-            $this->getRepo(), $number), Request::METHOD_PATCH, [
-                'title' => $title,
-                'body'  => $body,
-                'state' => $state
-            ]);
-    }
+	/**
+	 * Update a pull request
+	 *
+	 * @link https://developer.github.com/v3/pulls/#update-a-pull-request
+	 *
+	 * @param int    $number
+	 * @param string $title
+	 * @param string $body
+	 * @param string $state
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function updatePullRequest(int $number, string $title = null, string $body = null,
+									  string $state = null): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/pulls/:number', $this->getOwner(),
+			$this->getRepo(), $number), Request::METHOD_PATCH, [
+				'title' => $title,
+				'body'  => $body,
+				'state' => $state
+			]);
+	}
 
-    /**
-     * List commits on a pull request
-     *
-     * @link https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request
-     *
-     * @param int $number
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function listCommits(int $number): array
-    {
-        return $this->getApi()->request($this->getApi()
-                                             ->sprintf('/repos/:owner/:repo/pulls/:number/commits', $this->getOwner(),
-                                                 $this->getRepo(), $number));
-    }
+	/**
+	 * List commits on a pull request
+	 *
+	 * @link https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request
+	 *
+	 * @param int $number
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function listCommits(int $number): array
+	{
+		return $this->getApi()->request($this->getApi()
+											 ->sprintf('/repos/:owner/:repo/pulls/:number/commits', $this->getOwner(),
+												 $this->getRepo(), $number));
+	}
 
-    /**
-     * List pull requests files
-     *
-     * @link https://developer.github.com/v3/pulls/#list-pull-requests-files
-     *
-     * @param int $number
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function listPullRequestsFiles(int $number): array
-    {
-        return $this->getApi()->request($this->getApi()
-                                             ->sprintf('/repos/:owner/:repo/pulls/:number/files', $this->getOwner(),
-                                                 $this->getRepo(), $number));
-    }
+	/**
+	 * List pull requests files
+	 *
+	 * @link https://developer.github.com/v3/pulls/#list-pull-requests-files
+	 *
+	 * @param int $number
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function listPullRequestsFiles(int $number): array
+	{
+		return $this->getApi()->request($this->getApi()
+											 ->sprintf('/repos/:owner/:repo/pulls/:number/files', $this->getOwner(),
+												 $this->getRepo(), $number));
+	}
 
-    /**
-     * Get if a pull request has been merged
-     *
-     * @link https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged
-     *
-     * @param int $number
-     *
-     * @return bool
-     * @throws \Exception
-     */
-    public function checkPullRequestsMerged(int $number): bool
-    {
-        $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/pulls/:number/merge', $this->getOwner(),
-            $this->getRepo(), $number));
+	/**
+	 * Get if a pull request has been merged
+	 *
+	 * @link https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged
+	 *
+	 * @param int $number
+	 *
+	 * @return bool
+	 * @throws \Exception
+	 */
+	public function checkPullRequestsMerged(int $number): bool
+	{
+		$this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/pulls/:number/merge', $this->getOwner(),
+			$this->getRepo(), $number));
 
-        if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
-            return true;
-        }
+		if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
+			return true;
+		}
 
-        return false;
-    }
+		return false;
+	}
 
-    /**
-     * Merge a pull request (Merge Button)
-     *
-     * @link https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button
-     *
-     * @param int    $number
-     * @param string $commitMessage
-     * @param string $sha
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function mergePullRequest(int $number, string $commitMessage = null, string $sha = null): array
-    {
-        return $this->getApi()->request($this->getApi()
-                                             ->sprintf('/repos/:owner/:repo/pulls/:number/merge', $this->getOwner(),
-                                                 $this->getRepo(), $number), Request::METHOD_PUT, [
-                'commit_message' => $commitMessage,
-                'sha'            => $sha
-            ]);
-    }
+	/**
+	 * Merge a pull request (Merge Button)
+	 *
+	 * @link https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button
+	 *
+	 * @param int    $number
+	 * @param string $commitMessage
+	 * @param string $sha
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function mergePullRequest(int $number, string $commitMessage = null, string $sha = null): array
+	{
+		return $this->getApi()->request($this->getApi()
+											 ->sprintf('/repos/:owner/:repo/pulls/:number/merge', $this->getOwner(),
+												 $this->getRepo(), $number), Request::METHOD_PUT, [
+				'commit_message' => $commitMessage,
+				'sha'            => $sha
+			]);
+	}
 }
\ No newline at end of file

lib/GitHub/WebHook.php

Indentation +17 added lines, -17 removed lines

@@ -12,24 +12,24 @@
 class WebHook extends AbstractApi
 {
 
-    /** Constants */
-    const PAYLOAD = 'Payload';
+	/** Constants */
+	const PAYLOAD = 'Payload';
 
-    /**
-     * Returns Event object
-     *
-     * @param string $event
-     *
-     * @return null|EventInterface
-     */
-    public function getEvent(string $event)
-    {
-        $class = (string)$this->sprintf(':namespace\Event\:event', __NAMESPACE__, $event);
+	/**
+	 * Returns Event object
+	 *
+	 * @param string $event
+	 *
+	 * @return null|EventInterface
+	 */
+	public function getEvent(string $event)
+	{
+		$class = (string)$this->sprintf(':namespace\Event\:event', __NAMESPACE__, $event);
 
-        if (class_exists($class)) {
-            return new $class($this);
-        }
+		if (class_exists($class)) {
+			return new $class($this);
+		}
 
-        return null;
-    }
+		return null;
+	}
 } 
\ No newline at end of file

lib/GitHub/Event/EventInterface.php

Indentation +12 added lines, -12 removed lines

@@ -11,17 +11,17 @@
 interface EventInterface
 {
 
-    /**
-     * Constructor, pass a WebHook object
-     *
-     * @param WebHook $webHook
-     */
-    public function __construct(WebHook $webHook);
+	/**
+	 * Constructor, pass a WebHook object
+	 *
+	 * @param WebHook $webHook
+	 */
+	public function __construct(WebHook $webHook);
 
-    /**
-     * Parse raw data
-     *
-     * @return Payload
-     */
-    public function parse(): Payload;
+	/**
+	 * Parse raw data
+	 *
+	 * @return Payload
+	 */
+	public function parse(): Payload;
 }
\ No newline at end of file

lib/GitHub/Event/Payload.php

Indentation +186 added lines, -186 removed lines

@@ -13,190 +13,190 @@
 class Payload implements EventInterface
 {
 
-    /** Protected properties */
-    protected $webHook;
-    protected $secret = null;
-    protected $rawData;
-    protected $parsedData;
-
-    /**
-     * Constructor, pass a WebHook object
-     *
-     * @param WebHook $webHook
-     */
-    public function __construct(WebHook $webHook)
-    {
-        $this->setWebHook($webHook);
-        $this->setRawData($webHook->getRequest()->getContent());
-    }
-
-    /**
-     * Get webHook
-     *
-     * @return null|WebHook
-     */
-    public function getWebHook()
-    {
-        return $this->webHook;
-    }
-
-    /**
-     * Set webHook
-     *
-     * @param mixed $webHook
-     *
-     * @return Payload
-     */
-    public function setWebHook($webHook): Payload
-    {
-        $this->webHook = $webHook;
-
-        return $this;
-    }
-
-    /**
-     * Set secret, encode this secret with Hmac, SHA1 method
-     *
-     * @param string $secret
-     *
-     * @return Payload
-     */
-    public function setSecret(string $secret): Payload
-    {
-        $this->secret = hash_hmac('sha1', $this->rawData, $secret);
-
-        return $this;
-    }
-
-    /**
-     * Get secret
-     *
-     * @return null|string
-     */
-    public function getSecret()
-    {
-        return $this->secret;
-    }
-
-    /**
-     * Get rawData
-     *
-     * @return resource|string
-     */
-    public function getRawData()
-    {
-        return $this->rawData;
-    }
-
-    /**
-     * Set rawData
-     *
-     * @param resource|string $rawData
-     *
-     * @return Payload
-     */
-    public function setRawData($rawData): Payload
-    {
-        $this->rawData = $rawData;
-
-        return $this;
-    }
-
-    /**
-     * Get parsedData
-     *
-     * @return mixed
-     */
-    public function getData()
-    {
-        return $this->parsedData;
-    }
-
-    /**
-     * Set parsedData
-     *
-     * @param mixed $parsedData
-     *
-     * @return Payload
-     */
-    protected function setParsedData($parsedData): Payload
-    {
-        $data = json_decode($parsedData);
-        if (JSON_ERROR_NONE === json_last_error()) {
-            $this->parsedData = $data;
-        }
-
-        return $this;
-    }
-
-    /**
-     * Debugger
-     *
-     * @return array
-     */
-    public function __debugInfo(): array
-    {
-        return [
-            'ramData'     => (array)$this->getRawData(),
-            'jsonEncoded' => json_decode($this->getRawData())
-        ];
-    }
-
-    /**
-     * Parse raw data
-     *
-     * @return Payload
-     * @throws BadSignatureException
-     * @throws \Exception
-     */
-    public function parse(): Payload
-    {
-        /** Check signature from header */
-        if (!$this->_checkSignature()) {
-            throw new BadSignatureException('Hook secret does not match.');
-        }
-
-        /** Get data from different locations according to content-type */
-        switch ($_SERVER['CONTENT_TYPE']) {
-            case 'application/json':
-                $data = $this->getRawData();
-                break;
-
-            case 'application/x-www-form-urlencoded':
-                $data = $_POST['payload'];
-                break;
-
-            default:
-                throw new \Exception('Unsupported content type: "' . $_SERVER['CONTENT_TYPE'] . '"');
-        }
-        $this->setParsedData($data);
-
-        return $this;
-    }
-
-    /**
-     * Check X-Hub-Signature
-     *
-     * @throws BadSignatureException
-     * @return bool
-     */
-    private function _checkSignature(): bool
-    {
-        if (null !== $this->secret) {
-            if ($this->getWebHook()->getRequest()->server->get('HTTP_X_HUB_SIGNATURE')) {
-                /**
-                 * Split signature into algorithm and hash
-                 *
-                 * @link http://isometriks.com/verify-github-webhooks-with-php
-                 */
-                list(, $hash) = explode('=', $this->getWebHook()->getRequest()->server->get('HTTP_X_HUB_SIGNATURE'), 2);
-
-                return $this->secret == $hash;
-            }
-
-            throw new BadSignatureException('HTTP header "X-Hub-Signature" is missing.');
-        }
-
-        return true;
-    }
+	/** Protected properties */
+	protected $webHook;
+	protected $secret = null;
+	protected $rawData;
+	protected $parsedData;
+
+	/**
+	 * Constructor, pass a WebHook object
+	 *
+	 * @param WebHook $webHook
+	 */
+	public function __construct(WebHook $webHook)
+	{
+		$this->setWebHook($webHook);
+		$this->setRawData($webHook->getRequest()->getContent());
+	}
+
+	/**
+	 * Get webHook
+	 *
+	 * @return null|WebHook
+	 */
+	public function getWebHook()
+	{
+		return $this->webHook;
+	}
+
+	/**
+	 * Set webHook
+	 *
+	 * @param mixed $webHook
+	 *
+	 * @return Payload
+	 */
+	public function setWebHook($webHook): Payload
+	{
+		$this->webHook = $webHook;
+
+		return $this;
+	}
+
+	/**
+	 * Set secret, encode this secret with Hmac, SHA1 method
+	 *
+	 * @param string $secret
+	 *
+	 * @return Payload
+	 */
+	public function setSecret(string $secret): Payload
+	{
+		$this->secret = hash_hmac('sha1', $this->rawData, $secret);
+
+		return $this;
+	}
+
+	/**
+	 * Get secret
+	 *
+	 * @return null|string
+	 */
+	public function getSecret()
+	{
+		return $this->secret;
+	}
+
+	/**
+	 * Get rawData
+	 *
+	 * @return resource|string
+	 */
+	public function getRawData()
+	{
+		return $this->rawData;
+	}
+
+	/**
+	 * Set rawData
+	 *
+	 * @param resource|string $rawData
+	 *
+	 * @return Payload
+	 */
+	public function setRawData($rawData): Payload
+	{
+		$this->rawData = $rawData;
+
+		return $this;
+	}
+
+	/**
+	 * Get parsedData
+	 *
+	 * @return mixed
+	 */
+	public function getData()
+	{
+		return $this->parsedData;
+	}
+
+	/**
+	 * Set parsedData
+	 *
+	 * @param mixed $parsedData
+	 *
+	 * @return Payload
+	 */
+	protected function setParsedData($parsedData): Payload
+	{
+		$data = json_decode($parsedData);
+		if (JSON_ERROR_NONE === json_last_error()) {
+			$this->parsedData = $data;
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Debugger
+	 *
+	 * @return array
+	 */
+	public function __debugInfo(): array
+	{
+		return [
+			'ramData'     => (array)$this->getRawData(),
+			'jsonEncoded' => json_decode($this->getRawData())
+		];
+	}
+
+	/**
+	 * Parse raw data
+	 *
+	 * @return Payload
+	 * @throws BadSignatureException
+	 * @throws \Exception
+	 */
+	public function parse(): Payload
+	{
+		/** Check signature from header */
+		if (!$this->_checkSignature()) {
+			throw new BadSignatureException('Hook secret does not match.');
+		}
+
+		/** Get data from different locations according to content-type */
+		switch ($_SERVER['CONTENT_TYPE']) {
+			case 'application/json':
+				$data = $this->getRawData();
+				break;
+
+			case 'application/x-www-form-urlencoded':
+				$data = $_POST['payload'];
+				break;
+
+			default:
+				throw new \Exception('Unsupported content type: "' . $_SERVER['CONTENT_TYPE'] . '"');
+		}
+		$this->setParsedData($data);
+
+		return $this;
+	}
+
+	/**
+	 * Check X-Hub-Signature
+	 *
+	 * @throws BadSignatureException
+	 * @return bool
+	 */
+	private function _checkSignature(): bool
+	{
+		if (null !== $this->secret) {
+			if ($this->getWebHook()->getRequest()->server->get('HTTP_X_HUB_SIGNATURE')) {
+				/**
+				 * Split signature into algorithm and hash
+				 *
+				 * @link http://isometriks.com/verify-github-webhooks-with-php
+				 */
+				list(, $hash) = explode('=', $this->getWebHook()->getRequest()->server->get('HTTP_X_HUB_SIGNATURE'), 2);
+
+				return $this->secret == $hash;
+			}
+
+			throw new BadSignatureException('HTTP header "X-Hub-Signature" is missing.');
+		}
+
+		return true;
+	}
 }
\ No newline at end of file