Tenside\Core\Composer\AuthJson

Complexity

Total Complexity

17

Size/Duplication

Total Lines	271
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	setGithubOAuthToken()	0	6	1
A	getGithubOAuthToken()	0	4	1
A	removeGithubOAuthToken()	0	6	1
A	setGitlabOAuthToken()	0	6	1
A	getGitlabOAuthToken()	0	4	1
A	removeGitlabOAuthToken()	0	6	1
A	setGitlabPrivateToken()	0	6	1
A	getGitlabPrivateToken()	0	4	1
A	removeGitlabPrivateToken()	0	6	1
A	setBitbucketOAuth()	0	9	1
A	getBitbucketOAuthKey()	0	4	1
A	getBitbucketOAuthSecret()	0	4	1
A	removeBitbucketOAuth()	0	6	1
A	setHttpBasic()	0	9	1
A	getHttpBasicUser()	0	4	1
A	getHttpBasicPassword()	0	4	1
A	removeHttpBasic()	0	6	1

<?php

/**
 * This file is part of tenside/core.
 *
 * (c) Christian Schiffler <c.schiffler@cyberspectrum.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * This project is provided in good faith and hope to be usable by anyone.
 *
 * @package    tenside/core
 * @author     Christian Schiffler <c.schiffler@cyberspectrum.de>
 * @copyright  2015 Christian Schiffler <c.schiffler@cyberspectrum.de>
 * @license    https://github.com/tenside/core/blob/master/LICENSE MIT
 * @link       https://github.com/tenside/core
 * @filesource
 */

namespace Tenside\Core\Composer;

use Tenside\Core\Util\JsonFile;

/**
 * This class abstracts the auth.json file manipulation.
 */
class AuthJson extends JsonFile
{
    /**
     * Const for github oauth tokens.
     */
    const GITHUB_OAUTH_KEY = 'github-oauth';

    /**
     * Const for gitlab oauth tokens.
     */
    const GITLAB_OAUTH_KEY = 'gitlab-oauth';

    /**
     * Const for gitlab private tokens.
     */
    const GITLAB_PRIVATE_KEY = 'gitlab-token';

    /**
     * Const for bitbucket tokens.
     */
    const BITBUCKET_OAUTH_KEY = 'bitbucket-oauth';

    /**
     * Const for htt-basic auth.
     */
    const HTTP_BASIC_KEY = 'http-basic';

    /**
     * Set a github OAuth token.
     *
     * @param string $token  The token.
     *
     * @param string $domain The domain.
     *
     * @return AuthJson
     */
    public function setGithubOAuthToken($token, $domain = 'github.com')
    {
        $this->set(self::GITHUB_OAUTH_KEY . '/' . $this->escape($domain), $token);

        return $this;
    }

    /**
     * Get a github OAuth token.
     *
     * @param string $domain The domain.
     *
     * @return string|null

Should the return type not be array|string|integer|null? Also, consider making the array more specific, something like array<String>, or String[].

     */
    public function getGithubOAuthToken($domain = 'github.com')
    {
        return $this->get(self::GITHUB_OAUTH_KEY . '/' . $this->escape($domain));
    }

    /**
     * Unset a github OAuth token.
     *
     * @param string $domain The domain.
     *
     * @return AuthJson
     */
    public function removeGithubOAuthToken($domain = 'github.com')
    {
        $this->remove(self::GITHUB_OAUTH_KEY . '/' . $this->escape($domain));

        return $this;
    }

    /**
     * Set a gitlab OAuth token.
     *
     * @param string $token  The token.
     *
     * @param string $domain The domain.
     *
     * @return AuthJson
     */
    public function setGitlabOAuthToken($token, $domain = 'gitlab.com')
    {
        $this->set(self::GITLAB_OAUTH_KEY . '/' . $this->escape($domain), $token);

        return $this;
    }

    /**
     * Get a gitlab OAuth token.
     *
     * @param string $domain The domain.
     *
     * @return string|null

Should the return type not be array|string|integer|null? Also, consider making the array more specific, something like array<String>, or String[].

     */
    public function getGitlabOAuthToken($domain = 'gitlab.com')
    {
        return $this->get(self::GITLAB_OAUTH_KEY . '/' . $this->escape($domain));
    }

    /**
     * Unset a gitlab OAuth token.
     *
     * @param string $domain The domain.
     *
     * @return AuthJson
     */
    public function removeGitlabOAuthToken($domain = 'gitlab.com')
    {
        $this->remove(self::GITLAB_OAUTH_KEY . '/' . $this->escape($domain));

        return $this;
    }

    /**
     * Set a gitlab private token.
     *
     * @param string $token  The token.
     *
     * @param string $domain The domain.
     *
     * @return AuthJson
     */
    public function setGitlabPrivateToken($token, $domain = 'gitlab.com')
    {
        $this->set(self::GITLAB_PRIVATE_KEY . '/' . $this->escape($domain), $token);

        return $this;
    }

    /**
     * Get a gitlab private token.
     *
     * @param string $domain The domain.
     *
     * @return string|null

Should the return type not be array|string|integer|null? Also, consider making the array more specific, something like array<String>, or String[].

     */
    public function getGitlabPrivateToken($domain = 'gitlab.com')
    {
        return $this->get(self::GITLAB_PRIVATE_KEY . '/' . $this->escape($domain));
    }

    /**
     * Unset a gitlab private token.
     *
     * @param string $domain The domain.
     *
     * @return AuthJson
     */
    public function removeGitlabPrivateToken($domain = 'gitlab.com')
    {
        $this->remove(self::GITLAB_PRIVATE_KEY . '/' . $this->escape($domain));

        return $this;
    }

    /**
     * Set Bitbucket OAuth.
     *
     * @param string $key    The consumer key.
     *
     * @param string $secret The consumer secret.
     *
     * @param string $domain The domain.
     *
     * @return AuthJson
     */
    public function setBitbucketOAuth($key, $secret, $domain = 'bitbucket.org')
    {
        $this->set(
            self::BITBUCKET_OAUTH_KEY . '/' . $this->escape($domain),
            ['consumer-key' => $key, 'consumer-secret' => $secret]
        );

        return $this;
    }

    /**
     * Get Bitbucket OAuth key.
     *
     * @param string $domain The domain.
     *
     * @return string|null

Should the return type not be array|string|integer|null? Also, consider making the array more specific, something like array<String>, or String[].

     */
    public function getBitbucketOAuthKey($domain = 'bitbucket.org')
    {
        return $this->get(self::BITBUCKET_OAUTH_KEY . '/' . $this->escape($domain) . '/consumer-key');
    }

    /**
     * Get Bitbucket OAuth secret.
     *
     * @param string $domain The domain.
     *
     * @return string|null

Should the return type not be array|string|integer|null? Also, consider making the array more specific, something like array<String>, or String[].

     */
    public function getBitbucketOAuthSecret($domain = 'bitbucket.org')
    {
        return $this->get(self::BITBUCKET_OAUTH_KEY . '/' . $this->escape($domain) . '/consumer-secret');
    }

    /**
     * Unset a Bitbucket token.
     *
     * @param string $domain The domain.
     *
     * @return AuthJson
     */
    public function removeBitbucketOAuth($domain = 'bitbucket.org')
    {
        $this->remove(self::BITBUCKET_OAUTH_KEY . '/' . $this->escape($domain));

        return $this;
    }

    /**
     * Set http-basic auth.
     *
     * @param string $username The consumer key.
     *
     * @param string $password The consumer secret.
     *
     * @param string $domain   The domain.
     *
     * @return AuthJson
     */
    public function setHttpBasic($username, $password, $domain)
    {
        $this->set(
            self::HTTP_BASIC_KEY . '/' . $this->escape($domain),
            ['username' => $username, 'password' => $password]
        );

        return $this;
    }

    /**
     * Get http-basic auth user name.
     *
     * @param string $domain The domain.
     *
     * @return string|null

Should the return type not be array|string|integer|null? Also, consider making the array more specific, something like array<String>, or String[].

     */
    public function getHttpBasicUser($domain)
    {
        return $this->get(self::HTTP_BASIC_KEY . '/' . $this->escape($domain) . '/username');
    }

    /**
     * Get http-basic auth password.
     *
     * @param string $domain The domain.
     *
     * @return string|null

Should the return type not be array|string|integer|null? Also, consider making the array more specific, something like array<String>, or String[].

     */
    public function getHttpBasicPassword($domain)
    {
        return $this->get(self::HTTP_BASIC_KEY . '/' . $this->escape($domain) . '/password');
    }

    /**
     * Unset http-basic auth.
     *
     * @param string $domain The domain.
     *
     * @return AuthJson
     */
    public function removeHttpBasic($domain)
    {
        $this->remove(self::HTTP_BASIC_KEY . '/' . $this->escape($domain));

        return $this;
    }
}