add new browse API

Author: dethi

Source/Index.swift

@@ -350,4 +350,59 @@ public class Index {
         let path = "1/indexes/\(urlEncodedIndexName)/browse?page=\(page)&hitsPerPage=\(hitsPerPage)"
         client.performHTTPQuery(path, method: .GET, body: nil, hostnames: client.readQueryHostnames, block: block)
     }
+    
+    public typealias BrowseIteratorHandler = (iterator: BrowseIterator, end: Bool, error: NSError?) -> Void
+    
+    public class BrowseIterator {
+        public let index: Index
+        public let query: Query
+        
+        private let path: String
+        private let queryURL: String
+        private let block: BrowseIteratorHandler
+        private var cursor = ""
+        private var end = false
+        
+        public var result: [String: AnyObject]?
+        
+        init(index: Index, query: Query, block: BrowseIteratorHandler) {
+            self.index = index
+            self.query = query
+            self.block = block
+            
+            queryURL = query.buildURL()
+            path = "1/indexes/\(index.urlEncodedIndexName)/browse?\(queryURL)"
+        }
+        
+        public func next() {
+            var requestPath = path
+            if cursor != "" {
+                if queryURL != "" {
+                    requestPath += "&"
+                }
+                
+                requestPath += "cursor=\(cursor.urlEncode())"
+            }
+            
+            index.client.performHTTPQuery(requestPath, method: .GET, body: nil, hostnames: index.client.readQueryHostnames) { (JSON, error) -> Void in
+                if let error = error {
+                    self.block(iterator: self, end: false, error: error)
+                } else {
+                    self.result = JSON
+                    if let cursor = JSON!["cursor"] as? String {
+                        self.cursor = cursor
+                    } else {
+                        self.end = true
+                    }
+                    
+                    self.block(iterator: self, end: self.end, error: nil)
+                }
+            }
+        }
+    }
+    
+    public func browse(query: Query, block: BrowseIteratorHandler) {
+        let iterator = BrowseIterator(index: self, query: query, block: block)
+        iterator.next() // first call
+    }
 }

Tests/IndexTests.swift

@@ -649,6 +649,48 @@ class IndexTests: XCTestCase {
         waitForExpectationsWithTimeout(expectationTimeout, handler: nil)
     }
 
+    func testBrowseWithQuery() {
+        let expectation = expectationWithDescription("testBrowseWithQuery")
+        var objects = [AnyObject]()
+        for i in 0...1500 {
+            objects.append(["i": i])
+        }
+        
+        index.addObjects(objects, block: { (JSON, error) -> Void in
+            if let error = error {
+                XCTFail("Error during addObjects: \(error)")
+                expectation.fulfill()
+            } else {
+                self.index.waitTask(JSON!["taskID"] as! Int, block: { (JSON, error) -> Void in
+                    if let error = error {
+                        XCTFail("Error during waitTask: \(error)")
+                        expectation.fulfill()
+                    } else {
+                        let query = Query()
+                        query.hitsPerPage = 10
+                        
+                        var n = 0;
+                        
+                        self.index.browse(query, block: { (iterator, end, error) -> Void in
+                            if let error = error {
+                                XCTFail("Error during browse: \(error)")
+                                expectation.fulfill()
+                            } else if end {
+                                XCTAssertEqual(n, 1500 / 10, "Wrong number of page")
+                                expectation.fulfill()
+                            } else {
+                                ++n
+                                iterator.next()
+                            }
+                        })
+                    }
+                })
+            }
+        })
+        
+        waitForExpectationsWithTimeout(expectationTimeout, handler: nil)
+    }
+    
     func testKeyOperations() {
         let expectation = expectationWithDescription("testKeyOperations")
         let object = ["city": "San Francisco", "objectID": "a/go/?à"]