fix(Index): missing request options methods (#458)

* fix(Index): Implement getObjectsAsync(objectIDs) with RequestOptions

* fix(Index): Implement deleteBy with RequestOptions

* fix(BrowseController): Add missing RequestOptions

Author: PLNech

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

@@ -630,6 +630,23 @@ public Request getObjectsAsync(final @NonNull List<String> objectIDs, final List
         return getObjectsAsync(objectIDs, attributesToRetrieve, /* requestOptions: */ null, completionHandler);
     }
 
+    /**
+     * Get several objects from this index (asynchronously), optionally restricting the retrieved content (asynchronously).
+     *
+     * @param objectIDs            Identifiers of objects to retrieve.
+     * @param requestOptions       Request-specific options.
+     * @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, @Nullable final RequestOptions requestOptions, @Nullable CompletionHandler completionHandler) {
+        return getClient().new AsyncTaskRequest(completionHandler) {
+            @NonNull
+            @Override protected JSONObject run() throws AlgoliaException {
+                return getObjects(objectIDs, null, requestOptions);
+            }
+        }.start();
+    }
+
     /**
      * Get several objects from this index (asynchronously), optionally restricting the retrieved content (asynchronously).
      *
@@ -777,16 +794,27 @@ public Request deleteByQueryAsync(@NonNull Query query, @Nullable final RequestO
      * @param completionHandler The listener that will be notified of the request's outcome.
      * @return A cancellable request.
      */
-    public Request deleteByAsync(@NonNull Query query, CompletionHandler completionHandler) {
+    public Request deleteByAsync(@NonNull Query query, @Nullable final RequestOptions requestOptions, @Nullable CompletionHandler completionHandler) {
         final Query queryCopy = new Query(query);
         return getClient().new AsyncTaskRequest(completionHandler) {
             @NonNull
             @Override protected JSONObject run() throws AlgoliaException {
-                return deleteBy(queryCopy);
+                return deleteBy(queryCopy, requestOptions);
             }
         }.start();
     }
 
+    /**
+     * Delete all objects matching a query (helper).
+     *
+     * @param query             The query that objects to delete must match.
+     * @param completionHandler The listener that will be notified of the request's outcome.
+     * @return A cancellable request.
+     */
+    public Request deleteByAsync(@NonNull Query query, @Nullable CompletionHandler completionHandler) {
+        return deleteByAsync(query, null, completionHandler);
+    }
+
     /**
      * Get this index's settings (asynchronously).
      *
@@ -1293,8 +1321,19 @@ protected void deleteByQuery(@NonNull Query query, @Nullable RequestOptions requ
      * @throws AlgoliaException
      */
     protected JSONObject deleteBy(@NonNull Query query) throws AlgoliaException {
+        return deleteBy(query, null);
+    }
+
+    /**
+     * Delete all records matching the query.
+     *
+     * @param query the query string
+     * @throws AlgoliaException
+     *
+     */
+    protected JSONObject deleteBy(@NonNull Query query, RequestOptions requestOptions) throws AlgoliaException {
         try {
-            return client.postRequest("/1/indexes/" + encodedIndexName + "/deleteByQuery", query.getParameters(), new JSONObject().put("params", query.build()).toString(), false, /* requestOptions: */ null);
+            return client.postRequest("/1/indexes/" + encodedIndexName + "/deleteByQuery", query.getParameters(), new JSONObject().put("params", query.build()).toString(), false, requestOptions);
         } catch (JSONException e) {
             e.printStackTrace();
             return null;

algoliasearch/src/main/java/com/algolia/search/saas/helpers/BrowseIterator.java

@@ -24,18 +24,20 @@
 package com.algolia.search.saas.helpers;
 
 import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
 
 import com.algolia.search.saas.AlgoliaException;
 import com.algolia.search.saas.CompletionHandler;
 import com.algolia.search.saas.Index;
 import com.algolia.search.saas.Query;
 import com.algolia.search.saas.Request;
+import com.algolia.search.saas.RequestOptions;
 
 import org.json.JSONObject;
 
 /**
  * Iterator to browse all index content.
- *
+ * <p>
  * This helper takes care of chaining API requests and calling back the handler block with the results, until:
  * - the end of the index has been reached;
  * - an error has been encountered;
@@ -51,8 +53,8 @@ public interface BrowseIteratorHandler {
          * Called at each batch of results.
          *
          * @param iterator The iterator where the results originate from.
-         * @param result The results (in case of success).
-         * @param error The error (in case of error).
+         * @param result   The results (in case of success).
+         * @param error    The error (in case of error).
          */
         public void handleBatch(@NonNull BrowseIterator iterator, JSONObject result, AlgoliaException error);
     }
@@ -66,6 +68,9 @@ public interface BrowseIteratorHandler {
     /** Listener. */
     private BrowseIteratorHandler handler;
 
+    /** Eventual request-specific options */
+    private @Nullable RequestOptions requestOptions;
+
     /** Cursor to use for the next call, if any. */
     private String cursor;
 
@@ -82,14 +87,28 @@ public interface BrowseIteratorHandler {
      * Construct a new browse iterator.
      * NOTE: The iteration does not start automatically. You have to call `start()` explicitly.
      *
-     * @param index The index to be browsed.
-     * @param query The query used to filter the results.
+     * @param index   The index to be browsed.
+     * @param query   The query used to filter the results.
      * @param handler Handler called for each batch of results.
      */
     public BrowseIterator(@NonNull Index index, @NonNull Query query, @NonNull BrowseIteratorHandler handler) {
+        this(index, query, null, handler);
+    }
+
+    /**
+     * Construct a new browse iterator.
+     * NOTE: The iteration does not start automatically. You have to call `start()` explicitly.
+     *
+     * @param index          The index to be browsed.
+     * @param query          The query used to filter the results.
+     * @param requestOptions Request-specific options.
+     * @param handler        Handler called for each batch of results.
+     */
+    public BrowseIterator(@NonNull Index index, @NonNull Query query, @Nullable RequestOptions requestOptions, @NonNull BrowseIteratorHandler handler) {
         this.index = index;
         this.query = query;
         this.handler = handler;
+        this.requestOptions = requestOptions;
     }
 
     /**
@@ -100,7 +119,7 @@ public void start() {
             throw new IllegalStateException();
         }
         started = true;
-        request = index.browseAsync(query, completionHandler);
+        request = index.browseAsync(query, requestOptions, completionHandler);
     }
 
     /**
@@ -109,8 +128,9 @@ public void start() {
      * The listener will not be called after the iteration has been cancelled.
      */
     public void cancel() {
-        if (cancelled)
+        if (cancelled) {
             return;
+        }
         request.cancel();
         request = null;
         cancelled = true;
@@ -131,7 +151,7 @@ private void next() {
         if (!hasNext()) {
             throw new IllegalStateException();
         }
-        request = index.browseFromAsync(cursor, completionHandler);
+        request = index.browseFromAsync(cursor, requestOptions, completionHandler);
     }
 
     private CompletionHandler completionHandler = new CompletionHandler() {