Merge pull request #204 from rosette-api/WS-2744-restore-genre

WS-2744: restore genre

Author: Katsuya-Tomioka

annotations/pom.xml

@@ -19,7 +19,7 @@
     <parent>
         <groupId>com.basistech.rosette</groupId>
         <artifactId>rosette-api-java-binding</artifactId>
-        <version>1.25.1-SNAPSHOT</version>
+        <version>1.25.101-SNAPSHOT</version>
     </parent>
     <artifactId>rosette-api-annotations</artifactId>
     <name>rosette-api-annotations</name>

api/pom.xml

@@ -19,7 +19,7 @@
     <parent>
         <groupId>com.basistech.rosette</groupId>
          <artifactId>rosette-api-java-binding</artifactId>
-        <version>1.25.1-SNAPSHOT</version>
+        <version>1.25.101-SNAPSHOT</version>
     </parent>
     <artifactId>rosette-api</artifactId>
     <name>rosette-api</name>

common/pom.xml

@@ -19,7 +19,7 @@
     <parent>
         <groupId>com.basistech.rosette</groupId>
         <artifactId>rosette-api-java-binding</artifactId>
-        <version>1.25.1-SNAPSHOT</version>
+        <version>1.25.101-SNAPSHOT</version>
     </parent>
     <artifactId>rosette-api-common</artifactId>
     <name>rosette-api-common</name>

examples/pom.xml

@@ -20,7 +20,7 @@
     <parent>
         <groupId>com.basistech.rosette</groupId>
         <artifactId>rosette-api-java-binding</artifactId>
-        <version>1.25.1-SNAPSHOT</version>
+        <version>1.25.101-SNAPSHOT</version>
     </parent>
     <groupId>com.basistech.rosette</groupId>
     <artifactId>rosette-api-examples</artifactId>

json/pom.xml

@@ -20,7 +20,7 @@
     <parent>
         <groupId>com.basistech.rosette</groupId>
         <artifactId>rosette-api-java-binding</artifactId>
-        <version>1.25.1-SNAPSHOT</version>
+        <version>1.25.101-SNAPSHOT</version>
     </parent>
     <artifactId>rosette-api-json</artifactId>
     <name>rosette-api-json</name>

json/src/main/java/com/basistech/rosette/apimodel/jackson/DocumentRequestMixin.java

@@ -20,6 +20,7 @@
 import com.basistech.util.LanguageCode;
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeName;
@@ -30,6 +31,7 @@
 
 //CHECKSTYLE:OFF
 @JsonTypeName("DocumentRequest")
+@JsonIgnoreProperties({"genre"})
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public abstract class DocumentRequestMixin {
 

json/src/test/java/com/basistech/rosette/apimodel/ModelTest.java

@@ -18,10 +18,13 @@
 
 import com.basistech.rosette.apimodel.jackson.ApiModelMixinModule;
 import com.basistech.rosette.apimodel.jackson.DocumentRequestMixin;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.ObjectWriter;
 import com.google.common.collect.Lists;
 import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.MethodSource;
@@ -43,6 +46,7 @@
 import java.util.stream.Stream;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assertions.fail;
 
 @SuppressWarnings("PMD.UnusedPrivateMethod") // Parameterized Tests
@@ -376,4 +380,12 @@ private Object createObjectOfType(Type type) {
         }
         return object;
     }
+
+    @Test
+    void doNotDeserializeGenre() throws JsonProcessingException {
+        String json = "{\"content\": \"foo\", \"genre\":\"foo\"}";
+        // Ensure that the document request no longer deserializes genre
+        Request request = mapper.readValue(json, new TypeReference<DocumentRequest<EntitiesOptions>>() { });
+        assertTrue(mapper.writeValueAsString(request).indexOf("genre") == -1);
+    }
 }

json/src/test/java/com/basistech/rosette/apimodel/PolymorphicRequestTest.java

@@ -38,10 +38,14 @@ public void init() {
     @Test
     void testRequestTypes() throws Exception {
 
-        String json = "{\"content\": \"what is my type\", \"language\": \"eng\", \"options\": {\"calculateConfidence\": true}}";
+        String json = "{\"content\": \"what is my type\", \"language\": \"eng\", \"genre\": \"news\"}";
         Request request = mapper.readValue(json, new TypeReference<DocumentRequest<EntitiesOptions>>() { });
         assertEquals(DOC_REQUEST, request.getClass().getName());
 
+        json = "{\"content\": \"what is my type\", \"language\": \"eng\", \"options\": {\"calculateConfidence\": true}}";
+        request = mapper.readValue(json, new TypeReference<DocumentRequest<EntitiesOptions>>() { });
+        assertEquals(DOC_REQUEST, request.getClass().getName());
+
         json = "{\"content\": \"what is my type\", \"language\": \"eng\", \"options\": {\"includeDBpediaTypes\": true, \"calculateConfidence\": true}}";
         request = mapper.readValue(json, new TypeReference<DocumentRequest<EntitiesOptions>>() { });
         assertEquals(DOC_REQUEST, request.getClass().getName());

model/pom.xml

@@ -19,7 +19,7 @@
     <parent>
         <groupId>com.basistech.rosette</groupId>
         <artifactId>rosette-api-java-binding</artifactId>
-        <version>1.25.1-SNAPSHOT</version>
+        <version>1.25.101-SNAPSHOT</version>
     </parent>
     <artifactId>rosette-api-model</artifactId>
     <name>rosette-api-model</name>

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

@@ -17,6 +17,7 @@
 package com.basistech.rosette.apimodel;
 
 import com.basistech.rosette.annotations.JacksonMixin;
+import javax.validation.constraints.Min;
 import lombok.Builder;
 import lombok.Value;
 
@@ -28,6 +29,16 @@
 @JacksonMixin
 public class CategoriesOptions extends Options {
 
+    /**
+     * @deprecated
+     * Users should use {@link singleLabel} to return only one result
+     * or {@link scoreThreshold} to filter results based on raw score
+     * @return number of categories
+     */
+    @Deprecated
+    @Min(1)
+    private final Integer numCategories;
+
     /**
      * Single label mode will return only the highest scoring category, regardless of score
      * If singleLabel is false, every category whose score exceeds the default