Support returnProperties and includedProperties parameters of ListItems and ListUsers. Send User-Agent HTTP header. Use POST for recomm requests.

Author: OndraFiedler

README.md

@@ -8,12 +8,12 @@ Documentation of the API can be found at [docs.recombee.com](https://docs.recomb
 
 ## Installation
 
-The client is available in the [Maven Central Repository](https://mvnrepository.com/artifact/com.recombee/api-client/), so you need only to add the following `<dependency>` entry to your project's POM:
+The client is available in the [Maven Central Repository](https://mvnrepository.com/artifact/com.recombee/api-client/), so you just need to add the following `<dependency>` entry to your project's POM:
 ```xml
     <dependency>
         <groupId>com.recombee</groupId>
         <artifactId>api-client</artifactId>
-        <version>1.3</version>
+        <version>1.4.0</version>
     </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.recombee</groupId>
     <artifactId>api-client</artifactId>
-    <version>1.3</version>
+    <version>1.4.0</version>
     <name>Recombee API Client</name>
     <description>A client library for easy use of the Recombee recommendation API</description>
     <url>http://recombee.com</url>

src/main/java/com/recombee/api_client/RecombeeClient.java

@@ -77,6 +77,8 @@ public class RecombeeClient {
 
     final int BATCH_MAX_SIZE = 10000; //Maximal number of requests within one batch request
 
+    final String USER_AGENT = "recombee-java-api-client/1.4.0";
+
     public RecombeeClient(String databaseId, String token) {
         this.databaseId = databaseId;
         this.token = token;
@@ -96,16 +98,6 @@ public void setDefaultProtocol(NetworkApplicationProtocol defaultProtocol) {
         this.defaultProtocol = defaultProtocol;
     }
     /* Start of the generated code */
-    public Item[] send(ListItems request) throws ApiException {
-        String responseStr = sendRequest(request);
-        try {
-            return this.mapper.readValue(responseStr, Item[].class);
-        } catch (IOException e) {
-            e.printStackTrace();
-         }
-         return null;
-    }
-
     public PropertyInfo send(GetItemPropertyInfo request) throws ApiException {
         String responseStr = sendRequest(request);
         try {
@@ -166,16 +158,6 @@ public GroupItem[] send(ListGroupItems request) throws ApiException {
          return null;
     }
 
-    public User[] send(ListUsers request) throws ApiException {
-        String responseStr = sendRequest(request);
-        try {
-            return this.mapper.readValue(responseStr, User[].class);
-        } catch (IOException e) {
-            e.printStackTrace();
-         }
-         return null;
-    }
-
     public PropertyInfo send(GetUserPropertyInfo request) throws ApiException {
         String responseStr = sendRequest(request);
         try {
@@ -344,15 +326,43 @@ public BatchResponse[] send(Batch batchRequest) throws ApiException {
                             parsedResponse = ar;
                         }
                     }
-                    /* Start of the generated code */
                     else if (request instanceof ListItems)
                     {
-                        ArrayList<String> array = (ArrayList<String>) parsedResponse;
-                        Item[] ar = new Item[array.size()];
-                        for(int j=0;j<ar.length;j++) ar[j] = new Item(array.get(j));
-                        parsedResponse = ar;
+                        boolean returnProperties = ((ListItems) request).getReturnProperties();
+                        if(returnProperties)
+                        {
+                            ArrayList<Map<String, Object>> array = (ArrayList<Map<String, Object>>) parsedResponse;
+                            Item[] ar = new Item[array.size()];
+                            for(int j=0;j<ar.length;j++) ar[j] = new Item((String)array.get(j).get("itemId"), array.get(j));
+                            parsedResponse = ar;
+                        }
+                        else
+                        {
+                            ArrayList<String> array = (ArrayList<String>) parsedResponse;
+                            Item[] ar = new Item[array.size()];
+                            for(int j=0;j<ar.length;j++) ar[j] = new Item(array.get(j));
+                            parsedResponse = ar;
+                        }
                     }
-
+                    else if (request instanceof ListUsers)
+                    {
+                        boolean returnProperties = ((ListUsers) request).getReturnProperties();
+                        if(returnProperties)
+                        {
+                            ArrayList<Map<String, Object>> array = (ArrayList<Map<String, Object>>) parsedResponse;
+                            User[] ar = new User[array.size()];
+                            for(int j=0;j<ar.length;j++) ar[j] = new User((String)array.get(j).get("userId"), array.get(j));
+                            parsedResponse = ar;
+                        }
+                        else
+                        {
+                            ArrayList<String> array = (ArrayList<String>) parsedResponse;
+                            User[] ar = new User[array.size()];
+                            for(int j=0;j<ar.length;j++) ar[j] = new User(array.get(j));
+                            parsedResponse = ar;
+                        }
+                    }
+                    /* Start of the generated code */
                     else if (request instanceof GetItemPropertyInfo)
                     {
                         Map<String, Object> obj = (Map<String, Object>) parsedResponse;
@@ -399,14 +409,6 @@ else if (request instanceof ListGroupItems)
                         parsedResponse = ar;
                     }
 
-                    else if (request instanceof ListUsers)
-                    {
-                        ArrayList<String> array = (ArrayList<String>) parsedResponse;
-                        User[] ar = new User[array.size()];
-                        for(int j=0;j<ar.length;j++) ar[j] = new User(array.get(j));
-                        parsedResponse = ar;
-                    }
-
                     else if (request instanceof GetUserPropertyInfo)
                     {
                         Map<String, Object> obj = (Map<String, Object>) parsedResponse;
@@ -616,6 +618,50 @@ protected Recommendation[] sendRecomm(Request request) throws ApiException {
          return null;
     }
 
+    public Item[] send(ListItems request) throws ApiException {
+        String responseStr = sendRequest(request);
+
+        try {
+            return this.mapper.readValue(responseStr, Item[].class);
+        } catch (IOException e) {
+            //might have failed because it returned also the item properties
+            TypeReference<HashMap<String,Object>[]> typeRef 
+                    = new TypeReference<HashMap<String,Object>[]>() {};
+            try {
+                Map<String, Object>[] valsArray = this.mapper.readValue(responseStr, typeRef);
+                Item [] recomms = new Item[valsArray.length];
+                for(int i=0;i<valsArray.length;i++)
+                    recomms[i] = new Item((String)valsArray[i].get("itemId"), valsArray[i]);
+                return recomms;
+            } catch (IOException e2) {
+                e2.printStackTrace();
+            }
+         }
+         return null;
+    }
+
+
+    public User[] send(ListUsers request) throws ApiException {
+        String responseStr = sendRequest(request);
+
+        try {
+            return this.mapper.readValue(responseStr, User[].class);
+        } catch (IOException e) {
+            //might have failed because it returned also the user properties
+            TypeReference<HashMap<String,Object>[]> typeRef 
+                    = new TypeReference<HashMap<String,Object>[]>() {};
+            try {
+                Map<String, Object>[] valsArray = this.mapper.readValue(responseStr, typeRef);
+                User [] recomms = new User[valsArray.length];
+                for(int i=0;i<valsArray.length;i++)
+                    recomms[i] = new User((String)valsArray[i].get("userId"), valsArray[i]);
+                return recomms;
+            } catch (IOException e2) {
+                e2.printStackTrace();
+            }
+         }
+         return null;
+    }
 
     public String send(Request request) throws ApiException {
         return sendRequest(request);
@@ -636,7 +682,7 @@ protected String sendRequest(Request request) throws ApiException {
                 httpRequest = post(uri, request);
                 break;
             case PUT:
-                httpRequest = put(uri);
+                httpRequest = put(uri, request);
                 break;
             case DELETE:
                 httpRequest = delete(uri);
@@ -700,21 +746,30 @@ private String formatQueryParameterValue(Object val) {
     }
 
     private HttpRequest get(String url) {
-        return Unirest.get(url);
+        return Unirest.get(url).header("User-Agent", this.USER_AGENT);
     }
 
-    private HttpRequest put(String url) {
-        return Unirest.put(url);
+    private HttpRequest put(String url, Request req) {
+        try {
+            String json = this.mapper.writeValueAsString(req.getBodyParameters());
+            return Unirest.put(url).header("Content-Type", "application/json").
+                    header("User-Agent", this.USER_AGENT).
+                    body(json.getBytes()).getHttpRequest();
+        } catch (JsonProcessingException e) {
+            e.printStackTrace();
+        }
+        return null;
     }
 
     private HttpRequest delete(String url) {
-        return Unirest.delete(url);
+        return Unirest.delete(url).header("User-Agent", this.USER_AGENT);
     }
 
     private HttpRequest post(String url, Request req) {
         try {
             String json = this.mapper.writeValueAsString(req.getBodyParameters());
             return Unirest.post(url).header("Content-Type", "application/json").
+                    header("User-Agent", this.USER_AGENT).
                     body(json.getBytes()).getHttpRequest();
         } catch (JsonProcessingException e) {
             e.printStackTrace();
@@ -727,4 +782,4 @@ private void checkErrors(HttpResponse<String> response, Request request) throws
         throw new ResponseException(request, response.getStatus(), response.getBody());
 
     }
-}
+}