Now ResponseBodyParsable conforms Codable

Author: burak.uzunboy

Package.swift

@@ -24,6 +24,6 @@ let package = Package(
             dependencies: ["CoreUsefulSDK"]),
 //        .testTarget(
 //        name: "iOSUsefulNetworkLayerTests",
-//        dependencies: ["iOSUsefulNetworkLayer", "iOSCoreUsefulSDK"]),
+//        dependencies: ["UsefulNetworkLayer", "CoreUsefulSDK"]),
     ]
 )

Sources/UsefulNetworkLayer/NetworkLayer/APIConfiguration.swift

@@ -182,52 +182,22 @@ public struct APIConfiguration<T> where T: ResponseBodyParsable {
 }
 
 /**
- The response objects should be inherited from the `ResponseBodyParsable` to operate by the `NetworkLayer`.
- */
-open class ResponseBodyParsable: NSObject, NSDiscardableContent {
-    
-    /// Returns creation date of the response by the `NetworkLayer`.
-    public private(set) var creationDate: Date
-    
-    /// Override this initializer to create responses from the `Data`.
-    /// - parameter data: The response represented as `Data`
-    required public init?(_ data: Data) {
-        self.creationDate = Date()
-    }
-    
-    /// Override this initializer to create responses from the `JSON` object.
-    /// - parameter response: The `JSON` object as `Any` type which could be casted to `Dictionary` or `Array`
-    required public init?(_ response: Any?) {
-        self.creationDate = Date()
-    }
-    
-    /// Returns `true` in default.
-    public func beginContentAccess() -> Bool {
-        print("\(self.typeName): Content access successful")
-        return true
-    }
-    
-    /// Doesn't do anything in default.
-    public func endContentAccess() {
-        print("\(self.typeName): Content cannot be accessed anymore")
-    }
-    
-    /// Doesn't do anything in default.
-    public func discardContentIfPossible() {
-        print("\(self.typeName): Discard content called")
-    }
-    
-    /// Returns `false` in default.
-    public func isContentDiscarded() -> Bool {
-        return false
-    }
-    
-    /// Return specified parameter to work with `autoCache` API requests.
-    public func cachingEndsAt() -> Date? {
-        return nil
-    }
+The response objects should be inherited from the `ResponseBodyParsable` to operate by the `NetworkLayer`.
+*/
+public protocol ResponseBodyParsable: Codable, NameDescribeable {
+    /// To allow `NetworkLayer` to use defined initializer, set `true`, otherwise `Codable` protocol will be used.
+    static var shouldUseCustomInitializer: Bool { get }
+    /// Use this initializer to allow custom parsing from JSON object.
+    init?(response: Any?)
+    /// Use this initializer to allow custom parsing from Data directly.
+    init?(data: Data)
+    /// If custom value is defined, Caching will use this method to detect expiry.
+    func cachingEndsAt() -> Date?
 }
 
+public extension ResponseBodyParsable {
+    func cachingEndsAt() -> Date? { return nil }
+}
 
 /// Response of the API if request is completed successfully.
 public struct APIResponse<T> where T: ResponseBodyParsable {

Sources/UsefulNetworkLayer/NetworkLayer/NetworkLayer.swift

@@ -198,7 +198,18 @@ public class NetworkLayer: NSObject, URLSessionDataDelegate {
                                     request: APIConfiguration<T>,
                                     completion: @escaping (Result<T>)->()) where T: ResponseBodyParsable {
 
-        if let dataObject = request.responseBodyObject.init(data) {
+        if !request.responseBodyObject.shouldUseCustomInitializer {
+            do {
+                let jsonObject = try JSONDecoder().decode(request.responseBodyObject, from: data)
+                completion(.success(.init(response: response, responseBody: jsonObject)))
+            } catch {
+                completion(.error(.init(request: request, error: error as NSError)))
+            }
+            
+            return
+        }
+        
+        if let dataObject = request.responseBodyObject.init(data: data) {
             self.sendLog(message: "Data Object created from Operation: \(operationId) - Object: \(dataObject.typeName)")
             if request.autoCache, let cacheTiming = dataObject.cachingEndsAt() {
                 self._cache?.changeCacheExpiry(for: request.request!, to: cacheTiming)
@@ -211,7 +222,7 @@ public class NetworkLayer: NSObject, URLSessionDataDelegate {
 
         do {
             let json = try JSONSerialization.jsonObject(with: data, options: .allowFragments)
-            if let responseObject = request.responseBodyObject.init(json) {
+            if let responseObject = request.responseBodyObject.init(response: json) {
                 self.sendLog(message: "Response Object Created from JSON Data with Operation: \(operationId) - Object: \(responseObject.typeName)")
                 if request.autoCache, let cacheTiming = responseObject.cachingEndsAt() {
                     self._cache?.changeCacheExpiry(for: request.request!, to: cacheTiming)

Tests/iOSUsefulNetworkLayerTests/iOSUsefulNetworkLayerTests.swift

@@ -1,5 +1,5 @@
 import XCTest
-@testable import iOSUsefulNetworkLayer
+@testable import UsefulNetworkLayer
 
 final class iOSUsefulNetworkLayerTests: XCTestCase {
     func testExample() {
@@ -31,7 +31,7 @@ final class iOSUsefulNetworkLayerTests: XCTestCase {
             case .error(let err):
                 XCTFail("Error: \(err.error.localizedDescription)")
                 break
-            case .success(_):
+            case .success(let obj):
                 exp.fulfill()
             }
         }
@@ -47,26 +47,26 @@ final class iOSUsefulNetworkLayerTests: XCTestCase {
 
 class ExampleResponseObject: ResponseBodyParsable {
 
+    static var shouldUseCustomInitializer: Bool { return false }
     var userId: Int
     var id: Int
     var title: String
     var completed: Bool
 
-    required init?(_ data: Data) {
+    required init?(data: Data) {
         return nil
     }
-    
-    required init?(_ response: Any?) {
+
+    required init?(response: Any?) {
         guard let dict = response as? [String:Any] else { return nil }
         guard let userId = dict["userId"] as? Int,
         let id = dict["id"] as? Int,
         let title = dict["title"] as? String,
             let completed = dict["completed"] as? Bool else { return nil }
-        
+
         self.userId = userId
         self.id = id
         self.title = title
         self.completed = completed
-        super.init(response)
     }
 }