Skip to content

Release v1.1.1 #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Release v1.1.1 #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion composer.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions src/IEnqueueToken.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

namespace QueueIT\QueueToken;

use QueueIT\QueueToken\IEnqueueTokenPayload;

interface IEnqueueToken
{
public function getTokenIdentifier(): string;
Expand Down
1 change: 1 addition & 0 deletions src/Models/TokenOrigin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ class TokenOrigin
{
const CONNECTOR = 'Connector';
const INVITE_ONLY = 'InviteOnly';
const AKAMAI_BOT_MANAGER_HEADER_VALIDATOR = 'AkamaiBotManagerHeaderValidator';
}
2 changes: 2 additions & 0 deletions src/Payload.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

namespace QueueIT\QueueToken;

use QueueIT\QueueToken\EnqueueTokenPayloadGenerator;

class Payload
{
public static function enqueue()
Expand Down
117 changes: 117 additions & 0 deletions tests/EnqueueTokenPayloadTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use QueueIT\QueueToken\Helpers\Utils;
use QueueIT\QueueToken\Payload;
use QueueIT\QueueToken\EnqueueTokenPayload;
use QueueIT\QueueToken\Models\TokenOrigin;

class EnqueueTokenPayloadTest extends TestCase
{
Expand Down Expand Up @@ -243,4 +244,120 @@ public function testEncryptedCorrectly()
$this->assertEquals($expectedEncryptedPayload, $actualEncryptedPayload);
$this->assertEquals($payload, $decryptPayload);
}

public function testGeneratePayloadWithInviteOnlyOrigin()
{
$expectedKey = "myKey";
$expectedOrigin = TokenOrigin::INVITE_ONLY;

$instance = Payload::Enqueue()
->WithKey($expectedKey)
->WithOrigin($expectedOrigin)
->Generate();

$this->assertEquals($expectedKey, $instance->getKey());
$this->assertEquals($expectedOrigin, $instance->getTokenOrigin());
}

public function testGeneratePayloadWithAkamaiBotManagerHeaderValidatorOrigin()
{
$expectedKey = "myKey";
$expectedOrigin = TokenOrigin::AKAMAI_BOT_MANAGER_HEADER_VALIDATOR;

$instance = Payload::Enqueue()
->WithKey($expectedKey)
->WithOrigin($expectedOrigin)
->Generate();

$this->assertEquals($expectedKey, $instance->getKey());
$this->assertEquals($expectedOrigin, $instance->getTokenOrigin());
}

public function testGeneratePayloadWithConnectorOrigin()
{
$expectedKey = "myKey";
$expectedOrigin = TokenOrigin::CONNECTOR;

$instance = Payload::Enqueue()
->WithKey($expectedKey)
->WithOrigin($expectedOrigin)
->Generate();

$this->assertEquals($expectedKey, $instance->getKey());
$this->assertEquals($expectedOrigin, $instance->getTokenOrigin());
}

public function testSerializeWithInviteOnlyOrigin()
{
$expectedJson = '{"r":0.456,"k":"myKey","o":"InviteOnly"}';

$instance = Payload::Enqueue()
->WithKey("myKey")
->WithRelativeQuality(0.456)
->WithOrigin(TokenOrigin::INVITE_ONLY)
->Generate();
$actualJson = Utils::uint8ArrayToString($instance->Serialize());

$this->assertEquals($expectedJson, $actualJson);
}

public function testSerializeWithAkamaiBotManagerHeaderValidatorOrigin()
{
$expectedJson = '{"r":0.456,"k":"myKey","o":"AkamaiBotManagerHeaderValidator"}';

$instance = Payload::Enqueue()
->WithKey("myKey")
->WithRelativeQuality(0.456)
->WithOrigin(TokenOrigin::AKAMAI_BOT_MANAGER_HEADER_VALIDATOR)
->Generate();
$actualJson = Utils::uint8ArrayToString($instance->Serialize());

$this->assertEquals($expectedJson, $actualJson);
}

public function testSerializeWithConnectorOrigin()
{
$expectedJson = '{"r":0.456,"k":"myKey","o":"Connector"}';

$instance = Payload::Enqueue()
->WithKey("myKey")
->WithRelativeQuality(0.456)
->WithOrigin(TokenOrigin::CONNECTOR)
->Generate();
$actualJson = Utils::uint8ArrayToString($instance->Serialize());

$this->assertEquals($expectedJson, $actualJson);
}

public function testSerializeWithInviteOnlyOriginAndCustomData()
{
$expectedJson = '{"r":0.456,"k":"myKey","cd":{"key1":"Value1","key2":"Value2"},"o":"InviteOnly"}';

$instance = Payload::Enqueue()
->WithKey("myKey")
->WithRelativeQuality(0.456)
->WithCustomData("key1", "Value1")
->WithCustomData("key2", "Value2")
->WithOrigin(TokenOrigin::INVITE_ONLY)
->Generate();
$actualJson = Utils::uint8ArrayToString($instance->Serialize());

$this->assertEquals($expectedJson, $actualJson);
}

public function testSerializeWithAkamaiBotManagerOriginAndCustomData()
{
$expectedJson = '{"r":0.456,"k":"myKey","cd":{"key1":"Value1","key2":"Value2"},"o":"AkamaiBotManagerHeaderValidator"}';

$instance = Payload::Enqueue()
->WithKey("myKey")
->WithRelativeQuality(0.456)
->WithCustomData("key1", "Value1")
->WithCustomData("key2", "Value2")
->WithOrigin(TokenOrigin::AKAMAI_BOT_MANAGER_HEADER_VALIDATOR)
->Generate();
$actualJson = Utils::uint8ArrayToString($instance->Serialize());

$this->assertEquals($expectedJson, $actualJson);
}
}
94 changes: 94 additions & 0 deletions tests/EnqueueTokenTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use QueueIT\QueueToken\Models\TokenVersion;
use QueueIT\QueueToken\Models\EncryptionType;
use QueueIT\QueueToken\Models\HeaderDto;
use QueueIT\QueueToken\Models\TokenOrigin;

use QueueIT\QueueToken\Tests\SampleTokenValues;

Expand Down Expand Up @@ -389,4 +390,97 @@ public function testSecondTokenGenerationDoesNotModifyFirstToken()
$parsedToken1 = Token::parse($token1String, SampleTokenValues::$secretKey);
$this->assertEquals("event1", $parsedToken1->eventId);
}

public function testCreateTokenWithInviteOnlyOriginAndParse()
{
$secret = SampleTokenValues::$secretKey;

$payload = Payload::enqueue()
->withKey('TestKey')
->withRelativeQuality(0.5)
->withOrigin(TokenOrigin::INVITE_ONLY)
->generate();

$token = Token::enqueue(SampleTokenValues::$customerId)
->withPayload($payload)
->withEventId('testevent')
->generate($secret);

$tokenString = $token->getToken();
$parsed = Token::parse($tokenString, $secret);

$this->assertNotNull($parsed->getPayload());
$this->assertEquals(TokenOrigin::INVITE_ONLY, $parsed->getPayload()->getTokenOrigin());
$this->assertEquals('TestKey', $parsed->getPayload()->getKey());
$this->assertEquals(0.5, $parsed->getPayload()->getRelativeQuality());
}

public function testCreateTokenWithAkamaiBotManagerOriginAndParse()
{
$secret = SampleTokenValues::$secretKey;

$payload = Payload::enqueue()
->withKey('BotManagerKey')
->withRelativeQuality(0.75)
->withCustomData('detector', 'bot-manager')
->withOrigin(TokenOrigin::AKAMAI_BOT_MANAGER_HEADER_VALIDATOR)
->generate();

$token = Token::enqueue(SampleTokenValues::$customerId)
->withPayload($payload)
->withEventId('bot-test-event')
->generate($secret);

$tokenString = $token->getToken();
$parsed = Token::parse($tokenString, $secret);

$this->assertNotNull($parsed->getPayload());
$this->assertEquals(TokenOrigin::AKAMAI_BOT_MANAGER_HEADER_VALIDATOR, $parsed->getPayload()->getTokenOrigin());
$this->assertEquals('BotManagerKey', $parsed->getPayload()->getKey());
$this->assertEquals(0.75, $parsed->getPayload()->getRelativeQuality());
$this->assertEquals('bot-manager', $parsed->getPayload()->getCustomData()['detector']);
}

public function testCreateTokenWithConnectorOriginAndParse()
{
$secret = SampleTokenValues::$secretKey;

$payload = Payload::enqueue()
->withKey('ConnectorKey')
->withRelativeQuality(0.25)
->withOrigin(TokenOrigin::CONNECTOR)
->generate();

$token = Token::enqueue(SampleTokenValues::$customerId)
->withPayload($payload)
->withEventId('connector-event')
->generate($secret);

$tokenString = $token->getToken();
$parsed = Token::parse($tokenString, $secret);

$this->assertNotNull($parsed->getPayload());
$this->assertEquals(TokenOrigin::CONNECTOR, $parsed->getPayload()->getTokenOrigin());
$this->assertEquals('ConnectorKey', $parsed->getPayload()->getKey());
$this->assertEquals(0.25, $parsed->getPayload()->getRelativeQuality());
}

public function testTokenOriginDefaultsToConnector()
{
$secret = SampleTokenValues::$secretKey;

$payload = Payload::enqueue()
->withKey('DefaultKey')
->generate();

$token = Token::enqueue(SampleTokenValues::$customerId)
->withPayload($payload)
->generate($secret);

$tokenString = $token->getToken();
$parsed = Token::parse($tokenString, $secret);

$this->assertNotNull($parsed->getPayload());
$this->assertEquals(TokenOrigin::CONNECTOR, $parsed->getPayload()->getTokenOrigin());
}
}
Loading