Retry requests

Author: Alex Rupérez

Alamofire/NetAlamofire.swift

@@ -28,6 +28,12 @@ public class NetAlamofire: Net {
 
     open var responseInterceptors = [ResponseInterceptor]()
 
+    open var retryClosure: NetTask.RetryClosure? {
+        didSet {
+            sessionManager.retrier = self
+        }
+    }
+
     open private(set) var sessionManager: Alamofire.SessionManager!
 
     open var authChallenge: ((URLAuthenticationChallenge, (URLSession.AuthChallengeDisposition, URLCredential?) -> Swift.Void) -> Swift.Void)? {
@@ -114,3 +120,11 @@ extension NetAlamofire {
     }
 
 }
+
+extension NetAlamofire: RequestRetrier {
+
+    public func should(_ manager: SessionManager, retry request: Request, with error: Error, completion: @escaping RequestRetryCompletion) {
+        completion(retryClosure?(netResponse(request.response), netError(error), request.retryCount) == true, 0)
+    }
+
+}

CHANGELOG.md

@@ -1,3 +1,7 @@
+# Release 0.2.0
+
+- [x] Retry requests
+
 # Release 0.1.3
 
 - [x] Multipart form data encoder

Core/Net.swift

@@ -20,6 +20,8 @@ public protocol Net: class {
 
     var responseInterceptors: [ResponseInterceptor] { get set }
 
+    var retryClosure: NetTask.RetryClosure? { get set }
+
     func addRequestInterceptor(_ interceptor: @escaping RequestInterceptor)
 
     func addResponseInterceptor(_ interceptor: @escaping ResponseInterceptor)

Core/NetTask.swift

@@ -28,7 +28,7 @@ open class NetTask {
 
     open let identifier: NetTaskIdentifier
 
-    open let request: NetRequest?
+    open internal(set) var request: NetRequest?
 
     open internal(set) var response: NetResponse? {
         didSet {
@@ -52,13 +52,17 @@ open class NetTask {
 
     open internal(set) var metrics: NetTaskMetrics?
 
-    fileprivate let netTask: NetTaskProtocol?
+    var netTask: NetTaskProtocol?
+
+    open internal(set) var retryCount: UInt = 0
 
     fileprivate(set) var dispatchSemaphore: DispatchSemaphore?
 
-    fileprivate(set) var completionClosure: CompletionClosure?
+    var completionClosure: CompletionClosure?
+
+    fileprivate(set) var retryClosure: RetryClosure?
 
-    fileprivate(set) var progressClosure: ProgressClosure?
+    var progressClosure: ProgressClosure?
 
     public init(_ identifier: NetTaskIdentifier? = nil, request: NetRequest? = nil , response: NetResponse? = nil, taskDescription: String? = nil, state: NetState = .suspended, error: NetError? = nil, priority: Float? = nil, progress: Progress? = nil, metrics: NetTaskMetrics? = nil, task: NetTaskProtocol? = nil) {
         self.request = request
@@ -77,6 +81,7 @@ open class NetTask {
 extension NetTask {
 
     public typealias CompletionClosure = (NetResponse?, NetError?) -> Swift.Void
+    public typealias RetryClosure = (NetResponse?, NetError?, UInt) -> Bool
 
     @discardableResult open func async(_ completion: CompletionClosure? = nil) -> Self {
         guard state == .suspended else {
@@ -131,6 +136,11 @@ extension NetTask {
         throw taskError
     }
 
+    @discardableResult open func retry(_ retry: @escaping RetryClosure) -> Self {
+        retryClosure = retry
+        return self
+    }
+
 }
 
 extension NetTask {

Net.xcodeproj/project.pbxproj

@@ -1405,8 +1405,8 @@
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				CURRENT_PROJECT_VERSION = "$(DYLIB_CURRENT_VERSION)";
 				DEVELOPMENT_TEAM = 3VW789WSMP;
-				DYLIB_COMPATIBILITY_VERSION = 0.1.2;
-				DYLIB_CURRENT_VERSION = 0.1.3;
+				DYLIB_COMPATIBILITY_VERSION = 0.2.0;
+				DYLIB_CURRENT_VERSION = 0.2.0;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				ENABLE_TESTABILITY = YES;
 				GCC_C_LANGUAGE_STANDARD = gnu99;
@@ -1452,8 +1452,8 @@
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				CURRENT_PROJECT_VERSION = "$(DYLIB_CURRENT_VERSION)";
 				DEVELOPMENT_TEAM = 3VW789WSMP;
-				DYLIB_COMPATIBILITY_VERSION = 0.1.2;
-				DYLIB_CURRENT_VERSION = 0.1.3;
+				DYLIB_COMPATIBILITY_VERSION = 0.2.0;
+				DYLIB_CURRENT_VERSION = 0.2.0;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_C_LANGUAGE_STANDARD = gnu99;
 				GCC_NO_COMMON_BLOCKS = YES;

NetClient.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'NetClient'
-  s.version          = '0.1.3'
+  s.version          = '0.2.0'
   s.summary          = 'Versatile HTTP networking library written in Swift 3.'
 
   s.homepage         = 'https://github.com/intelygenz/NetClient-iOS'

README.md

@@ -27,6 +27,7 @@
 - [x] Asynchronous and synchronous task execution
 - [x] Inference of response object type
 - [x] Network reachability
+- [x] Retry requests
 - [x] watchOS Compatible
 - [x] tvOS Compatible
 - [x] macOS Compatible
@@ -163,6 +164,24 @@ net.addRequestInterceptor { request in
 }
 ```
 
+### Retry requests
+
+```swift
+import Net
+
+let net = NetURLSession()
+
+net.retryClosure = { response, _, _ in response?.statusCode == XXX }
+
+do {
+    let task = try net.data("YOUR_URL").retry({ response, error, retryCount in
+        return retryCount < 2
+    }).sync()
+} catch {
+    print("Error: \(error)")
+}
+```
+
 ### Love [Alamofire](https://github.com/Alamofire/Alamofire)?
 
 ```ruby

URLSession/NetURLSession+Data.swift

@@ -13,10 +13,7 @@ extension NetURLSession {
         let task = session.dataTask(with: urlRequest(request)) { [weak self] (data, response, error) in
             let netResponse = self?.netResponse(response, netDataTask, data)
             let netError = self?.netError(error, data, response)
-            netDataTask?.response = netResponse
-            netDataTask?.error = netError
-            netDataTask?.dispatchSemaphore?.signal()
-            netDataTask?.completionClosure?(netResponse, netError)
+            self?.process(netDataTask, netResponse, netError)
         }
         netDataTask = netTask(task, request)
         observe(task, netDataTask)

URLSession/NetURLSession+Download.swift

@@ -13,10 +13,7 @@ extension NetURLSession {
         let task = session.downloadTask(withResumeData: resumeData) { [weak self] (url, response, error) in
             let netResponse = self?.netResponse(response, netDownloadTask, url)
             let netError = self?.netError(error, url, response)
-            netDownloadTask?.response = netResponse
-            netDownloadTask?.error = netError
-            netDownloadTask?.dispatchSemaphore?.signal()
-            netDownloadTask?.completionClosure?(netResponse, netError)
+            self?.process(netDownloadTask, netResponse, netError)
         }
         netDownloadTask = netTask(task)
         observe(task, netDownloadTask)
@@ -28,10 +25,7 @@ extension NetURLSession {
         let task = session.downloadTask(with: urlRequest(request)) { [weak self] (url, response, error) in
             let netResponse = self?.netResponse(response, netDownloadTask, url)
             let netError = self?.netError(error, url, response)
-            netDownloadTask?.response = netResponse
-            netDownloadTask?.error = netError
-            netDownloadTask?.dispatchSemaphore?.signal()
-            netDownloadTask?.completionClosure?(netResponse, netError)
+            self?.process(netDownloadTask, netResponse, netError)
         }
         netDownloadTask = netTask(task, request)
         observe(task, netDownloadTask)

URLSession/NetURLSession+Upload.swift

@@ -38,10 +38,7 @@ extension NetURLSession {
         let task = session.uploadTask(with: urlRequest(request), from: data) { [weak self] (data, response, error) in
             let netResponse = self?.netResponse(response, netUploadTask, data)
             let netError = self?.netError(error, data, response)
-            netUploadTask?.response = netResponse
-            netUploadTask?.error = netError
-            netUploadTask?.dispatchSemaphore?.signal()
-            netUploadTask?.completionClosure?(netResponse, netError)
+            self?.process(netUploadTask, netResponse, netError)
         }
         netUploadTask = netTask(task, request)
         observe(task, netUploadTask)
@@ -71,10 +68,7 @@ extension NetURLSession {
         let task = session.uploadTask(with: urlRequest(request), fromFile: fileURL) { [weak self] (data, response, error) in
             let netResponse = self?.netResponse(response, netUploadTask, data)
             let netError = self?.netError(error, data, response)
-            netUploadTask?.response = netResponse
-            netUploadTask?.error = netError
-            netUploadTask?.dispatchSemaphore?.signal()
-            netUploadTask?.completionClosure?(netResponse, netError)
+            self?.process(netUploadTask, netResponse, netError)
         }
         netUploadTask = netTask(task, request)
         observe(task, netUploadTask)