Skip to content

Commit 604660b

Browse files
cicnavicicnavi
committed
Rename TrustMarkStatus to TrustMarkStatusResponse
1 parent bf58e8a commit 604660b

10 files changed

Lines changed: 89 additions & 89 deletions

‎src/Federation.php‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@
2525
use SimpleSAML\OpenID\Federation\Factories\TrustChainFactory;
2626
use SimpleSAML\OpenID\Federation\Factories\TrustMarkDelegationFactory;
2727
use SimpleSAML\OpenID\Federation\Factories\TrustMarkFactory;
28-
use SimpleSAML\OpenID\Federation\Factories\TrustMarkStatusFactory;
28+
use SimpleSAML\OpenID\Federation\Factories\TrustMarkStatusResponseFactory;
2929
use SimpleSAML\OpenID\Federation\MetadataPolicyApplicator;
3030
use SimpleSAML\OpenID\Federation\MetadataPolicyResolver;
3131
use SimpleSAML\OpenID\Federation\TrustChainResolver;
3232
use SimpleSAML\OpenID\Federation\TrustMarkFetcher;
33-
use SimpleSAML\OpenID\Federation\TrustMarkStatusFetcher;
33+
use SimpleSAML\OpenID\Federation\TrustMarkStatusResponseFetcher;
3434
use SimpleSAML\OpenID\Federation\TrustMarkValidator;
3535
use SimpleSAML\OpenID\Jwks\Factories\JwksFactory;
3636
use SimpleSAML\OpenID\Jws\Factories\JwsParserFactory;
@@ -104,9 +104,9 @@ class Federation
104104

105105
protected ?TrustMarkFetcher $trustMarkFetcher = null;
106106

107-
protected ?TrustMarkStatusFactory $trustMarkStatusFactory = null;
107+
protected ?TrustMarkStatusResponseFactory $trustMarkStatusResponseFactory = null;
108108

109-
protected ?TrustMarkStatusFetcher $trustMarkStatusFetcher = null;
109+
protected ?TrustMarkStatusResponseFetcher $trustMarkStatusResponseFetcher = null;
110110

111111

112112
public function __construct(
@@ -257,9 +257,9 @@ public function trustMarkDelegationFactory(): TrustMarkDelegationFactory
257257
}
258258

259259

260-
public function trustMarkStatusFactory(): TrustMarkStatusFactory
260+
public function trustMarkStatusResponseFactory(): TrustMarkStatusResponseFactory
261261
{
262-
return $this->trustMarkStatusFactory ??= new TrustMarkStatusFactory(
262+
return $this->trustMarkStatusResponseFactory ??= new TrustMarkStatusResponseFactory(
263263
$this->jwsParser(),
264264
$this->jwsVerifierDecorator(),
265265
$this->jwksFactory(),
@@ -271,10 +271,10 @@ public function trustMarkStatusFactory(): TrustMarkStatusFactory
271271
}
272272

273273

274-
public function trustMarkStatusFetcher(): TrustMarkStatusFetcher
274+
public function trustMarkStatusResponseFetcher(): TrustMarkStatusResponseFetcher
275275
{
276-
return $this->trustMarkStatusFetcher ??= new TrustMarkStatusFetcher(
277-
$this->trustMarkStatusFactory(),
276+
return $this->trustMarkStatusResponseFetcher ??= new TrustMarkStatusResponseFetcher(
277+
$this->trustMarkStatusResponseFactory(),
278278
$this->artifactFetcher(),
279279
$this->maxCacheDurationDecorator,
280280
$this->helpers(),
@@ -289,7 +289,7 @@ public function trustMarkValidator(): TrustMarkValidator
289289
$this->trustChainResolver(),
290290
$this->trustMarkFactory(),
291291
$this->trustMarkDelegationFactory(),
292-
$this->trustMarkStatusFetcher(),
292+
$this->trustMarkStatusResponseFetcher(),
293293
$this->maxCacheDurationDecorator,
294294
$this->cacheDecorator(),
295295
$this->logger,

src/Federation/Factories/TrustMarkStatusFactory.php renamed to src/Federation/Factories/TrustMarkStatusResponseFactory.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44

55
namespace SimpleSAML\OpenID\Federation\Factories;
66

7-
use SimpleSAML\OpenID\Federation\TrustMarkStatus;
7+
use SimpleSAML\OpenID\Federation\TrustMarkStatusResponse;
88
use SimpleSAML\OpenID\Jws\Factories\ParsedJwsFactory;
99

10-
class TrustMarkStatusFactory extends ParsedJwsFactory
10+
class TrustMarkStatusResponseFactory extends ParsedJwsFactory
1111
{
12-
public function fromToken(string $token): TrustMarkStatus
12+
public function fromToken(string $token): TrustMarkStatusResponse
1313
{
14-
return new TrustMarkStatus(
14+
return new TrustMarkStatusResponse(
1515
$this->jwsParser->parse($token),
1616
$this->jwsVerifierDecorator,
1717
$this->jwksFactory,

src/Federation/TrustMarkStatus.php renamed to src/Federation/TrustMarkStatusResponse.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
use SimpleSAML\OpenID\Exceptions\TrustMarkStatusException;
1010
use SimpleSAML\OpenID\Jws\ParsedJws;
1111

12-
class TrustMarkStatus extends ParsedJws
12+
class TrustMarkStatusResponse extends ParsedJws
1313
{
1414
/**
1515
* @return non-empty-string

src/Federation/TrustMarkStatusFetcher.php renamed to src/Federation/TrustMarkStatusResponseFetcher.php

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@
1010
use SimpleSAML\OpenID\Decorators\DateIntervalDecorator;
1111
use SimpleSAML\OpenID\Exceptions\EntityStatementException;
1212
use SimpleSAML\OpenID\Exceptions\FetchException;
13-
use SimpleSAML\OpenID\Federation\Factories\TrustMarkStatusFactory;
13+
use SimpleSAML\OpenID\Federation\Factories\TrustMarkStatusResponseFactory;
1414
use SimpleSAML\OpenID\Helpers;
1515
use SimpleSAML\OpenID\Jws\JwsFetcher;
1616
use SimpleSAML\OpenID\Utils\ArtifactFetcher;
1717

18-
class TrustMarkStatusFetcher extends JwsFetcher
18+
class TrustMarkStatusResponseFetcher extends JwsFetcher
1919
{
2020
public function __construct(
21-
private readonly TrustMarkStatusFactory $parsedJwsFactory,
21+
private readonly TrustMarkStatusResponseFactory $parsedJwsFactory,
2222
ArtifactFetcher $artifactFetcher,
2323
DateIntervalDecorator $maxCacheDuration,
2424
Helpers $helpers,
@@ -28,7 +28,7 @@ public function __construct(
2828
}
2929

3030

31-
protected function buildJwsInstance(string $token): TrustMarkStatus
31+
protected function buildJwsInstance(string $token): TrustMarkStatusResponse
3232
{
3333
return $this->parsedJwsFactory->fromToken($token);
3434
}
@@ -52,7 +52,7 @@ public function getExpectedContentTypeHttpHeader(): string
5252
public function fromFederationTrustMarkStatusEndpoint(
5353
TrustMark $trustMark,
5454
EntityStatement $entityConfiguration,
55-
): TrustMarkStatus {
55+
): TrustMarkStatusResponse {
5656
$trustMarkStatusEndpoint = $entityConfiguration->getFederationTrustMarkStatusEndpoint() ??
5757
throw new EntityStatementException('No federation trust mark status endpoint found in entity configuration.');
5858

@@ -87,18 +87,18 @@ public function fromNetwork(
8787
array $options = [],
8888
bool $shouldCache = false,
8989
string ...$additionalCacheKeyElements,
90-
): TrustMarkStatus {
91-
$trustMarkStatus = parent::fromNetwork($uri, $httpMethodsEnum, $options, $shouldCache);
90+
): TrustMarkStatusResponse {
91+
$trustMarkStatusResponse = parent::fromNetwork($uri, $httpMethodsEnum, $options, $shouldCache);
9292

93-
if ($trustMarkStatus instanceof TrustMarkStatus) {
94-
return $trustMarkStatus;
93+
if ($trustMarkStatusResponse instanceof TrustMarkStatusResponse) {
94+
return $trustMarkStatusResponse;
9595
}
9696

9797
// @codeCoverageIgnoreStart
9898
$message = 'Unexpected Trust Mark Status instance encountered for network fetch.';
9999
$this->logger?->error(
100100
$message,
101-
['uri' => $uri, 'trustMarkStatus' => $trustMarkStatus],
101+
['uri' => $uri, 'trustMarkStatusResponse' => $trustMarkStatusResponse],
102102
);
103103

104104
throw new FetchException($message);

‎src/Federation/TrustMarkValidator.php‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public function __construct(
2929
protected readonly TrustChainResolver $trustChainResolver,
3030
protected readonly TrustMarkFactory $trustMarkFactory,
3131
protected readonly TrustMarkDelegationFactory $trustMarkDelegationFactory,
32-
protected readonly TrustMarkStatusFetcher $trustMarkStatusFetcher,
32+
protected readonly TrustMarkStatusResponseFetcher $trustMarkStatusResponseFetcher,
3333
protected readonly DateIntervalDecorator $maxCacheDurationDecorator,
3434
protected readonly ?CacheDecorator $cacheDecorator = null,
3535
protected readonly ?LoggerInterface $logger = null,
@@ -956,7 +956,7 @@ public function validateUsingTrustMarkStatusEndpoint(
956956
$this->logger?->debug('Validating Trust Mark using Trust Mark Status Endpoint.');
957957

958958
try {
959-
$trustMarkStatus = $this->trustMarkStatusFetcher->fromFederationTrustMarkStatusEndpoint(
959+
$trustMarkStatusResponse = $this->trustMarkStatusResponseFetcher->fromFederationTrustMarkStatusEndpoint(
960960
$trustMark,
961961
$trustMarkIssuerEntityConfiguration,
962962
);
@@ -971,10 +971,10 @@ public function validateUsingTrustMarkStatusEndpoint(
971971

972972
$this->logger?->debug(
973973
'Successfully fetched Trust Mark Status from Trust Mark Status Endpoint.',
974-
['trustMarkStatus' => $trustMarkStatus->getStatus()],
974+
['trustMarkStatus' => $trustMarkStatusResponse->getStatus()],
975975
);
976976

977-
$trustMarkStatusEnum = TrustMarkStatusEnum::tryFrom($trustMarkStatus->getStatus());
977+
$trustMarkStatusEnum = TrustMarkStatusEnum::tryFrom($trustMarkStatusResponse->getStatus());
978978

979979
if ($trustMarkStatusEnum instanceof TrustMarkStatusEnum) {
980980
$this->logger?->debug(
@@ -994,7 +994,7 @@ public function validateUsingTrustMarkStatusEndpoint(
994994

995995
if ($additionallyValidStatues === []) {
996996
throw new TrustMarkStatusException(
997-
sprintf('Trust Mark Status %s is not valid.', $trustMarkStatus->getStatus()),
997+
sprintf('Trust Mark Status %s is not valid.', $trustMarkStatusResponse->getStatus()),
998998
);
999999
}
10001000

@@ -1003,19 +1003,19 @@ public function validateUsingTrustMarkStatusEndpoint(
10031003
['additionallyValidStatues' => $additionallyValidStatues],
10041004
);
10051005

1006-
if (in_array($trustMarkStatus->getStatus(), $additionallyValidStatues, true)) {
1006+
if (in_array($trustMarkStatusResponse->getStatus(), $additionallyValidStatues, true)) {
10071007
$this->logger?->debug(
10081008
'Trust Mark Status is valid based on user-defined statuses.',
10091009
[
1010-
'trustMarkStatus' => $trustMarkStatus->getStatus(),
1010+
'trustMarkStatus' => $trustMarkStatusResponse->getStatus(),
10111011
'additionallyValidStatues' => $additionallyValidStatues,
10121012
],
10131013
);
10141014
return;
10151015
}
10161016

10171017
throw new TrustMarkStatusException(
1018-
sprintf('Trust Mark Status %s is not valid.', $trustMarkStatus->getStatus()),
1018+
sprintf('Trust Mark Status %s is not valid.', $trustMarkStatusResponse->getStatus()),
10191019
);
10201020
}
10211021
}

tests/src/Federation/Factories/TrustMarkStatusFactoryTest.php renamed to tests/src/Federation/Factories/TrustMarkStatusResponseFactoryTest.php

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
use PHPUnit\Framework\TestCase;
1313
use SimpleSAML\OpenID\Decorators\DateIntervalDecorator;
1414
use SimpleSAML\OpenID\Factories\ClaimFactory;
15-
use SimpleSAML\OpenID\Federation\Factories\TrustMarkStatusFactory;
16-
use SimpleSAML\OpenID\Federation\TrustMarkStatus;
15+
use SimpleSAML\OpenID\Federation\Factories\TrustMarkStatusResponseFactory;
16+
use SimpleSAML\OpenID\Federation\TrustMarkStatusResponse;
1717
use SimpleSAML\OpenID\Helpers;
1818
use SimpleSAML\OpenID\Jwks\Factories\JwksFactory;
1919
use SimpleSAML\OpenID\Jws\Factories\ParsedJwsFactory;
@@ -23,11 +23,11 @@
2323
use SimpleSAML\OpenID\Jws\ParsedJws;
2424
use SimpleSAML\OpenID\Serializers\JwsSerializerManagerDecorator;
2525

26-
#[CoversClass(TrustMarkStatusFactory::class)]
26+
#[CoversClass(TrustMarkStatusResponseFactory::class)]
2727
#[UsesClass(ParsedJwsFactory::class)]
2828
#[UsesClass(ParsedJws::class)]
29-
#[UsesClass(TrustMarkStatus::class)]
30-
final class TrustMarkStatusFactoryTest extends TestCase
29+
#[UsesClass(TrustMarkStatusResponse::class)]
30+
final class TrustMarkStatusResponseFactoryTest extends TestCase
3131
{
3232
protected MockObject $signatureMock;
3333

@@ -102,7 +102,7 @@ protected function sut(
102102
?DateIntervalDecorator $dateIntervalDecorator = null,
103103
?Helpers $helpers = null,
104104
?ClaimFactory $claimFactory = null,
105-
): TrustMarkStatusFactory {
105+
): TrustMarkStatusResponseFactory {
106106
$jwsParser ??= $this->jwsParserMock;
107107
$jwsVerifierDecorator ??= $this->jwsVerifierDecoratorMock;
108108
$jwksFactory ??= $this->jwksFactoryMock;
@@ -111,7 +111,7 @@ protected function sut(
111111
$helpers ??= $this->helpersMock;
112112
$claimFactory ??= $this->claimFactoryMock;
113113

114-
return new TrustMarkStatusFactory(
114+
return new TrustMarkStatusResponseFactory(
115115
$jwsParser,
116116
$jwsVerifierDecorator,
117117
$jwksFactory,
@@ -125,7 +125,7 @@ protected function sut(
125125

126126
public function testCanCreateInstance(): void
127127
{
128-
$this->assertInstanceOf(TrustMarkStatusFactory::class, $this->sut());
128+
$this->assertInstanceOf(TrustMarkStatusResponseFactory::class, $this->sut());
129129
}
130130

131131

@@ -135,7 +135,7 @@ public function testCanBuildFromToken(): void
135135
$this->signatureMock->method('getProtectedHeader')->willReturn($this->sampleHeader);
136136

137137
$this->assertInstanceOf(
138-
TrustMarkStatus::class,
138+
TrustMarkStatusResponse::class,
139139
$this->sut()->fromToken('token'),
140140
);
141141
}

tests/src/Federation/TrustMarkStatusFetcherTest.php renamed to tests/src/Federation/TrustMarkStatusResponseFetcherTest.php

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,21 @@
1515
use SimpleSAML\OpenID\Decorators\DateIntervalDecorator;
1616
use SimpleSAML\OpenID\Exceptions\EntityStatementException;
1717
use SimpleSAML\OpenID\Federation\EntityStatement;
18-
use SimpleSAML\OpenID\Federation\Factories\TrustMarkStatusFactory;
18+
use SimpleSAML\OpenID\Federation\Factories\TrustMarkStatusResponseFactory;
1919
use SimpleSAML\OpenID\Federation\TrustMark;
20-
use SimpleSAML\OpenID\Federation\TrustMarkStatusFetcher;
20+
use SimpleSAML\OpenID\Federation\TrustMarkStatusResponseFetcher;
2121
use SimpleSAML\OpenID\Helpers;
2222
use SimpleSAML\OpenID\Jws\AbstractJwsFetcher;
2323
use SimpleSAML\OpenID\Jws\JwsFetcher;
2424
use SimpleSAML\OpenID\Utils\ArtifactFetcher;
2525

26-
#[CoversClass(TrustMarkStatusFetcher::class)]
26+
#[CoversClass(TrustMarkStatusResponseFetcher::class)]
2727
#[UsesClass(AbstractJwsFetcher::class)]
2828
#[UsesClass(JwsFetcher::class)]
2929
#[UsesClass(WellKnownEnum::class)]
30-
final class TrustMarkStatusFetcherTest extends TestCase
30+
final class TrustMarkStatusResponseFetcherTest extends TestCase
3131
{
32-
protected MockObject $trustMarkStatusFactoryMock;
32+
protected MockObject $trustMarkStatusResponseFactoryMock;
3333

3434
protected MockObject $artifactFetcherMock;
3535

@@ -48,7 +48,7 @@ final class TrustMarkStatusFetcherTest extends TestCase
4848

4949
protected function setUp(): void
5050
{
51-
$this->trustMarkStatusFactoryMock = $this->createMock(TrustMarkStatusFactory::class);
51+
$this->trustMarkStatusResponseFactoryMock = $this->createMock(TrustMarkStatusResponseFactory::class);
5252
$this->artifactFetcherMock = $this->createMock(ArtifactFetcher::class);
5353
$this->maxCacheDurationMock = $this->createMock(DateIntervalDecorator::class);
5454
$this->helpersMock = $this->createMock(Helpers::class);
@@ -63,20 +63,20 @@ protected function setUp(): void
6363

6464

6565
protected function sut(
66-
?TrustMarkStatusFactory $trustMarkStatusFactory = null,
66+
?TrustMarkStatusResponseFactory $trustMarkStatusResponseFactory = null,
6767
?ArtifactFetcher $artifactFetcher = null,
6868
?DateIntervalDecorator $maxCacheDuration = null,
6969
?Helpers $helpers = null,
7070
?LoggerInterface $logger = null,
71-
): TrustMarkStatusFetcher {
72-
$trustMarkStatusFactory ??= $this->trustMarkStatusFactoryMock;
71+
): TrustMarkStatusResponseFetcher {
72+
$trustMarkStatusResponseFactory ??= $this->trustMarkStatusResponseFactoryMock;
7373
$artifactFetcher ??= $this->artifactFetcherMock;
7474
$maxCacheDuration ??= $this->maxCacheDurationMock;
7575
$helpers ??= $this->helpersMock;
7676
$logger ??= $this->loggerMock;
7777

78-
return new TrustMarkStatusFetcher(
79-
$trustMarkStatusFactory,
78+
return new TrustMarkStatusResponseFetcher(
79+
$trustMarkStatusResponseFactory,
8080
$artifactFetcher,
8181
$maxCacheDuration,
8282
$helpers,
@@ -87,7 +87,7 @@ protected function sut(
8787

8888
public function testCanCreateInstance(): void
8989
{
90-
$this->assertInstanceOf(TrustMarkStatusFetcher::class, $this->sut());
90+
$this->assertInstanceOf(TrustMarkStatusResponseFetcher::class, $this->sut());
9191
}
9292

9393

@@ -113,7 +113,7 @@ public function testCanFetchFromTrustMarkStatusEndpoint(): void
113113
$this->responseMock->method('getHeaderLine')
114114
->willReturn('application/trust-mark-status-response+jwt');
115115

116-
$this->trustMarkStatusFactoryMock->expects($this->once())->method('fromToken');
116+
$this->trustMarkStatusResponseFactoryMock->expects($this->once())->method('fromToken');
117117

118118
$this->sut()->fromFederationTrustMarkStatusEndpoint(
119119
$this->trustMarkMock,

0 commit comments

Comments
 (0)