add support for configurable limit count per server API (#85)

Author: incanus

MapboxGeocoder/MBGeocodeOptions.swift

@@ -26,7 +26,7 @@ public class GeocodeOptions: NSObject {
     public var allowedISOCountryCodes: [String]?
 
     /**
-     A loation to use as a hint when looking up the specified address.
+     A location to use as a hint when looking up the specified address.
 
      This property prioritizes results that are close to a specific location, which is typically the user’s current location. If the value of this property is `nil` – which it is by default – no specific location is prioritized.
      */
@@ -46,6 +46,11 @@ public class GeocodeOptions: NSObject {
      */
     public var allowedRegion: RectangularRegion?
 
+    /**
+     Limit the number of results returned. The default is `5` for forward geocoding and `1` for reverse geocoding.
+     */
+    public var maximumResultCount: UInt
+
     // MARK: Specifying the Output Format
 
     /**
@@ -59,7 +64,10 @@ public class GeocodeOptions: NSObject {
      */
     public var locale: NSLocale?
 
-    private override init() {}
+    private override init() {
+        self.maximumResultCount = 0
+        super.init()
+    }
 
     /**
      An array of geocoding query strings to include in the request URL.
@@ -87,6 +95,9 @@ public class GeocodeOptions: NSObject {
         if let allowedRegion = allowedRegion {
             params.append(NSURLQueryItem(name: "bbox", value: String(allowedRegion)))
         }
+        if maximumResultCount > 0 {
+            params.append(NSURLQueryItem(name: "limit", value: String(maximumResultCount)))
+        }
         if let languageCode = locale?.objectForKey(NSLocaleLanguageCode) as? String {
             params.append(NSURLQueryItem(name: "language", value: languageCode))
         }
@@ -105,10 +116,11 @@ public class ForwardGeocodeOptions: GeocodeOptions {
      If true, a resulting placemark’s name may contain a word that begins with the query string. If false, the query string must match a whole word or phrase in the placemark’s name. The default value of this property is true, which is best suited for continuous search fields.
      */
     public var autocompletesQuery = true
-    
+
     private init(queries: [String]) {
         super.init()
         self.queries = queries
+        self.maximumResultCount = 5
     }
 
     /**
@@ -151,10 +163,11 @@ public class ReverseGeocodeOptions: GeocodeOptions {
      An array of coordinates to search for.
      */
     public var coordinates: [CLLocationCoordinate2D]
-    
+
     private init(coordinates: [CLLocationCoordinate2D]) {
         self.coordinates = coordinates
         super.init()
+        self.maximumResultCount = 1
         queries = coordinates.map { String(format: "%.5f,%.5f", $0.longitude, $0.latitude) }
     }
 

Podfile.lock

@@ -1,17 +1,17 @@
 PODS:
-  - Mapbox-iOS-SDK (3.3.4)
-  - OHHTTPStubs/Core (5.2.1)
-  - OHHTTPStubs/Swift (5.2.1):
+  - Mapbox-iOS-SDK (3.3.6)
+  - OHHTTPStubs/Core (5.2.2)
+  - OHHTTPStubs/Swift (5.2.2):
     - OHHTTPStubs/Core
 
 DEPENDENCIES:
   - Mapbox-iOS-SDK (~> 3.3)
   - OHHTTPStubs/Swift (~> 5.0)
 
 SPEC CHECKSUMS:
-  Mapbox-iOS-SDK: b22da0d9703fcfb0a8b592b6a7f6a21264fe44b0
-  OHHTTPStubs: 3a42f25c00563b71355ac73112ba2324e9e6cef4
+  Mapbox-iOS-SDK: 1651ab31beec917b60ccbb8f737d0435ec80eeb3
+  OHHTTPStubs: 34d9d0994e64fcf8552dbfade5ce82ada913ee31
 
 PODFILE CHECKSUM: 0d327e0fe430b4211f61e91065c69151ac64aef7
 
-COCOAPODS: 1.1.0.rc.2
+COCOAPODS: 1.1.1