add cancelQueries + documentation + optimization (reserve capacity for array)

Author: dethi

AlgoliaSearch.xcodeproj/project.pbxproj

@@ -16,6 +16,7 @@
 		5D9F70851A93B9C9004B751B /* Alamofire.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 5D9F70811A93B4BE004B751B /* Alamofire.framework */; };
 		5D9F70871A93BE2A004B751B /* Alamofire.framework in CopyFiles */ = {isa = PBXBuildFile; fileRef = 5D9F70811A93B4BE004B751B /* Alamofire.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; };
 		5DECA2DA1A960BC5001A6088 /* Index.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5DECA2D91A960BC5001A6088 /* Index.swift */; };
+		5DF8C1311A9CA354006E107B /* Type.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5DF8C1301A9CA354006E107B /* Type.swift */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -52,6 +53,7 @@
 		5D7495A61A8E499B00B0263F /* Query.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Query.swift; sourceTree = "<group>"; };
 		5D9F70811A93B4BE004B751B /* Alamofire.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Alamofire.framework; path = Carthage/Build/Mac/Alamofire.framework; sourceTree = "<group>"; };
 		5DECA2D91A960BC5001A6088 /* Index.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Index.swift; sourceTree = "<group>"; };
+		5DF8C1301A9CA354006E107B /* Type.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Type.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -100,6 +102,7 @@
 				5D7495A01A8E277400B0263F /* Client.swift */,
 				5D7495A61A8E499B00B0263F /* Query.swift */,
 				5DECA2D91A960BC5001A6088 /* Index.swift */,
+				5DF8C1301A9CA354006E107B /* Type.swift */,
 				5D74959F1A8E277400B0263F /* Extension.swift */,
 				5D7495811A8E25A600B0263F /* Supporting Files */,
 			);
@@ -238,6 +241,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				5DF8C1311A9CA354006E107B /* Type.swift in Sources */,
 				5DECA2DA1A960BC5001A6088 /* Index.swift in Sources */,
 				5D7495A21A8E277400B0263F /* Client.swift in Sources */,
 				5D7495A71A8E499B00B0263F /* Query.swift in Sources */,

Source/Client.swift

@@ -25,8 +25,7 @@ import Foundation
 import Alamofire
 
 // TODO: need to know for which key is the response, sometimes other information needed. Fix this.
-
-public typealias CompletionHandlerType = (JSON: AnyObject?, error: NSError?) -> Void?
+// TODO: is it really safe to change the appID? I mean, the hostname will not change...
 
 /// Entry point in the Swift API.
 ///
@@ -73,6 +72,8 @@ public class Client {
 
     let hostnames: [String]
 
+    private var requestBuffer = RingBuffer<Alamofire.Request>(maxCapacity: 10)
+    
     /// Algolia Search initialization
     ///
     /// :param: appID the application ID you have in your admin interface
@@ -128,7 +129,11 @@ public class Client {
         Alamofire.Manager.sharedInstance.session.configuration.HTTPAdditionalHeaders = HTTPHeader
     }
 
-    func setExtraHeader(value: String, forKey key: String) {
+    /// Allow to set custom extra header
+    ///
+    /// :param: value value of the header
+    /// :param: forKey key of the header
+    public func setExtraHeader(value: String, forKey key: String) {
         if (Alamofire.Manager.sharedInstance.session.configuration.HTTPAdditionalHeaders != nil) {
             Alamofire.Manager.sharedInstance.session.configuration.HTTPAdditionalHeaders!.updateValue(value, forKey: key)
         } else {
@@ -208,15 +213,18 @@ public class Client {
         performHTTPQuery(path, method: .GET, body: nil, block: block)
     }
 
+    /// List all existing user keys with their associated ACLs
     public func listUserKeys(block: CompletionHandlerType) {
         performHTTPQuery("1/keys", method: .GET, body: nil, block: block)
     }
 
+    /// Get ACL of a user key
     public func getUserKeyACL(key: String, block: CompletionHandlerType) {
         let path = "1/keys/\(key)"
         performHTTPQuery(path, method: .GET, body: nil, block: block)
     }
 
+    /// Delete an existing user key
     public func deleteUserKey(key: String, block: CompletionHandlerType? = nil) {
         let path = "1/keys/\(key)"
         performHTTPQuery(path, method: .DELETE, body: nil, block: block)
@@ -281,17 +289,41 @@ public class Client {
         performHTTPQuery(path, method: .PUT, body: request, block: block)
     }
 
+    /// Get the index object initialized (no server call needed for initialization)
+    ///
+    /// :param: indexName the name of index
     public func getIndex(indexName: String) -> Index {
         return Index(client: self, indexName: indexName)
     }
 
+    /// Query multiple indexes with one API call
+    ///
+    /// :param: queries An array of queries with the associated index (Array of Dictionnary object ["indexName": "targettedIndex", "query": "theASQuery"]).
+    public func multipleQueries(queries: [AnyObject], block: CompletionHandlerType?) {
+        let path = "1/indexes/*/queries"
+        
+        var convertedQueries = [AnyObject]()
+        convertedQueries.reserveCapacity(queries.count)
+        for query in queries {
+            if let query = query as? [String: String] {
+                convertedQueries.append([
+                    "params": query["query"]!.urlEncode(),
+                    "indexName": query["indexName"]!
+                ])
+            }
+        }
+        
+        let request = ["requests": convertedQueries]
+        performHTTPQuery(path, method: .POST, body: request, block: block)
+    }
+    
     // MARK: - Network
 
     /// Perform an HTTP Query
     func performHTTPQuery(path: String, method: Alamofire.Method, body: [String: AnyObject]?, index: Int = 0, block: CompletionHandlerType? = nil) {
         assert(index < hostnames.count, "\(index) < \(hostnames.count) !")
 
-        Alamofire.request(method, "https://\(hostnames[index])/\(path)", parameters: body).responseJSON {
+        let request = Alamofire.request(method, "https://\(hostnames[index])/\(path)", parameters: body).responseJSON {
             (request, response, data, error) -> Void in
             if let statusCode = response?.statusCode {
                 if let block = block {
@@ -320,5 +352,17 @@ public class Client {
                 }
             }
         }
+        
+        requestBuffer.append(request)
+    }
+    
+    func cancelQueries(method: Alamofire.Method, path: String) {
+        for request in requestBuffer {
+            if request.request.URL.path == path {
+                if request.request.HTTPMethod == method.rawValue {
+                    request.cancel()
+                }
+            }
+        }
     }
 }

Source/Index.swift

@@ -36,6 +36,7 @@ public class Index {
         let path = "1/indexes/\(urlEncodedIndexName)/batch"
 
         var requests = [AnyObject]()
+        requests.reserveCapacity(objects.count)
         for object in objects {
             requests.append(["action": "addObject", "body": object])
         }
@@ -48,6 +49,7 @@ public class Index {
         let path = "1/indexes/\(urlEncodedIndexName)/batch"
 
         var requests = [AnyObject]()
+        requests.reserveCapacity(objectIDs.count)
         for id in objectIDs {
             requests.append(["action": "deleteObject", "objectID": id])
         }
@@ -71,6 +73,7 @@ public class Index {
         let path = "1/indexes/*/objects"
 
         var requests = [AnyObject]()
+        requests.reserveCapacity(objectIDs.count)
         for id in objectIDs {
             requests.append(["indexName": indexName, "objectID": id])
         }
@@ -88,6 +91,7 @@ public class Index {
         let path = "1/indexes/\(urlEncodedIndexName)/batch"
 
         var requests = [AnyObject]()
+        requests.reserveCapacity(objects.count)
         for object in objects {
             if let object = object as? [String: AnyObject] {
                 requests.append([
@@ -111,6 +115,7 @@ public class Index {
         let path = "1/indexes/\(urlEncodedIndexName)/batch"
 
         var requests = [AnyObject]()
+        requests.reserveCapacity(objects.count)
         for object in objects {
             if let object = object as? [String: AnyObject] {
                 requests.append([
@@ -136,13 +141,10 @@ public class Index {
         client.performHTTPQuery(path, method: .POST, body: request, block: block)
     }
 
-    //
-    //-(void) cancelPreviousSearches
-    //    {
-    //        NSString *path = [NSString stringWithFormat:@"/1/indexes/%@/query", self.urlEncodedIndexName];
-    //        [self.apiClient cancelQueries:@"POST" path:path];
-    //}
-    
+    public func cancelPreviousSearch() {
+        client.cancelQueries(.POST, path: "1/indexes/\(urlEncodedIndexName)/query")
+    }
+
     //
     //-(void) waitTask:(NSString*)taskID
     //success:(void(^)(ASRemoteIndex *index, NSString *taskID, NSDictionary *result))success

Source/Type.swift

@@ -0,0 +1,41 @@
+//
+//  Type.swift
+//  AlgoliaSearch
+//
+//  Created by Thibault Deutsch on 24/02/15.
+//  Copyright (c) 2015 Algolia. All rights reserved.
+//
+
+import Foundation
+
+public typealias CompletionHandlerType = (JSON: AnyObject?, error: NSError?) -> Void?
+
+struct RingBuffer<T>: SequenceType {
+    typealias Generator = IndexingGenerator<Array<T>>
+    private var buff: [T]
+    private var capacity: Int
+    private var index = 0
+    
+    private var isFull: Bool {
+        return buff.count >= capacity
+    }
+    
+    init(maxCapacity: Int) {
+        buff = [T]()
+        buff.reserveCapacity(maxCapacity)
+        capacity = maxCapacity
+    }
+    
+    func generate() -> Generator {
+        return buff.generate()
+    }
+    
+    mutating func append(newElement: T) {
+        if !isFull {
+            buff.append(newElement)
+        } else {
+            buff[index % capacity] = newElement
+        }
+        ++index
+    }
+}