[Bugfix] Communications (#7)

This PR contains the work done to implement some bugfixes to the existing source code related to the `Communications` library of this package.

To provide further details about the work done:
- [x] removed an unnecessary function from the `Client` public protocol;
- [x] moved the `MakeURLRequestError` public error to its own file;
- [x] added the `parameters` property to the `Endpoint` public protocol;
- [x] added support for the parameters handling in the `MakeURLRequestUseCase` use case.

Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #7
This commit was merged in pull request #7.
This commit is contained in:
2023-04-18 22:55:25 +00:00
parent 6e785b4255
commit d8163ab0de
5 changed files with 63 additions and 23 deletions
@@ -27,9 +27,4 @@ public protocol Client {
as model: Model.Type
) async throws -> Model
/// Makes a request to a remote location based on a given endpoint and expects to return an original, uncasted response.
/// - Parameter endpoint: The endpoint for which to make a remote call.
/// - Returns: An original data response from a call to a remote endpoint.
@discardableResult func request(endpoint: some Endpoint) async throws -> Data
}
@@ -15,27 +15,35 @@ import Foundation
/// This protocol defines an endpoint to be used in a remote call.
public protocol Endpoint {
// MARK: Type aliases
typealias Parameters = [String : String?]
typealias Headers = [String : String]
// MARK: Properties
/// The scheme subcomponent for the endpoint.
var scheme: String { get }
/// The host subcomponent for the endpoint.
var host: String { get }
/// The port subcomponent for the component.
var port: Int? { get }
/// The path subcomponent for the endpoint.
var path: String { get }
/// The query parameter subcomponents for the endpoint.
var parameters: Parameters { get }
/// The HTTP request method for the endpoint.
var method: HTTPRequestMethod { get }
/// The HTTP header fields as a dictionary for the endpoint.
var headers: [String: String] { get }
var headers: Headers { get }
/// The message body as data for a request.
var body: Data? { get }
}