Add the OS version in the User-Agent header (#112)

Author: Clément Le Provost

Source/Client.swift

@@ -146,8 +146,6 @@ public let ErrorDomain = "AlgoliaSearch"
     @objc public init(appID: String, apiKey: String) {
         self.appID = appID
         self.apiKey = apiKey
-        let version = NSBundle(forClass: self.dynamicType).infoDictionary!["CFBundleShortVersionString"] as! String
-        self.userAgents = [ LibraryVersion(name: "Algolia for Swift", version: version) ]
 
         // Initialize hosts to their default values.
         //
@@ -166,6 +164,7 @@ public let ErrorDomain = "AlgoliaSearch"
         writeHosts = [ "\(appID).algolia.net" ] + fallbackHosts
 
         // WARNING: Those headers cannot be changed for the lifetime of the session.
+        // Other headers are likely to change during the lifetime of the session: they will be passed at every request.
         let fixedHTTPHeaders = [
             "X-Algolia-Application-Id": self.appID
         ]
@@ -175,7 +174,22 @@ public let ErrorDomain = "AlgoliaSearch"
 
         super.init()
 
-        // Other headers are likely to change during the lifetime of the session: they will be passed for every request.
+        // Add this library's version to the user agents.
+        let version = NSBundle(forClass: self.dynamicType).infoDictionary!["CFBundleShortVersionString"] as! String
+        self.userAgents = [ LibraryVersion(name: "Algolia for Swift", version: version) ]
+        
+        // Add the operating system's version to the user agents.
+        if #available(iOS 8.0, OSX 10.0, tvOS 9.0, *) {
+            let osVersion = NSProcessInfo.processInfo().operatingSystemVersion
+            var osVersionString = "\(osVersion.majorVersion).\(osVersion.minorVersion)"
+            if osVersion.patchVersion != 0 {
+                osVersionString += ".\(osVersion.patchVersion)"
+            }
+            if let osName = getOSName() {
+                self.userAgents.append(LibraryVersion(name: osName, version: osVersionString))
+            }
+        }
+        
         // WARNING: `didSet` not called during initialization => we need to update the headers manually here.
         updateHeadersFromAPIKey()
         updateHeadersFromUserAgents()

Source/Helpers.swift

@@ -102,3 +102,23 @@ extension MutableCollectionType where Index == Int {
         }
     }
 }
+
+// MARK: - Miscellaneous
+
+/// Get the operating system's name.
+///
+/// - returns: The operating system's name, or nil if it could not be determined.
+///
+func getOSName() -> String? {
+    #if os(iOS)
+        return "iOS"
+    #elseif os(OSX)
+        return "macOS"
+    #elseif os(tvOS)
+        return "tvOS"
+    #elseif os(watchOS)
+        return "watchOS"
+    #else
+        return nil
+    #endif
+}

Source/Network.swift

@@ -42,7 +42,7 @@ extension NSURLSession: URLSession {
 }
 
 
-#if DEBUG
+#if os(iOS) && DEBUG
 
 import CoreTelephony
 import SystemConfiguration

Tests/ClientTests.swift

@@ -406,7 +406,7 @@ class ClientTests: XCTestCase {
 
     func testUserAgentHeader() {
         // Test that the initial value of the header is correct.
-        XCTAssert(client.headers["User-Agent"]?.rangeOfString("^Algolia for Swift \\([0-9.]+\\)$", options: .RegularExpressionSearch) != nil)
+        XCTAssert(client.headers["User-Agent"]?.rangeOfString("^Algolia for Swift \\([0-9.]+\\); (iOS|macOS|tvOS) \\([0-9.]+\\)$", options: .RegularExpressionSearch) != nil)
 
         // Test that changing the user agents results in a proper format.
         client.userAgents = [