Adjust Region class with valid regions plus endpoint mappings for terminal api live

pom.xml

@@ -270,5 +270,11 @@
             <version>${swagger-core-version}</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-params</artifactId>
+            <version>5.10.0</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>

src/main/java/com/adyen/Client.java

@@ -1,6 +1,8 @@
 package com.adyen;
 
 import com.adyen.enums.Environment;
+import com.adyen.enums.Regions;
+import com.adyen.enums.Regions.Region;
 import com.adyen.httpclient.AdyenHttpClient;
 import com.adyen.httpclient.ClientInterface;
 
@@ -13,6 +15,9 @@ public class Client {
     public static final String LIB_VERSION = "32.0.0";
     public static final String TERMINAL_API_ENDPOINT_TEST = "https://terminal-api-test.adyen.com";
     public static final String TERMINAL_API_ENDPOINT_LIVE = "https://terminal-api-live.adyen.com";
+    public static final String TERMINAL_API_ENDPOINT_US = "https://terminal-api-live-us.adyen.com";
+    public static final String TERMINAL_API_ENDPOINT_AU = "https://terminal-api-live-au.adyen.com";
+    public static final String TERMINAL_API_ENDPOINT_APSE = "https://terminal-api-live-apse.adyen.com";
 
     public Client() {
         this.config = new Config();
@@ -130,6 +135,7 @@ public void setEnvironment(Environment environment, String liveEndpointUrlPrefix
         if (liveEndpointUrlPrefix != null) {
             config.setLiveEndpointUrlPrefix(liveEndpointUrlPrefix);
         }
+
         if (Environment.TEST.equals(environment)) {
             this.config.setEnvironment(environment);
             this.config.setTerminalApiCloudEndpoint(TERMINAL_API_ENDPOINT_TEST);
@@ -139,6 +145,25 @@ public void setEnvironment(Environment environment, String liveEndpointUrlPrefix
         }
     }
 
+    /**
+     * @param region The region for which the endpoint is requested. If null or the region is not found, defaults to default EU endpoint.
+     */
+    public String getCloudEndpoint(Region region, Environment environment) {
+        if (region != null && !Regions.TERMINAL_API_ENDPOINTS_MAPPING.containsKey(region)) {
+            throw new IllegalArgumentException("Region " + region + " is not supported yet");
+        }
+        // Check the environment for TEST and get the endpoint
+        if (environment.equals(Environment.TEST)) {
+            return Client.TERMINAL_API_ENDPOINT_TEST;
+        }
+        // For LIVE environment, lookup the endpoint using the map
+        if (environment.equals(Environment.LIVE)) {
+            return Regions.TERMINAL_API_ENDPOINTS_MAPPING.getOrDefault(region, TERMINAL_API_ENDPOINT_LIVE);
+        }
+        // Default to EU endpoint if no environment or region is specified
+        return Regions.TERMINAL_API_ENDPOINTS_MAPPING.get(Region.EU);
+    }
+
     @Override
     public String toString() {
         return "Client [webServiceUser=" + this.config.username + ", environment=" + this.config.environment + "]";

src/main/java/com/adyen/Config.java

@@ -1,7 +1,7 @@
 package com.adyen;
 
 import com.adyen.enums.Environment;
-
+import com.adyen.enums.Regions.Region;
 import javax.net.ssl.HostnameVerifier;
 import javax.net.ssl.SSLContext;
 
@@ -22,6 +22,7 @@ public class Config {
     protected String terminalApiCloudEndpoint;
     protected String terminalApiLocalEndpoint;
     protected String liveEndpointUrlPrefix;
+    protected Region terminalApiRegion;
     protected SSLContext sslContext;
     protected HostnameVerifier hostnameVerifier;
 
@@ -69,7 +70,7 @@ public void setApiKey(String apiKey) {
         this.apiKey = apiKey;
     }
 
-    public String getTerminalApiCloudEndpoint() {
+    public String  getTerminalApiCloudEndpoint() {
         return terminalApiCloudEndpoint;
     }
 
@@ -85,6 +86,14 @@ public void setTerminalApiLocalEndpoint(String terminalApiLocalEndpoint) {
         this.terminalApiLocalEndpoint = terminalApiLocalEndpoint;
     }
 
+    public Region getTerminalApiRegion() {
+        return terminalApiRegion;
+    }
+
+    public void setTerminalApiRegion(Region terminalApiRegion) {
+        this.terminalApiRegion = terminalApiRegion;
+    }
+
     public int getConnectionTimeoutMillis() {
         return connectionTimeoutMillis;
     }

src/main/java/com/adyen/enums/Regions.java

@@ -0,0 +1,62 @@
+package com.adyen.enums;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import com.adyen.Client;
+
+public final class Regions {
+
+    // Prevent instantiation
+    private Regions() {
+        throw new UnsupportedOperationException("Utility class");
+    }
+
+    public enum Region {
+
+        /**
+         * European Union region
+         */
+        EU,
+
+        /**
+         * United States region
+         */
+        US,
+
+        /**
+         * Australia region
+         */
+        AU,
+
+        /**
+         * India region
+         */
+        IN,
+
+        /**
+         * Asia-Pacific, South East region
+         */
+        APSE
+    }
+
+    /**
+     * List of all valid regions
+     */
+    public static final List<Region> VALID_REGIONS =
+            Collections.unmodifiableList(List.of(Region.values()));
+
+    /**
+     * Maps regions to their respective Terminal API endpoints.
+     */
+    public static final Map<Region, String> TERMINAL_API_ENDPOINTS_MAPPING;
+
+    static {
+        Map<Region, String> endpointsMapping = new HashMap<>();
+        endpointsMapping.put(Region.EU, Client.TERMINAL_API_ENDPOINT_LIVE);
+        endpointsMapping.put(Region.US, Client.TERMINAL_API_ENDPOINT_US);
+        endpointsMapping.put(Region.AU, Client.TERMINAL_API_ENDPOINT_AU);
+        endpointsMapping.put(Region.APSE, Client.TERMINAL_API_ENDPOINT_APSE);
+        TERMINAL_API_ENDPOINTS_MAPPING = Collections.unmodifiableMap(endpointsMapping);
+    }
+}

src/test/java/com/adyen/ClientTest.java

@@ -1,14 +1,23 @@
 package com.adyen;
 
-import com.adyen.enums.Environment;
-import com.adyen.enums.Region;
-import com.adyen.model.RequestOptions;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.stream.Stream;
+
+import javax.net.ssl.SSLContext;
+
 import org.junit.Assert;
 import org.junit.Test;
 import org.mockito.Mock;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
 
-import javax.net.ssl.SSLContext;
-import java.util.HashMap;
+import com.adyen.enums.Environment;
+import com.adyen.enums.Regions;
+import com.adyen.enums.Regions.Region;
+import com.adyen.model.RequestOptions;
 
 public class ClientTest {
 
@@ -18,16 +27,17 @@ public class ClientTest {
     @Mock
     private String apiKey;
 
+
     @Test
     public void testConfigTestClient() {
         Config config = new Config();
         config.setEnvironment(Environment.TEST);
         config.setApiKey(apiKey);
         Client client = new Client(config);
-
+        
         Assert.assertEquals(Environment.TEST, client.getConfig().getEnvironment());
     }
-
+    
     @Test
     public void testConfigLiveClient() {
         Config config = new Config();
@@ -38,6 +48,83 @@ public void testConfigLiveClient() {
         Assert.assertEquals(Environment.LIVE, client.getConfig().getEnvironment());
     }
 
+    private static Stream<Arguments> provideCloudTestEndpointTestCases() {
+        return Stream.of(
+            Arguments.of(null, Environment.TEST, "https://terminal-api-test.adyen.com"),
+            Arguments.of(Region.EU, Environment.TEST, "https://terminal-api-test.adyen.com"),
+            Arguments.of(Region.AU, Environment.TEST, "https://terminal-api-test.adyen.com"),
+            Arguments.of(Region.US, Environment.TEST, "https://terminal-api-test.adyen.com"),
+            Arguments.of(Region.APSE, Environment.TEST, "https://terminal-api-test.adyen.com")
+        );
+    }
+
+    @ParameterizedTest
+    @MethodSource("provideCloudTestEndpointTestCases")
+    public void testGetCloudEndpointForTestEnvironment(Region region, Environment environment, String expectedEndpoint) {
+        Config testConfig = new Config();
+        testConfig.setEnvironment(Environment.TEST);
+        Client testClient = new Client(testConfig);
+
+        // call the method and assert the result
+        String result = testClient.getCloudEndpoint(region, testConfig.getEnvironment());
+        Assert.assertEquals("Unexpected endpoint for region: " + region, expectedEndpoint, result);
+    }
+
+    private static Stream<Arguments> provideCloudLiveEndpointTestCases() {
+        return Stream.of(
+            Arguments.of(null, Environment.LIVE, "https://terminal-api-live.adyen.com"),
+            Arguments.of(Region.EU, Environment.LIVE, "https://terminal-api-live.adyen.com"),
+            Arguments.of(Region.AU, Environment.LIVE, "https://terminal-api-live-au.adyen.com"),
+            Arguments.of(Region.US, Environment.LIVE, "https://terminal-api-live-us.adyen.com"),
+            Arguments.of(Region.APSE, Environment.LIVE, "https://terminal-api-live-apse.adyen.com")
+        );
+    }
+
+    @ParameterizedTest
+    @MethodSource("provideCloudLiveEndpointTestCases")
+    public void testGetCloudEndpointForLiveEnvironment(Region region, Environment environment, String expectedEndpoint) {
+        // Create a Config object for the LIVE environment
+        Config liveConfig = new Config();
+        liveConfig.setEnvironment(Environment.LIVE);
+        Client liveClient = new Client(liveConfig);
+
+        // call the method and assert the result
+        String result = liveClient.getCloudEndpoint(region, liveConfig.getEnvironment());
+        Assert.assertEquals("Unexpected endpoint for region: " + region, expectedEndpoint, result);
+    }
+
+    @Test
+    public void testRegionsNotInMappingThrowException() {
+        List<Region> unmappedRegions = new ArrayList<>();
+
+        // Find unmapped regions
+        for (Region region : Regions.VALID_REGIONS) {
+            if (!Regions.TERMINAL_API_ENDPOINTS_MAPPING.containsKey(region)) {
+                unmappedRegions.add(region);
+            }
+        }
+
+        // If no unmapped regions exist, skip the test
+        if (unmappedRegions.isEmpty()) {
+            System.out.println("Skipping test: All regions are in the mapping.");
+            return;
+        }
+
+        // Iterate through unmapped regions and test
+        for (Region region : unmappedRegions) {
+            Config config = new Config();
+            config.setEnvironment(Environment.LIVE);
+            Client client = new Client(config);
+
+            try {
+                client.getCloudEndpoint(region, Environment.LIVE);
+                Assert.fail("Expected IllegalArgumentException to be thrown for region: " + region);
+            } catch (IllegalArgumentException e) {
+                Assert.assertEquals("Region " + region + " is not supported yet", e.getMessage());
+            }
+        }
+    }          
+
     @Test
     public void testClientCertificateAuth() {
         Client client = new Client(clientCertificateAuthSSLContext, apiKey);
@@ -54,8 +141,4 @@ public void testRequestOptionsBuilderPattern() {
                 .additionalServiceHeaders(map);
         Assert.assertEquals(requestOptions.getAdditionalServiceHeaders(), map);
     }
-
-    private void assertCommonEndpoints(Config config) {
-        Assert.assertEquals(Client.TERMINAL_API_ENDPOINT_LIVE, config.getTerminalApiCloudEndpoint());
-    }
 }

src/test/java/com/adyen/RegionTest.java

@@ -0,0 +1,64 @@
+package com.adyen;
+
+import com.adyen.enums.Regions.Region;
+import com.adyen.enums.Regions;
+import java.util.stream.Collectors;
+import org.junit.Test;
+import java.util.List;
+import java.util.Map;
+
+import static org.junit.Assert.assertEquals;
+
+public class RegionTest {
+    @Test
+    public void testValidRegions() {
+
+        // Convert Regions.VALID_REGIONS to lowercase strings for comparison
+        List<String> actual = Regions.VALID_REGIONS.stream()
+        .map(region -> region.name().toLowerCase())
+        .collect(Collectors.toList());
+
+        // Define the expected list of valid regions
+        List<String> expected = List.of(
+            "eu",
+            "us",
+            "au",
+            "in",
+            "apse"
+        );
+
+        // Assert that the VALID_REGIONS in Region matches the expected list
+        assertEquals(
+            "VALID_REGIONS should match the expected regions.",
+            expected,
+            actual
+        );
+    }
+
+    @Test
+    public void testTerminalApiEndpointsMapping() {
+
+        // Convert TERMINAL_API_ENDPOINTS_MAPPING keys to lowercase strings for comparison
+        Map<String, String> actual = Regions.TERMINAL_API_ENDPOINTS_MAPPING.entrySet()
+        .stream()
+        .collect(Collectors.toMap(
+                entry -> entry.getKey().name().toLowerCase(), // Convert key (Region enum) to lowercase
+                Map.Entry::getValue
+        ));
+
+        // Define the expected map of region to endpoint mappings
+        Map<String, String> expected = Map.of(
+            "eu", "https://terminal-api-live.adyen.com",
+            "us", "https://terminal-api-live-us.adyen.com",
+            "au", "https://terminal-api-live-au.adyen.com",
+            "apse", "https://terminal-api-live-apse.adyen.com"
+        );
+
+        // Assert that the TERMINAL_API_ENDPOINTS_MAPPING in Region matches the expected map
+        assertEquals(
+            "TERMINAL_API_ENDPOINTS_MAPPING should match the expected mappings.",
+            expected,
+            actual
+        );
+    }
+}