Merge branch 'master' of github.com:algolia/algoliasearch-client-android

Author: Clément Le Provost

algoliasearch/src/main/java/com/algolia/search/saas/Index.java

@@ -364,6 +364,23 @@ public Request getObjectsAsync(final @NonNull List<String> objectIDs, @NonNull C
         }.start();
     }
 
+    /**
+     * Get several objects from this index (asynchronously), optionally restricting the retrieved content (asynchronously).
+     *
+     * @param objectIDs            Identifiers of objects to retrieve.
+     * @param attributesToRetrieve List of attributes to retrieve.
+     * @param completionHandler    The listener that will be notified of the request's outcome.
+     * @return A cancellable request.
+     */
+    public Request getObjectsAsync(final @NonNull List<String> objectIDs, final List<String> attributesToRetrieve, @NonNull CompletionHandler completionHandler) {
+        return getClient().new AsyncTaskRequest(completionHandler) {
+            @NonNull
+            @Override JSONObject run() throws AlgoliaException {
+                return getObjects(objectIDs, attributesToRetrieve);
+            }
+        }.start();
+    }
+
     /**
      * Wait until the publication of a task on the server (helper).
      * All server tasks are asynchronous. This method helps you check that a task is published.
@@ -649,15 +666,8 @@ protected JSONObject getObject(String objectID) throws AlgoliaException {
      */
     protected JSONObject getObject(String objectID, List<String> attributesToRetrieve) throws AlgoliaException {
         try {
-            StringBuilder params = new StringBuilder();
-            params.append("?attributes=");
-            for (int i = 0; i < attributesToRetrieve.size(); ++i) {
-                if (i > 0) {
-                    params.append(",");
-                }
-                params.append(URLEncoder.encode(attributesToRetrieve.get(i), "UTF-8"));
-            }
-            return client.getRequest("/1/indexes/" + encodedIndexName + "/" + URLEncoder.encode(objectID, "UTF-8") + params.toString(), false);
+            String params = encodeAttributes(attributesToRetrieve, true);
+            return client.getRequest("/1/indexes/" + encodedIndexName + "/" + URLEncoder.encode(objectID, "UTF-8") + params, false);
         } catch (UnsupportedEncodingException e) {
             throw new RuntimeException(e);
         }
@@ -670,22 +680,53 @@ protected JSONObject getObject(String objectID, List<String> attributesToRetriev
      * @throws AlgoliaException
      */
     protected JSONObject getObjects(List<String> objectIDs) throws AlgoliaException {
+        return getObjects(objectIDs, null);
+    }
+
+    /**
+     * Get several objects from this index
+     *
+     * @param objectIDs            the array of unique identifier of objects to retrieve
+     * @param attributesToRetrieve contains the list of attributes to retrieve.
+     * @throws AlgoliaException
+     */
+    protected JSONObject getObjects(List<String> objectIDs, List<String> attributesToRetrieve) throws AlgoliaException {
         try {
             JSONArray requests = new JSONArray();
             for (String id : objectIDs) {
                 JSONObject request = new JSONObject();
                 request.put("indexName", this.indexName);
                 request.put("objectID", id);
+                request.put("attributesToRetrieve", encodeAttributes(attributesToRetrieve, false));
                 requests.put(request);
             }
             JSONObject body = new JSONObject();
             body.put("requests", requests);
             return client.postRequest("/1/indexes/*/objects", body.toString(), true);
-        } catch (JSONException e) {
+        } catch (JSONException | UnsupportedEncodingException e) {
             throw new AlgoliaException(e.getMessage());
         }
     }
 
+    @Nullable
+    private String encodeAttributes(List<String> attributesToRetrieve, boolean forURL) throws UnsupportedEncodingException {
+        if (attributesToRetrieve == null) {
+            return null;
+        }
+
+        StringBuilder params = new StringBuilder();
+        if (forURL) {
+            params.append("?attributesToRetrieve=");
+        }
+        for (int i = 0; i < attributesToRetrieve.size(); ++i) {
+            if (i > 0) {
+                params.append(",");
+            }
+            params.append(URLEncoder.encode(attributesToRetrieve.get(i), "UTF-8"));
+        }
+        return params.toString();
+    }
+
     /**
      * Update partially an object (only update attributes passed in argument)
      *
@@ -993,7 +1034,8 @@ Map<String, List<String>> computeDisjunctiveRefinements(@NonNull List<String> di
      * @param refinements       The current refinements, mapping facet names to a list of values.
      * @return A list of queries suitable for {@link Index#multipleQueries}.
      */
-    private @NonNull List<Query> computeDisjunctiveFacetingQueries(@NonNull Query query, @NonNull List<String> disjunctiveFacets, @NonNull Map<String, List<String>> refinements) {
+    private @NonNull
+    List<Query> computeDisjunctiveFacetingQueries(@NonNull Query query, @NonNull List<String> disjunctiveFacets, @NonNull Map<String, List<String>> refinements) {
         // Retain only refinements corresponding to the disjunctive facets.
         Map<String, List<String>> disjunctiveRefinements = computeDisjunctiveRefinements(disjunctiveFacets, refinements);
 

algoliasearch/src/test/java/com/algolia/search/saas/IndexTest.java

@@ -37,6 +37,7 @@
 import java.net.Socket;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -870,14 +871,44 @@ public void doRequestCompleted(JSONObject content, AlgoliaException error) {
     @Test
     public void testUserAgent() throws Exception {
         // Test the default value.
-        String userAgent = (String)Whitebox.getInternalState(client, "userAgentRaw");
+        String userAgent = (String) Whitebox.getInternalState(client, "userAgentRaw");
         assertTrue(userAgent.matches("^Algolia for Android \\([0-9.]+\\); Android \\(([0-9.]+|unknown)\\)$"));
 
         // Manipulate the list.
         assertFalse(client.hasUserAgent(new Client.LibraryVersion("toto", "6.6.6")));
         client.addUserAgent(new Client.LibraryVersion("toto", "6.6.6"));
         assertTrue(client.hasUserAgent(new Client.LibraryVersion("toto", "6.6.6")));
-        userAgent = (String)Whitebox.getInternalState(client, "userAgentRaw");
+        userAgent = (String) Whitebox.getInternalState(client, "userAgentRaw");
         assertTrue(userAgent.matches("^.*; toto \\(6.6.6\\)$"));
     }
+
+    @Test
+    public void testGetObjectAttributes() throws AlgoliaException {
+        for (String id : ids) {
+            JSONObject object = index.getObject(id);
+            assertEquals("The retrieved object should have two attributes.", 2, object.names().length());
+            object = index.getObject(id, Collections.singletonList("objectID"));
+            assertEquals("The retrieved object should have only one attribute.", 1, object.names().length());
+            assertTrue("The retrieved object should have one objectID attribute.", object.optString("objectID", "").length() > 0);
+        }
+    }
+
+    @Test
+    public void testGetObjectsAttributes() throws AlgoliaException {
+        try {
+            JSONArray results = index.getObjects(ids).getJSONArray("results");
+            for (int i = 0; i < results.length(); i++) {
+                JSONObject object = results.getJSONObject(i);
+                assertEquals("The retrieved object should have two attributes.", 2, object.names().length());
+            }
+            results = index.getObjects(ids, Collections.singletonList("objectID")).getJSONArray("results");
+            for (int i = 0; i < results.length(); i++) {
+                JSONObject object = results.getJSONObject(i);
+                assertEquals("The retrieved object should have only one attribute.", 1, object.names().length());
+                assertTrue("The retrieved object should have one objectID attribute.", object.optString("objectID", "").length() > 0);
+            }
+        } catch (JSONException e) {
+            fail(e.getMessage());
+        }
+    }
 }