Merge pull request #214 from algolia/feat/offline-improvements

New offline features

Author: Clément Le Provost

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

@@ -399,12 +399,7 @@ public Request partialUpdateObjectsAsync(final @NonNull JSONArray partialObjects
      * @return A cancellable request.
      */
     public Request getObjectAsync(final @NonNull String objectID, @NonNull CompletionHandler completionHandler) {
-        return getClient().new AsyncTaskRequest(completionHandler) {
-            @NonNull
-            @Override protected JSONObject run() throws AlgoliaException {
-                return getObject(objectID);
-            }
-        }.start();
+        return getObjectAsync(objectID, null, completionHandler);
     }
 
     /**
@@ -432,12 +427,7 @@ public Request getObjectAsync(final @NonNull String objectID, final List<String>
      * @return A cancellable request.
      */
     public Request getObjectsAsync(final @NonNull List<String> objectIDs, @NonNull CompletionHandler completionHandler) {
-        return getClient().new AsyncTaskRequest(completionHandler) {
-            @NonNull
-            @Override protected JSONObject run() throws AlgoliaException {
-                return getObjects(objectIDs);
-            }
-        }.start();
+        return getObjectsAsync(objectIDs, null, completionHandler);
     }
 
     /**
@@ -742,8 +732,11 @@ protected JSONObject getObject(String objectID) throws AlgoliaException {
      */
     protected JSONObject getObject(String objectID, List<String> attributesToRetrieve) throws AlgoliaException {
         try {
-            String params = encodeAttributes(attributesToRetrieve, true);
-            return client.getRequest("/1/indexes/" + encodedIndexName + "/" + URLEncoder.encode(objectID, "UTF-8") + params, false);
+            String path = "/1/indexes/" + encodedIndexName + "/" + URLEncoder.encode(objectID, "UTF-8");
+            if (attributesToRetrieve != null) {
+                path += encodeAttributes(attributesToRetrieve, true); // includes the query separator (`?`)
+            }
+            return client.getRequest(path, false);
         } catch (UnsupportedEncodingException e) {
             throw new RuntimeException(e);
         }

algoliasearch/src/offline/java/com/algolia/search/saas/BuildListener.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2012-2016 Algolia
+ * http://www.algolia.com/
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package com.algolia.search.saas;
+
+import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
+
+/**
+ * Listener for events related to index building.
+ *
+ * Notifications are sent on a per-index basis, but you may register the same listener for all indices.
+ * Notifications are sent on the main thread.
+ */
+public interface BuildListener
+{
+    /**
+     * Build of the local index has just started.
+     *
+     * @param index The index being built.
+     */
+    public void buildDidStart(@NonNull MirroredIndex index);
+
+    /**
+     * Build of the local index has just finished.
+     *
+     * @param index The index having been built.
+     * @param error `null` if success, otherwise indicates the error.
+     */
+    public void buildDidFinish(@NonNull MirroredIndex index, @Nullable Throwable error);
+}

algoliasearch/src/offline/java/com/algolia/search/saas/FileUtils.java

@@ -26,6 +26,9 @@
 import android.support.annotation.NonNull;
 
 import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
 
 /**
  * Various filesystem-related utilities.
@@ -49,4 +52,26 @@ public static boolean deleteRecursive(@NonNull File item)
         ok = ok && item.delete();
         return ok;
     }
+
+    /**
+     * Write a stream of bytes to a file.
+     *
+     * @param destinationFile The file to be written to. The parent directory must exist. If the file already exists,
+     *                        it will be overwritten.
+     * @param content The bytes to write.
+     * @throws IOException if anything goes wrong.
+     */
+    public static void writeFile(@NonNull File destinationFile, @NonNull InputStream content) throws IOException {
+        byte[] buffer = new byte[64 * 1024]; // 64 kB buffer
+        FileOutputStream outputStream = new FileOutputStream(destinationFile);
+        try {
+            int bytesRead;
+            while ((bytesRead = content.read(buffer)) >= 0) {
+                outputStream.write(buffer, 0, bytesRead);
+            }
+        } finally {
+            content.close();
+            outputStream.close();
+        }
+    }
 }