55 lines
2.3 KiB
Swift
55 lines
2.3 KiB
Swift
import Foundation
|
|
|
|
/// A Moya Plugin receives callbacks to perform side effects wherever a request is sent or received.
|
|
///
|
|
/// for example, a plugin may be used to
|
|
/// - log network requests
|
|
/// - hide and show a network activity indicator
|
|
/// - inject additional information into a request
|
|
public protocol PluginType {
|
|
/// Called to modify a request before sending.
|
|
func prepare(_ request: URLRequest, target: TargetType) -> URLRequest
|
|
|
|
/// Called immediately before a request is sent over the network (or stubbed).
|
|
func willSend(_ request: RequestType, target: TargetType)
|
|
|
|
/// Called after a response has been received, but before the MoyaProvider has invoked its completion handler.
|
|
func didReceive(_ result: Result<Moya.Response, MoyaError>, target: TargetType)
|
|
|
|
/// Called to modify a result before completion.
|
|
func process(_ result: Result<Moya.Response, MoyaError>, target: TargetType) -> Result<Moya.Response, MoyaError>
|
|
}
|
|
|
|
public extension PluginType {
|
|
func prepare(_ request: URLRequest, target: TargetType) -> URLRequest { request }
|
|
func willSend(_ request: RequestType, target: TargetType) { }
|
|
func didReceive(_ result: Result<Moya.Response, MoyaError>, target: TargetType) { }
|
|
func process(_ result: Result<Moya.Response, MoyaError>, target: TargetType) -> Result<Moya.Response, MoyaError> { result }
|
|
}
|
|
|
|
/// Request type used by `willSend` plugin function.
|
|
public protocol RequestType {
|
|
|
|
// Note:
|
|
//
|
|
// We use this protocol instead of the Alamofire request to avoid leaking that abstraction.
|
|
// A plugin should not know about Alamofire at all.
|
|
|
|
/// Retrieve an `NSURLRequest` representation.
|
|
var request: URLRequest? { get }
|
|
|
|
/// Additional headers appended to the request when added to the session.
|
|
var sessionHeaders: [String: String] { get }
|
|
|
|
/// Authenticates the request with a username and password.
|
|
func authenticate(username: String, password: String, persistence: URLCredential.Persistence) -> Self
|
|
|
|
/// Authenticates the request with an `NSURLCredential` instance.
|
|
func authenticate(with credential: URLCredential) -> Self
|
|
|
|
/// cURL representation of the instance.
|
|
///
|
|
/// - Returns: The cURL equivalent of the instance.
|
|
func cURLDescription(calling handler: @escaping (String) -> Void) -> Self
|
|
}
|