SONetworking
NSURLSession network abstraction layer, using Codable and Decodable for response and Encodable for request.
Project Folder and File Structure
Data
βββ ServiceConfig
βββ DataTransferService
β βββ DataTransferService
β βββ ResponseDecoder
β βββ DataTransferErrorLogger
β βββ DataTransferErrorResolver
βββ NetworkService
β βββ NetworkService
β βββ NetworkSessionManager
β βββ NetworkCancellable
β βββ NetworkError
β βββ NetworkErrorLogger
βββ Endpoint
β βββ Requestable
β βββ ResponseRequestable
β βββ HTTPMethodType
β βββ Endpoint
βββ Extensions
......
High Level Overview
ServiceConfig
Configuration file, contains base URL, headers and query Parameters to be reused as an interceptor, under any instance.
public protocol NetworkConfigurable {
var baseURL: URL { get }
var headers: [String: String] { get }
var queryParameters: [String: String] { get }
}
DataTransferService
Decode the response into the model and return a error in an case failure.
public protocol DataTransferService {
typealias CompletionHandler<T> = (Result<T, DataTransferError>) -> Void
@discardableResult
func request<T: Decodable, E: ResponseRequestable>(with endpoint: E,
completion: @escaping CompletionHandler<T>) -> NetworkCancellable? where E.Response == T
@discardableResult
func request<E: ResponseRequestable>(with endpoint: E,
completion: @escaping CompletionHandler<Void>) -> NetworkCancellable? where E.Response == Void
}
public protocol DataTransferErrorResolver {
func resolve(error: NetworkError) -> Error
}
public protocol DataTransferErrorLogger {
func log(error: Error)
}
NetworkService
take the configuration and do the request and log it.
public protocol NetworkService {
typealias CompletionHandler = (Result<Data?, NetworkError>) -> Void
func request(endpoint: Requestable, completion: @escaping CompletionHandler) -> NetworkCancellable?
}
public protocol NetworkSessionManager {
typealias CompletionHandler = (Data?, URLResponse?, Error?) -> Void
func request(_ request: URLRequest,
completion: @escaping CompletionHandler) -> NetworkCancellable
}
public protocol NetworkErrorLogger {
var logEnabled: Bool {get set}
func log(request: URLRequest)
func log(responseData data: Data?, response: URLResponse?)
func log(error: Error)
}
Endpoint
Convert path to the URL Request with a certain method, header, body, and query.
public protocol Requestable {
var path: String { get }
var isFullPath: Bool { get }
var method: HTTPMethodType { get }
var headerParamaters: [String: String] { get }
var queryParametersEncodable: Encodable? { get }
var queryParameters: [String: Any] { get }
var bodyParamatersEncodable: Encodable? { get }
var bodyParamaters: [String: Any] { get }
var bodyEncoding: BodyEncoding { get }
func urlRequest(with networkConfig: NetworkConfigurable) throws -> URLRequest
}
extension Requestable {
/// prepare the url by appening the base url and query parameters.
private func url(with config: NetworkConfigurable) throws -> URL { }
/// prepare the Request by adding headers and bodyParamaters.
public func urlRequest(with config: NetworkConfigurable) throws -> URLRequest { }
}
public protocol ResponseRequestable: Requestable {
associatedtype Response
var responseDecoder: ResponseDecoder { get }
}
Installing
SONetworking is available through CocoaPods. To install it, simply add the following line to your Podfile:
pod 'SONetworking'
SONetworking is also available through Carthage. To install it, simply add the following line to your Cartfile:
// TODO
SONetworking is also available through Package Manager. To install it, simply add the following line to your Package Manager:
// TODO
π¨π»βπ» Author
- Created by Ahmad AlSofi
- Ahmadalsofi, [email protected]
β€οΈ
Contributing
Bug reports and pull requests are welcome on GitHub