Feat: Authentication + Private Banking tests

tests/Feature/AuthenticationTest.php

@@ -0,0 +1,56 @@
+<?php
+
+use InvestecSdkPhp\Connectors\InvestecConnector;
+use InvestecSdkPhp\Connectors\InvestecOAuthConnector;
+use InvestecSdkPhp\Enumerations\Environment;
+use Saloon\Contracts\OAuthAuthenticator;
+
+it('can get a personal use access token', function () {
+ $connector = new InvestecConnector(
+ $_ENV['INVESTEC_OPENAPI_CLIENTID'],
+ $_ENV['INVESTEC_OPENAPI_SECRET'],
+ $_ENV['INVESTEC_OPENAPI_API_KEY'],
+ Environment::SANDBOX
+ );
+
+ $authenticator = $connector->getAccessToken();
+
+ expect($authenticator)
+ ->toBeInstanceOf(OAuthAuthenticator::class)
+ ->and($authenticator->getAccessToken())
+ ->toBeTruthy();
+})
+ ->group('auth-personal');
+
+it('generates an OAuth redirect URL', function () {
+ $redirectUri = 'https://www.example.com';
+ $connector = new InvestecOAuthConnector(
+ $_ENV['INVESTEC_OPENAPI_CLIENTID'],
+ $_ENV['INVESTEC_OPENAPI_SECRET'],
+ Environment::SANDBOX
+ );
+
+ $authUrl = $connector->getAuthorizationUrl($redirectUri);
+
+ expect($authUrl)
+ ->toBeTruthy()
+ ->toContain(
+ 'scope=accounts',
+ 'client_id='.$_ENV['INVESTEC_OPENAPI_CLIENTID'],
+ 'redirect_uri='.urlencode($redirectUri),
+ 'response_type=code'
+ );
+})
+ ->group('auth-business');
+
+it('generates a 3rd party access token', function () {
+ //TODO
+})
+ ->skip('Sandbox credentials for 3-legged OAuth missing')
+ ->group('auth-business');
+
+it('can refresh an access token', function () {
+ //TODO
+})
+ ->skip('Sandbox credentials for 3-legged OAuth missing')
+ ->group('auth-business');

tests/Feature/PrivateBankingTest.php

@@ -0,0 +1,221 @@
+<?php
+
+use Carbon\Carbon;
+use InvestecSdkPhp\Connectors\InvestecConnector;
+use InvestecSdkPhp\DataTransferObjects\PrivateBanking\PayMultiple\PayMultipleDto;
+use InvestecSdkPhp\DataTransferObjects\PrivateBanking\TransferMultiple\TransferMultipleDto;
+use InvestecSdkPhp\Enumerations\Environment;
+use Saloon\Contracts\Response;
+
+$connector = null;
+$authenticator = null;
+
+beforeAll(function () use (&$connector, &$authenticator) {
+ $connector = new InvestecConnector(
+ $_ENV['INVESTEC_OPENAPI_CLIENTID'],
+ $_ENV['INVESTEC_OPENAPI_SECRET'],
+ $_ENV['INVESTEC_OPENAPI_API_KEY'],
+ Environment::SANDBOX
+ );
+
+ $authenticator = $connector->getAccessToken();
+});
+
+beforeEach(function () use (&$connector, &$authenticator) {
+ $this->privateBankingClient = $connector->privateBanking($authenticator);
+});
+
+it('gets accounts', function () {
+ /** @var Response $response */
+ $response = $this->privateBankingClient->getAccounts();
+ expect($response->status())
+ ->toBe(200)
+ ->and($response->json())
+ ->toBeArray()
+ ->toHaveKeys(['data.accounts'])
+ ->and($response->json('data.accounts'))
+ ->each
+ ->toHaveCount(8) //Canary if field count changes
+ ->toHaveKeys([
+ 'accountId',
+ 'accountNumber',
+ 'accountName',
+ 'referenceName',
+ 'productName',
+ 'kycCompliant',
+ 'profileId',
+ 'profileName',
+ ]);
+})
+ ->group('private-banking');
+
+it('gets account balance', function () {
+ $accountIdentifier = $this->privateBankingClient->getAccounts()->json('data.accounts.0')['accountId'];
+ $response = $this->privateBankingClient->getAccountBalance($accountIdentifier);
+ expect($response->status())
+ ->toBe(200)
+ ->and($response->json())
+ ->toBeArray()
+ ->toHaveKeys(['data'])
+ ->and($response->json('data'))
+ ->toHaveCount(4) //Canary if field count changes
+ ->toHaveKeys([
+ 'accountId',
+ 'currentBalance',
+ 'availableBalance',
+ 'currency',
+ ]);
+})
+ ->group('private-banking');
+
+it('gets account transactions', function () {
+ $accountIdentifier = $this->privateBankingClient->getAccounts()->json('data.accounts.0')['accountId'];
+ $fromDate = Carbon::yesterday()->toDateString();
+ $toDate = Carbon::today()->toDateString();
+ $response = $this->privateBankingClient->getAccountTransactions($accountIdentifier, $fromDate, $toDate);
+ expect($response->status())
+ ->toBe(200)
+ ->and($response->json())
+ ->toBeArray()
+ ->toHaveKeys(['data.transactions'])
+ ->and($response->json('data.transactions'))
+ ->each
+ ->toHaveCount(13) //Canary if field count changes
+ ->toHaveKeys([
+ 'accountId',
+ 'type',
+ 'transactionType',
+ 'status',
+ 'description',
+ 'cardNumber',
+ 'postedOrder',
+ 'postingDate',
+ 'valueDate',
+ 'actionDate',
+ 'transactionDate',
+ 'amount',
+ 'runningBalance',
+ ]);
+})
+ ->group('private-banking');
+
+it('gets beneficiaries', function () {
+ /** @var Response $response */
+ $response = $this->privateBankingClient->getBeneficiaries();
+ expect($response->status())
+ ->toBe(200)
+ ->and($response->json())
+ ->toBeArray()
+ ->toHaveKeys(['data'])
+ ->and($response->json('data'))
+ ->each
+ ->toHaveCount(14) //Canary if field count changes
+ ->toHaveKeys([
+ 'beneficiaryId',
+ 'accountNumber',
+ 'code',
+ 'bank',
+ 'beneficiaryName',
+ 'lastPaymentAmount',
+ 'lastPaymentDate',
+ 'cellNo',
+ 'emailAddress',
+ 'name',
+ 'referenceAccountNumber',
+ 'referenceName',
+ 'categoryId',
+ 'profileId',
+ ]);
+})
+ ->group('private-banking');
+
+it('gets beneficiary categories', function () {
+ /** @var Response $response */
+ $response = $this->privateBankingClient->getBeneficiaryCategories();
+ expect($response->status())
+ ->toBe(200)
+ ->and($response->json())
+ ->toBeArray()
+ ->toHaveKeys(['data'])
+ ->and($response->json('data'))
+ ->each
+ ->toHaveCount(3) //Canary if field count changes
+ ->toHaveKeys([
+ 'CategoryId',
+ 'DefaultCategory',
+ 'CategoryName',
+ ]);
+})
+ ->group('private-banking');
+
+it('transfers money between accounts', function () {
+ $accountIdentifiers = array_column($this->privateBankingClient->getAccounts()->json('data.accounts'), 'accountId');
+ $accountInstances = [];
+ //Only picking two out since there is potential for many transfers to occur here
+ foreach (array_slice($accountIdentifiers, 1, 2) as $accountIdentifier) {
+ $accountInstances[] = [
+ 'beneficiaryAccountId' => $accountIdentifier,
+ 'amount' => 1,
+ 'myReference' => 'API Transfer',
+ 'theirReference' => 'API Transfer',
+ ];
+ }
+ $transferMultipleDto = new TransferMultipleDto(['accountInstances' => $accountInstances]);
+ /** @var Response $response */
+ $response = $this->privateBankingClient->transferMultiple($accountIdentifiers[0], $transferMultipleDto);
+ expect($response->status())
+ ->toBe(200)
+ ->and($response->json())
+ ->toBeArray()
+ ->toHaveKeys(['data.TransferResponses'])
+ ->and($response->json('data.TransferResponses'))
+ ->each
+ ->toHaveCount(6) //Canary if field count changes
+ ->toHaveKeys([
+ 'PaymentReferenceNumber',
+ 'PaymentDate',
+ 'Status',
+ 'BeneficiaryName',
+ 'BeneficiaryAccountId',
+ 'AuthorisationRequired',
+ ]);
+})
+ ->group('private-banking');
+
+it('pays money to beneficiaries', function () {
+ $accountIdentifier = $this->privateBankingClient->getAccounts()->json('data.accounts.0')['accountId'];
+ //Only picking two out since there is potential for many payments to occur here
+ $beneficiaryIds = array_column(
+ array_slice($this->privateBankingClient->getBeneficiaries()->json('data'), 0, 2),
+ 'beneficiaryId'
+ );
+ $accountInstances = [];
+ foreach ($beneficiaryIds as $beneficiaryId) {
+ $accountInstances[] = [
+ 'beneficiaryId' => $beneficiaryId,
+ 'amount' => 1,
+ 'myReference' => 'API Payment',
+ 'theirReference' => 'API Payment',
+ ];
+ }
+ $payMultipleDto = new PayMultipleDto(['accountInstances' => $accountInstances]);
+ /** @var Response $response */
+ $response = $this->privateBankingClient->payMultiple($accountIdentifier, $payMultipleDto);
+ expect($response->status())
+ ->toBe(200)
+ ->and($response->json())
+ ->toBeArray()
+ ->toHaveKeys(['data.TransferResponses'])
+ ->and($response->json('data.TransferResponses'))
+ ->each
+ ->toHaveCount(6) //Canary if field count changes
+ ->toHaveKeys([
+ 'PaymentReferenceNumber',
+ 'PaymentDate',
+ 'Status',
+ 'BeneficiaryName',
+ 'BeneficiaryAccountId',
+ 'AuthorisationRequired',
+ ]);
+})
+ ->group('private-banking');

tests/Pest.php

@@ -1 +1,4 @@
 <?php
+
+$dotenv = Dotenv\Dotenv::createImmutable(__DIR__.'/../');
+$dotenv->load();