Merge pull request #13 from intelygenz/feature/acceptable-status-codes

Added customizable acceptable status codes range.
intelygenz · Mar 6, 2018 · b46c0fc · b46c0fc
2 parents c8c0f91 + 93d16c6
commit b46c0fc
Show file tree

Hide file tree

Showing 14 changed files with 57 additions and 28 deletions.
diff --git a/Alamofire/NetAlamofire+Data.swift b/Alamofire/NetAlamofire+Data.swift
@@ -18,7 +18,8 @@ extension NetAlamofire {
             netDataTask?.progress = progress
             netDataTask?.progressClosure?(progress)
         }
-        dataRequest.response(queue: queue) { [weak self] response in
+        .validate(statusCode: acceptableStatusCodes)
+        .response(queue: queue) { [weak self] response in
             let netResponse = self?.netResponse(response.response, netDataTask, response.data)
             let netError = self?.netError(response.error, response.data, response.response)
             netDataTask?.response = netResponse

diff --git a/Alamofire/NetAlamofire+Download.swift b/Alamofire/NetAlamofire+Download.swift
@@ -18,7 +18,8 @@ extension NetAlamofire {
             netDownloadTask?.progress = progress
             netDownloadTask?.progressClosure?(progress)
         }
-        downloadRequest.response(queue: queue) { [weak self] response in
+        .validate(statusCode: acceptableStatusCodes)
+        .response(queue: queue) { [weak self] response in
             let netResponse = self?.netResponse(response.response, netDownloadTask, response.destinationURL)
             let netError = self?.netError(response.error, response.destinationURL, response.response)
             netDownloadTask?.response = netResponse
@@ -43,7 +44,8 @@ extension NetAlamofire {
             netDownloadTask?.progress = progress
             netDownloadTask?.progressClosure?(progress)
         }
-        downloadRequest.response(queue: queue) { [weak self] response in
+        .validate(statusCode: acceptableStatusCodes)
+        .response(queue: queue) { [weak self] response in
             let netResponse = self?.netResponse(response.response, netDownloadTask, response.destinationURL)
             let netError = self?.netError(response.error, response.destinationURL, response.response)
             netDownloadTask?.response = netResponse

diff --git a/Alamofire/NetAlamofire+Upload.swift b/Alamofire/NetAlamofire+Upload.swift
@@ -18,7 +18,8 @@ extension NetAlamofire {
             netUploadTask?.progress = progress
             netUploadTask?.progressClosure?(progress)
         }
-        uploadRequest.response(queue: queue) { [weak self] response in
+        .validate(statusCode: acceptableStatusCodes)
+        .response(queue: queue) { [weak self] response in
             let netResponse = self?.netResponse(response.response, netUploadTask, response.data)
             let netError = self?.netError(response.error, response.data, response.response)
             netUploadTask?.response = netResponse
@@ -61,7 +62,8 @@ extension NetAlamofire {
             netUploadTask?.progress = progress
             netUploadTask?.progressClosure?(progress)
         }
-        uploadRequest.response(queue: queue) { [weak self] response in
+        .validate(statusCode: acceptableStatusCodes)
+        .response(queue: queue) { [weak self] response in
             let netResponse = self?.netResponse(response.response, netUploadTask, response.data)
             let netError = self?.netError(response.error, response.data, response.response)
             netUploadTask?.response = netResponse
@@ -104,7 +106,8 @@ extension NetAlamofire {
             netUploadTask?.progress = progress
             netUploadTask?.progressClosure?(progress)
         }
-        uploadRequest.response(queue: queue) { [weak self] response in
+        .validate(statusCode: acceptableStatusCodes)
+        .response(queue: queue) { [weak self] response in
             let netResponse = self?.netResponse(response.response, netUploadTask, response.data)
             let netError = self?.netError(response.error, response.data, response.response)
             netUploadTask?.response = netResponse

diff --git a/Alamofire/NetAlamofire.swift b/Alamofire/NetAlamofire.swift
@@ -34,6 +34,8 @@ open class NetAlamofire: Net {
         }
     }
 
+    open var acceptableStatusCodes = defaultAcceptableStatusCodes
+
     open private(set) var sessionManager: Alamofire.SessionManager!
 
     open var authChallenge: ((URLAuthenticationChallenge, (URLSession.AuthChallengeDisposition, URLCredential?) -> Swift.Void) -> Swift.Void)? {
@@ -131,7 +133,7 @@ extension NetAlamofire {
 
     func netError(_ error: Error?, _ responseObject: Any? = nil, _ response: URLResponse? = nil) -> NetError? {
         if let error = error {
-            return NetError.net(code: error._code, message: error.localizedDescription, headers: (response as? HTTPURLResponse)?.allHeaderFields, object: responseObject, underlying: error)
+            return .net(code: error._code, message: error.localizedDescription, headers: (response as? HTTPURLResponse)?.allHeaderFields, object: responseObject, underlying: error)
         }
         return nil
     }

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# Release 0.4.5
+
+- [x] Added customizable acceptable status codes range
+
 # Release 0.4.4
 
 - [x] [#12](https://github.com/intelygenz/NetClient-iOS/pull/12) New removable interceptors API

diff --git a/Core/Net.swift b/Core/Net.swift
@@ -10,6 +10,10 @@ import Foundation
 
 public typealias InterceptorToken = UUID
 
+public typealias StatusCode = Int
+
+public typealias StatusCodes = Set<StatusCode>
+
 public typealias RequestInterceptor = (NetRequest.Builder) -> NetRequest.Builder
 
 public typealias ResponseInterceptor = (NetResponse.Builder) -> NetResponse.Builder
@@ -26,6 +30,8 @@ public protocol Net: class {
 
     @discardableResult func removeInterceptor(_ token: InterceptorToken) -> Bool
 
+    var acceptableStatusCodes: StatusCodes { get set }
+
     func data(_ request: NetRequest) -> NetTask
 
     func download(_ resumeData: Data) -> NetTask
@@ -50,3 +56,7 @@ public protocol Net: class {
     #endif
 
 }
+
+extension Net {
+    static var defaultAcceptableStatusCodes: StatusCodes { return Set(200..<300) }
+}
diff --git a/Core/NetMultipartFormData.swift b/Core/NetMultipartFormData.swift
@@ -313,16 +313,16 @@ public class NetMultipartFormData {
         }
 
         if FileManager.default.fileExists(atPath: fileURL.path) {
-            let underlying = URLError(.fileDoesNotExist)
-            throw NetError.parse(code: underlying._code, message: "Output stream file already exists.", object: fileURL, underlying: underlying)
+            let urlError = URLError(.fileDoesNotExist)
+            throw NetError.parse(code: urlError._code, message: "Output stream file already exists.", object: fileURL, underlying: urlError)
         } else if !fileURL.isFileURL {
-            let underlying = URLError(.badURL)
-            throw NetError.parse(code: underlying._code, message: "Output stream URL is invalid.", object: fileURL, underlying: underlying)
+            let urlError = URLError(.badURL)
+            throw NetError.parse(code: urlError._code, message: "Output stream URL is invalid.", object: fileURL, underlying: urlError)
         }
 
         guard let outputStream = OutputStream(url: fileURL, append: false) else {
-            let underlying = URLError(.cannotCreateFile)
-            throw NetError.parse(code: underlying._code, message: "Output stream creation failed.", object: fileURL, underlying: underlying)
+            let urlError = URLError(.cannotCreateFile)
+            throw NetError.parse(code: urlError._code, message: "Output stream creation failed.", object: fileURL, underlying: urlError)
         }
 
         outputStream.open()
@@ -502,7 +502,7 @@ public class NetMultipartFormData {
         guard bodyPartError == nil else {
             return
         }
-        bodyPartError = NetError.parse(code: underlying?._code, message: reason, object: object, underlying: underlying)
+        bodyPartError = .parse(code: underlying?._code, message: reason, object: object, underlying: underlying)
     }
 
 

diff --git a/Core/NetTask.swift b/Core/NetTask.swift
@@ -125,7 +125,7 @@ open class NetTask: NetTaskProtocol,
         let dispatchTimeoutResult = dispatchSemaphore?.wait(timeout: DispatchTime.distantFuture)
         if dispatchTimeoutResult == .timedOut {
             let urlError = URLError(.timedOut)
-            error = NetError.net(code: urlError._code, message: urlError.localizedDescription, headers: response?.headers, object: response?.responseObject, underlying: urlError)
+            error = .net(code: urlError._code, message: urlError.localizedDescription, headers: response?.headers, object: response?.responseObject, underlying: urlError)
         }
         if let error = error {
             throw error
@@ -139,17 +139,17 @@ open class NetTask: NetTaskProtocol,
         }
         guard let urlRequest = request?.urlRequest else {
             guard let taskError = error else {
-                let error = URLError(.resourceUnavailable)
-                throw NetError.net(code: error._code, message: "Request not found.", headers: response?.headers, object: response?.responseObject, underlying: error)
+                let urlError = URLError(.resourceUnavailable)
+                throw NetError.net(code: urlError._code, message: "Request not found.", headers: response?.headers, object: response?.responseObject, underlying: urlError)
             }
             throw taskError
         }
         if let cachedResponse = URLCache.shared.cachedResponse(for: urlRequest) {
             return NetResponse(cachedResponse, self)
         }
         guard let taskError = error else {
-            let error = URLError(.resourceUnavailable)
-            throw NetError.net(code: error._code, message: "Cached response not found.", headers: response?.headers, object: response?.responseObject, underlying: error)
+            let urlError = URLError(.resourceUnavailable)
+            throw NetError.net(code: urlError._code, message: "Cached response not found.", headers: response?.headers, object: response?.responseObject, underlying: urlError)
         }
         throw taskError
     }

diff --git a/Example/ViewController.swift b/Example/ViewController.swift
@@ -72,12 +72,12 @@ class ViewController: UIViewController {
         // Decode
         net.data(request).async { (response, error) in
             do {
-                if let article: Article = try response?.decode() {
+                if let error = error {
+                    print("Net error: \(error)")
+                } else if let article: Article = try response?.decode() {
                     print(article)
                     // Encode
                     try request.builder().setJSONObject(article)
-                } else if let error = error {
-                    print("Net error: \(error)")
                 }
             } catch {
                 print("Parse error: \(error.localizedDescription)")

diff --git a/Net.xcodeproj/project.pbxproj b/Net.xcodeproj/project.pbxproj
@@ -1566,8 +1566,8 @@
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				CURRENT_PROJECT_VERSION = "$(DYLIB_CURRENT_VERSION)";
 				DEVELOPMENT_TEAM = 3VW789WSMP;
-				DYLIB_COMPATIBILITY_VERSION = 0.4.0;
-				DYLIB_CURRENT_VERSION = 0.4.4;
+				DYLIB_COMPATIBILITY_VERSION = 0.4.5;
+				DYLIB_CURRENT_VERSION = 0.4.5;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				ENABLE_TESTABILITY = YES;
 				GCC_C_LANGUAGE_STANDARD = gnu99;
@@ -1620,8 +1620,8 @@
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				CURRENT_PROJECT_VERSION = "$(DYLIB_CURRENT_VERSION)";
 				DEVELOPMENT_TEAM = 3VW789WSMP;
-				DYLIB_COMPATIBILITY_VERSION = 0.4.0;
-				DYLIB_CURRENT_VERSION = 0.4.4;
+				DYLIB_COMPATIBILITY_VERSION = 0.4.5;
+				DYLIB_CURRENT_VERSION = 0.4.5;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_C_LANGUAGE_STANDARD = gnu99;
 				GCC_NO_COMMON_BLOCKS = YES;

diff --git a/NetClient.podspec b/NetClient.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'NetClient'
-  s.version          = '0.4.4'
+  s.version          = '0.4.5'
   s.summary          = 'Versatile HTTP networking library written in Swift.'
 
   s.homepage         = 'https://github.com/intelygenz/NetClient-iOS'

diff --git a/README.md b/README.md
@@ -32,6 +32,7 @@
 - [x] TLS Certificate and Public Key Pinning
 - [x] Retry requests
 - [x] Codable / Decodable / Encodable protocols compatible (JSON / Property List)
+- [x] Customizable acceptable status codes range
 - [x] watchOS Compatible
 - [x] tvOS Compatible
 - [x] macOS Compatible

diff --git a/Stub/NetStub.swift b/Stub/NetStub.swift
@@ -21,6 +21,8 @@ open class NetStub: Net {
 
     open var retryClosure: NetTask.RetryClosure?
 
+    open var acceptableStatusCodes = defaultAcceptableStatusCodes
+
     open var nextResult: Result?
 
     public init(_ nextResult: Result? = nil) {

diff --git a/URLSession/NetURLSession.swift b/URLSession/NetURLSession.swift
@@ -47,6 +47,8 @@ open class NetURLSession: Net {
 
     open var retryClosure: NetTask.RetryClosure?
 
+    open var acceptableStatusCodes = defaultAcceptableStatusCodes
+
     open private(set) var authChallenge: ((URLAuthenticationChallenge, (URLSession.AuthChallengeDisposition, URLCredential?) -> Swift.Void) -> Swift.Void)?
 
     open private(set) var serverTrust = [String: NetServerTrust]()
@@ -158,7 +160,9 @@ extension NetURLSession {
 
     func netError(_ error: Error?, _ responseObject: Any? = nil, _ response: URLResponse? = nil) -> NetError? {
         if let error = error {
-            return NetError.net(code: error._code, message: error.localizedDescription, headers: (response as? HTTPURLResponse)?.allHeaderFields, object: responseObject, underlying: error)
+            return .net(code: error._code, message: error.localizedDescription, headers: (response as? HTTPURLResponse)?.allHeaderFields, object: responseObject, underlying: error)
+        } else if let httpResponse = response as? HTTPURLResponse, !acceptableStatusCodes.contains(httpResponse.statusCode) {
+            return .net(code: httpResponse.statusCode, message: HTTPURLResponse.localizedString(forStatusCode: httpResponse.statusCode), headers: httpResponse.allHeaderFields, object: responseObject, underlying: error)
         }
         return nil
     }