feat: add support for optional services

gandalf-network · Jun 24, 2024 · eb5df17 · eb5df17
1 parent 6aa9b2c
commit eb5df17
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -66,10 +66,17 @@ import GandalfConnect
 Create an instance of `ConnectInput` with the necessary details:
 
 ```swift
+<!-- One service -->
 let services: InputData = [
     "uber": .service(Service(traits: ["rating"], activities: ["trip"]))
 ]
 
+<!-- Multiple services -->
+let services: InputData = [
+    "uber": .service(Service(traits: ["rating"], activities: ["trip"],  required: false)),
+    "netflix": .service(Service(activities: ["watch"])),
+]
+
 let input = ConnectInput(
     publicKey: "yourPublicKey",
     redirectURL: "https://example.com",

diff --git a/Sources/Example/Example.swift b/Sources/Example/Example.swift
@@ -10,7 +10,7 @@ struct Example {
 
 func testConnect() async {
     let services: InputData = [
-        "uber": .service(Service(traits: ["rating"], activities: ["trip"])),
+        "uber": .service(Service(traits: ["rating"], activities: ["trip"],  required: false)),
         "netflix": .service(Service(activities: ["watch"])),
     ]
     let input = ConnectInput(

diff --git a/Sources/GandalfConnect/GandalfConnect.swift b/Sources/GandalfConnect/GandalfConnect.swift
@@ -15,10 +15,12 @@ public struct GandalfError: Error {
 public struct Service {
     public var traits: [String]?
     public var activities: [String]?
+    public var required: Bool
 
-    public init(traits: [String]? = nil, activities: [String]? = nil) {
+    public init(traits: [String]? = nil, activities: [String]? = nil, required: Bool = true) {
         self.traits = traits
         self.activities = activities
+        self.required = required
     }
 }
 
@@ -74,7 +76,8 @@ public class Connect {
             case .service(let serviceValue):
                 dictionary[key] = [
                     "traits": serviceValue.traits ?? [],
-                    "activities": serviceValue.activities ?? []
+                    "activities": serviceValue.activities ?? [],
+                    "required": serviceValue.required
                 ]
             }
         }
@@ -121,6 +124,20 @@ public class Connect {
             try Self.validateRedirectURL(url: redirectURL)
             let cleanServices = try await Self.validateInputData(input: data)
             self.data = cleanServices
+
+            // Validate that at least one service has the required property set to true
+            let hasRequiredService = cleanServices.values.contains { value in
+                switch value {
+                case .boolean(let isActive):
+                    return isActive
+                case .service(let serviceData):
+                    return serviceData.required
+                }
+            }
+
+            if !hasRequiredService {
+                throw GandalfError(message: "At least one service must have the required property set to true", code: .InvalidService)
+            }
         }
         verificationComplete = true
     }

diff --git a/Tests/GandalfConnectTests/GandalfConnectTests.swift b/Tests/GandalfConnectTests/GandalfConnectTests.swift
@@ -10,13 +10,13 @@ final class ConnectTests: XCTestCase {
     let invalidRedirectURL = "invalid-url"
 
     // Define services in terms of InputData
-    let services: InputData = ["uber": .service(Service(traits: ["rating"], activities: ["trip"]))]
-    let invalidServices: InputData = ["facebook": .service(Service(traits: ["plan"], activities: ["watch"]))]
-    let noRequiredServices: InputData = ["netflix": .service(Service(traits: [], activities: []))]
+    let services: InputData = ["uber": .service(Service(traits: ["rating"], activities: ["trip"], required: true))]
+    let invalidServices: InputData = ["facebook": .service(Service(traits: ["plan"], activities: ["watch"], required: true))]
+    let noRequiredServices: InputData = ["netflix": .service(Service(traits: [], activities: [], required: false))]
     let multipleServices: InputData = [
-        "uber": .service(Service(traits: ["rating"], activities: ["trip"])),
-        "netflix": .service(Service(traits: ["plan"], activities: ["watch"])),
-        "instacart": .service(Service(traits: [], activities: ["shop"]))
+        "uber": .service(Service(traits: ["rating"], activities: ["trip"], required: true)),
+        "netflix": .service(Service(traits: ["plan"], activities: ["watch"], required: false)),
+        "instacart": .service(Service(traits: [], activities: ["shop"], required: false))
     ]
 
     func testInitialization() {
@@ -70,7 +70,7 @@ final class ConnectTests: XCTestCase {
         }
     }
 
-    func testGenerateURLWithNoRequiredTraitOrActivity() async {
+    func testGenerateURLWithNoRequiredService() async {
         let input = ConnectInput(publicKey: publicKey, redirectURL: redirectURL, services: noRequiredServices)
         let connect = Connect(input: input)
 
@@ -120,4 +120,4 @@ final class ConnectTests: XCTestCase {
             XCTFail("Unexpected error type: \(type(of: error))")
         }
     }
-}
+}