RLPNC-4887: Made changes to support supported-languages for names (#137)

* RLPNC-4887: Made changes to support supported-languages for names

* RLPNC-4887: Updated if condition to use CONSTANT.equals() to avoid NPEs

* RLPNC-4887: Changed schemes to all uppercase.

Author: fhasanaj

api/src/main/java/com/basistech/rosette/api/HttpRosetteAPI.java

@@ -25,6 +25,7 @@
 import com.basistech.rosette.apimodel.PingResponse;
 import com.basistech.rosette.apimodel.Request;
 import com.basistech.rosette.apimodel.Response;
+import com.basistech.rosette.apimodel.SupportedLanguagePairsResponse;
 import com.basistech.rosette.apimodel.SupportedLanguagesResponse;
 import com.basistech.rosette.apimodel.jackson.ApiModelMixinModule;
 import com.basistech.rosette.apimodel.jackson.DocumentRequestMixin;
@@ -227,13 +228,30 @@ public PingResponse ping() throws IOException, HttpRosetteAPIException {
      */
     @Override
     public SupportedLanguagesResponse getSupportedLanguages(String endpoint) throws HttpRosetteAPIException  {
-        if (DOC_ENDPOINTS.contains(endpoint)) {
+        if (DOC_ENDPOINTS.contains(endpoint) || NAME_DEDUPLICATION_SERVICE_PATH.equals(endpoint)) {
             return sendGetRequest(urlBase + endpoint + SUPPORTED_LANGUAGES_SUBPATH, SupportedLanguagesResponse.class);
         } else {
             return null;
         }
     }
 
+    /**
+     * Gets the set of language, script codes and transliteration scheme pairs supported by the specified Rosette API
+     * endpoint.
+     *
+     * @param endpoint Rosette API endpoint.
+     * @return SupportedLanguagePairsResponse
+     * @throws HttpRosetteAPIException for an error returned from the Rosette API.
+     */
+    @Override
+    public SupportedLanguagePairsResponse getSupportedLanguagePairs(String endpoint) throws HttpRosetteAPIException  {
+        if (NAMES_ENDPOINTS.contains(endpoint) && !NAME_DEDUPLICATION_SERVICE_PATH.equals(endpoint)) {
+            return sendGetRequest(urlBase + endpoint + SUPPORTED_LANGUAGES_SUBPATH, SupportedLanguagePairsResponse.class);
+        } else {
+            return null;
+        }
+    }
+
     /**
      *
      * @param endpoint which endpoint.

api/src/test/java/com/basistech/rosette/api/BasicTest.java

@@ -19,12 +19,17 @@
 import com.basistech.rosette.apimodel.AdmRequest;
 import com.basistech.rosette.apimodel.Response;
 import com.basistech.rosette.apimodel.SupportedLanguage;
+import com.basistech.rosette.apimodel.SupportedLanguagePair;
+import com.basistech.rosette.apimodel.SupportedLanguagePairsResponse;
 import com.basistech.rosette.apimodel.SupportedLanguagesResponse;
 import com.basistech.rosette.apimodel.jackson.ApiModelMixinModule;
 import com.basistech.rosette.dm.AnnotatedText;
 
 import com.basistech.util.ISO15924;
 import com.basistech.util.LanguageCode;
+import com.basistech.util.TextDomain;
+import com.basistech.util.TransliterationScheme;
+
 import org.apache.commons.io.IOUtils;
 import org.apache.http.HttpHeaders;
 import org.junit.Before;
@@ -48,6 +53,8 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 import static com.basistech.rosette.api.common.AbstractRosetteAPI.ENTITIES_SERVICE_PATH;
+import static com.basistech.rosette.api.common.AbstractRosetteAPI.NAME_SIMILARITY_SERVICE_PATH;
+import static com.basistech.rosette.api.common.AbstractRosetteAPI.NAME_TRANSLATION_SERVICE_PATH;
 import static java.util.concurrent.TimeUnit.SECONDS;
 
 public class BasicTest extends AbstractTest {
@@ -244,4 +251,60 @@ public void testLanguageSupport() throws Exception {
                     .build()));
         }
     }
+
+    @Test
+    public void testNameSimilarityLanguageSupport() throws Exception {
+        try (InputStream respIns = getClass().getResourceAsStream("/name-similarity-supported-languages.json")) {
+            mockServer.when(HttpRequest.request()
+                    .withMethod("GET")
+                    .withPath("/rest/v1/name-similarity/supported-languages"))
+                    .respond(HttpResponse.response()
+                            .withStatusCode(200)
+                            .withHeader("Content-Type", "application/json")
+                            .withBody(IOUtils.toString(respIns, "UTF-8")));
+            api = new HttpRosetteAPI.Builder()
+                    .key("foo-key")
+                    .url(String.format("http://localhost:%d/rest/v1", serverPort))
+                    .build();
+
+            SupportedLanguagePairsResponse resp = api.getSupportedLanguagePairs(NAME_SIMILARITY_SERVICE_PATH);
+            assertEquals(2, resp.getSupportedLanguagePairs().size());
+            assertTrue(resp.getSupportedLanguagePairs().contains(SupportedLanguagePair.builder()
+                    .source(new TextDomain(ISO15924.Latn, LanguageCode.ENGLISH, null))
+                    .target(new TextDomain(ISO15924.Latn, LanguageCode.ENGLISH, null))
+                    .build()));
+            assertTrue(resp.getSupportedLanguagePairs().contains(SupportedLanguagePair.builder()
+                    .source(new TextDomain(ISO15924.Arab, LanguageCode.ARABIC, null))
+                    .target(new TextDomain(ISO15924.Arab, LanguageCode.ARABIC, null))
+                    .build()));
+        }
+    }
+
+    @Test
+    public void testNameTranslationLanguageSupport() throws Exception {
+        try (InputStream respIns = getClass().getResourceAsStream("/name-translation-supported-languages.json")) {
+            mockServer.when(HttpRequest.request()
+                    .withMethod("GET")
+                    .withPath("/rest/v1/name-translation/supported-languages"))
+                    .respond(HttpResponse.response()
+                            .withStatusCode(200)
+                            .withHeader("Content-Type", "application/json")
+                            .withBody(IOUtils.toString(respIns, "UTF-8")));
+            api = new HttpRosetteAPI.Builder()
+                    .key("foo-key")
+                    .url(String.format("http://localhost:%d/rest/v1", serverPort))
+                    .build();
+
+            SupportedLanguagePairsResponse resp = api.getSupportedLanguagePairs(NAME_TRANSLATION_SERVICE_PATH);
+            assertEquals(2, resp.getSupportedLanguagePairs().size());
+            assertTrue(resp.getSupportedLanguagePairs().contains(SupportedLanguagePair.builder()
+                    .source(new TextDomain(ISO15924.Latn, LanguageCode.ENGLISH, TransliterationScheme.NATIVE))
+                    .target(new TextDomain(ISO15924.Latn, LanguageCode.ENGLISH, TransliterationScheme.IC))
+                    .build()));
+            assertTrue(resp.getSupportedLanguagePairs().contains(SupportedLanguagePair.builder()
+                    .source(new TextDomain(ISO15924.Arab, LanguageCode.ARABIC, TransliterationScheme.NATIVE))
+                    .target(new TextDomain(ISO15924.Arab, LanguageCode.ARABIC, TransliterationScheme.NATIVE))
+                    .build()));
+        }
+    }
 }

api/src/test/resources/name-similarity-supported-languages.json

@@ -0,0 +1,6 @@
+{
+  "supportedLanguagePairs": [
+    {"source": {"language": "eng", "script": "Latn"}, "target": {"language": "eng", "script": "Latn"}},
+    {"source": {"language": "ara", "script": "Arab"}, "target": {"language": "ara", "script": "Arab"}}
+  ]
+}

api/src/test/resources/name-translation-supported-languages.json

@@ -0,0 +1,6 @@
+{
+  "supportedLanguagePairs": [
+    {"source": {"language": "eng", "script": "Latn", "transliterationScheme": "NATIVE"}, "target": {"language": "eng", "script": "Latn", "transliterationScheme": "IC"}},
+    {"source": {"language": "ara", "script": "Arab", "transliterationScheme": "NATIVE"}, "target": {"language": "ara", "script": "Arab", "transliterationScheme": "NATIVE"}}
+  ]
+}

common/src/main/java/com/basistech/rosette/api/common/AbstractRosetteAPI.java

@@ -24,6 +24,7 @@
 import com.basistech.rosette.apimodel.CommonRosetteAPIException;
 import com.basistech.rosette.apimodel.Request;
 import com.basistech.rosette.apimodel.Response;
+import com.basistech.rosette.apimodel.SupportedLanguagePairsResponse;
 import com.basistech.rosette.apimodel.SupportedLanguagesResponse;
 import com.basistech.rosette.dm.AnnotatedText;
 
@@ -85,6 +86,16 @@ public abstract class AbstractRosetteAPI implements AutoCloseable {
      */
     public abstract SupportedLanguagesResponse getSupportedLanguages(String endpoint) throws CommonRosetteAPIException;
 
+    /**
+     * Gets the set of language, script codes and transliteration scheme pairs supported by the specified Rosette API
+     * endpoint.
+     *
+     * @param endpoint Rosette API endpoint.
+     * @return SupportedLanguagePairsResponse
+     * @throws CommonRosetteAPIException for an error returned from the Rosette API.
+     */
+    public abstract SupportedLanguagePairsResponse getSupportedLanguagePairs(String endpoint) throws CommonRosetteAPIException;
+
     /**
      * Perform a request to an endpoint of the Rosette API.
      * @param endpoint which endpoint.

model/src/main/java/com/basistech/rosette/apimodel/SupportedLanguagePair.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2018 Basis Technology Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basistech.rosette.apimodel;
+
+import com.basistech.rosette.annotations.JacksonMixin;
+import com.basistech.util.TextDomain;
+
+import lombok.Builder;
+import lombok.Value;
+
+/**
+ * Supported language/script/scheme pairs
+ */
+@Value
+@Builder
+@JacksonMixin
+public class SupportedLanguagePair {
+    /**
+     * @return the source TextDomain
+     */
+    private final TextDomain source;
+
+    /**
+     * @return the target TextDomain
+     */
+    private final TextDomain target;
+}

model/src/main/java/com/basistech/rosette/apimodel/SupportedLanguagePairsResponse.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2018 Basis Technology Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basistech.rosette.apimodel;
+
+import com.basistech.rosette.annotations.JacksonMixin;
+
+import lombok.Builder;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+
+import java.util.Set;
+
+/**
+ * Supported language/script/scheme pairs for name-translation and name-similarity endpoints
+ */
+@Getter
+@EqualsAndHashCode
+@Builder
+@JacksonMixin
+public class SupportedLanguagePairsResponse extends Response {
+    /**
+     * @return the set of supported language pairs
+     */
+    private final Set<SupportedLanguagePair> supportedLanguagePairs;
+}

model/src/main/java/com/basistech/rosette/apimodel/SupportedLanguagesResponse.java

@@ -24,7 +24,7 @@
 import java.util.Set;
 
 /**
- * Supported langauges/scripts for a given endpoint
+ * Supported languages/scripts for a given endpoint
  */
 @Getter
 @EqualsAndHashCode