Merge pull request #75 from textkernel/matchv1-obsolete

Marked Search & Match V1 as obsolete

Author: rafaeloliveiraatbh

README.md

@@ -13,7 +13,7 @@ The official Java SDK for the Textkernel Tx v10 API for resume/CV and job parsin
 ### Gradle Users
 Add this dependency to your project's build file:
 ```
-implementation "com.textkernel:tx-java:3.0.2"
+implementation "com.textkernel:tx-java:3.0.3"
 ```
 
 ### Maven Users

pom.xml

@@ -4,7 +4,7 @@
     <groupId>com.textkernel</groupId>
     <artifactId>tx-java</artifactId>
 
-    <version>3.0.2</version>
+    <version>3.0.3</version>
 
     <packaging>jar</packaging>
     <name>Textkernel Tx Java SDK</name>

src/main/java/com/textkernel/tx/TxClient.java

@@ -70,7 +70,9 @@ public class TxClient {
 
     /**
      * @return access all endpoints/methods for Search & Match V1
+     * @deprecated Search & Match V1 is deprecated. You should use {@link #searchMatchV2()} instead.
      */
+    @Deprecated
     public SearchMatchService searchMatchV1() { return _searchMatchV1Service; }
 
     static {

src/main/java/com/textkernel/tx/services/SearchMatchService.java

@@ -540,7 +540,9 @@ SearchRequest createRequest(List<String> indexesToQuery, FilterCriteria query, S
      * @param settings The settings for this search request. Use {@code null} for defaults.
      * @return The API response body
      * @throws TxException Thrown when an API error occurs
+     * @deprecated BimetricScore is deprecated.
      */
+    @Deprecated
     @SuppressWarnings("unchecked") //these actually are checked, compiler just can't tell
     public <TTarget extends IParsedDocWithId> BimetricScoreResponse bimetricScore(
             ParsedResumeWithId sourceResume,
@@ -585,7 +587,9 @@ public <TTarget extends IParsedDocWithId> BimetricScoreResponse bimetricScore(
      * @param settings The settings for this search request. Use {@code null} for defaults.
      * @return The API response body
      * @throws TxException Thrown when an API error occurs
+     * @deprecated BimetricScore is deprecated.
      */
+    @Deprecated
     @SuppressWarnings("unchecked") //these actually are checked, compiler just can't tell
     public <TTarget extends IParsedDocWithId> BimetricScoreResponse bimetricScore(
             ParsedJobWithId sourceJob,

src/test/java/com/textkernel/tx/integration/MatchV2Tests.java

@@ -35,16 +35,27 @@
 import com.textkernel.tx.models.api.parsing.ParseOptions;
 import com.textkernel.tx.models.api.parsing.ParseRequest;
 import com.textkernel.tx.models.api.parsing.ParseResumeResponse;
+import com.textkernel.tx.models.api.parsing.SkillsSettings;
+import com.textkernel.tx.TestData;
+import com.textkernel.tx.models.job.ParsedJob;
+import com.textkernel.tx.models.resume.ParsedResume;
 
 public class MatchV2Tests  extends TestBase {
 
     private static final String _documentId = "1";
 
     @BeforeAll
     static void setup() throws TxException {
-        // add a document to each index
-        ClientDESv2.searchMatchV2().addJob(_documentId, TestParsedJobTech, null, null);
-        ClientDESv2.searchMatchV2().addCandidate(_documentId, TestParsedResume, null, false, null);
+        ParseOptions v2Options = new ParseOptions();
+        v2Options.SkillsSettings = new SkillsSettings();
+        v2Options.SkillsSettings.Normalize = true;
+        v2Options.SkillsSettings.TaxonomyVersion = "V2";
+
+        ParsedJob jobV2 = ClientDESv2.parser().parseJob(new ParseRequest(TestData.JobOrderTech, v2Options)).Value.JobData;
+        ParsedResume resumeV2 = ClientDESv2.parser().parseResume(new ParseRequest(TestData.Resume, v2Options)).Value.ResumeData;
+
+        ClientDESv2.searchMatchV2().addJob(_documentId, jobV2, null, null);
+        ClientDESv2.searchMatchV2().addCandidate(_documentId, resumeV2, null, false, null);
         delayForIndexSync(5);
     }
 
@@ -94,6 +105,9 @@ public void testParseAndUpload() throws TxException, IOException {
 
         ParseOptions options = new ParseOptions();
         options.IndexingOptions = new IndexingOptionsGeneric(MatchV2Environment.PROD, docId, null, null);
+        options.SkillsSettings = new SkillsSettings();
+        options.SkillsSettings.Normalize = true;
+        options.SkillsSettings.TaxonomyVersion = "V2";
 
         ParseResumeResponse parseResponse = ClientDESv2.parser().parseResume(new ParseRequest(document, options));
         assertTrue(parseResponse.Value.IndexingResponse.isSuccess());

src/test/java/com/textkernel/tx/integration/ParsingTests.java

@@ -170,7 +170,7 @@ public void verifyparseJobSuccess() throws Exception
         assertNotNull(response.ParsingMetadata);
     }
 
-    @Test
+     @Test
     public void testParseResumeGeocodeIndex() throws TxException {
         String indexId = "SDK-testParseResumeGeocodeIndex";
         String documentId = "1";
@@ -181,7 +181,7 @@ public void testParseResumeGeocodeIndex() throws TxException {
         IndexingOptionsGeneric indexingOptions = new IndexingOptionsGeneric(documentId, indexId, null);
 
         // since there isn't an address this will throw an exception
-        assertThrows(TxGeocodeResumeException.class, () -> {
+        assertThrows(TxException.class, () -> {
             ParseRequest request = new ParseRequest(TestData.Resume, null);
             request.GeocodeOptions = geocodeOptions;
             request.IndexingOptions = indexingOptions;
@@ -190,7 +190,7 @@ public void testParseResumeGeocodeIndex() throws TxException {
 
 
         // confirm you can geocode but indexing fails
-        assertThrows(TxIndexResumeException.class, () -> {
+        assertThrows(TxException.class, () -> {
             ParseRequest request = new ParseRequest(TestData.ResumeWithAddress, null);
             request.GeocodeOptions = geocodeOptions;
             request.IndexingOptions = indexingOptions;