FlexyProject / GitHubAPI

lib/GitHub/Receiver/Activity/Notifications.php

Indentation +153 added lines, -153 removed lines

@@ -14,167 +14,167 @@
 class Notifications extends AbstractActivity
 {
 
-    /**
-     * List your notifications
-     *
-     * @link https://developer.github.com/v3/activity/notifications/#list-your-notifications
-     *
-     * @param bool   $all
-     * @param bool   $participating
-     * @param string $since
-     * @param string $before
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function listNotifications(bool $all = false, bool $participating = false, string $since = 'now',
-                                      string $before = null): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/notifications?:args', http_build_query([
-            'all'           => $all,
-            'participating' => $participating,
-            'since'         => (new DateTime($since))->format(DateTime::ATOM),
-            'before'        => (new DateTime($before))->format(DateTime::ATOM)
-        ])));
-    }
+	/**
+	 * List your notifications
+	 *
+	 * @link https://developer.github.com/v3/activity/notifications/#list-your-notifications
+	 *
+	 * @param bool   $all
+	 * @param bool   $participating
+	 * @param string $since
+	 * @param string $before
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function listNotifications(bool $all = false, bool $participating = false, string $since = 'now',
+									  string $before = null): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/notifications?:args', http_build_query([
+			'all'           => $all,
+			'participating' => $participating,
+			'since'         => (new DateTime($since))->format(DateTime::ATOM),
+			'before'        => (new DateTime($before))->format(DateTime::ATOM)
+		])));
+	}
 
-    /**
-     * List your notifications in a repository
-     *
-     * @link https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository
-     *
-     * @param bool   $all
-     * @param bool   $participating
-     * @param string $since
-     * @param string $before
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function listRepositoryNotifications(bool $all = false, bool $participating = false, string $since = 'now',
-                                                string $before = null): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/notifications?:args',
-            $this->getActivity()->getOwner(), $this->getActivity()->getRepo(), http_build_query([
-                'all'           => $all,
-                'participating' => $participating,
-                'since'         => (new DateTime($since))->format(DateTime::ATOM),
-                'before'        => (new DateTime($before))->format(DateTime::ATOM)
-            ])));
-    }
+	/**
+	 * List your notifications in a repository
+	 *
+	 * @link https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository
+	 *
+	 * @param bool   $all
+	 * @param bool   $participating
+	 * @param string $since
+	 * @param string $before
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function listRepositoryNotifications(bool $all = false, bool $participating = false, string $since = 'now',
+												string $before = null): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/notifications?:args',
+			$this->getActivity()->getOwner(), $this->getActivity()->getRepo(), http_build_query([
+				'all'           => $all,
+				'participating' => $participating,
+				'since'         => (new DateTime($since))->format(DateTime::ATOM),
+				'before'        => (new DateTime($before))->format(DateTime::ATOM)
+			])));
+	}
 
-    /**
-     * Mark as read
-     *
-     * @link https://developer.github.com/v3/activity/notifications/#mark-as-read
-     *
-     * @param string $lastReadAt
-     *
-     * @return array
-     */
-    public function markAsRead(string $lastReadAt = 'now'): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/notifications?:args',
-            http_build_query(['last_read_at' => (new DateTime($lastReadAt))->format(DateTime::ATOM)])),
-            Request::METHOD_PUT);
-    }
+	/**
+	 * Mark as read
+	 *
+	 * @link https://developer.github.com/v3/activity/notifications/#mark-as-read
+	 *
+	 * @param string $lastReadAt
+	 *
+	 * @return array
+	 */
+	public function markAsRead(string $lastReadAt = 'now'): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/notifications?:args',
+			http_build_query(['last_read_at' => (new DateTime($lastReadAt))->format(DateTime::ATOM)])),
+			Request::METHOD_PUT);
+	}
 
-    /**
-     * Mark notifications as read in a repository
-     *
-     * @link https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository
-     *
-     * @param string $lastReadAt
-     *
-     * @return array
-     */
-    public function markAsReadInRepository(string $lastReadAt = 'now'): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/notifications?:args',
-            $this->getActivity()->getOwner(), $this->getActivity()->getRepo(),
-            http_build_query(['last_read_at' => (new DateTime($lastReadAt))->format(DateTime::ATOM)])),
-            Request::METHOD_PUT);
-    }
+	/**
+	 * Mark notifications as read in a repository
+	 *
+	 * @link https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository
+	 *
+	 * @param string $lastReadAt
+	 *
+	 * @return array
+	 */
+	public function markAsReadInRepository(string $lastReadAt = 'now'): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/notifications?:args',
+			$this->getActivity()->getOwner(), $this->getActivity()->getRepo(),
+			http_build_query(['last_read_at' => (new DateTime($lastReadAt))->format(DateTime::ATOM)])),
+			Request::METHOD_PUT);
+	}
 
-    /**
-     * View a single thread
-     *
-     * @link https://developer.github.com/v3/activity/notifications/#view-a-single-thread
-     *
-     * @param int $id
-     *
-     * @return array
-     */
-    public function viewThread(int $id): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/notifications/threads/:id', (string)$id));
-    }
+	/**
+	 * View a single thread
+	 *
+	 * @link https://developer.github.com/v3/activity/notifications/#view-a-single-thread
+	 *
+	 * @param int $id
+	 *
+	 * @return array
+	 */
+	public function viewThread(int $id): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/notifications/threads/:id', (string)$id));
+	}
 
-    /**
-     * Mark a thread as read
-     *
-     * @link https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read
-     *
-     * @param int $id
-     *
-     * @return array
-     */
-    public function markThreadAsRead(int $id): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/notifications/threads/:id', (string)$id),
-            Request::METHOD_PATCH);
-    }
+	/**
+	 * Mark a thread as read
+	 *
+	 * @link https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read
+	 *
+	 * @param int $id
+	 *
+	 * @return array
+	 */
+	public function markThreadAsRead(int $id): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/notifications/threads/:id', (string)$id),
+			Request::METHOD_PATCH);
+	}
 
-    /**
-     * Get a Thread Subscription
-     *
-     * @link https://developer.github.com/v3/activity/notifications/#get-a-thread-subscription
-     *
-     * @param int $id
-     *
-     * @return array
-     */
-    public function getThreadSubscription(int $id): array
-    {
-        return $this->getApi()->request($this->getApi()
-                                             ->sprintf('/notifications/threads/:id/subscription', (string)$id));
-    }
+	/**
+	 * Get a Thread Subscription
+	 *
+	 * @link https://developer.github.com/v3/activity/notifications/#get-a-thread-subscription
+	 *
+	 * @param int $id
+	 *
+	 * @return array
+	 */
+	public function getThreadSubscription(int $id): array
+	{
+		return $this->getApi()->request($this->getApi()
+											 ->sprintf('/notifications/threads/:id/subscription', (string)$id));
+	}
 
-    /**
-     * Set a Thread Subscription
-     *
-     * @link https://developer.github.com/v3/activity/notifications/#set-a-thread-subscription
-     *
-     * @param int  $id
-     * @param bool $subscribed
-     * @param bool $ignored
-     *
-     * @return array
-     */
-    public function setThreadSubscription(int $id, bool $subscribed = false, bool $ignored = false): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/notifications/threads/:id/subscription?:args', $id,
-            http_build_query(['subscribed' => $subscribed, 'ignored' => $ignored])), Request::METHOD_PUT);
-    }
+	/**
+	 * Set a Thread Subscription
+	 *
+	 * @link https://developer.github.com/v3/activity/notifications/#set-a-thread-subscription
+	 *
+	 * @param int  $id
+	 * @param bool $subscribed
+	 * @param bool $ignored
+	 *
+	 * @return array
+	 */
+	public function setThreadSubscription(int $id, bool $subscribed = false, bool $ignored = false): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/notifications/threads/:id/subscription?:args', $id,
+			http_build_query(['subscribed' => $subscribed, 'ignored' => $ignored])), Request::METHOD_PUT);
+	}
 
-    /**
-     * Delete a Thread Subscription
-     *
-     * @link https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription
-     *
-     * @param int $id
-     *
-     * @return bool
-     */
-    public function deleteThreadSubscription(int $id): bool
-    {
-        $this->getApi()->request($this->getApi()->sprintf('/notifications/threads/:id/subscription', (string)$id),
-            Request::METHOD_DELETE);
+	/**
+	 * Delete a Thread Subscription
+	 *
+	 * @link https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription
+	 *
+	 * @param int $id
+	 *
+	 * @return bool
+	 */
+	public function deleteThreadSubscription(int $id): bool
+	{
+		$this->getApi()->request($this->getApi()->sprintf('/notifications/threads/:id/subscription', (string)$id),
+			Request::METHOD_DELETE);
 
-        if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
-            return true;
-        }
+		if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
+			return true;
+		}
 
-        return false;
-    }
+		return false;
+	}
 }
\ No newline at end of file

lib/GitHub/Event/Payload.php

Indentation +200 added lines, -200 removed lines

@@ -14,204 +14,204 @@
  */
 class Payload implements EventInterface
 {
-    /** @var WebHook */
-    protected $webHook;
-
-    /** @var null|string */
-    protected $secret = null;
-
-    /** @var string|resource */
-    protected $rawData;
-
-    /** @var mixed */
-    protected $parsedData;
-
-    /** @var ServerBag */
-    protected $serverBag;
-
-    /**
-     * Constructor, pass a WebHook object
-     *
-     * @param WebHook $webHook
-     */
-    public function __construct(WebHook $webHook)
-    {
-        $this->setWebHook($webHook);
-        $request = $webHook->getRequest();
-        $this->setRawData($request->getContent());
-        $this->serverBag = $request->server;
-    }
-
-    /**
-     * 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 ($this->serverBag->get('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: "' . $this->serverBag->get('CONTENT_TYPE') . '"');
-        }
-        $this->setParsedData($data);
-
-        return $this;
-    }
-
-    /**
-     * Check X-Hub-Signature
-     *
-     * @throws BadSignatureException
-     * @return bool
-     */
-    private function _checkSignature(): bool
-    {
-        $secret           = $this->getSecret();
-        $httpHubSignature = $this->serverBag->get('HTTP_X_HUB_SIGNATURE');
-
-        if (null !== $secret) {
-            if ($httpHubSignature) {
-                /**
-                 * Split signature into algorithm and hash
-                 *
-                 * @link http://isometriks.com/verify-github-webhooks-with-php
-                 */
-                list(, $hash) = explode('=', $httpHubSignature, 2);
-
-                return $secret == $hash;
-            }
-
-            throw new BadSignatureException('HTTP header "X-Hub-Signature" is missing.');
-        }
-
-        return true;
-    }
+	/** @var WebHook */
+	protected $webHook;
+
+	/** @var null|string */
+	protected $secret = null;
+
+	/** @var string|resource */
+	protected $rawData;
+
+	/** @var mixed */
+	protected $parsedData;
+
+	/** @var ServerBag */
+	protected $serverBag;
+
+	/**
+	 * Constructor, pass a WebHook object
+	 *
+	 * @param WebHook $webHook
+	 */
+	public function __construct(WebHook $webHook)
+	{
+		$this->setWebHook($webHook);
+		$request = $webHook->getRequest();
+		$this->setRawData($request->getContent());
+		$this->serverBag = $request->server;
+	}
+
+	/**
+	 * 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 ($this->serverBag->get('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: "' . $this->serverBag->get('CONTENT_TYPE') . '"');
+		}
+		$this->setParsedData($data);
+
+		return $this;
+	}
+
+	/**
+	 * Check X-Hub-Signature
+	 *
+	 * @throws BadSignatureException
+	 * @return bool
+	 */
+	private function _checkSignature(): bool
+	{
+		$secret           = $this->getSecret();
+		$httpHubSignature = $this->serverBag->get('HTTP_X_HUB_SIGNATURE');
+
+		if (null !== $secret) {
+			if ($httpHubSignature) {
+				/**
+				 * Split signature into algorithm and hash
+				 *
+				 * @link http://isometriks.com/verify-github-webhooks-with-php
+				 */
+				list(, $hash) = explode('=', $httpHubSignature, 2);
+
+				return $secret == $hash;
+			}
+
+			throw new BadSignatureException('HTTP header "X-Hub-Signature" is missing.');
+		}
+
+		return true;
+	}
 }
\ No newline at end of file

lib/GitHub/Receiver/Repositories/Commits.php

Indentation +54 added lines, -54 removed lines

@@ -12,62 +12,62 @@
 class Commits extends AbstractRepositories
 {
 
-    /**
-     * List commits on a repository
-     *
-     * @link https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
-     *
-     * @param string      $sha
-     * @param string|null $path
-     * @param string|null $author
-     * @param string|null $since
-     * @param string|null $until
-     *
-     * @return array
-     */
-    public function listCommits(string $sha = AbstractApi::BRANCH_MASTER, string $path = null, string $author = null,
-                                string $since = null, string $until = null, $page = null, $per_page = null): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/commits?:args',
-            $this->getRepositories()->getOwner(), $this->getRepositories()->getRepo(), http_build_query([
-                "sha"    => $sha,
-                "path"   => $path,
-                "author" => $author,
-                "since"  => $since,
-                "until"  => $until,
+	/**
+	 * List commits on a repository
+	 *
+	 * @link https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
+	 *
+	 * @param string      $sha
+	 * @param string|null $path
+	 * @param string|null $author
+	 * @param string|null $since
+	 * @param string|null $until
+	 *
+	 * @return array
+	 */
+	public function listCommits(string $sha = AbstractApi::BRANCH_MASTER, string $path = null, string $author = null,
+								string $since = null, string $until = null, $page = null, $per_page = null): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/commits?:args',
+			$this->getRepositories()->getOwner(), $this->getRepositories()->getRepo(), http_build_query([
+				"sha"    => $sha,
+				"path"   => $path,
+				"author" => $author,
+				"since"  => $since,
+				"until"  => $until,
 				"page"   => $page,
 				"per_page"  => $per_page
-            ])));
-    }
+			])));
+	}
 
-    /**
-     * Get a single commit
-     *
-     * @link https://developer.github.com/v3/repos/commits/#get-a-single-commit
-     *
-     * @param string $sha
-     *
-     * @return array
-     */
-    public function getSingleCommit(string $sha): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/commits/:sha',
-            $this->getRepositories()->getOwner(), $this->getRepositories()->getRepo(), $sha));
-    }
+	/**
+	 * Get a single commit
+	 *
+	 * @link https://developer.github.com/v3/repos/commits/#get-a-single-commit
+	 *
+	 * @param string $sha
+	 *
+	 * @return array
+	 */
+	public function getSingleCommit(string $sha): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/commits/:sha',
+			$this->getRepositories()->getOwner(), $this->getRepositories()->getRepo(), $sha));
+	}
 
-    /**
-     * Compare two commits
-     *
-     * @link https://developer.github.com/v3/repos/commits/#compare-two-commits
-     *
-     * @param string $base
-     * @param string $head
-     *
-     * @return array
-     */
-    public function compareTwoCommits(string $base, string $head): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/compare/:base...:head',
-            $this->getRepositories()->getOwner(), $this->getRepositories()->getRepo(), $base, $head));
-    }
+	/**
+	 * Compare two commits
+	 *
+	 * @link https://developer.github.com/v3/repos/commits/#compare-two-commits
+	 *
+	 * @param string $base
+	 * @param string $head
+	 *
+	 * @return array
+	 */
+	public function compareTwoCommits(string $base, string $head): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/repos/:owner/:repo/compare/:base...:head',
+			$this->getRepositories()->getOwner(), $this->getRepositories()->getRepo(), $base, $head));
+	}
 }