Merge branch 'sdk'

Author: Clément Le Provost

AlgoliaSearch-Client-Swift.podspec

@@ -11,7 +11,7 @@ Pod::Spec.new do |s|
     s.ios.deployment_target = '7.0'
     s.osx.deployment_target = '10.10'
 
-    # By default, do not require the offline SDK.
+    # By default, do not require the offline Core.
     s.default_subspec = 'Online'
 
     # Online-only API client.
@@ -27,14 +27,14 @@ Pod::Spec.new do |s|
 
     # Offline-enabled API client.
     # NOTE: Disabled until release.
-    # s.subspec 'Offline' do |offline|
-    #     offline.dependency 'AlgoliaSearchSDK-iOS'
-    #     # Activate SDK-dependent code.
-    #     # WARNING: Specifying the preprocessor macro is not enough; it must be added to Swift flags as well.
-    #     offline.pod_target_xcconfig = {
-    #         'GCC_PREPROCESSOR_DEFINITIONS' => 'ALGOLIA_SDK=1',
-    #         'OTHER_SWIFT_FLAGS' => '-DALGOLIA_SDK'
-    #     }
-    #     offline.source_files = 'Source/Offline/*.swift'
-    # end
+    s.subspec 'Offline' do |offline|
+        offline.dependency 'AlgoliaSearchOfflineCore-iOS'
+        # Activate Core-dependent code.
+        # WARNING: Specifying the preprocessor macro is not enough; it must be added to Swift flags as well.
+        offline.pod_target_xcconfig = {
+            'GCC_PREPROCESSOR_DEFINITIONS' => 'ALGOLIA_SDK=1',
+            'OTHER_SWIFT_FLAGS' => '-DALGOLIA_SDK'
+        }
+        offline.source_files = 'Source/Offline/*.swift'
+    end
 end

Source/Client.swift

@@ -114,7 +114,6 @@ import Foundation
         // WARNING: Those headers cannot be changed for the lifetime of the session.
         let version = NSBundle(forClass: self.dynamicType).infoDictionary!["CFBundleShortVersionString"] as! String
         let fixedHTTPHeaders = [
-            "User-Agent": "Algolia for Swift \(version)",
             "X-Algolia-Application-Id": self.appID
         ]
         let configuration = NSURLSessionConfiguration.defaultSessionConfiguration()
@@ -125,6 +124,8 @@ import Foundation
 
         // Other headers are likely to change during the lifetime of the session: they will be passed for every request.
         headers["X-Algolia-API-Key"] = self.apiKey // necessary because `didSet` not called during initialization
+        // NOTE: This one will not change... except it can be overridden by the offline client:
+        headers["User-Agent"] = "Algolia for Swift \(version)"
     }
 
     /// Set an HTTP header that will be sent with every request.

Source/Error.swift

@@ -61,15 +61,18 @@ public enum StatusCode: Int {
     }
 }
 
-/// Determine if a given error is transient or not.
-/// "Transient" means retrying an identical request at a later time might lead to a different result.
-///
-func isErrorTransient(error: NSError) -> Bool {
-    if (error.domain == Client.ErrorDomain) {
-        return StatusCode.isServerError(error.code)
-    } else if (error.domain == NSURLErrorDomain) {
-        return true
-    } else {
-        return false
+extension NSError {
+    /// Determine if this error is transient or not.
+    /// "Transient" means retrying an identical request at a later time might lead to a different result.
+    ///
+    func isTransient() -> Bool {
+        if (domain == Client.ErrorDomain) {
+            return StatusCode.isServerError(code)
+        } else if (domain == NSURLErrorDomain) {
+            return true
+        } else {
+            return false
+        }
     }
 }
+

Source/Helpers.swift

@@ -31,7 +31,21 @@ extension String {
     }
 }
 
-// Collection shuffling taken from <http://stackoverflow.com/questions/24026510/how-do-i-shuffle-an-array-in-swift>.
+// MARK: - Memory debugging
+
+// NOTE: Those helpers are not used in the code, but let's keep them because they can be handy when debugging.
+
+/// Log the initialization of an object.
+func logInit(object: AnyObject) {
+    print("<INIT> \(unsafeAddressOf(object)) (\(object.dynamicType)) \(object.description)")
+}
+
+/// Log the termination ("de-initialization" in Swift terms) of an object.
+func logTerm(object: AnyObject) {
+    print("<TERM> \(unsafeAddressOf(object)) (\(object.dynamicType)) \(object.description)")
+
+// MARK: - Collection shuffling
+// Taken from <http://stackoverflow.com/questions/24026510/how-do-i-shuffle-an-array-in-swift>.
 
 extension CollectionType {
     /// Return a copy of `self` with its elements shuffled.

Source/Index.swift

@@ -39,7 +39,17 @@ import Foundation
         self.indexName = indexName
         urlEncodedIndexName = indexName.urlEncode()
     }
+
+    // MARK: - Utils
+
+    override public var description: String {
+        get {
+            return "Index{\"\(indexName)\"}"
+        }
+    }
 
+    // MARK: - Core API operations
+
     /// Add an object to this index.
     ///
     /// - parameter object: The object to add.