FlexyProject / GitHubAPI

lib/GitHub/AbstractApi.php

Doc Comments +1 added lines, -1 removed lines

@@ -156,7 +156,7 @@
     /**
      * Set accept
      *
-     * @param array|string $accept
+     * @param string $accept
      *
      * @return AbstractApi
      */

Spacing +2 added lines, -2 removed lines

@@ -517,7 +517,7 @@ 
                 break;
         }
 
-        $curl->success(function (CurlClient $instance) {
+        $curl->success(function(CurlClient $instance) {
             $this->headers = $instance->getHeaders();
             $this->success = $instance->getResponse();
             $data          = json_decode($this->success, true);
@@ -525,7 +525,7 @@ 
                 $this->success = $data;
             }
         });
-        $curl->error(function (CurlClient $instance) {
+        $curl->error(function(CurlClient $instance) {
             $this->headers = $instance->getHeaders();
             $this->failure = $instance->getResponse();
             $data          = json_decode($this->failure, true);

Indentation +568 added lines, -568 removed lines

@@ -13,572 +13,572 @@
 abstract class AbstractApi
 {
 
-    /** API version */
-    const API_VERSION = 'v3';
-
-    /** API constants */
-    const API_URL        = 'https://api.github.com';
-    const API_UPLOADS    = 'https://uploads.github.com';
-    const API_RAW_URL    = 'https://raw.github.com';
-    const CONTENT_TYPE   = 'application/json';
-    const DEFAULT_ACCEPT = 'application/vnd.github.' . self::API_VERSION . '+json';
-    const USER_AGENT     = 'FlexyProject-GitHubAPI';
-
-    /** Archive constants */
-    const ARCHIVE_TARBALL = 'tarball';
-    const ARCHIVE_ZIPBALL = 'zipball';
-
-    /** Authentication constants */
-    const OAUTH_AUTH             = 0;
-    const OAUTH2_HEADER_AUTH     = 1;
-    const OAUTH2_PARAMETERS_AUTH = 2;
-
-    /** Branch constants */
-    const BRANCH_MASTER  = 'master';
-    const BRANCH_DEVELOP = 'develop';
-
-    /** Direction constants */
-    const DIRECTION_ASC  = 'asc';
-    const DIRECTION_DESC = 'desc';
-
-    /** Environment constants */
-    const ENVIRONMENT_PRODUCTION = 'production';
-    const ENVIRONMENT_STAGING    = 'staging';
-    const ENVIRONMENT_QA         = 'qa';
-
-    /** Events constants */
-    const EVENTS_PULL         = 'pull';
-    const EVENTS_PULL_REQUEST = 'pull_request';
-    const EVENTS_PUSH         = 'push';
-
-    /** Filter constants */
-    const FILTER_ALL        = 'all';
-    const FILTER_ASSIGNED   = 'assigned';
-    const FILTER_CREATED    = 'created';
-    const FILTER_MENTIONED  = 'mentioned';
-    const FILTER_SUBSCRIBED = 'subscribed';
-
-    /** Media types constants */
-    const MEDIA_TYPE_JSON = 'json';
-    const MEDIA_TYPE_RAW  = 'raw';
-    const MEDIA_TYPE_FULL = 'full';
-    const MEDIA_TYPE_TEXT = 'text';
-
-    /** Modes constants */
-    const MODE_MARKDOWN = 'markdown';
-    const MODE_GFM      = 'gfm';
-
-    /** Permissions constants */
-    const PERMISSION_ADMIN = 'admin';
-    const PERMISSION_PULL  = 'pull';
-    const PERMISSION_PUSH  = 'push';
-
-    /** Sort constants */
-    const SORT_COMPLETENESS = 'completeness';
-    const SORT_CREATED      = 'created';
-    const SORT_DUE_DATE     = 'due_date';
-    const SORT_FULL_NAME    = 'full_name';
-    const SORT_NEWEST       = 'newest';
-    const SORT_OLDEST       = 'oldest';
-    const SORT_PUSHED       = 'pushed';
-    const SORT_STARGAZERS   = 'stargazers';
-    const SORT_UPDATED      = 'updated';
-
-    /** State constants */
-    const STATE_ACTIVE  = 'active';
-    const STATE_ALL     = 'all';
-    const STATE_CLOSED  = 'closed';
-    const STATE_ERROR   = 'error';
-    const STATE_FAILURE = 'failure';
-    const STATE_OPEN    = 'open';
-    const STATE_PENDING = 'pending';
-    const STATE_SUCCESS = 'success';
-
-    /** Task constants */
-    const TASK_DEPLOY            = 'deploy';
-    const TASK_DEPLOY_MIGRATIONS = 'deploy:migrations';
-
-    /** Type constants */
-    const TYPE_ALL        = 'all';
-    const TYPE_COMMENTS   = 'comments';
-    const TYPE_GISTS      = 'gists';
-    const TYPE_HOOKS      = 'hooks';
-    const TYPE_ISSUES     = 'issues';
-    const TYPE_MEMBER     = 'member';
-    const TYPE_MILESTONES = 'milestones';
-    const TYPE_ORGS       = 'orgs';
-    const TYPE_OWNER      = 'owner';
-    const TYPE_PAGES      = 'pages';
-    const TYPE_PUBLIC     = 'public';
-    const TYPE_PULLS      = 'pulls';
-    const TYPE_PRIVATE    = 'private';
-    const TYPE_REPOS      = 'repos';
-    const TYPE_USERS      = 'users';
-
-    /** Properties */
-    protected $accept         = self::DEFAULT_ACCEPT;
-    protected $apiUrl         = self::API_URL;
-    protected $authentication = self::OAUTH_AUTH;
-    protected $clientId;
-    protected $clientSecret;
-    protected $contentType    = self::CONTENT_TYPE;
-    protected $failure;
-    protected $headers        = [];
-    protected $httpAuth       = ['username' => '', 'password' => ''];
-    protected $success;
-    protected $timeout        = 240;
-    protected $token          = '';
-    protected $request;
-
-    /**
-     * Constructor
-     */
-    public function __construct()
-    {
-        $this->request = Request::createFromGlobals();
-    }
-
-    /**
-     * Get request
-     *
-     * @return Request
-     */
-    public function getRequest(): Request
-    {
-        return $this->request;
-    }
-
-    /**
-     * Get accept
-     *
-     * @return mixed
-     */
-    public function getAccept()
-    {
-        return $this->accept;
-    }
-
-    /**
-     * Set accept
-     *
-     * @param array|string $accept
-     *
-     * @return AbstractApi
-     */
-    public function setAccept($accept): AbstractApi
-    {
-        $this->accept = $accept;
-
-        return $this;
-    }
-
-    /**
-     * Get authentication
-     *
-     * @return int
-     */
-    public function getAuthentication(): int
-    {
-        return $this->authentication;
-    }
-
-    /**
-     * Set authentication
-     *
-     * @param int $authentication
-     *
-     * @return AbstractApi
-     */
-    public function setAuthentication(int $authentication): AbstractApi
-    {
-        $this->authentication = $authentication;
-
-        return $this;
-    }
-
-    /**
-     * Get apiUrl
-     *
-     * @return string
-     */
-    public function getApiUrl(): string
-    {
-        return $this->apiUrl;
-    }
-
-    /**
-     * Set apiUrl
-     *
-     * @param mixed $apiUrl
-     *
-     * @return AbstractApi
-     */
-    public function setApiUrl($apiUrl): AbstractApi
-    {
-        $this->apiUrl = $apiUrl;
-
-        return $this;
-    }
-
-    /**
-     * Get clientId
-     *
-     * @return null|int
-     */
-    public function getClientId()
-    {
-        return $this->clientId;
-    }
-
-    /**
-     * Set clientId
-     *
-     * @param mixed $clientId
-     *
-     * @return AbstractApi
-     */
-    public function setClientId($clientId): AbstractApi
-    {
-        $this->clientId = $clientId;
-
-        return $this;
-    }
-
-    /**
-     * Get clientSecret
-     *
-     * @return null|string
-     */
-    public function getClientSecret()
-    {
-        return $this->clientSecret;
-    }
-
-    /**
-     * Set clientSecret
-     *
-     * @param mixed $clientSecret
-     *
-     * @return AbstractApi
-     */
-    public function setClientSecret($clientSecret): AbstractApi
-    {
-        $this->clientSecret = $clientSecret;
-
-        return $this;
-    }
-
-    /**
-     * Get httpAuth
-     *
-     * @return array
-     */
-    public function getHttpAuth(): array
-    {
-        return $this->httpAuth;
-    }
-
-    /**
-     * Set httpAuth
-     *
-     * @param string $username
-     * @param string $password
-     *
-     * @return AbstractApi
-     */
-    public function setHttpAuth(string $username, string $password = ''): AbstractApi
-    {
-        $this->httpAuth['username'] = $username;
-        $this->httpAuth['password'] = $password;
-
-        return $this;
-    }
-
-    /**
-     * Get token
-     *
-     * @return string
-     */
-    public function getToken(): string
-    {
-        return $this->token;
-    }
-
-    /**
-     * Set token
-     *
-     * @param string $token
-     * @param int    $authentication
-     *
-     * @return AbstractApi
-     */
-    public function setToken(string $token, int $authentication = self::OAUTH_AUTH): AbstractApi
-    {
-        $this->token = $token;
-        $this->setAuthentication($authentication);
-
-        return $this;
-    }
-
-    /**
-     * Get timeout
-     *
-     * @return int
-     */
-    public function getTimeout(): int
-    {
-        return $this->timeout;
-    }
-
-    /**
-     * Set timeout
-     *
-     * @param int $timeout
-     *
-     * @return AbstractApi
-     */
-    public function setTimeout(int $timeout): AbstractApi
-    {
-        $this->timeout = $timeout;
-
-        return $this;
-    }
-
-    /**
-     * Get contentType
-     *
-     * @return string
-     */
-    public function getContentType(): string
-    {
-        return $this->contentType;
-    }
-
-    /**
-     * Set contentType
-     *
-     * @param string $contentType
-     *
-     * @return AbstractApi
-     */
-    public function setContentType(string $contentType): AbstractApi
-    {
-        $this->contentType = $contentType;
-
-        return $this;
-    }
-
-    /**
-     * Get headers
-     *
-     * @return array
-     */
-    public function getHeaders(): array
-    {
-        return $this->headers;
-    }
-
-    /**
-     * Curl request
-     *
-     * @param string      $url
-     * @param string      $method
-     * @param array       $postFields
-     * @param null|string $apiUrl
-     *
-     * @return array
-     */
-    public function request(string $url, string $method = Request::METHOD_GET, array $postFields = [],
-                            string $apiUrl = null): array
-    {
-        /** Building url */
-        if (null === $apiUrl) {
-            $apiUrl = $this->getApiUrl();
-        }
-        $url = $apiUrl . $url;
-
-        /**
-         * OAuth2 Key/Secret authentication
-         *
-         * @see https://developer.github.com/v3/#oauth2-keysecret
-         */
-        if (null !== $this->getClientId() && null !== $this->getClientSecret()) {
-            $url .= (strstr($url, '?') !== false ? '&' : '?');
-            $url .= http_build_query(['client_id'     => $this->getClientId(),
-                                      'client_secret' => $this->getClientSecret()
-            ]);
-        } /**
-         * Basic authentication via OAuth2 Token (sent as a parameter)
-         *
-         * @see https://developer.github.com/v3/#oauth2-token-sent-as-a-parameter
-         */ else if ($this->getAuthentication() === self::OAUTH2_PARAMETERS_AUTH) {
-            $url .= http_build_query(['access_token' => $this->getToken()]);
-        }
-
-        /** Call curl */
-        $curl = new CurlClient();
-        $curl->setOption([
-            CURLOPT_USERAGENT      => self::USER_AGENT,
-            CURLOPT_TIMEOUT        => $this->getTimeout(),
-            CURLOPT_HEADER         => false, // Use $client->getHeaders() to get full header
-            CURLOPT_FOLLOWLOCATION => true,
-            CURLOPT_HTTPHEADER     => [
-                'Accept: ' . $this->getAccept(),
-                'Content-Type: ' . $this->getContentType()
-            ],
-            CURLOPT_URL            => $url
-        ]);
-
-        /**
-         * Basic authentication via username and Password
-         *
-         * @see https://developer.github.com/v3/auth/#via-username-and-password
-         */
-        if (!empty($this->getHttpAuth())) {
-            if (!isset($this->getHttpAuth()['password']) || empty($this->getHttpAuth()['password'])) {
-                $curl->setOption([
-                    CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
-                    CURLOPT_USERPWD  => $this->getHttpAuth()['username']
-                ]);
-            } else {
-                $curl->setOption([
-                    CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
-                    CURLOPT_USERPWD  => sprintf('%s:%s', $this->getHttpAuth()['username'],
-                        $this->getHttpAuth()['password'])
-                ]);
-            }
-        }
-
-        if (!empty($this->getToken()) && $this->getAuthentication() !== self::OAUTH2_PARAMETERS_AUTH) {
-            /**
-             * Basic authentication via OAuth token
-             *
-             * @see https://developer.github.com/v3/auth/#via-oauth-tokens
-             **/
-            if ($this->getAuthentication() === self::OAUTH_AUTH) {
-                $curl->setOption([
-                    CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
-                    CURLOPT_USERPWD  => sprintf('%s:x-oauth-basic', $this->getToken())
-                ]);
-            } /**
-             * Basic authentication via OAuth2 Token (sent in a header)
-             *
-             * @see https://developer.github.com/v3/#oauth2-token-sent-in-a-header
-             */ else if ($this->getAuthentication() === self::OAUTH2_HEADER_AUTH) {
-                $curl->setOption([
-                    CURLOPT_HTTPAUTH   => CURLAUTH_BASIC,
-                    CURLOPT_HTTPHEADER => [sprintf('Authorization: token %s', $this->getToken())]
-                ]);
-            }
-        }
-
-        /** Methods */
-        switch ($method) {
-            /** @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.7 */
-            case Request::METHOD_DELETE:
-                /** @see http://tools.ietf.org/html/rfc5789 */
-            case Request::METHOD_PATCH:
-                $curl->setOption([
-                    CURLOPT_CUSTOMREQUEST => $method,
-                    CURLOPT_POST          => true,
-                    CURLOPT_POSTFIELDS    => json_encode(array_filter($postFields))
-                ]);
-                break;
-
-            /** @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.3 */
-            case Request::METHOD_GET:
-                $curl->setOption(CURLOPT_HTTPGET, true);
-                break;
-
-            /** @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.4 */
-            case Request::METHOD_HEAD:
-                $curl->setOption([
-                    CURLOPT_CUSTOMREQUEST => $method,
-                    CURLOPT_NOBODY        => true
-                ]);
-                break;
-
-            /** @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.5 */
-            case Request::METHOD_POST:
-                $curl->setOption([
-                    CURLOPT_POST       => true,
-                    CURLOPT_POSTFIELDS => json_encode(array_filter($postFields))
-                ]);
-                break;
-
-            /** @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.6 */
-            case Request::METHOD_PUT:
-                $curl->setOption([
-                    CURLOPT_CUSTOMREQUEST => $method,
-                    CURLOPT_PUT           => true,
-                    CURLOPT_HTTPHEADER    => [
-                        'X-HTTP-Method-Override: PUT',
-                        'Content-type: application/x-www-form-urlencoded'
-                    ]
-                ]);
-                break;
-
-            default:
-                break;
-        }
-
-        $curl->success(function (CurlClient $instance) {
-            $this->headers = $instance->getHeaders();
-            $this->success = $instance->getResponse();
-            $data          = json_decode($this->success, true);
-            if (JSON_ERROR_NONE === json_last_error()) {
-                $this->success = $data;
-            }
-        });
-        $curl->error(function (CurlClient $instance) {
-            $this->headers = $instance->getHeaders();
-            $this->failure = $instance->getResponse();
-            $data          = json_decode($this->failure, true);
-            if (JSON_ERROR_NONE === json_last_error()) {
-                $this->failure = $data;
-            }
-        });
-        $curl->perform();
-
-        return (array)($this->success ?? $this->failure);
-    }
-
-    /**
-     * Return a formatted string. Modified version of sprintf using colon(:)
-     *
-     * @param string $string
-     * @param array  $params
-     *
-     * @return String
-     * @throws Exception
-     */
-    public function sprintf(string $string, ...$params): string
-    {
-        preg_match_all('/\:([A-Za-z0-9_]+)/', $string, $matches);
-        $matches = $matches[1];
-
-        if (count($matches)) {
-            $tokens   = [];
-            $replaces = [];
-
-            foreach ($matches as $key => $value) {
-                if (count($params) > 1 || !is_array($params[0])) {
-                    if (!array_key_exists($key, $params)) {
-                        throw new Exception('Too few arguments, missing argument: ' . $key);
-                    }
-                    $replaces[] = $params[$key];
-                } else {
-                    if (!array_key_exists($value, $params[0])) {
-                        throw new Exception('Missing array argument: ' . $key);
-                    }
-                    $replaces[] = $params[0][$value];
-                }
-                $tokens[] = ':' . $value;
-            }
-
-            $string = str_replace($tokens, $replaces, $string);
-        }
-
-        return $string;
-    }
+	/** API version */
+	const API_VERSION = 'v3';
+
+	/** API constants */
+	const API_URL        = 'https://api.github.com';
+	const API_UPLOADS    = 'https://uploads.github.com';
+	const API_RAW_URL    = 'https://raw.github.com';
+	const CONTENT_TYPE   = 'application/json';
+	const DEFAULT_ACCEPT = 'application/vnd.github.' . self::API_VERSION . '+json';
+	const USER_AGENT     = 'FlexyProject-GitHubAPI';
+
+	/** Archive constants */
+	const ARCHIVE_TARBALL = 'tarball';
+	const ARCHIVE_ZIPBALL = 'zipball';
+
+	/** Authentication constants */
+	const OAUTH_AUTH             = 0;
+	const OAUTH2_HEADER_AUTH     = 1;
+	const OAUTH2_PARAMETERS_AUTH = 2;
+
+	/** Branch constants */
+	const BRANCH_MASTER  = 'master';
+	const BRANCH_DEVELOP = 'develop';
+
+	/** Direction constants */
+	const DIRECTION_ASC  = 'asc';
+	const DIRECTION_DESC = 'desc';
+
+	/** Environment constants */
+	const ENVIRONMENT_PRODUCTION = 'production';
+	const ENVIRONMENT_STAGING    = 'staging';
+	const ENVIRONMENT_QA         = 'qa';
+
+	/** Events constants */
+	const EVENTS_PULL         = 'pull';
+	const EVENTS_PULL_REQUEST = 'pull_request';
+	const EVENTS_PUSH         = 'push';
+
+	/** Filter constants */
+	const FILTER_ALL        = 'all';
+	const FILTER_ASSIGNED   = 'assigned';
+	const FILTER_CREATED    = 'created';
+	const FILTER_MENTIONED  = 'mentioned';
+	const FILTER_SUBSCRIBED = 'subscribed';
+
+	/** Media types constants */
+	const MEDIA_TYPE_JSON = 'json';
+	const MEDIA_TYPE_RAW  = 'raw';
+	const MEDIA_TYPE_FULL = 'full';
+	const MEDIA_TYPE_TEXT = 'text';
+
+	/** Modes constants */
+	const MODE_MARKDOWN = 'markdown';
+	const MODE_GFM      = 'gfm';
+
+	/** Permissions constants */
+	const PERMISSION_ADMIN = 'admin';
+	const PERMISSION_PULL  = 'pull';
+	const PERMISSION_PUSH  = 'push';
+
+	/** Sort constants */
+	const SORT_COMPLETENESS = 'completeness';
+	const SORT_CREATED      = 'created';
+	const SORT_DUE_DATE     = 'due_date';
+	const SORT_FULL_NAME    = 'full_name';
+	const SORT_NEWEST       = 'newest';
+	const SORT_OLDEST       = 'oldest';
+	const SORT_PUSHED       = 'pushed';
+	const SORT_STARGAZERS   = 'stargazers';
+	const SORT_UPDATED      = 'updated';
+
+	/** State constants */
+	const STATE_ACTIVE  = 'active';
+	const STATE_ALL     = 'all';
+	const STATE_CLOSED  = 'closed';
+	const STATE_ERROR   = 'error';
+	const STATE_FAILURE = 'failure';
+	const STATE_OPEN    = 'open';
+	const STATE_PENDING = 'pending';
+	const STATE_SUCCESS = 'success';
+
+	/** Task constants */
+	const TASK_DEPLOY            = 'deploy';
+	const TASK_DEPLOY_MIGRATIONS = 'deploy:migrations';
+
+	/** Type constants */
+	const TYPE_ALL        = 'all';
+	const TYPE_COMMENTS   = 'comments';
+	const TYPE_GISTS      = 'gists';
+	const TYPE_HOOKS      = 'hooks';
+	const TYPE_ISSUES     = 'issues';
+	const TYPE_MEMBER     = 'member';
+	const TYPE_MILESTONES = 'milestones';
+	const TYPE_ORGS       = 'orgs';
+	const TYPE_OWNER      = 'owner';
+	const TYPE_PAGES      = 'pages';
+	const TYPE_PUBLIC     = 'public';
+	const TYPE_PULLS      = 'pulls';
+	const TYPE_PRIVATE    = 'private';
+	const TYPE_REPOS      = 'repos';
+	const TYPE_USERS      = 'users';
+
+	/** Properties */
+	protected $accept         = self::DEFAULT_ACCEPT;
+	protected $apiUrl         = self::API_URL;
+	protected $authentication = self::OAUTH_AUTH;
+	protected $clientId;
+	protected $clientSecret;
+	protected $contentType    = self::CONTENT_TYPE;
+	protected $failure;
+	protected $headers        = [];
+	protected $httpAuth       = ['username' => '', 'password' => ''];
+	protected $success;
+	protected $timeout        = 240;
+	protected $token          = '';
+	protected $request;
+
+	/**
+	 * Constructor
+	 */
+	public function __construct()
+	{
+		$this->request = Request::createFromGlobals();
+	}
+
+	/**
+	 * Get request
+	 *
+	 * @return Request
+	 */
+	public function getRequest(): Request
+	{
+		return $this->request;
+	}
+
+	/**
+	 * Get accept
+	 *
+	 * @return mixed
+	 */
+	public function getAccept()
+	{
+		return $this->accept;
+	}
+
+	/**
+	 * Set accept
+	 *
+	 * @param array|string $accept
+	 *
+	 * @return AbstractApi
+	 */
+	public function setAccept($accept): AbstractApi
+	{
+		$this->accept = $accept;
+
+		return $this;
+	}
+
+	/**
+	 * Get authentication
+	 *
+	 * @return int
+	 */
+	public function getAuthentication(): int
+	{
+		return $this->authentication;
+	}
+
+	/**
+	 * Set authentication
+	 *
+	 * @param int $authentication
+	 *
+	 * @return AbstractApi
+	 */
+	public function setAuthentication(int $authentication): AbstractApi
+	{
+		$this->authentication = $authentication;
+
+		return $this;
+	}
+
+	/**
+	 * Get apiUrl
+	 *
+	 * @return string
+	 */
+	public function getApiUrl(): string
+	{
+		return $this->apiUrl;
+	}
+
+	/**
+	 * Set apiUrl
+	 *
+	 * @param mixed $apiUrl
+	 *
+	 * @return AbstractApi
+	 */
+	public function setApiUrl($apiUrl): AbstractApi
+	{
+		$this->apiUrl = $apiUrl;
+
+		return $this;
+	}
+
+	/**
+	 * Get clientId
+	 *
+	 * @return null|int
+	 */
+	public function getClientId()
+	{
+		return $this->clientId;
+	}
+
+	/**
+	 * Set clientId
+	 *
+	 * @param mixed $clientId
+	 *
+	 * @return AbstractApi
+	 */
+	public function setClientId($clientId): AbstractApi
+	{
+		$this->clientId = $clientId;
+
+		return $this;
+	}
+
+	/**
+	 * Get clientSecret
+	 *
+	 * @return null|string
+	 */
+	public function getClientSecret()
+	{
+		return $this->clientSecret;
+	}
+
+	/**
+	 * Set clientSecret
+	 *
+	 * @param mixed $clientSecret
+	 *
+	 * @return AbstractApi
+	 */
+	public function setClientSecret($clientSecret): AbstractApi
+	{
+		$this->clientSecret = $clientSecret;
+
+		return $this;
+	}
+
+	/**
+	 * Get httpAuth
+	 *
+	 * @return array
+	 */
+	public function getHttpAuth(): array
+	{
+		return $this->httpAuth;
+	}
+
+	/**
+	 * Set httpAuth
+	 *
+	 * @param string $username
+	 * @param string $password
+	 *
+	 * @return AbstractApi
+	 */
+	public function setHttpAuth(string $username, string $password = ''): AbstractApi
+	{
+		$this->httpAuth['username'] = $username;
+		$this->httpAuth['password'] = $password;
+
+		return $this;
+	}
+
+	/**
+	 * Get token
+	 *
+	 * @return string
+	 */
+	public function getToken(): string
+	{
+		return $this->token;
+	}
+
+	/**
+	 * Set token
+	 *
+	 * @param string $token
+	 * @param int    $authentication
+	 *
+	 * @return AbstractApi
+	 */
+	public function setToken(string $token, int $authentication = self::OAUTH_AUTH): AbstractApi
+	{
+		$this->token = $token;
+		$this->setAuthentication($authentication);
+
+		return $this;
+	}
+
+	/**
+	 * Get timeout
+	 *
+	 * @return int
+	 */
+	public function getTimeout(): int
+	{
+		return $this->timeout;
+	}
+
+	/**
+	 * Set timeout
+	 *
+	 * @param int $timeout
+	 *
+	 * @return AbstractApi
+	 */
+	public function setTimeout(int $timeout): AbstractApi
+	{
+		$this->timeout = $timeout;
+
+		return $this;
+	}
+
+	/**
+	 * Get contentType
+	 *
+	 * @return string
+	 */
+	public function getContentType(): string
+	{
+		return $this->contentType;
+	}
+
+	/**
+	 * Set contentType
+	 *
+	 * @param string $contentType
+	 *
+	 * @return AbstractApi
+	 */
+	public function setContentType(string $contentType): AbstractApi
+	{
+		$this->contentType = $contentType;
+
+		return $this;
+	}
+
+	/**
+	 * Get headers
+	 *
+	 * @return array
+	 */
+	public function getHeaders(): array
+	{
+		return $this->headers;
+	}
+
+	/**
+	 * Curl request
+	 *
+	 * @param string      $url
+	 * @param string      $method
+	 * @param array       $postFields
+	 * @param null|string $apiUrl
+	 *
+	 * @return array
+	 */
+	public function request(string $url, string $method = Request::METHOD_GET, array $postFields = [],
+							string $apiUrl = null): array
+	{
+		/** Building url */
+		if (null === $apiUrl) {
+			$apiUrl = $this->getApiUrl();
+		}
+		$url = $apiUrl . $url;
+
+		/**
+		 * OAuth2 Key/Secret authentication
+		 *
+		 * @see https://developer.github.com/v3/#oauth2-keysecret
+		 */
+		if (null !== $this->getClientId() && null !== $this->getClientSecret()) {
+			$url .= (strstr($url, '?') !== false ? '&' : '?');
+			$url .= http_build_query(['client_id'     => $this->getClientId(),
+									  'client_secret' => $this->getClientSecret()
+			]);
+		} /**
+		 * Basic authentication via OAuth2 Token (sent as a parameter)
+		 *
+		 * @see https://developer.github.com/v3/#oauth2-token-sent-as-a-parameter
+		 */ else if ($this->getAuthentication() === self::OAUTH2_PARAMETERS_AUTH) {
+			$url .= http_build_query(['access_token' => $this->getToken()]);
+		}
+
+		/** Call curl */
+		$curl = new CurlClient();
+		$curl->setOption([
+			CURLOPT_USERAGENT      => self::USER_AGENT,
+			CURLOPT_TIMEOUT        => $this->getTimeout(),
+			CURLOPT_HEADER         => false, // Use $client->getHeaders() to get full header
+			CURLOPT_FOLLOWLOCATION => true,
+			CURLOPT_HTTPHEADER     => [
+				'Accept: ' . $this->getAccept(),
+				'Content-Type: ' . $this->getContentType()
+			],
+			CURLOPT_URL            => $url
+		]);
+
+		/**
+		 * Basic authentication via username and Password
+		 *
+		 * @see https://developer.github.com/v3/auth/#via-username-and-password
+		 */
+		if (!empty($this->getHttpAuth())) {
+			if (!isset($this->getHttpAuth()['password']) || empty($this->getHttpAuth()['password'])) {
+				$curl->setOption([
+					CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
+					CURLOPT_USERPWD  => $this->getHttpAuth()['username']
+				]);
+			} else {
+				$curl->setOption([
+					CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
+					CURLOPT_USERPWD  => sprintf('%s:%s', $this->getHttpAuth()['username'],
+						$this->getHttpAuth()['password'])
+				]);
+			}
+		}
+
+		if (!empty($this->getToken()) && $this->getAuthentication() !== self::OAUTH2_PARAMETERS_AUTH) {
+			/**
+			 * Basic authentication via OAuth token
+			 *
+			 * @see https://developer.github.com/v3/auth/#via-oauth-tokens
+			 **/
+			if ($this->getAuthentication() === self::OAUTH_AUTH) {
+				$curl->setOption([
+					CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
+					CURLOPT_USERPWD  => sprintf('%s:x-oauth-basic', $this->getToken())
+				]);
+			} /**
+			 * Basic authentication via OAuth2 Token (sent in a header)
+			 *
+			 * @see https://developer.github.com/v3/#oauth2-token-sent-in-a-header
+			 */ else if ($this->getAuthentication() === self::OAUTH2_HEADER_AUTH) {
+				$curl->setOption([
+					CURLOPT_HTTPAUTH   => CURLAUTH_BASIC,
+					CURLOPT_HTTPHEADER => [sprintf('Authorization: token %s', $this->getToken())]
+				]);
+			}
+		}
+
+		/** Methods */
+		switch ($method) {
+			/** @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.7 */
+			case Request::METHOD_DELETE:
+				/** @see http://tools.ietf.org/html/rfc5789 */
+			case Request::METHOD_PATCH:
+				$curl->setOption([
+					CURLOPT_CUSTOMREQUEST => $method,
+					CURLOPT_POST          => true,
+					CURLOPT_POSTFIELDS    => json_encode(array_filter($postFields))
+				]);
+				break;
+
+			/** @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.3 */
+			case Request::METHOD_GET:
+				$curl->setOption(CURLOPT_HTTPGET, true);
+				break;
+
+			/** @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.4 */
+			case Request::METHOD_HEAD:
+				$curl->setOption([
+					CURLOPT_CUSTOMREQUEST => $method,
+					CURLOPT_NOBODY        => true
+				]);
+				break;
+
+			/** @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.5 */
+			case Request::METHOD_POST:
+				$curl->setOption([
+					CURLOPT_POST       => true,
+					CURLOPT_POSTFIELDS => json_encode(array_filter($postFields))
+				]);
+				break;
+
+			/** @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.6 */
+			case Request::METHOD_PUT:
+				$curl->setOption([
+					CURLOPT_CUSTOMREQUEST => $method,
+					CURLOPT_PUT           => true,
+					CURLOPT_HTTPHEADER    => [
+						'X-HTTP-Method-Override: PUT',
+						'Content-type: application/x-www-form-urlencoded'
+					]
+				]);
+				break;
+
+			default:
+				break;
+		}
+
+		$curl->success(function (CurlClient $instance) {
+			$this->headers = $instance->getHeaders();
+			$this->success = $instance->getResponse();
+			$data          = json_decode($this->success, true);
+			if (JSON_ERROR_NONE === json_last_error()) {
+				$this->success = $data;
+			}
+		});
+		$curl->error(function (CurlClient $instance) {
+			$this->headers = $instance->getHeaders();
+			$this->failure = $instance->getResponse();
+			$data          = json_decode($this->failure, true);
+			if (JSON_ERROR_NONE === json_last_error()) {
+				$this->failure = $data;
+			}
+		});
+		$curl->perform();
+
+		return (array)($this->success ?? $this->failure);
+	}
+
+	/**
+	 * Return a formatted string. Modified version of sprintf using colon(:)
+	 *
+	 * @param string $string
+	 * @param array  $params
+	 *
+	 * @return String
+	 * @throws Exception
+	 */
+	public function sprintf(string $string, ...$params): string
+	{
+		preg_match_all('/\:([A-Za-z0-9_]+)/', $string, $matches);
+		$matches = $matches[1];
+
+		if (count($matches)) {
+			$tokens   = [];
+			$replaces = [];
+
+			foreach ($matches as $key => $value) {
+				if (count($params) > 1 || !is_array($params[0])) {
+					if (!array_key_exists($key, $params)) {
+						throw new Exception('Too few arguments, missing argument: ' . $key);
+					}
+					$replaces[] = $params[$key];
+				} else {
+					if (!array_key_exists($value, $params[0])) {
+						throw new Exception('Missing array argument: ' . $key);
+					}
+					$replaces[] = $params[0][$value];
+				}
+				$tokens[] = ':' . $value;
+			}
+
+			$string = str_replace($tokens, $replaces, $string);
+		}
+
+		return $string;
+	}
 }
\ No newline at end of file

lib/GitHub/Client.php

Indentation +27 added lines, -27 removed lines

@@ -12,35 +12,35 @@
 class Client extends AbstractApi
 {
 
-    /** Receiver constants */
-    const ACTIVITY      = 'Activity';
-    const ENTERPRISE    = 'Enterprise';
-    const GISTS         = 'Gists';
-    const GIT_DATA      = 'GitData';
-    const ISSUES        = 'Issues';
-    const MISCELLANEOUS = 'Miscellaneous';
-    const ORGANIZATIONS = 'Organizations';
-    const PULL_REQUESTS = 'PullRequests';
-    const REPOSITORIES  = 'Repositories';
-    const SEARCH        = 'Search';
-    const USERS         = 'Users';
+	/** Receiver constants */
+	const ACTIVITY      = 'Activity';
+	const ENTERPRISE    = 'Enterprise';
+	const GISTS         = 'Gists';
+	const GIT_DATA      = 'GitData';
+	const ISSUES        = 'Issues';
+	const MISCELLANEOUS = 'Miscellaneous';
+	const ORGANIZATIONS = 'Organizations';
+	const PULL_REQUESTS = 'PullRequests';
+	const REPOSITORIES  = 'Repositories';
+	const SEARCH        = 'Search';
+	const USERS         = 'Users';
 
-    /**
-     * Returns receiver object
-     *
-     * @param string $receiver
-     *
-     * @return null|AbstractReceiver
-     */
-    public function getReceiver(string $receiver)
-    {
-        $class = (string)$this->sprintf(':namespace\Receiver\:receiver', __NAMESPACE__, $receiver);
+	/**
+	 * Returns receiver object
+	 *
+	 * @param string $receiver
+	 *
+	 * @return null|AbstractReceiver
+	 */
+	public function getReceiver(string $receiver)
+	{
+		$class = (string)$this->sprintf(':namespace\Receiver\:receiver', __NAMESPACE__, $receiver);
 
-        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/Receiver/Users.php

Indentation +73 added lines, -73 removed lines

@@ -12,81 +12,81 @@
 class Users extends AbstractReceiver
 {
 
-    /** Available sub-Receiver */
-    const EMAILS      = 'Emails';
-    const FOLLOWERS   = 'Followers';
-    const PUBLIC_KEYS = 'PublicKeys';
+	/** Available sub-Receiver */
+	const EMAILS      = 'Emails';
+	const FOLLOWERS   = 'Followers';
+	const PUBLIC_KEYS = 'PublicKeys';
 
-    /**
-     * Get a single user
-     *
-     * @link https://developer.github.com/v3/users/#get-a-single-user
-     *
-     * @param string $username
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function getSingleUser(string $username): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/users/:username', $username));
-    }
+	/**
+	 * Get a single user
+	 *
+	 * @link https://developer.github.com/v3/users/#get-a-single-user
+	 *
+	 * @param string $username
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function getSingleUser(string $username): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/users/:username', $username));
+	}
 
-    /**
-     * Get the authenticated user
-     *
-     * @link https://developer.github.com/v3/users/#get-the-authenticated-user
-     * @return array
-     * @throws \Exception
-     */
-    public function getUser(): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/user'));
-    }
+	/**
+	 * Get the authenticated user
+	 *
+	 * @link https://developer.github.com/v3/users/#get-the-authenticated-user
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function getUser(): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/user'));
+	}
 
-    /**
-     * Update the authenticated user
-     *
-     * @link https://developer.github.com/v3/users/#update-the-authenticated-user
-     *
-     * @param string $name
-     * @param string $email
-     * @param string $blog
-     * @param string $company
-     * @param string $location
-     * @param bool   $hireable
-     * @param string $bio
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function updateUser(string $name = null, string $email = null, string $blog = null, string $company = null,
-                               string $location = null, bool $hireable = false, string $bio = null): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/user'), Request::METHOD_PATCH, [
-                'name'     => $name,
-                'email'    => $email,
-                'blog'     => $blog,
-                'company'  => $company,
-                'location' => $location,
-                'hireable' => $hireable,
-                'bio'      => $bio
-            ]);
-    }
+	/**
+	 * Update the authenticated user
+	 *
+	 * @link https://developer.github.com/v3/users/#update-the-authenticated-user
+	 *
+	 * @param string $name
+	 * @param string $email
+	 * @param string $blog
+	 * @param string $company
+	 * @param string $location
+	 * @param bool   $hireable
+	 * @param string $bio
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function updateUser(string $name = null, string $email = null, string $blog = null, string $company = null,
+							   string $location = null, bool $hireable = false, string $bio = null): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/user'), Request::METHOD_PATCH, [
+				'name'     => $name,
+				'email'    => $email,
+				'blog'     => $blog,
+				'company'  => $company,
+				'location' => $location,
+				'hireable' => $hireable,
+				'bio'      => $bio
+			]);
+	}
 
-    /**
-     * Get all users
-     *
-     * @link https://developer.github.com/v3/users/#get-all-users
-     *
-     * @param string $since
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function getAllUsers(string $since = null): array
-    {
-        return $this->getApi()->request($this->getApi()
-                                             ->sprintf('/users?:args', http_build_query(['since' => $since])));
-    }
+	/**
+	 * Get all users
+	 *
+	 * @link https://developer.github.com/v3/users/#get-all-users
+	 *
+	 * @param string $since
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function getAllUsers(string $since = null): array
+	{
+		return $this->getApi()->request($this->getApi()
+											 ->sprintf('/users?:args', http_build_query(['since' => $since])));
+	}
 }
\ No newline at end of file

lib/GitHub/Receiver/Search.php

Indentation +75 added lines, -75 removed lines

@@ -12,83 +12,83 @@
 class Search extends AbstractReceiver
 {
 
-    /** Available sub-Receiver */
-    const REPOSITORIES  = 'Repositories';
-    const CODE          = 'Code';
-    const ISSUES        = 'Issues';
-    const USERS         = 'Users';
-    const LEGACY_SEARCH = 'LegacySearch';
+	/** Available sub-Receiver */
+	const REPOSITORIES  = 'Repositories';
+	const CODE          = 'Code';
+	const ISSUES        = 'Issues';
+	const USERS         = 'Users';
+	const LEGACY_SEARCH = 'LegacySearch';
 
-    /**
-     * Search repositories
-     *
-     * @link https://developer.github.com/v3/search/#search-repositories
-     *
-     * @param string $q
-     * @param string $sort
-     * @param string $order
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function searchRepositories(string $q, string $sort = null,
-                                       string $order = AbstractApi::DIRECTION_DESC): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/search/repositories?:args',
-            http_build_query(['q' => $q, 'sort' => $sort, 'order' => $order])));
-    }
+	/**
+	 * Search repositories
+	 *
+	 * @link https://developer.github.com/v3/search/#search-repositories
+	 *
+	 * @param string $q
+	 * @param string $sort
+	 * @param string $order
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function searchRepositories(string $q, string $sort = null,
+									   string $order = AbstractApi::DIRECTION_DESC): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/search/repositories?:args',
+			http_build_query(['q' => $q, 'sort' => $sort, 'order' => $order])));
+	}
 
-    /**
-     * Search code
-     *
-     * @link https://developer.github.com/v3/search/#search-code
-     *
-     * @param string $q
-     * @param string $sort
-     * @param string $order
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function searchCode(string $q, string $sort = null, string $order = AbstractApi::DIRECTION_DESC): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/search/code?:args',
-            http_build_query(['q' => $q, 'sort' => $sort, 'order' => $order])));
-    }
+	/**
+	 * Search code
+	 *
+	 * @link https://developer.github.com/v3/search/#search-code
+	 *
+	 * @param string $q
+	 * @param string $sort
+	 * @param string $order
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function searchCode(string $q, string $sort = null, string $order = AbstractApi::DIRECTION_DESC): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/search/code?:args',
+			http_build_query(['q' => $q, 'sort' => $sort, 'order' => $order])));
+	}
 
-    /**
-     * Search issues
-     *
-     * @link https://developer.github.com/v3/search/#search-issues
-     *
-     * @param string $q
-     * @param string $sort
-     * @param string $order
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function searchIssues(string $q, string $sort = null, string $order = AbstractApi::DIRECTION_DESC): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/search/issues?:args',
-            http_build_query(['q' => $q, 'sort' => $sort, 'order' => $order])));
-    }
+	/**
+	 * Search issues
+	 *
+	 * @link https://developer.github.com/v3/search/#search-issues
+	 *
+	 * @param string $q
+	 * @param string $sort
+	 * @param string $order
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function searchIssues(string $q, string $sort = null, string $order = AbstractApi::DIRECTION_DESC): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/search/issues?:args',
+			http_build_query(['q' => $q, 'sort' => $sort, 'order' => $order])));
+	}
 
-    /**
-     * Search users
-     *
-     * @link https://developer.github.com/v3/search/#search-users
-     *
-     * @param string $q
-     * @param string $sort
-     * @param string $order
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function searchUsers(string $q, string $sort = null, string $order = AbstractApi::DIRECTION_DESC): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/search/users?:args',
-            http_build_query(['q' => $q, 'sort' => $sort, 'order' => $order])));
-    }
+	/**
+	 * Search users
+	 *
+	 * @link https://developer.github.com/v3/search/#search-users
+	 *
+	 * @param string $q
+	 * @param string $sort
+	 * @param string $order
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function searchUsers(string $q, string $sort = null, string $order = AbstractApi::DIRECTION_DESC): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/search/users?:args',
+			http_build_query(['q' => $q, 'sort' => $sort, 'order' => $order])));
+	}
 }
\ No newline at end of file

lib/GitHub/Receiver/Enterprise.php

Indentation +6 added lines, -6 removed lines

@@ -12,10 +12,10 @@
 class Enterprise extends AbstractReceiver
 {
 
-    /** Available sub-Receiver */
-    const ADMIN_STATS        = 'AdminStats';
-    const LDAP               = 'Ldap';
-    const LICENSE            = 'License';
-    const MANAGEMENT_CONSOLE = 'ManagementConsole';
-    const SEARCH_INDEXING    = 'SearchIndexing';
+	/** Available sub-Receiver */
+	const ADMIN_STATS        = 'AdminStats';
+	const LDAP               = 'Ldap';
+	const LICENSE            = 'License';
+	const MANAGEMENT_CONSOLE = 'ManagementConsole';
+	const SEARCH_INDEXING    = 'SearchIndexing';
 }
\ No newline at end of file

lib/GitHub/Receiver/Users/Followers.php

Indentation +126 added lines, -126 removed lines

@@ -12,130 +12,130 @@
 class Followers extends AbstractUsers
 {
 
-    /**
-     * List followers of a user
-     *
-     * @link https://developer.github.com/v3/users/followers/#list-followers-of-a-user
-     *
-     * @param null|string $username
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function listFollowers(string $username = null): array
-    {
-        $url = '/user/followers';
-        if (null !== $username) {
-            $url = $this->getApi()->sprintf('/users/:username/followers', $username);
-        }
-
-        return $this->getApi()->request($url);
-    }
-
-    /**
-     * List users followed by another user
-     *
-     * @link https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user
-     *
-     * @param null|string $username
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function listUsersFollowedBy(string $username = null): array
-    {
-        $url = '/user/following';
-        if (null !== $username) {
-            $url = $this->getApi()->sprintf('/users/:username/following', $username);
-        }
-
-        return $this->getApi()->request($url);
-    }
-
-    /**
-     * Check if you are following a user
-     *
-     * @link https://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user
-     *
-     * @param string $username
-     *
-     * @return bool
-     * @throws \Exception
-     */
-    public function checkFollowingUser(string $username): bool
-    {
-        $this->getApi()->request($this->getApi()->sprintf('/user/following/:username', $username));
-
-        if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
-            return true;
-        }
-
-        return false;
-    }
-
-    /**
-     * Check if one user follows another
-     *
-     * @link https://developer.github.com/v3/users/followers/#check-if-one-user-follows-another
-     *
-     * @param string $username
-     * @param string $targetUser
-     *
-     * @return bool
-     * @throws \Exception
-     */
-    public function checkUserFollowsAnother(string $username, string $targetUser): bool
-    {
-        $this->getApi()->request($this->getApi()
-                                      ->sprintf('/users/:username/following/:target_user', $username, $targetUser));
-
-        if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
-            return true;
-        }
-
-        return false;
-    }
-
-    /**
-     * Follow a user
-     *
-     * @link https://developer.github.com/v3/users/followers/#follow-a-user
-     *
-     * @param string $username
-     *
-     * @return bool
-     * @throws \Exception
-     */
-    public function followUser(string $username): bool
-    {
-        $this->getApi()->request($this->getApi()->sprintf('/user/following/:username', $username), Request::METHOD_PUT);
-
-        if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
-            return true;
-        }
-
-        return false;
-    }
-
-    /**
-     * Unfollow a user
-     *
-     * @link https://developer.github.com/v3/users/followers/#unfollow-a-user
-     *
-     * @param string $username
-     *
-     * @return bool
-     * @throws \Exception
-     */
-    public function unfollowUser(string $username): bool
-    {
-        $this->getApi()->request($this->getApi()->sprintf('/user/following/:username', $username),
-            Request::METHOD_DELETE);
-
-        if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
-            return true;
-        }
-
-        return false;
-    }
+	/**
+	 * List followers of a user
+	 *
+	 * @link https://developer.github.com/v3/users/followers/#list-followers-of-a-user
+	 *
+	 * @param null|string $username
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function listFollowers(string $username = null): array
+	{
+		$url = '/user/followers';
+		if (null !== $username) {
+			$url = $this->getApi()->sprintf('/users/:username/followers', $username);
+		}
+
+		return $this->getApi()->request($url);
+	}
+
+	/**
+	 * List users followed by another user
+	 *
+	 * @link https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user
+	 *
+	 * @param null|string $username
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function listUsersFollowedBy(string $username = null): array
+	{
+		$url = '/user/following';
+		if (null !== $username) {
+			$url = $this->getApi()->sprintf('/users/:username/following', $username);
+		}
+
+		return $this->getApi()->request($url);
+	}
+
+	/**
+	 * Check if you are following a user
+	 *
+	 * @link https://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user
+	 *
+	 * @param string $username
+	 *
+	 * @return bool
+	 * @throws \Exception
+	 */
+	public function checkFollowingUser(string $username): bool
+	{
+		$this->getApi()->request($this->getApi()->sprintf('/user/following/:username', $username));
+
+		if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
+			return true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Check if one user follows another
+	 *
+	 * @link https://developer.github.com/v3/users/followers/#check-if-one-user-follows-another
+	 *
+	 * @param string $username
+	 * @param string $targetUser
+	 *
+	 * @return bool
+	 * @throws \Exception
+	 */
+	public function checkUserFollowsAnother(string $username, string $targetUser): bool
+	{
+		$this->getApi()->request($this->getApi()
+									  ->sprintf('/users/:username/following/:target_user', $username, $targetUser));
+
+		if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
+			return true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Follow a user
+	 *
+	 * @link https://developer.github.com/v3/users/followers/#follow-a-user
+	 *
+	 * @param string $username
+	 *
+	 * @return bool
+	 * @throws \Exception
+	 */
+	public function followUser(string $username): bool
+	{
+		$this->getApi()->request($this->getApi()->sprintf('/user/following/:username', $username), Request::METHOD_PUT);
+
+		if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
+			return true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Unfollow a user
+	 *
+	 * @link https://developer.github.com/v3/users/followers/#unfollow-a-user
+	 *
+	 * @param string $username
+	 *
+	 * @return bool
+	 * @throws \Exception
+	 */
+	public function unfollowUser(string $username): bool
+	{
+		$this->getApi()->request($this->getApi()->sprintf('/user/following/:username', $username),
+			Request::METHOD_DELETE);
+
+		if ($this->getApi()->getHeaders()['Status'] == '204 No Content') {
+			return true;
+		}
+
+		return false;
+	}
 } 
\ No newline at end of file

lib/GitHub/Receiver/Users/Emails.php

Indentation +43 added lines, -43 removed lines

@@ -12,51 +12,51 @@
 class Emails extends AbstractUsers
 {
 
-    /**
-     * List email addresses for a user
-     *
-     * @link https://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user
-     * @return array
-     * @throws \Exception
-     */
-    public function listEmailAddresses(): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/user/emails'));
-    }
+	/**
+	 * List email addresses for a user
+	 *
+	 * @link https://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function listEmailAddresses(): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/user/emails'));
+	}
 
-    /**
-     * Add email address(es)
-     *
-     * @link https://developer.github.com/v3/users/emails/#add-email-addresses
-     *
-     * @param array $addresses
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function addEmailAddress(array $addresses = []): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/user/emails'), Request::METHOD_POST, $addresses);
-    }
+	/**
+	 * Add email address(es)
+	 *
+	 * @link https://developer.github.com/v3/users/emails/#add-email-addresses
+	 *
+	 * @param array $addresses
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function addEmailAddress(array $addresses = []): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/user/emails'), Request::METHOD_POST, $addresses);
+	}
 
-    /**
-     * Delete email address(es)
-     *
-     * @link https://developer.github.com/v3/users/emails/#delete-email-addresses
-     *
-     * @param array $addresses
-     *
-     * @return bool
-     * @throws \Exception
-     */
-    public function deleteEmailAddress(array $addresses = []): bool
-    {
-        $this->getApi()->request($this->getApi()->sprintf('/user/emails'), Request::METHOD_DELETE, $addresses);
+	/**
+	 * Delete email address(es)
+	 *
+	 * @link https://developer.github.com/v3/users/emails/#delete-email-addresses
+	 *
+	 * @param array $addresses
+	 *
+	 * @return bool
+	 * @throws \Exception
+	 */
+	public function deleteEmailAddress(array $addresses = []): bool
+	{
+		$this->getApi()->request($this->getApi()->sprintf('/user/emails'), Request::METHOD_DELETE, $addresses);
 
-        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/Receiver/Users/PublicKeys.php

Indentation +65 added lines, -65 removed lines

@@ -12,73 +12,73 @@
 class PublicKeys extends AbstractUsers
 {
 
-    /**
-     * List public keys for a user
-     *
-     * @link https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user
-     *
-     * @param string $username
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function listUserPublicKeys(string $username): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/users/:username/keys', $username));
-    }
+	/**
+	 * List public keys for a user
+	 *
+	 * @link https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user
+	 *
+	 * @param string $username
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function listUserPublicKeys(string $username): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/users/:username/keys', $username));
+	}
 
-    /**
-     * List your public keys
-     *
-     * @link https://developer.github.com/v3/users/keys/#list-your-public-keys
-     * @return array
-     * @throws \Exception
-     */
-    public function listYourPublicKeys(): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/user/keys'));
-    }
+	/**
+	 * List your public keys
+	 *
+	 * @link https://developer.github.com/v3/users/keys/#list-your-public-keys
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function listYourPublicKeys(): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/user/keys'));
+	}
 
-    /**
-     * Get a single public key
-     *
-     * @link https://developer.github.com/v3/users/keys/#get-a-single-public-key
-     *
-     * @param int $id
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function getSinglePublicKey(int $id): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/user/keys/:id', (string)$id));
-    }
+	/**
+	 * Get a single public key
+	 *
+	 * @link https://developer.github.com/v3/users/keys/#get-a-single-public-key
+	 *
+	 * @param int $id
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function getSinglePublicKey(int $id): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/user/keys/:id', (string)$id));
+	}
 
-    /**
-     * Create a public key
-     *
-     * @link https://developer.github.com/v3/users/keys/#create-a-public-key
-     * @return array
-     * @throws \Exception
-     */
-    public function createPublicKey(): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/user/keys'), Request::METHOD_POST);
-    }
+	/**
+	 * Create a public key
+	 *
+	 * @link https://developer.github.com/v3/users/keys/#create-a-public-key
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function createPublicKey(): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/user/keys'), Request::METHOD_POST);
+	}
 
-    /**
-     * Delete a public key
-     *
-     * @link https://developer.github.com/v3/users/keys/#delete-a-public-key
-     *
-     * @param int $id
-     *
-     * @return array
-     * @throws \Exception
-     */
-    public function deletePublicKey(int $id): array
-    {
-        return $this->getApi()->request($this->getApi()->sprintf('/user/keys/:id', (string)$id),
-            Request::METHOD_DELETE);
-    }
+	/**
+	 * Delete a public key
+	 *
+	 * @link https://developer.github.com/v3/users/keys/#delete-a-public-key
+	 *
+	 * @param int $id
+	 *
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function deletePublicKey(int $id): array
+	{
+		return $this->getApi()->request($this->getApi()->sprintf('/user/keys/:id', (string)$id),
+			Request::METHOD_DELETE);
+	}
 }
\ No newline at end of file

lib/GitHub/Receiver/Miscellaneous/Emojis.php

Indentation +10 added lines, -10 removed lines

@@ -10,14 +10,14 @@
 class Emojis extends AbstractMiscellaneous
 {
 
-    /**
-     * Lists all the emojis available to use on GitHub.
-     *
-     * @link https://developer.github.com/v3/emojis/#emojis
-     * @return array
-     */
-    public function get(): array
-    {
-        return $this->getApi()->request('/emojis');
-    }
+	/**
+	 * Lists all the emojis available to use on GitHub.
+	 *
+	 * @link https://developer.github.com/v3/emojis/#emojis
+	 * @return array
+	 */
+	public function get(): array
+	{
+		return $this->getApi()->request('/emojis');
+	}
 } 
\ No newline at end of file