all: refactor isOptOut from display receipt to AppInformationProvider

Author: abarisain

Sources/Swift/AppInformationProvider.swift

@@ -15,6 +15,8 @@ protocol AppInformationProvider {
     func sharedDirectory() throws -> URL
 
     func sharedDefaults() throws -> UserDefaults
+
+    func isOptOut() throws -> Bool
 }
 
 public enum AppInformationProviderError: Error, CustomNSError {
@@ -81,6 +83,15 @@ extension AppInformationProvider {
         else { throw DisplayReceiptHelperError.appGroupError }
         return defaults
     }
+    
+    func isOptOut() throws -> Bool {
+        let defaults = try self.sharedDefaults()
+        if defaults.object(forKey: "batch_shared_optout") == nil {
+            // Key is missing, we don't send display receipt
+            return true
+        }
+        return defaults.bool(forKey: "batch_shared_optout")
+    }
 }
 
 

Sources/Swift/Display Receipt/DisplayReceiptCacheHelper.swift

@@ -116,15 +116,4 @@ internal struct DisplayReceiptCacheHelper {
             throw DisplayReceiptHelperError.readCacheError(underlyingError: error)
         }
     }
-    
-    // MARK: Methods reading user defaults
-
-    func isOptOut() throws -> Bool {
-        let defaults = try appInformationProvider.sharedDefaults()
-        if defaults.object(forKey: "batch_shared_optout") == nil {
-            // Key is missing, we don't send display receipt
-            return true
-        }
-        return defaults.bool(forKey: "batch_shared_optout")
-    }
 }

Sources/Swift/Display Receipt/DisplayReceiptHelper.swift

@@ -42,7 +42,7 @@ public class DisplayReceiptHelper : NSObject {
     public func didReceive(_ request: UNNotificationRequest) {
 
         do {
-            if try DisplayReceiptCacheHelper().isOptOut() {
+            if try AppInformationProviderDefaultImpl().isOptOut() {
                 print("Batch - SDK is opt-out, skipping display receipts")
                 return
             }

Tests/SharedDefaultsTests.swift

@@ -23,15 +23,15 @@ class SharedDefaultsTests: XCTestCase {
     }
 
     func testOptOutReading() throws {
-        let cacheHelper = DisplayReceiptCacheHelper(appInformationProvider: appInformationProvider)
+        
         // Default value, when key is missing, should be "true"
-        XCTAssertTrue(try cacheHelper.isOptOut())
+        XCTAssertTrue(try appInformationProvider.isOptOut())
 
         defaults.set(true, forKey: sharedOptOutKey)
-        XCTAssertTrue(try cacheHelper.isOptOut())
+        XCTAssertTrue(try appInformationProvider.isOptOut())
 
         defaults.set(false, forKey: sharedOptOutKey)
-        XCTAssertFalse(try cacheHelper.isOptOut())
+        XCTAssertFalse(try appInformationProvider.isOptOut())
     }
 }