resolving conflicts

Author: andresilveirah

.github/workflows/swift.yml

@@ -19,5 +19,8 @@ jobs:
       - uses: actions/checkout@v2
       - name: CocoaPod Install
         run: cd Example && pod install
-      - name: testing -> iPhone 11 (iOS 13.6)
-        run: xcodebuild test -scheme ConsentViewController-Example -workspace Example/CCPAConsentViewController.xcworkspace -destination 'platform=iOS Simulator,name=iPhone 11,OS=13.6' CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO CODE_SIGN_ENTITLEMENTS="" CODE_SIGNING_ALLOWED="NO"
+      - name: Example app Unit and UI testing -> iPhone 11 (iOS 14.0)
+        run: xcodebuild test -scheme ConsentViewController-Example -workspace Example/CCPAConsentViewController.xcworkspace -destination 'platform=iOS Simulator,name=iPhone 11,OS=14.0' CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO CODE_SIGN_ENTITLEMENTS="" CODE_SIGNING_ALLOWED="NO"
+      - name: SourcePointMetaApp UI testing -> iPhone 11 (iOS 14.0)
+        run: xcodebuild test -scheme SourcePointMetaApp -workspace Example/CCPAConsentViewController.xcworkspace -destination 'platform=iOS Simulator,name=iPhone 11,OS=14.0' CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO CODE_SIGN_ENTITLEMENTS="" CODE_SIGNING_ALLOWED="NO"
+

CCPAConsentViewController.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'CCPAConsentViewController'
-  s.version          = '1.3.1'
+  s.version          = '1.4.0'
   s.summary          = 'SourcePoint\'s CCPAConsentViewController to handle privacy consents.'
   s.homepage         = 'https://www.sourcepoint.com'
   s.license          = { :type => 'MIT', :file => 'LICENSE' }

CCPAConsentViewController/Classes/CCPAConsentViewController.swift

@@ -174,10 +174,10 @@ public typealias TargetingParams = [String: String]
     public func loadMessage(forAuthId authId: String?) {
         if loading == .Ready {
             loading = .Loading
-            UserDefaults.standard.setValue(authId, forKey: CCPAConsentViewController.CCPA_AUTH_ID_KEY)
             if didAuthIdChange(newAuthId: (authId)) {
                 resetConsentData()
             }
+            UserDefaults.standard.setValue(authId, forKey: CCPAConsentViewController.CCPA_AUTH_ID_KEY)
             sourcePoint.getMessage(consentUUID: consentUUID, authId: authId) { [weak self] messageResponse, error in
                 self?.loading = .Ready
                 if let message = messageResponse {
@@ -229,11 +229,11 @@ public typealias TargetingParams = [String: String]
 
     func resetConsentData() {
         self.consentUUID = ""
-        clearAllConsentData()
+        CCPAConsentViewController.clearAllConsentData()
     }
 
     /// Remove all consent related data from the UserDefaults
-    public func clearAllConsentData() {
+    static public func clearAllConsentData() {
         UserDefaults.standard.removeObject(forKey: CCPAConsentViewController.CCPA_AUTH_ID_KEY)
         UserDefaults.standard.removeObject(forKey: CCPAConsentViewController.CCPA_USER_CONSENTS)
         UserDefaults.standard.removeObject(forKey: CCPAConsentViewController.CONSENT_UUID_KEY)
@@ -260,9 +260,9 @@ extension CCPAConsentViewController: ConsentDelegate {
     public func onError(error: CCPAConsentViewControllerError?) {
         loading = .Ready
         if shouldCleanConsentOnError {
-            clearAllConsentData()
+            CCPAConsentViewController.clearAllConsentData()
         }
-        consentDelegate?.onError?(error: error)
+        consentDelegate?.onError?(ccpaError: error)
     }
 
     public func onAction(_ action: Action, consents: PMConsents?) {

CCPAConsentViewController/Classes/CCPAConsentViewControllerError.swift

@@ -16,7 +16,7 @@ import Foundation
     }
 }
 
-@objcMembers public class GeneralRequestError: CCPAConsentViewControllerError {
+@objcMembers public class CCPAGeneralRequestError: CCPAConsentViewControllerError {
     public let url, response, error: String
 
     public var failureReason: String? { return "The request to: \(url) failed with response: \(response) and error: \(error)" }
@@ -34,7 +34,7 @@ import Foundation
     override public var description: String { return "\(failureReason!)" }
 }
 
-@objcMembers public class APIParsingError: CCPAConsentViewControllerError {
+@objcMembers public class CCPAAPIParsingError: CCPAConsentViewControllerError {
     private let parsingError: Error?
     private let endpoint: String
 
@@ -51,17 +51,17 @@ import Foundation
     public var failureReason: String? { return description }
 }
 
-@objcMembers public class UnableToLoadJSReceiver: CCPAConsentViewControllerError {
+@objcMembers public class CCPAUnableToLoadJSReceiver: CCPAConsentViewControllerError {
     public var failureReason: String? { return "Unable to load the JSReceiver.js resource." }
     override public var description: String { return "\(failureReason!)\n" }
 }
 
-@objcMembers public class NoInternetConnection: CCPAConsentViewControllerError {
+@objcMembers public class CCPANoInternetConnection: CCPAConsentViewControllerError {
     public var failureReason: String? { return "The device is not connected to the internet." }
     override public var description: String { return "\(failureReason!)\n" }
 }
 
-@objcMembers public class MessageEventParsingError: CCPAConsentViewControllerError {
+@objcMembers public class CCPAMessageEventParsingError: CCPAConsentViewControllerError {
     let message: String
 
     init(message: String) {
@@ -75,12 +75,12 @@ import Foundation
     override public var description: String { return "\(failureReason!)\n" }
 }
 
-@objcMembers public class WebViewError: CCPAConsentViewControllerError {
+@objcMembers public class CCPAWebViewError: CCPAConsentViewControllerError {
     public var failureReason: String? { return "Something went wrong in the webview" }
     override public var description: String { return "\(failureReason!)\n" }
 }
 
-@objcMembers public class URLParsingError: CCPAConsentViewControllerError {
+@objcMembers public class CCPAURLParsingError: CCPAConsentViewControllerError {
     let urlString: String
 
     init(urlString: String) {
@@ -94,7 +94,7 @@ import Foundation
     override public var description: String { return "\(failureReason!)\n" }
 }
 
-@objcMembers public class InvalidArgumentError: CCPAConsentViewControllerError {
+@objcMembers public class CCPAInvalidArgumentError: CCPAConsentViewControllerError {
     let message: String
 
     init(message: String) {

CCPAConsentViewController/Classes/ConsentDelegate.swift

@@ -44,5 +44,5 @@ import Foundation
     @objc optional func onConsentReady(consentUUID: ConsentUUID, userConsent: UserConsent)
 
     /// the `onError` function can be called at any moment during the SDKs lifecycle
-    @objc optional func onError(error: CCPAConsentViewControllerError?)
+    @objc optional func onError(ccpaError: CCPAConsentViewControllerError?)
 }

CCPAConsentViewController/Classes/MessageWebViewController.swift

@@ -22,7 +22,7 @@ class MessageWebViewController: MessageViewController, WKUIDelegate, WKNavigatio
         guard let scriptSource = try? String(
             contentsOfFile: Bundle(for: CCPAConsentViewController.self).path(forResource: MessageWebViewController.MESSAGE_HANDLER_NAME, ofType: "js")!)
             else {
-                consentDelegate?.onError?(error: UnableToLoadJSReceiver())
+                consentDelegate?.onError?(ccpaError: CCPAUnableToLoadJSReceiver())
                 return nil
         }
         let script = WKUserScript(source: scriptSource, injectionTime: .atDocumentStart, forMainFrameOnly: true)
@@ -104,7 +104,7 @@ class MessageWebViewController: MessageViewController, WKUIDelegate, WKNavigatio
     }
 
     func onError(error: CCPAConsentViewControllerError?) {
-        consentDelegate?.onError?(error: error)
+        consentDelegate?.onError?(ccpaError: error)
         closeConsentUIIfOpen()
     }
 
@@ -147,7 +147,7 @@ class MessageWebViewController: MessageViewController, WKUIDelegate, WKNavigatio
         if connectvityManager.isConnectedToNetwork() {
             webview?.load(URLRequest(url: url))
         } else {
-            onError(error: NoInternetConnection())
+            onError(error: CCPANoInternetConnection())
         }
     }
 
@@ -162,7 +162,7 @@ class MessageWebViewController: MessageViewController, WKUIDelegate, WKNavigatio
 
     override func loadPrivacyManager() {
         guard let url = pmUrl() else {
-            onError(error: URLParsingError(urlString: "PMUrl"))
+            onError(error: CCPAURLParsingError(urlString: "PMUrl"))
             return
         }
         load(url: url)
@@ -207,7 +207,7 @@ class MessageWebViewController: MessageViewController, WKUIDelegate, WKNavigatio
             let body = message.body as? [String: Any?],
             let name = body["name"] as? String
         else {
-            onError(error: MessageEventParsingError(message: Optional(message.body).debugDescription))
+            onError(error: CCPAMessageEventParsingError(message: Optional(message.body).debugDescription))
             return
         }
 
@@ -222,12 +222,12 @@ class MessageWebViewController: MessageViewController, WKUIDelegate, WKNavigatio
                 let actionType = payload["type"] as? Int,
                 let action = Action(rawValue: actionType)
             else {
-                onError(error: MessageEventParsingError(message: Optional(message.body).debugDescription))
+                onError(error: CCPAMessageEventParsingError(message: Optional(message.body).debugDescription))
                 return
             }
             onAction(action, consents: getPMConsentsIfAny(payload))
         case "onError":
-            onError(error: WebViewError())
+            onError(error: CCPAWebViewError())
         default:
             print(message.body)
         }

CCPAConsentViewController/Classes/PropertyName.swift

@@ -17,7 +17,7 @@ import Foundation
     private static func validate(_ string: String) throws -> String {
         let regex = try NSRegularExpression(pattern: validPattern, options: [])
         if regex.matches(in: string, options: [], range: NSRange(location: 0, length: string.count)).isEmpty {
-            throw InvalidArgumentError(message: "PropertyName can only include letters, numbers, '.', ':', '-' and '/'. \(string) passed is invalid")
+            throw CCPAInvalidArgumentError(message: "PropertyName can only include letters, numbers, '.', ':', '-' and '/'. \(string) passed is invalid")
         } else {
             return string
         }

CCPAConsentViewController/Classes/SourcePointClient/SimpleClient.swift

@@ -85,7 +85,7 @@ class SimpleClient: HttpClient {
     func request(_ urlRequest: URLRequest, _ completionHandler: @escaping CompletionHandler) {
         logRequest(urlRequest, urlRequest.httpBody)
         guard connectivityManager.isConnectedToNetwork() else {
-            completionHandler(nil, NoInternetConnection())
+            completionHandler(nil, CCPANoInternetConnection())
             return
         }
         session.configuration.requestCachePolicy = .reloadIgnoringLocalCacheData
@@ -94,14 +94,14 @@ class SimpleClient: HttpClient {
                 self?.logResponse(urlRequest, data)
                 data != nil ?
                     completionHandler(data, nil) :
-                    completionHandler(nil, GeneralRequestError(urlRequest.url, response, error))
+                    completionHandler(nil, CCPAGeneralRequestError(urlRequest.url, response, error))
             }
         }.resume()
     }
 
     func post(url: URL?, body: Data?, completionHandler: @escaping CompletionHandler) {
         guard let _url = url else {
-            completionHandler(nil, GeneralRequestError(url, nil, nil))
+            completionHandler(nil, CCPAGeneralRequestError(url, nil, nil))
             return
         }
         var urlRequest = URLRequest(url: _url)
@@ -113,7 +113,7 @@ class SimpleClient: HttpClient {
 
     func get(url: URL?, completionHandler: @escaping CompletionHandler) {
         guard let _url = url else {
-            completionHandler(nil, GeneralRequestError(url, nil, nil))
+            completionHandler(nil, CCPAGeneralRequestError(url, nil, nil))
             return
         }
         request(URLRequest(url: _url), completionHandler)

CCPAConsentViewController/Classes/SourcePointClient/SourcePointClient.swift

@@ -87,7 +87,7 @@ class SourcePointClient {
         return components?.url
     }
 
-    func getMessage(consentUUID: ConsentUUID, authId: String?, completionHandler: @escaping (MessageResponse?, APIParsingError?) -> Void) {
+    func getMessage(consentUUID: ConsentUUID, authId: String?, completionHandler: @escaping (MessageResponse?, CCPAAPIParsingError?) -> Void) {
         let url = getMessageUrl(consentUUID, propertyName: propertyName, authId: authId)
         client.get(url: url) { [weak self] data, error in
             do {
@@ -96,10 +96,10 @@ class SourcePointClient {
                     UserDefaults.standard.setValue(messageResponse?.meta, forKey: CCPAConsentViewController.META_KEY)
                     completionHandler(messageResponse, nil)
                 } else {
-                    completionHandler(nil, APIParsingError(url?.absoluteString ?? "getMessage", error))
+                    completionHandler(nil, CCPAAPIParsingError(url?.absoluteString ?? "getMessage", error))
                 }
             } catch {
-                completionHandler(nil, APIParsingError(url?.absoluteString ?? "getMessage", error))
+                completionHandler(nil, CCPAAPIParsingError(url?.absoluteString ?? "getMessage", error))
             }
         }
     }
@@ -111,7 +111,7 @@ class SourcePointClient {
         )
     }
 
-    func postAction(action: Action, consentUUID: ConsentUUID, consents: PMConsents?, completionHandler: @escaping (ActionResponse?, APIParsingError?) -> Void) {
+    func postAction(action: Action, consentUUID: ConsentUUID, consents: PMConsents?, completionHandler: @escaping (ActionResponse?, CCPAAPIParsingError?) -> Void) {
         let url = postActionUrl(action.rawValue)
         let meta = UserDefaults.standard.string(forKey: CCPAConsentViewController.META_KEY) ?? "{}"
         let ccpaConsents = CPPAPMConsents(rejectedVendors: consents?.vendors.rejected ?? [], rejectedCategories: consents?.categories.rejected ?? [])
@@ -124,7 +124,7 @@ class SourcePointClient {
             consents: ccpaConsents,
             meta: meta
         )) else {
-            completionHandler(nil, APIParsingError(url?.absoluteString ?? "POST consent", nil))
+            completionHandler(nil, CCPAAPIParsingError(url?.absoluteString ?? "POST consent", nil))
             return
         }
 
@@ -135,10 +135,10 @@ class SourcePointClient {
                     UserDefaults.standard.setValue(actionResponse?.meta, forKey: CCPAConsentViewController.META_KEY)
                     completionHandler(actionResponse, nil)
                 } else {
-                    completionHandler(nil, APIParsingError(url?.absoluteString ?? "POST consent", error))
+                    completionHandler(nil, CCPAAPIParsingError(url?.absoluteString ?? "POST consent", error))
                 }
             } catch {
-                completionHandler(nil, APIParsingError(url?.absoluteString ?? "POST consent", error))
+                completionHandler(nil, CCPAAPIParsingError(url?.absoluteString ?? "POST consent", error))
             }
         }
     }

CCPAConsentViewController/Classes/UserConsent.swift

@@ -108,7 +108,7 @@ public typealias SPUsPrivacyString = String
         case "rejectedSome": status = .RejectedSome
         case "rejectedAll":  status = .RejectedAll
         case "consentedAll": status = .ConsentedAll
-        default: throw MessageEventParsingError(message: "Unknown status string: \(statusString)")
+        default: throw CCPAMessageEventParsingError(message: "Unknown status string: \(statusString)")
         }
     }
 }

CHANGELOG.md

@@ -1,8 +1,16 @@
+## 1.4.0 (Nov, 07, 2020)
+* Prefixed error classes with `CCPA` to avoid class naming clashes with the GDPR SDK [#50](https://github.com/SourcePointUSA/CCPA_iOS_SDK/pull/50)
+* Fixed an issue with authenticated consent not clearing user data when authId changed [#54](https://github.com/SourcePointUSA/CCPA_iOS_SDK/pull/54)
+* Significantly improved end-to-end testing
+
+## 1.3.3 (Oct, 09, 2020)
+*  Fixed an issue that was causing clash between GeneralRequestError class in GDPR and CCPA SDKs [#50](https://github.com/SourcePointUSA/CCPA_iOS_SDK/pull/50).
+## 1.3.2 (Sept, 29, 2020)
+* Fixed an issue that was causing clash between onError methods in GDPR and CCPA SDKs [#48](https://github.com/SourcePointUSA/CCPA_iOS_SDK/pull/48).
 ## 1.3.1 (Aug, 13, 2020)
-* Fix an issue that'd prevent the `onAction` delegate method from being called #47
-* Implement `.description` to `Action` class #46
-* Make sure `onConsentReady` is called on all actions that closes the ConsentUI #41
-
+* Fix an issue that'd prevent the onAction delegate method from being called [#47](https://github.com/SourcePointUSA/CCPA_iOS_SDK/pull/47).
+* Implement .description to Action class [#46](https://github.com/SourcePointUSA/CCPA_iOS_SDK/pull/46).
+* Make sure onConsentReady is called on all actions that closes the ConsentUI [#41](https://github.com/SourcePointUSA/CCPA_iOS_SDK/pull/41).
 ## 1.3.0 (Jun, 12, 2020)
 * Store the `IABUSPrivacy_String` as spec'ed by the [CCPA IAB](https://github.com/InteractiveAdvertisingBureau/USPrivacy/blob/master/CCPA/USP%20API.md#in-app-support).
 * Store the "ccpa applies" boolean. This is not covered by the IAB CCPA In-app spec so we're using our own key. It can be retrieved by reading it from the `UserDefaults` with: