Acquia\Rest\SignatureAbstract

Complexity

Total Complexity

13

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Test Coverage

Coverage

96.77%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
	generate()	0	1	?
A	getSecretKey()	0	4	1
A	setDefaultNoncerClass()	0	4	1
A	getDefaultNoncerClass()	0	4	1
A	getNoncer()	0	10	3
A	generateNonce()	0	4	1
A	getNonce()	0	4	1
A	setRequestTime()	0	5	1
A	unsetRequestTime()	0	5	1
A	getRequestTime()	0	5	2

<?php

namespace Acquia\Rest;

abstract class SignatureAbstract
{
    /**
     * @var string
     */
    protected $secretKey;

    /**
     * @var \Acquia\Rest\NoncerInterface
     */
    private $noncer;

    /**
     * @var int
     */
    private $requestTime = 0;

    /**
     * @var int
     */
    protected $noncerLength = NoncerAbstract::DEFAULT_LENGTH;

    /**
     * @var string
     */
    protected static $defaultNoncerClass = 'Acquia\Rest\RandomStringNoncer';

    /**
     * @param string $secretKey
     */
    public function __construct($secretKey)
    {
        $this->secretKey = $secretKey;
    }

    /**
     * @param mixed $data
     *
     * @return string
     */
    abstract public function generate($data);

    /**
     * Returns the shared secret.
     *
     * @return string
     */
    public function getSecretKey()
    {
        return $this->secretKey;
    }

    /**
     * @param string $class
     */
    public static function setDefaultNoncerClass($class)
    {
        self::$defaultNoncerClass = $class;
    }

    /**
     * @return string
     */
    public static function getDefaultNoncerClass()
    {
        return self::$defaultNoncerClass;
    }

    /**
     * Returns a noncer, instantiates it if it doesn't exist.
     *
     * @return \Acquia\Rest\NoncerInterface
     *
     * @throws \UnexpectedValueException
     */
    public function getNoncer()
    {
        if (!isset($this->noncer)) {
            $this->noncer = new self::$defaultNoncerClass($this->noncerLength);
            if (!$this->noncer instanceof NoncerInterface) {
                throw new \UnexpectedValueException('Noncer must implement Acquia\Rest\NoncerInterface');
            }
        }
        return $this->noncer;
    }

    /**
     * @return string
     */
    public function generateNonce()
    {
        return $this->getNoncer()->generate();
    }

    /**
     * Returns the last nonce that was generated.
     *
     * @return string
     */
    public function getNonce()
    {
        return $this->getNoncer()->getLastNonce();
    }

    /**
     * @param int $requestTime
     *
     * @return \Acquia\Rest\SignatureAbstract
     */
    public function setRequestTime($requestTime)
    {
        $this->requestTime = $requestTime;
        return $this;
    }

    /**
     * @return \Acquia\Rest\SignatureAbstract
     */
    public function unsetRequestTime()
    {
        $this->requestTime = 0;
        return $this;
    }

    /**
     * @return int
     */
    public function getRequestTime()
    {
        $this->requestTime = $this->requestTime ?: time();
        return $this->requestTime;
    }
}