Surfnet\StepupMiddlewareClientBundle\Identity\Service\SecondFactorService

Complexity

Total Complexity

19

Size/Duplication

Total Lines	196
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes	8
Bugs	0	Features	2

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getUnverified()	0	20	3
A	getVerified()	0	20	3
A	getVetted()	0	20	3
A	searchUnverified()	0	20	3
A	searchVerified()	0	20	3
A	searchVetted()	0	20	3

<?php

/**
 * Copyright 2014 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\StepupMiddlewareClientBundle\Identity\Service;

use Surfnet\StepupMiddlewareClient\Exception\AccessDeniedToResourceException;
use Surfnet\StepupMiddlewareClient\Exception\MalformedResponseException;
use Surfnet\StepupMiddlewareClient\Exception\ResourceReadException;
use Surfnet\StepupMiddlewareClient\Identity\Dto\UnverifiedSecondFactorSearchQuery;
use Surfnet\StepupMiddlewareClient\Identity\Dto\VerifiedSecondFactorSearchQuery;
use Surfnet\StepupMiddlewareClient\Identity\Dto\VettedSecondFactorSearchQuery;
use Surfnet\StepupMiddlewareClient\Identity\Service\SecondFactorService as LibrarySecondFactorService;
use Surfnet\StepupMiddlewareClientBundle\Exception\InvalidResponseException;
use Surfnet\StepupMiddlewareClientBundle\Identity\Dto\UnverifiedSecondFactor;
use Surfnet\StepupMiddlewareClientBundle\Identity\Dto\UnverifiedSecondFactorCollection;
use Surfnet\StepupMiddlewareClientBundle\Identity\Dto\VerifiedSecondFactor;
use Surfnet\StepupMiddlewareClientBundle\Identity\Dto\VerifiedSecondFactorCollection;
use Surfnet\StepupMiddlewareClientBundle\Identity\Dto\VettedSecondFactor;
use Surfnet\StepupMiddlewareClientBundle\Identity\Dto\VettedSecondFactorCollection;
use Symfony\Component\Validator\Validator\ValidatorInterface;

/**
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
class SecondFactorService
{
    /**
     * @var LibrarySecondFactorService
     */
    private $service;

    /**
     * @var ValidatorInterface
     */
    private $validator;

    /**
     * @param LibrarySecondFactorService $service
     * @param ValidatorInterface $validator
     */
    public function __construct(LibrarySecondFactorService $service, ValidatorInterface $validator)
    {
        $this->service = $service;
        $this->validator = $validator;
    }

    /**
     * @param string $secondFactorId
     * @return UnverifiedSecondFactor|null
     * @throws AccessDeniedToResourceException When the consumer isn't authorised to access given resource.
     * @throws InvalidResponseException When the API responded with invalid data.
     * @throws ResourceReadException When the API doesn't respond with the resource.
     * @throws MalformedResponseException When the API doesn't respond with a proper response.
     */
    public function getUnverified($secondFactorId)
    {
        $data = $this->service->getUnverified($secondFactorId);

        if ($data === null) {
            return null;
        }

        $secondFactor = UnverifiedSecondFactor::fromData($data);
        $violations = $this->validator->validate($secondFactor);

        if (count($violations) > 0) {
            throw InvalidResponseException::withViolations(
                "Unverified second factor retrieved from the Middleware was invalid",

The string literal Unverified second factor retrieved from the Middleware was invalid does not require double quotes, as per coding-style, please use single quotes.

                $violations
            );
        }

        return $secondFactor;
    }

    /**
     * @param string $secondFactorId
     * @return VerifiedSecondFactor|null
     * @throws AccessDeniedToResourceException When the consumer isn't authorised to access given resource.
     * @throws InvalidResponseException When the API responded with invalid data.
     * @throws ResourceReadException When the API doesn't respond with the resource.
     * @throws MalformedResponseException When the API doesn't respond with a proper response.
     */
    public function getVerified($secondFactorId)
    {
        $data = $this->service->getVerified($secondFactorId);

        if ($data === null) {
            return null;
        }

        $secondFactor = VerifiedSecondFactor::fromData($data);
        $violations = $this->validator->validate($secondFactor);

        if (count($violations) > 0) {
            throw InvalidResponseException::withViolations(
                "Verified second factor retrieved from the Middleware was invalid",

The string literal Verified second factor retrieved from the Middleware was invalid does not require double quotes, as per coding-style, please use single quotes.

                $violations
            );
        }

        return $secondFactor;
    }

    /**
     * @param string $secondFactorId
     * @return VettedSecondFactor|null
     * @throws AccessDeniedToResourceException When the consumer isn't authorised to access given resource.
     * @throws InvalidResponseException When the API responded with invalid data.
     * @throws ResourceReadException When the API doesn't respond with the resource.
     * @throws MalformedResponseException When the API doesn't respond with a proper response.
     */
    public function getVetted($secondFactorId)
    {
        $data = $this->service->getVetted($secondFactorId);

        if ($data === null) {
            return null;
        }

        $secondFactor = VettedSecondFactor::fromData($data);
        $violations = $this->validator->validate($secondFactor);

        if (count($violations) > 0) {
            throw InvalidResponseException::withViolations(
                "Vetted second factor retrieved from the Middleware was invalid",

The string literal Vetted second factor retrieved from the Middleware was invalid does not require double quotes, as per coding-style, please use single quotes.

                $violations
            );
        }

        return $secondFactor;
    }

    /**
     * @param UnverifiedSecondFactorSearchQuery $query
     * @return UnverifiedSecondFactorCollection

Should the return type not be UnverifiedSecondFactorCollection|null?

     * @throws AccessDeniedToResourceException When the consumer isn't authorised to access given resource.
     * @throws InvalidResponseException When the API responded with invalid data.
     * @throws ResourceReadException When the API doesn't respond with the resource.
     * @throws MalformedResponseException When the API doesn't respond with a proper response.
     */
    public function searchUnverified(UnverifiedSecondFactorSearchQuery $query)
    {
        $data = $this->service->searchUnverified($query);

        if ($data === null) {
            return null;
        }

        $secondFactors = UnverifiedSecondFactorCollection::fromData($data);
        $violations = $this->validator->validate($secondFactors);

        if (count($violations) > 0) {
            throw InvalidResponseException::withViolations(
                "One or more second factors retrieved from the Middleware were invalid",

The string literal One or more second factors retrieved from the Middleware were invalid does not require double quotes, as per coding-style, please use single quotes.

                $violations
            );
        }

        return $secondFactors;
    }

    /**
     * @param VerifiedSecondFactorSearchQuery $query
     * @return VerifiedSecondFactorCollection

Should the return type not be VerifiedSecondFactorCollection|null?

     * @throws AccessDeniedToResourceException When the consumer isn't authorised to access given resource.
     * @throws InvalidResponseException When the API responded with invalid data.
     * @throws ResourceReadException When the API doesn't respond with the resource.
     * @throws MalformedResponseException When the API doesn't respond with a proper response.
     */
    public function searchVerified(VerifiedSecondFactorSearchQuery $query)
    {
        $data = $this->service->searchVerified($query);

        if ($data === null) {
            return null;
        }

        $secondFactors = VerifiedSecondFactorCollection::fromData($data);
        $violations = $this->validator->validate($secondFactors);

        if (count($violations) > 0) {
            throw InvalidResponseException::withViolations(
                "One or more second factors retrieved from the Middleware were invalid",

The string literal One or more second factors retrieved from the Middleware were invalid does not require double quotes, as per coding-style, please use single quotes.

                $violations
            );
        }

        return $secondFactors;
    }

    /**
     * @param VettedSecondFactorSearchQuery $query
     * @return VettedSecondFactorCollection

Should the return type not be VettedSecondFactorCollection|null?

     * @throws AccessDeniedToResourceException When the consumer isn't authorised to access given resource.
     * @throws InvalidResponseException When the API responded with invalid data.
     * @throws ResourceReadException When the API doesn't respond with the resource.
     * @throws MalformedResponseException When the API doesn't respond with a proper response.
     */
    public function searchVetted(VettedSecondFactorSearchQuery $query)
    {
        $data = $this->service->searchVetted($query);

        if ($data === null) {
            return null;
        }

        $secondFactors = VettedSecondFactorCollection::fromData($data);
        $violations = $this->validator->validate($secondFactors);

        if (count($violations) > 0) {
            throw InvalidResponseException::withViolations(
                "One or more second factors retrieved from the Middleware were invalid",

The string literal One or more second factors retrieved from the Middleware were invalid does not require double quotes, as per coding-style, please use single quotes.

                $violations
            );
        }

        return $secondFactors;
    }
}