MOB-920 Adding DeviceId Header To Requests (#109)

* MOB-920 Adding DeviceId Header To Requests - Created deviceId header that consists of prefix and vendor identifier - Added it to the network request
PaystackHQ · Mar 5, 2024 · fd0ada2 · fd0ada2
1 parent 5b6ee3d
commit fd0ada2
Show file tree

Hide file tree

Showing 23 changed files with 151 additions and 137 deletions.
diff --git a/Sources/PaystackSDK/Core/Models/CardType.swift b/Sources/PaystackSDK/Core/Models/CardType.swift
@@ -4,7 +4,7 @@ public enum CardType: String, Decodable {
     case visa
     case visaDebit = "visa DEBIT"
     case mastercardDebit = "mastercard DEBIT"
-    
+
     public init(from decoder: Decoder) throws {
         let container = try decoder.singleValueContainer()
         let string = try container.decode(String.self)
@@ -15,7 +15,7 @@ public enum CardType: String, Decodable {
                                                                    debugDescription: "Could not find value for \(trimmedString) in CardType",
                                                                    underlyingError: nil))
         }
-        
+
         self = value
     }
 }
diff --git a/Sources/PaystackSDK/Core/Models/Custom/IntegerObject.swift b/Sources/PaystackSDK/Core/Models/Custom/IntegerObject.swift
@@ -3,7 +3,7 @@ import Foundation
 /// Service sometimes returns a string for an integer field
 public struct IntegerObject: Decodable {
     public var value: Int
-    
+
     public init(from decoder: Decoder) throws {
         let container = try decoder.singleValueContainer()
         do {

diff --git a/Sources/PaystackSDK/Core/Models/Custom/OptionalStringObject.swift b/Sources/PaystackSDK/Core/Models/Custom/OptionalStringObject.swift
@@ -6,9 +6,9 @@ public struct OptionalStringObject: Decodable {
     enum CodingKeys: String, CodingKey {
         case value
     }
-    
+
     public var value: String?
-    
+
     public init(from decoder: Decoder) throws {
         let container = try decoder.singleValueContainer()
         self.value = try? container.decode(String.self)

diff --git a/Sources/PaystackSDK/Core/Models/CustomField.swift b/Sources/PaystackSDK/Core/Models/CustomField.swift
@@ -4,7 +4,7 @@ public struct CustomField: Codable {
     public var displayName: String
     public var variableName: String
     public var value: String
-    
+
     public init(displayName: String,
                 variableName: String,
                 value: String) {

diff --git a/Sources/PaystackSDK/Core/Models/Metadata.swift b/Sources/PaystackSDK/Core/Models/Metadata.swift
@@ -2,22 +2,22 @@ import Foundation
 
 public struct Metadata: Codable {
     public var customFields: [CustomField]?
-    
+
     public init(customFields: [CustomField]?) {
         self.customFields = customFields
     }
-    
+
     public init(from decoder: Decoder) throws {
         let container = try decoder.singleValueContainer()
         let string = try? container.decode(String.self)
         guard let data = string?.data(using: .utf8), data.count > 0 else {
             return
         }
-        
+
         let metadata = try JSONDecoder.decoder.decode(InnerMetadata.self, from: data)
         self.customFields = metadata.customFields
     }
-    
+
     public func encode(to encoder: Encoder) throws {
         var container = encoder.singleValueContainer()
         let data = try JSONEncoder.encoder.encode(InnerMetadata(customFields: customFields))

diff --git a/Sources/PaystackSDK/Core/Models/Models/ModelErrorResponse.swift b/Sources/PaystackSDK/Core/Models/Models/ModelErrorResponse.swift
@@ -7,8 +7,6 @@
 
 import Foundation
 
-
-
 public struct ModelErrorResponse: Codable {
 
     public var status: Bool
@@ -19,5 +17,4 @@ public struct ModelErrorResponse: Codable {
         self.message = message
     }
 
-
 }
diff --git a/Sources/PaystackSDK/Core/Paystack.swift b/Sources/PaystackSDK/Core/Paystack.swift
@@ -1,11 +1,11 @@
 import Foundation
 
 public class Paystack {
-    
+
     public let config: PaystackConfig
-    
+
     init(config: PaystackConfig) {
         self.config = config
     }
-    
+
 }
diff --git a/Sources/PaystackSDK/Core/Service/Extensions/Publisher.swift b/Sources/PaystackSDK/Core/Service/Extensions/Publisher.swift
@@ -3,18 +3,18 @@ import Combine
 
 @available(iOS 13.0, *)
 public extension Service {
-    
+
     func publisher() -> AnyPublisher<T, Error> {
         return Future { promise in
             async {
                 if let result = $0 {
                     promise(.success(result))
                 }
-                
+
                 promise(.failure($1 ?? PaystackError.technical))
             }
         }
         .eraseToAnyPublisher()
     }
-    
+
 }
diff --git a/Sources/PaystackSDK/Core/Service/Extensions/Sync.swift b/Sources/PaystackSDK/Core/Service/Extensions/Sync.swift
@@ -1,7 +1,7 @@
 import Foundation
 
 public extension Service {
-    
+
     func sync() throws -> T {
         let semaphore = DispatchSemaphore(value: 0)
         var result: T?
@@ -11,13 +11,13 @@ public extension Service {
             error = $1
             semaphore.signal()
         }
-        
+
         semaphore.wait()
         if let result = result {
             return result
         }
-        
+
         throw error ?? PaystackError.technical
     }
-    
+
 }
diff --git a/Sources/PaystackSDK/Core/Service/PaystackService.swift b/Sources/PaystackSDK/Core/Service/PaystackService.swift
@@ -6,17 +6,17 @@ public protocol PaystackService: URLRequestBuilderHelper {
 }
 
 public extension PaystackService {
-    
+
     var endpoint: String {
         return "https://api.paystack.co/\(parentPath)"
     }
-    
+
     var bearerToken: String {
         return config.apiKey
     }
-    
+
     var paystackUserAgentVersion: String {
         return config.version
     }
-    
+
 }
diff --git a/Sources/PaystackSDK/Core/Service/ServiceExecutor.swift b/Sources/PaystackSDK/Core/Service/ServiceExecutor.swift
@@ -5,9 +5,9 @@ protocol ServiceExecutor {
 }
 
 extension URLSession: ServiceExecutor {
-    
+
     func execute(request: URLRequest, completion: @escaping (Data?, URLResponse?, Error?) -> Void) {
         dataTask(with: request, completionHandler: completion).resume()
     }
-    
+
 }
diff --git a/Sources/PaystackSDK/Core/Service/ServiceExecutorProvider.swift b/Sources/PaystackSDK/Core/Service/ServiceExecutorProvider.swift
@@ -1,19 +1,19 @@
 import Foundation
 
 class ServiceExecutorProvider {
-    
+
     static var executor: ServiceExecutor = URLSession.shared
-    
+
     static func execute(request: URLRequest, completion: @escaping (Data?, URLResponse?, Error?) -> Void) {
         self.executor.execute(request: request, completion: completion)
     }
-    
+
     static func set(executor: ServiceExecutor) {
         self.executor = executor
     }
-    
+
     static func reset() {
         self.executor = URLSession.shared
     }
-    
+
 }
diff --git a/Sources/PaystackSDK/Core/Service/URLRequest/Extensions/Logging.swift b/Sources/PaystackSDK/Core/Service/URLRequest/Extensions/Logging.swift
@@ -11,21 +11,22 @@ import IOKit
 // MARK: - Logging
 extension URLRequestBuilder {
     private static let operatingSystem: String = {
-        #if os(iOS)
-            #if targetEnvironment(macCatalyst)
-            return "macOS - Catalyst"
-            #else
-            return "iOS"
-            #endif
-        #else
+#if os(iOS)
+#if targetEnvironment(macCatalyst)
+        return "macOS - Catalyst"
+#else
+        return "iOS"
+#endif
+#else
         return "macOS"
-        #endif
+#endif
     }()
 
     func addLoggingHeaders() -> Self {
         return addPlatformHeader()
             .addSDKVersionHeader()
             .addPlatformVersionHeader()
+            .addDeviceIdentifier()
             .addDeviceModelHeader()
     }
 
@@ -40,7 +41,7 @@ extension URLRequestBuilder {
               let data = try? Data(contentsOf: versionUrl),
               let plist = try? PropertyListSerialization.propertyList(
                 from: data, format: nil) as? [String: String],
-                let versionNumber = plist["Version"] else {
+              let versionNumber = plist["Version"] else {
             return self
         }
 
@@ -53,6 +54,10 @@ extension URLRequestBuilder {
         return addHeader("x-platform-version", "\(Self.operatingSystem) \(osVersionString)")
     }
 
+    func addDeviceIdentifier() -> Self {
+        addHeader("x-device-identifier", "sdk_ios_" + getDeviceID())
+    }
+
     private func addDeviceModelHeader() -> Self {
         guard let modelName = getDeviceModel() else {
             return self
@@ -61,14 +66,22 @@ extension URLRequestBuilder {
     }
 
     private func getDeviceModel() -> String? {
-        #if canImport(UIKit)
+#if canImport(UIKit)
         return UIDevice.modelName
-        #elseif canImport(IOKit)
+#elseif canImport(IOKit)
         return getModelIdentifier()
-        #endif
+#endif
+    }
+
+    private func getDeviceID() -> String {
+#if canImport(UIKit)
+        return UIDevice.deviceID
+#elseif canImport(IOKit)
+        return getModelIdentifier() ?? ""
+#endif
     }
 
-    #if canImport(IOKit)
+#if canImport(IOKit)
     func getModelIdentifier() -> String? {
         let service = IOServiceGetMatchingService(kIOMasterPortDefault,
                                                   IOServiceMatching("IOPlatformExpertDevice"))
@@ -81,7 +94,7 @@ extension URLRequestBuilder {
         IOObjectRelease(service)
         return modelIdentifier
     }
-    #endif
+#endif
 }
 
 #if canImport(UIKit)
@@ -96,5 +109,9 @@ private extension UIDevice {
         }
         return identifier
     }()
+
+    static let deviceID: String = {
+        UIDevice.current.identifierForVendor?.uuidString ?? ""
+    }()
 }
 #endif
diff --git a/Sources/PaystackSDK/Core/Service/URLRequest/Extensions/PaystackUserAgent.swift b/Sources/PaystackSDK/Core/Service/URLRequest/Extensions/PaystackUserAgent.swift
@@ -6,15 +6,14 @@ struct PaystackUserAgent: Encodable {
 }
 
 extension URLRequestBuilder {
-    
+
     func addPaystackUserAgent(_ version: String) -> Self {
         let agent = PaystackUserAgent(bindingsVersion: version)
         guard let data = try? JSONEncoder.encoder.encode(agent),
               let agentString = String(data: data, encoding: .utf8) else {
             return self
         }
-        
+
         return addHeader("X-Paystack-User-Agent", agentString)
     }
-
 }