EUID support

Author: dcaunt

Development/UID2GoogleGMADevelopmentApp/UID2GoogleGMADevelopmentApp.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -15,7 +15,7 @@ let package = Package(
             targets: ["UID2GMAPlugin"])
     ],
     dependencies: [
-        .package(url: "https://github.com/IABTechLab/uid2-ios-sdk.git", "0.2.0" ..< "2.0.0"),
+        .package(url: "https://github.com/IABTechLab/uid2-ios-sdk.git", .branchItem("dave/euid")),
         .package(url: "https://github.com/googleads/swift-package-manager-google-mobile-ads.git", "10.7.0" ..< "12.0.0")
     ],
     targets: [

Package.swift

@@ -0,0 +1,59 @@
+//
+//  EUIDGMAMediationAdapter.swift
+//  
+
+import Foundation
+import GoogleMobileAds
+import UID2
+
+/// Adapter to connect EUID to Google Mobile Ads
+/// https://developers.google.com/admob/ios/open-bidding-adapter
+@objc(EUIDGMAMediationAdapter)
+class EUIDGMAMediationAdapter: NSObject {
+
+    required override init() { }
+
+}
+
+extension EUIDGMAMediationAdapter: GADRTBAdapter {
+
+    static func setUpWith(_ configuration: GADMediationServerConfiguration, completionHandler: @escaping GADMediationAdapterSetUpCompletionBlock) {
+
+        // Ensure UID2Manager has started
+        _ = EUIDManager.shared
+
+        completionHandler(nil)
+    }
+
+    func collectSignals(for params: GADRTBRequestParameters, completionHandler: @escaping GADRTBSignalCompletionHandler) {
+        Task {
+            guard let advertisingToken = await EUIDManager.shared.getAdvertisingToken() else {
+                completionHandler(nil, AdvertisingTokenNotFoundError())
+                return
+            }
+            completionHandler(advertisingToken, nil)
+        }
+    }
+
+    static func adapterVersion() -> GADVersionNumber {
+        var version = GADVersionNumber()
+        version.majorVersion = 0
+        version.minorVersion = 3
+        version.patchVersion = 3
+        return version
+    }
+
+    static func adSDKVersion() -> GADVersionNumber {
+        let uid2Version = UID2SDKProperties.getUID2SDKVersion()
+        var version = GADVersionNumber()
+        version.majorVersion = uid2Version.major
+        version.minorVersion = uid2Version.minor
+        version.patchVersion = uid2Version.patch
+        return version
+    }
+
+    static func networkExtrasClass() -> GADAdNetworkExtras.Type? {
+        return nil
+    }
+
+}

Sources/UID2GMAPlugin/EUIDGMAMediationAdapter.swift

@@ -0,0 +1,81 @@
+//
+//  EUIDGMAMediationAdapterTests.swift
+//
+
+import XCTest
+import GoogleMobileAds
+import UID2
+@testable import UID2GMAPlugin
+
+final class EUIDGMAMediationAdapterTests: XCTestCase {
+
+    /// 🟩 - GMA Adapter Request Signal Success
+    func testRequestSignalsSuccess() async throws {
+        // Seed the sample UID2Identity data in the UID2Manager
+        await EUIDManager.shared.setAutomaticRefreshEnabled(false)
+        await EUIDManager.shared.setIdentity(
+            UID2Identity(
+                advertisingToken: "euid-test-token",
+                refreshToken: "refresh-token",
+                identityExpires: Date(timeIntervalSinceNow: 60 * 60).millisecondsSince1970,
+                refreshFrom: Date(timeIntervalSinceNow: 60 * 40).millisecondsSince1970,
+                refreshExpires: Date(timeIntervalSinceNow: 60 * 50).millisecondsSince1970,
+                refreshResponseKey: ""
+            )
+        )
+
+        let signal = try await EUIDGMAMediationAdapter().collectSignals(for: GADRTBRequestParameters())
+
+        // Confirm that Adapter returns expected data
+        XCTAssertEqual("euid-test-token", signal)
+    }
+
+    /// 🟥 - GMA Adapter Request Signal Error No Identity
+    func testRequestSignalsNoIdentity() async throws {
+        // Ensure no identity is set
+        await EUIDManager.shared.resetIdentity()
+
+        let result = await Task<String?, Error> {
+            try await EUIDGMAMediationAdapter().collectSignals(for: GADRTBRequestParameters())
+        }.result
+        XCTAssertThrowsError(try result.get()) { error in
+            let adapterError = error as? AdvertisingTokenNotFoundError
+            XCTAssertEqual(AdvertisingTokenNotFoundError(), adapterError)
+        }
+    }
+
+    /// 🟥  - GMA Adapter Request Signal No Advertising Token Erro
+    func testRequestSignalsNoAdvertisingToken() async throws {
+        // Set an identity with an invalid advertisingToken
+        await EUIDManager.shared.setAutomaticRefreshEnabled(false)
+        await EUIDManager.shared.setIdentity(
+            UID2Identity(
+                advertisingToken: "",
+                refreshToken: "refresh-token",
+                identityExpires: Date(timeIntervalSinceNow: 60 * 60).millisecondsSince1970,
+                refreshFrom: Date(timeIntervalSinceNow: 60 * 40).millisecondsSince1970,
+                refreshExpires: Date(timeIntervalSinceNow: 60 * 50).millisecondsSince1970,
+                refreshResponseKey: ""
+            )
+        )
+
+        let result = await Task<String?, Error> {
+            try await EUIDGMAMediationAdapter().collectSignals(for: GADRTBRequestParameters())
+        }.result
+        XCTAssertThrowsError(try result.get()) { error in
+            let adapterError = error as? AdvertisingTokenNotFoundError
+            XCTAssertEqual(AdvertisingTokenNotFoundError(), adapterError)
+        }
+    }
+    
+    /// 🟩 - GMA Adapter Ad SDK Version Check Success
+    func testAdSDKVersion() async throws {
+        
+        let adSDKVersion = EUIDGMAMediationAdapter.adSDKVersion()
+        let sdkVersion = await EUIDManager.shared.sdkVersion
+
+        XCTAssertEqual(sdkVersion.major, adSDKVersion.majorVersion)
+        XCTAssertEqual(sdkVersion.minor, adSDKVersion.minorVersion)
+        XCTAssertEqual(sdkVersion.patch, adSDKVersion.patchVersion)
+    }
+}

Tests/UID2GMAPluginTests/EUIDGMAMediationAdapterTests.swift

@@ -9,7 +9,7 @@
   },
   "source": {
     "git": "https://github.com/IABTechLab/uid2-ios-plugin-google-gma.git",
-    "tag": "v0.3.3"
+    "branch": "dave/euid"
   },
   "platforms": {
     "ios": "13.0"