GssfPossessionProvenEvent::serialize() - Code Metrics - Inspection of "Skip transition of unverified -> verified when ema..." - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/verify-email-new-prove... ( 83179e )

unknown

created 2018-05-02 11:24 UTC

GssfPossessionProvenEvent::serialize() A

↳ Parent: GssfPossessionProvenEvent

Complexity

Conditions	1
Paths	1

Size

Total Lines	13
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	13
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	10
nc	1
nop	0

<?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\Stepup\Identity\Event;

use Surfnet\Stepup\Identity\AuditLog\Metadata;
use Surfnet\Stepup\Identity\Value\CommonName;
use Surfnet\Stepup\Identity\Value\Email;
use Surfnet\Stepup\Identity\Value\EmailVerificationWindow;
use Surfnet\Stepup\Identity\Value\GssfId;
use Surfnet\Stepup\Identity\Value\IdentityId;
use Surfnet\Stepup\Identity\Value\Institution;
use Surfnet\Stepup\Identity\Value\Locale;
use Surfnet\Stepup\Identity\Value\SecondFactorId;
use Surfnet\Stepup\Identity\Value\StepupProvider;
use Surfnet\StepupBundle\Value\SecondFactorType;
use Surfnet\StepupMiddleware\CommandHandlingBundle\SensitiveData\Forgettable;
use Surfnet\StepupMiddleware\CommandHandlingBundle\SensitiveData\SensitiveData;

class GssfPossessionProvenEvent extends IdentityEvent implements Forgettable
{
    /**
     * @var \Surfnet\Stepup\Identity\Value\SecondFactorId
     */
    public $secondFactorId;

    /**
     * @var \Surfnet\Stepup\Identity\Value\StepupProvider
     */
    public $stepupProvider;

    /**
     * @var \Surfnet\Stepup\Identity\Value\GssfId
     */
    public $gssfId;

    /**
     * @var bool
     */
    public $emailVerificationRequired;

    /**
     * @var \Surfnet\Stepup\Identity\Value\EmailVerificationWindow
     */
    public $emailVerificationWindow;

    /**
     * @var string
     */
    public $emailVerificationNonce;

    /**
     * @var \Surfnet\Stepup\Identity\Value\CommonName
     */
    public $commonName;

    /**
     * @var \Surfnet\Stepup\Identity\Value\Email
     */
    public $email;

    /**
     * @var \Surfnet\Stepup\Identity\Value\Locale Eg. "en_GB"
     */
    public $preferredLocale;

    /**
     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
     *
     * @param IdentityId              $identityId
     * @param Institution             $identityInstitution
     * @param SecondFactorId          $secondFactorId
     * @param StepupProvider          $stepupProvider
     * @param GssfId                  $gssfId
     * @param bool                    $emailVerificationRequired
     * @param EmailVerificationWindow $emailVerificationWindow
     * @param string                  $emailVerificationNonce
     * @param CommonName              $commonName
     * @param Email                   $email
     * @param Locale                  $preferredLocale
     */
    public function __construct(
        IdentityId $identityId,
        Institution $identityInstitution,
        SecondFactorId $secondFactorId,
        StepupProvider $stepupProvider,
        GssfId $gssfId,
        $emailVerificationRequired,
        EmailVerificationWindow $emailVerificationWindow,
        $emailVerificationNonce,
        CommonName $commonName,
        Email $email,
        Locale $preferredLocale
    ) {
        parent::__construct($identityId, $identityInstitution);

        $this->secondFactorId            = $secondFactorId;
        $this->stepupProvider            = $stepupProvider;
        $this->gssfId                    = $gssfId;
        $this->emailVerificationRequired = $emailVerificationRequired;
        $this->emailVerificationWindow   = $emailVerificationWindow;
        $this->emailVerificationNonce    = $emailVerificationNonce;
        $this->commonName                = $commonName;
        $this->email                     = $email;
        $this->preferredLocale           = $preferredLocale;
    }

    public function getAuditLogMetadata()
    {
        $metadata = new Metadata();
        $metadata->identityId = $this->identityId;
        $metadata->identityInstitution = $this->identityInstitution;
        $metadata->secondFactorId = $this->secondFactorId;
        $metadata->secondFactorType = new SecondFactorType((string) $this->stepupProvider);
        $metadata->secondFactorIdentifier = $this->gssfId;

        return $metadata;
    }

    public static function deserialize(array $data)
    {
        if (!isset($data['email_verification_required'])) {
            $data['email_verification_required'] = true;
        }

        return new self(
            new IdentityId($data['identity_id']),
            new Institution($data['identity_institution']),
            new SecondFactorId($data['second_factor_id']),
            new StepupProvider($data['stepup_provider']),
            GssfId::unknown(),
            $data['email_verification_required'],
            EmailVerificationWindow::deserialize($data['email_verification_window']),
            $data['email_verification_nonce'],
            CommonName::unknown(),
            Email::unknown(),
            new Locale($data['preferred_locale'])
        );
    }

    public function serialize()
    {
        return [
            'identity_id'                 => (string) $this->identityId,
            'identity_institution'        => (string) $this->identityInstitution,
            'second_factor_id'            => (string) $this->secondFactorId,
            'stepup_provider'             => (string) $this->stepupProvider,
            'email_verification_required' => (bool) $this->emailVerificationRequired,
            'email_verification_window'   => $this->emailVerificationWindow->serialize(),
            'email_verification_nonce'    => (string) $this->emailVerificationNonce,
            'preferred_locale'            => (string) $this->preferredLocale,
        ];
    }

    public function getSensitiveData()

    {
        return (new SensitiveData)
            ->withCommonName($this->commonName)
            ->withEmail($this->email)
            ->withSecondFactorIdentifier($this->gssfId, new SecondFactorType((string) $this->stepupProvider));
    }

    public function setSensitiveData(SensitiveData $sensitiveData)
    {
        $this->email      = $sensitiveData->getEmail();
        $this->commonName = $sensitiveData->getCommonName();
        $this->gssfId     = $sensitiveData->getSecondFactorIdentifier();
    }
}


1		<?php
2
3		/**
4		* Copyright 2014 SURFnet bv
5		*
6		* Licensed under the Apache License, Version 2.0 (the "License");
7		* you may not use this file except in compliance with the License.
8		* You may obtain a copy of the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS,
14		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15		* See the License for the specific language governing permissions and
16		* limitations under the License.
17		*/
18
19		namespace Surfnet\Stepup\Identity\Event;
20
21		use Surfnet\Stepup\Identity\AuditLog\Metadata;
22		use Surfnet\Stepup\Identity\Value\CommonName;
23		use Surfnet\Stepup\Identity\Value\Email;
24		use Surfnet\Stepup\Identity\Value\EmailVerificationWindow;
25		use Surfnet\Stepup\Identity\Value\GssfId;
26		use Surfnet\Stepup\Identity\Value\IdentityId;
27		use Surfnet\Stepup\Identity\Value\Institution;
28		use Surfnet\Stepup\Identity\Value\Locale;
29		use Surfnet\Stepup\Identity\Value\SecondFactorId;
30		use Surfnet\Stepup\Identity\Value\StepupProvider;
31		use Surfnet\StepupBundle\Value\SecondFactorType;
32		use Surfnet\StepupMiddleware\CommandHandlingBundle\SensitiveData\Forgettable;
33		use Surfnet\StepupMiddleware\CommandHandlingBundle\SensitiveData\SensitiveData;
34
35		class GssfPossessionProvenEvent extends IdentityEvent implements Forgettable
36		{
37		/**
38		* @var \Surfnet\Stepup\Identity\Value\SecondFactorId
39		*/
40		public $secondFactorId;
41
42		/**
43		* @var \Surfnet\Stepup\Identity\Value\StepupProvider
44		*/
45		public $stepupProvider;
46
47		/**
48		* @var \Surfnet\Stepup\Identity\Value\GssfId
49		*/
50		public $gssfId;
51
52		/**
53		* @var bool
54		*/
55		public $emailVerificationRequired;
56
57		/**
58		* @var \Surfnet\Stepup\Identity\Value\EmailVerificationWindow
59		*/
60		public $emailVerificationWindow;
61
62		/**
63		* @var string
64		*/
65		public $emailVerificationNonce;
66
67		/**
68		* @var \Surfnet\Stepup\Identity\Value\CommonName
69		*/
70		public $commonName;
71
72		/**
73		* @var \Surfnet\Stepup\Identity\Value\Email
74		*/
75		public $email;
76
77		/**
78		* @var \Surfnet\Stepup\Identity\Value\Locale Eg. "en_GB"
79		*/
80		public $preferredLocale;
81
82		/**
83		* @SuppressWarnings(PHPMD.ExcessiveParameterList)
84		*
85		* @param IdentityId $identityId
86		* @param Institution $identityInstitution
87		* @param SecondFactorId $secondFactorId
88		* @param StepupProvider $stepupProvider
89		* @param GssfId $gssfId
90		* @param bool $emailVerificationRequired
91		* @param EmailVerificationWindow $emailVerificationWindow
92		* @param string $emailVerificationNonce
93		* @param CommonName $commonName
94		* @param Email $email
95		* @param Locale $preferredLocale
96		*/
97		public function __construct(
98		IdentityId $identityId,
99		Institution $identityInstitution,
100		SecondFactorId $secondFactorId,
101		StepupProvider $stepupProvider,
102		GssfId $gssfId,
103		$emailVerificationRequired,
104		EmailVerificationWindow $emailVerificationWindow,
105		$emailVerificationNonce,
106		CommonName $commonName,
107		Email $email,
108		Locale $preferredLocale
109		) {
110		parent::__construct($identityId, $identityInstitution);
111
112		$this->secondFactorId = $secondFactorId;
113		$this->stepupProvider = $stepupProvider;
114		$this->gssfId = $gssfId;
115		$this->emailVerificationRequired = $emailVerificationRequired;
116		$this->emailVerificationWindow = $emailVerificationWindow;
117		$this->emailVerificationNonce = $emailVerificationNonce;
118		$this->commonName = $commonName;
119		$this->email = $email;
120		$this->preferredLocale = $preferredLocale;
121		}
122
123		public function getAuditLogMetadata()
124		{
125		$metadata = new Metadata();
126		$metadata->identityId = $this->identityId;
127		$metadata->identityInstitution = $this->identityInstitution;
128		$metadata->secondFactorId = $this->secondFactorId;
129		$metadata->secondFactorType = new SecondFactorType((string) $this->stepupProvider);
130		$metadata->secondFactorIdentifier = $this->gssfId;
131
132		return $metadata;
133		}
134
135		public static function deserialize(array $data)
136		{
137		if (!isset($data['email_verification_required'])) {
138		$data['email_verification_required'] = true;
139		}
140
141		return new self(
142		new IdentityId($data['identity_id']),
143		new Institution($data['identity_institution']),
144		new SecondFactorId($data['second_factor_id']),
145		new StepupProvider($data['stepup_provider']),
146		GssfId::unknown(),
147		$data['email_verification_required'],
148		EmailVerificationWindow::deserialize($data['email_verification_window']),
149		$data['email_verification_nonce'],
150		CommonName::unknown(),
151		Email::unknown(),
152		new Locale($data['preferred_locale'])
153		);
154		}
155
156		public function serialize()
157		{
158		return [
159		'identity_id' => (string) $this->identityId,
160		'identity_institution' => (string) $this->identityInstitution,
161		'second_factor_id' => (string) $this->secondFactorId,
162		'stepup_provider' => (string) $this->stepupProvider,
163		'email_verification_required' => (bool) $this->emailVerificationRequired,
164		'email_verification_window' => $this->emailVerificationWindow->serialize(),
165		'email_verification_nonce' => (string) $this->emailVerificationNonce,
166		'preferred_locale' => (string) $this->preferredLocale,
167		];
168		}
169
170	View Code Duplication	public function getSensitiveData()
		0 ignored issues – show Duplication introduced 2018-04-18 07:47 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
171		{
172		return (new SensitiveData)
173		->withCommonName($this->commonName)
174		->withEmail($this->email)
175		->withSecondFactorIdentifier($this->gssfId, new SecondFactorType((string) $this->stepupProvider));
176		}
177
178		public function setSensitiveData(SensitiveData $sensitiveData)
179		{
180		$this->email = $sensitiveData->getEmail();
181		$this->commonName = $sensitiveData->getCommonName();
182		$this->gssfId = $sensitiveData->getSecondFactorIdentifier();
183		}
184		}
185

OpenConext / Stepup-Middleware

Push — feature/verify-email-new-prove... ( 83179e )

GssfPossessionProvenEvent::serialize() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like