Executor is moved inside of the APIConfiguration object.

Author: burak.uzunboy

Sources/iOSUsefulNetworkLayer/NetworkLayer/APIConfiguration.swift

@@ -26,34 +26,34 @@ import iOSCoreUsefulSDK
 /// Structure that keeps all information needed from Network Layer for operations.
 public struct APIConfiguration<T> where T: ResponseBodyParsable {
     /// Returns `URL` of the API request.
-    var requestURL: URL
+    public var requestURL: URL
 
     /// Type of the API request.
-    var requestType: NetworkLayer.RequestType
+    public var requestType: NetworkLayer.RequestType
 
     /// Headers for the API request.
-    var headers: [String:String]?
+    public var headers: [String:String]?
 
     /// Request body for the API request.
-    var body: [String:Any]?
+    public var body: [String:Any]?
 
     /// The expected object type from the request.
-    var responseBodyObject: T.Type
+    public var responseBodyObject: T.Type
 
     /// `NetworkLayer` priorities the API request by looking that parameter.
-    var priority: Operation.QueuePriority
+    public var priority: Operation.QueuePriority
 
     /// The desired expiration time for the API request.
-    var cachingTime: NetworkLayer.CachingTime
+    public var cachingTime: NetworkLayer.CachingTime
 
     /// `NetworkLayer` adds desired queue by looking that parameter.
-    var isMainOperation: Bool
+    public var isMainOperation: Bool
 
     /// If `true`, the response will be cached by specified `cachingEndsAt` parameter of the response object.
-    var autoCache: Bool
+    public var autoCache: Bool
 
     /// The timeout value for the request wait time.
-    var timeOut: Int
+    public var timeOut: Int
 
     /**
      Initializes Configuration with the host URL and endpoint separately.
@@ -155,6 +155,13 @@ public struct APIConfiguration<T> where T: ResponseBodyParsable {
         return operation
     }
 
+    /// Requests given API configuration by using `NetworkLayer`.
+    /// - Parameter completion: Completion block which contains error or success case.
+    /// - Parameter response: Response `Enum` which has two cases, whether `error` or `success`.
+    public func request(completion: @escaping (_ response: NetworkLayer.Result<T>)->()) {
+        NetworkLayer.execute(self, completion: completion)
+    }
+    
 }
 
 /**
@@ -203,3 +210,36 @@ open class ResponseBodyParsable: NSObject, NSDiscardableContent {
         return nil
     }
 }
+
+
+/// Response of the API if request is completed successfully.
+public struct APIResponse<T> where T: ResponseBodyParsable {
+    
+    /// Response body of the API request.
+    public private(set) var responseBody: T
+    
+    /// Main URL response of the API request.
+    public private(set) var response: URLResponse
+    
+    internal init(response: URLResponse, responseBody: T) {
+        self.response = response
+        self.responseBody = responseBody
+    }
+    
+}
+
+/// Error result if the API request fails.
+public struct APIError<T> where T: ResponseBodyParsable {
+    
+    /// Error reason that explains why API request is failed.
+    public private(set) var error: NSError
+    
+    /// The API request that fails.
+    public private(set) var api: APIConfiguration<T>
+    
+    internal init(request: APIConfiguration<T>, error: NSError) {
+        self.api = request
+        self.error = error
+    }
+
+}

Sources/iOSUsefulNetworkLayer/NetworkLayer/NetworkLayer+Cache.swift

@@ -25,10 +25,10 @@ import Foundation
 import UIKit
 #endif
 
-extension NetworkLayer {
+public extension NetworkLayer {
 
     /// Custom Caching class.
-    public class Cache: URLCache {
+    class Cache: URLCache {
 
         /// Default initializer.
         override init() {

Sources/iOSUsefulNetworkLayer/NetworkLayer/NetworkLayer.swift

@@ -35,10 +35,11 @@ public class NetworkLayer: NSObject, URLSessionDataDelegate {
      */
     public enum Result<T> where T: ResponseBodyParsable {
         /// Returns response.
-        case success(T)
+        case success(APIResponse<T>)
         /// Returns reason of the error.
-        case error(NSError)
+        case error(APIError<T>)
     }
+
 
     // MARK: - Properties
 
@@ -103,7 +104,7 @@ public class NetworkLayer: NSObject, URLSessionDataDelegate {
         NotificationCenter.default.removeObserver(self)
     }
 
-    // MARK: Public Methods
+    // MARK: Internal Methods
 
     /**
      Executes configured API.
@@ -112,14 +113,14 @@ public class NetworkLayer: NSObject, URLSessionDataDelegate {
      - parameter error: Returns reason of the error if operation fails. `nil` otherwise
      - parameter response: Returns response with the specified type of response
      */
-    public class func execute<T>(_ request: APIConfiguration<T>, completion: @escaping (Result<T>)->()) where T:ResponseBodyParsable {
+    internal class func execute<T>(_ request: APIConfiguration<T>, completion: @escaping (Result<T>)->()) where T:ResponseBodyParsable {
         let instance = NetworkLayer.shared
         DispatchQueue.global().async {
             guard let urlRequest = request.request else {
                 let err = NSError(domain: "", code: 500, description: "Cannot create URL Request with specified configurations")
                 instance.sendLog(message: err.localizedDescription, logType: .error(code: 900, name: err.localizedDescription))
                 DispatchQueue.main.async {
-                    completion(.error(err))
+                    completion(.error(APIError(request: request, error: err)))
                 }
                 return
             }
@@ -144,7 +145,7 @@ public class NetworkLayer: NSObject, URLSessionDataDelegate {
                     } else {
                         instance.sendLog(message: "Operation:\(operation.identifier) failed with error: \(error.localizedDescription)", logType: .error(code: (error as NSError).code, name: error.localizedDescription))
                         DispatchQueue.main.async {
-                            completion(.error(error as NSError))
+                            completion(.error(.init(request: request, error: error as NSError)))
                         }
                         return
                     }
@@ -155,7 +156,7 @@ public class NetworkLayer: NSObject, URLSessionDataDelegate {
                 guard let data = dataResult, let loadResponse = loadedResponse else {
                     let err = NSError(domain: "", code: 500, description: "Data is empty - Operation: \(operation.identifier)")
                     DispatchQueue.main.async {
-                        completion(.error(err))
+                        completion(.error(.init(request: request, error: err)))
                     }
                     return
                 }
@@ -189,6 +190,8 @@ public class NetworkLayer: NSObject, URLSessionDataDelegate {
         }
     }
 
+    // MARK: Private Methods
+    
     /// Proceeds the response and completes.
     private func proceedResponse<T>(response: URLResponse, data: Data,
                                     operationId: Int,
@@ -201,7 +204,7 @@ public class NetworkLayer: NSObject, URLSessionDataDelegate {
                 self._cache?.changeCacheExpiry(for: request.request!, to: cacheTiming)
             }
             DispatchQueue.main.async {
-                completion(.success(dataObject))
+                completion(.success(APIResponse(response: response, responseBody: dataObject)))
             }
             return
         }
@@ -214,26 +217,24 @@ public class NetworkLayer: NSObject, URLSessionDataDelegate {
                     self._cache?.changeCacheExpiry(for: request.request!, to: cacheTiming)
                 }
                 DispatchQueue.main.async {
-                    completion(.success(responseObject))
+                    completion(.success(APIResponse(response: response, responseBody: responseObject)))
                 }
             } else {
                 DispatchQueue.main.async {
                     let err = NSError(domain: "", code: 500, description: "Cannot create response body - Operation: \(operationId)")
-                    completion(.error(err))
+                    completion(.error(.init(request: request, error: err)))
                 }
             }
         } catch {
             self.sendLog(message: "Couldn't create JSON Data from Operation: \(operationId) - Error: \(error.localizedDescription)",
                 logType: .error(code: 900, name: error.localizedDescription))
             DispatchQueue.main.async {
                 let err = NSError(domain: "", code: 500, description: error.localizedDescription)
-                completion(.error(err))
+                completion(.error(.init(request: request, error: err)))
             }
         }
     }
-    
-    // MARK: Private Methods
-    
+        
     /**
      Sends logs to listener. Shouldn't be called outside of the `NetworkLayer`.
      - parameter message: Log message

Tests/iOSUsefulNetworkLayerTests/iOSUsefulNetworkLayerTests.swift

@@ -26,10 +26,10 @@ final class iOSUsefulNetworkLayerTests: XCTestCase {
             return
         }
 
-        NetworkLayer.execute(apiReq) { (result) in
+        apiReq.request { (result) in
             switch result {
             case .error(let err):
-                XCTFail("Error: \(err.localizedDescription)")
+                XCTFail("Error: \(err.error.localizedDescription)")
                 break
             case .success(_):
                 exp.fulfill()