Merge pull request #36 from mapbox/1ec5-concurrency

Support concurrent requests

Author: 1ec5

MapboxGeocoder/MBGeocoder.swift

@@ -35,52 +35,27 @@ public class MBGeocoder: NSObject {
         self.init(accessToken: accessToken, host: nil)
     }
 
-    private var task: NSURLSessionDataTask?
+    private static let sessionConfiguration = NSURLSessionConfiguration.defaultSessionConfiguration()
+    public var session = NSURLSession(configuration: sessionConfiguration)
 
-    private var errorForSimultaneousRequests: NSError {
-        let userInfo = [
-            NSLocalizedFailureReasonErrorKey: "Cannot geocode on an MBGeocoder object that is already geocoding.",
-        ]
-        return NSError(domain: MBGeocoderErrorDomain, code: -1, userInfo: userInfo)
-    }
-    
-    public var geocoding: Bool {
-        return task?.state == .Running
-    }
-    
-    public func reverseGeocodeLocation(location: CLLocation, completionHandler: MBGeocodeCompletionHandler) {
-        guard !geocoding else {
-            completionHandler(nil, errorForSimultaneousRequests)
-            return
-        }
-        
+    public func reverseGeocodeLocation(location: CLLocation, completionHandler: MBGeocodeCompletionHandler) -> NSURLSessionDataTask? {
         let query = String(format: "%.5f,%.5f", location.coordinate.longitude, location.coordinate.latitude)
         let router = MBGeocoderRouter.V5(configuration, false, query, nil, nil, nil, nil)
-        task = taskWithRouter(router, completionHandler: completionHandler)
+        return taskWithRouter(router, completionHandler: completionHandler)
     }
 
 //    public func geocodeAddressDictionary(addressDictionary: [NSObject : AnyObject],
 //        completionHandler: MBGeocodeCompletionHandler)
 
-    public func geocodeAddressString(addressString: String, withAllowedScopes scopes: [MBPlacemark.Scope]? = nil, nearLocation focusLocation: CLLocation? = nil, inCountries ISOCountryCodes: [String]? = nil, completionHandler: MBGeocodeCompletionHandler) {
-        guard !geocoding else {
-            completionHandler(nil, errorForSimultaneousRequests)
-            return
-        }
-        
+    public func geocodeAddressString(addressString: String, withAllowedScopes scopes: [MBPlacemark.Scope]? = nil, nearLocation focusLocation: CLLocation? = nil, inCountries ISOCountryCodes: [String]? = nil, completionHandler: MBGeocodeCompletionHandler) -> NSURLSessionDataTask? {
         let router = MBGeocoderRouter.V5(configuration, false, addressString, ISOCountryCodes, focusLocation?.coordinate, scopes, nil)
-        task = taskWithRouter(router, completionHandler: completionHandler)
+        return taskWithRouter(router, completionHandler: completionHandler)
     }
 
 //    public func geocodeAddressString(addressString: String, inRegion region: CLRegion, completionHandler: MBGeocodeCompletionHandler)
 
     private func taskWithRouter(router: MBGeocoderRouter, completionHandler completion: MBGeocodeCompletionHandler) -> NSURLSessionDataTask? {
-        return router.loadJSON(JSON.self) { [weak self] (json, error) in
-            guard let dataTaskSelf = self where dataTaskSelf.task?.state == .Completed
-                else {
-                    return
-            }
-            
+        return router.loadJSON(session, expectedResultType: JSON.self) { (json, error) in
             guard error == nil && json != nil else {
                 dispatch_sync(dispatch_get_main_queue()) {
                     completion(nil, error as? NSError)
@@ -94,10 +69,11 @@ public class MBGeocoder: NSObject {
             dispatch_sync(dispatch_get_main_queue()) {
                 completion(placemarks, error as? NSError)
             }
-        }
+        } as? NSURLSessionDataTask
     }
 
     public func cancelGeocode() {
-        task?.cancel()
+        session.invalidateAndCancel()
+        session = NSURLSession(configuration: MBGeocoder.sessionConfiguration)
     }
 }

MapboxGeocoderTests/ForwardGeocodingTests.swift

@@ -23,16 +23,17 @@ class ForwardGeocodingTests: XCTestCase {
 
         let geocoder = MBGeocoder(accessToken: BogusToken)
         var addressPlacemark: MBPlacemark! = nil
-        geocoder.geocodeAddressString("1600 pennsylvania ave nw", inCountries: ["CA"]) { (placemarks, error) in
+        let task = geocoder.geocodeAddressString("1600 pennsylvania ave nw", inCountries: ["CA"]) { (placemarks, error) in
             XCTAssertEqual(placemarks?.count, 5, "forward geocode should have 5 results")
             addressPlacemark = placemarks![0]
 
             expectation.fulfill()
         }
+        XCTAssertNotNil(task)
 
         waitForExpectationsWithTimeout(1) { (error) in
             XCTAssertNil(error, "Error: \(error)")
-            XCTAssertFalse(geocoder.geocoding)
+            XCTAssertEqual(task?.state, .Completed)
         }
 
         XCTAssertEqual(addressPlacemark.description, "Pennsylvania Ave, Stellarton, Nova Scotia B0K 1S0, Canada", "forward geocode should populate description")
@@ -63,14 +64,15 @@ class ForwardGeocodingTests: XCTestCase {
 
         let expection = expectationWithDescription("forward geocode execute completion handler for invalid query")
         let geocoder = MBGeocoder(accessToken: BogusToken)
-        geocoder.geocodeAddressString("Sandy Island, New Caledonia", withAllowedScopes: [.AdministrativeArea, .Place, .Locality, .PointOfInterest], inCountries: ["FR"]) { (placemarks, error) in
+        let task = geocoder.geocodeAddressString("Sandy Island, New Caledonia", withAllowedScopes: [.AdministrativeArea, .Place, .Locality, .PointOfInterest], inCountries: ["FR"]) { (placemarks, error) in
             XCTAssertEqual(placemarks?.count, 0, "forward geocode should return no results for invalid query")
             expection.fulfill()
         }
+        XCTAssertNotNil(task)
 
         waitForExpectationsWithTimeout(1) { (error) in
             XCTAssertNil(error, "Error: \(error)")
-            XCTAssertFalse(geocoder.geocoding)
+            XCTAssertEqual(task?.state, .Completed)
         }
     }
 }

MapboxGeocoderTests/ReverseGeocodingTests.swift

@@ -25,18 +25,19 @@ class ReverseGeocodingTests: XCTestCase {
         let geocoder = MBGeocoder(accessToken: BogusToken)
         var addressPlacemark: MBPlacemark! = nil
         var placePlacemark: MBPlacemark! = nil
-        geocoder.reverseGeocodeLocation(
+        let task = geocoder.reverseGeocodeLocation(
           CLLocation(latitude: 37.13284000, longitude: -95.78558000)) { (placemarks, error) in
             XCTAssertEqual(placemarks?.count, 5, "reverse geocode should have 5 results")
             addressPlacemark = placemarks![0]
             placePlacemark = placemarks![1]
 
             expectation.fulfill()
         }
+        XCTAssertNotNil(task)
 
         waitForExpectationsWithTimeout(1) { (error) in
             XCTAssertNil(error, "Error: \(error)")
-            XCTAssertFalse(geocoder.geocoding)
+            XCTAssertEqual(task?.state, .Completed)
         }
 
         XCTAssertEqual(addressPlacemark.description, "3099 3100 Rd, Independence, Kansas 67301, United States", "reverse geocode should populate description")
@@ -76,14 +77,15 @@ class ReverseGeocodingTests: XCTestCase {
 
         let expection = expectationWithDescription("reverse geocode execute completion handler for invalid query")
         let geocoder = MBGeocoder(accessToken: BogusToken)
-        geocoder.reverseGeocodeLocation(CLLocation(latitude: 0, longitude: 0)) { (placemarks, error) in
+        let task = geocoder.reverseGeocodeLocation(CLLocation(latitude: 0, longitude: 0)) { (placemarks, error) in
             XCTAssertEqual(placemarks?.count, 0, "reverse geocode should return no results for invalid query")
             expection.fulfill()
         }
+        XCTAssertNotNil(task)
 
         waitForExpectationsWithTimeout(1) { (error) in
             XCTAssertNil(error, "Error: \(error)")
-            XCTAssertFalse(geocoder.geocoding)
+            XCTAssertEqual(task?.state, .Completed)
         }
     }
 }