Skip to content

feat!: add region validation for Terminal Cloud API #1576

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat!: add region validation for Terminal Cloud API #1576

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
3 changes: 2 additions & 1 deletion src/__mocks__/base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
*/

import Client from "../client";
import Config, { EnvironmentEnum } from "../config";
import Config, { EnvironmentEnum, RegionEnum } from "../config";
import {
AmountsReq,
MessageCategoryType,
Expand All @@ -38,6 +38,7 @@ import {
export const createClient = (apiKey = process.env.ADYEN_API_KEY): Client => {
const config: Config = new Config();
config.environment = EnvironmentEnum.TEST;
config.region = RegionEnum.EU;
config.terminalApiCloudEndpoint = Client.TERMINAL_API_ENDPOINT_TEST;
config.terminalApiLocalEndpoint = "https://mocked_local_endpoint.com";
config.marketPayEndpoint = Client.MARKETPAY_ENDPOINT_TEST;
Expand Down
29 changes: 24 additions & 5 deletions src/__tests__/terminalCloudAPI.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { syncRefund, syncRes, syncResEventNotification, syncResEventNotification
import Client from "../client";
import TerminalCloudAPI from "../services/terminalCloudAPI";
import { terminal } from "../typings";
import { EnvironmentEnum } from "../config";
import { EnvironmentEnum, RegionEnum } from "../config";
import HttpClientException from "../httpClient/httpClientException";

let client: Client;
Expand All @@ -27,6 +27,26 @@ afterEach((): void => {
});

describe("Terminal Cloud API", (): void => {
test("should throw error when region is not specified", (): void => {
const clientWithoutRegion = new Client({
apiKey: "YOUR_API_KEY",
environment: EnvironmentEnum.TEST
});

expect(() => new TerminalCloudAPI(clientWithoutRegion))
.toThrow("Region is required for Terminal API");
});

test("should initialize successfully with region", (): void => {
const clientWithRegion = new Client({
apiKey: "YOUR_API_KEY",
environment: EnvironmentEnum.TEST,
region: RegionEnum.EU
});

expect(() => new TerminalCloudAPI(clientWithRegion)).not.toThrow();
});

test("should make an async payment request", async (): Promise<void> => {
scope.post("/async").reply(200, asyncRes);

Expand Down Expand Up @@ -141,7 +161,7 @@ describe("Terminal Cloud API", (): void => {

const terminalApiHost = "https://terminal-api-test.adyen.com";

const client = new Client({ apiKey: "YOUR_API_KEY", environment: EnvironmentEnum.TEST });
const client = new Client({ apiKey: "YOUR_API_KEY", environment: EnvironmentEnum.TEST, region: RegionEnum.EU });
const terminalCloudAPI = new TerminalCloudAPI(client);

const terminalAPIPaymentRequest = createTerminalAPIPaymentRequest();
Expand All @@ -168,7 +188,7 @@ describe("Terminal Cloud API", (): void => {
test("sync should validate 308 location header", async (): Promise<void> => {
const terminalApiHost = "https://terminal-api-test.adyen.com";

const client = new Client({ apiKey: "YOUR_API_KEY", environment: EnvironmentEnum.TEST });
const client = new Client({ apiKey: "YOUR_API_KEY", environment: EnvironmentEnum.TEST, region: RegionEnum.EU });

const terminalCloudAPI = new TerminalCloudAPI(client);

Expand Down Expand Up @@ -203,10 +223,9 @@ describe("Terminal Cloud API", (): void => {
});

test("async should skip 308 redirect", async (): Promise<void> => {

const terminalApiHost = "https://terminal-api-test.adyen.com";

const client = new Client({ apiKey: "YOUR_API_KEY", environment: EnvironmentEnum.TEST, enable308Redirect: false });
const client = new Client({ apiKey: "YOUR_API_KEY", environment: EnvironmentEnum.TEST, region: RegionEnum.EU, enable308Redirect: false });
const terminalCloudAPI = new TerminalCloudAPI(client);

const terminalAPIPaymentRequest = createTerminalAPIPaymentRequest();
Expand Down
5 changes: 5 additions & 0 deletions src/services/terminalCloudAPI.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ class TerminalCloudAPI extends Service {

public constructor(client: Client) {
super(client);

if (!client.config.region) {
throw new Error("Region is required for Terminal API");
}

this.apiKeyRequired = true;
this.terminalApiAsync = new Async(this);
this.terminalApiSync = new Sync(this);
Expand Down