Implemented the AuthMiddleware middleware in the library target.
This commit is contained in:
@@ -0,0 +1,104 @@
|
|||||||
|
//===----------------------------------------------------------------------===
|
||||||
|
//
|
||||||
|
// This source file is part of the MarvelService open source project
|
||||||
|
//
|
||||||
|
// Copyright (c) 2025 Röck+Cöde VoF. and the MarvelService project authors
|
||||||
|
// Licensed under the EUPL 1.2 or later.
|
||||||
|
//
|
||||||
|
// See LICENSE for license information
|
||||||
|
// See CONTRIBUTORS for the list of MarvelService project authors
|
||||||
|
//
|
||||||
|
//===----------------------------------------------------------------------===
|
||||||
|
|
||||||
|
import class OpenAPIRuntime.HTTPBody
|
||||||
|
|
||||||
|
import protocol OpenAPIRuntime.ClientMiddleware
|
||||||
|
|
||||||
|
import struct Foundation.Date
|
||||||
|
import struct Foundation.TimeInterval
|
||||||
|
import struct Foundation.URL
|
||||||
|
import struct Foundation.URLComponents
|
||||||
|
import struct HTTPTypes.HTTPRequest
|
||||||
|
import struct HTTPTypes.HTTPResponse
|
||||||
|
|
||||||
|
/// A middleware that attaches the necessary authentication parameters to the path of the request.
|
||||||
|
public struct AuthMiddleware {
|
||||||
|
|
||||||
|
// MARK: Properties
|
||||||
|
|
||||||
|
/// A use case that generates a MD5 hash value to use as an authentication parameter.
|
||||||
|
private let hash: GenerateHashUseCase
|
||||||
|
|
||||||
|
/// A Marvel API public key.
|
||||||
|
private let publicKey: String
|
||||||
|
|
||||||
|
// MARK: Initializers
|
||||||
|
|
||||||
|
/// Initializes this middleware with private and public keys.
|
||||||
|
///
|
||||||
|
/// The middleware attaches the required `apikey`, `ts`, and `hash` parameters to the URI path of the intercepted request.
|
||||||
|
/// This initializer should be used for server-side applications, as indicated in the [Marvel API documentation](https://developer.marvel.com/documentation/authorization)
|
||||||
|
///
|
||||||
|
/// - Parameters:
|
||||||
|
/// - privateKey: A Marvel API private key.
|
||||||
|
/// - publicKey: A Marvel API public key.
|
||||||
|
public init(
|
||||||
|
privateKey: String,
|
||||||
|
publicKey: String
|
||||||
|
) {
|
||||||
|
self.hash = .init(
|
||||||
|
privateKey: privateKey,
|
||||||
|
publicKey: publicKey
|
||||||
|
)
|
||||||
|
self.publicKey = publicKey
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
// MARK: - ClientMiddleware
|
||||||
|
|
||||||
|
extension AuthMiddleware: ClientMiddleware {
|
||||||
|
|
||||||
|
// MARK: Functions
|
||||||
|
|
||||||
|
public func intercept(
|
||||||
|
_ request: HTTPRequest,
|
||||||
|
body: HTTPBody?,
|
||||||
|
baseURL: URL,
|
||||||
|
operationID: String,
|
||||||
|
next: @Sendable (HTTPRequest, HTTPBody?, URL) async throws -> (HTTPResponse, HTTPBody?)
|
||||||
|
) async throws -> (HTTPResponse, HTTPBody?) {
|
||||||
|
guard
|
||||||
|
let uriPath = request.path,
|
||||||
|
var urlComponents = URLComponents(string: uriPath)
|
||||||
|
else {
|
||||||
|
return try await next(request, body, baseURL)
|
||||||
|
}
|
||||||
|
|
||||||
|
let queryItems = urlComponents.queryItems ?? []
|
||||||
|
let timestamp = Date().timeIntervalSince1970
|
||||||
|
|
||||||
|
urlComponents.queryItems = queryItems + [
|
||||||
|
.init(name: "ts", value: timestamp.asString),
|
||||||
|
.init(name: "apikey", value: publicKey),
|
||||||
|
.init(name: "hash", value: hash(timestamp: timestamp))
|
||||||
|
]
|
||||||
|
|
||||||
|
let newPath = if let urlQuery = urlComponents.query {
|
||||||
|
urlComponents.path + "?" + urlQuery
|
||||||
|
} else {
|
||||||
|
urlComponents.path
|
||||||
|
}
|
||||||
|
|
||||||
|
let newRequest = HTTPRequest(
|
||||||
|
method: request.method,
|
||||||
|
scheme: request.scheme,
|
||||||
|
authority: request.authority,
|
||||||
|
path: newPath,
|
||||||
|
headerFields: request.headerFields
|
||||||
|
)
|
||||||
|
|
||||||
|
return try await next(newRequest, body, baseURL)
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
@@ -93,13 +93,3 @@ private extension Output {
|
|||||||
"00fec88a254d42e3a439d49e14cd60d1"
|
"00fec88a254d42e3a439d49e14cd60d1"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
||||||
private extension String {
|
|
||||||
/// A namespace assigned for Marvel API key samples.
|
|
||||||
enum Key {
|
|
||||||
/// A Marvel API private key sample.
|
|
||||||
static let `private` = "SomePrivateKey"
|
|
||||||
/// A Marvel API public key sample.
|
|
||||||
static let `public` = "SomePublicKey"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -0,0 +1,135 @@
|
|||||||
|
//===----------------------------------------------------------------------===
|
||||||
|
//
|
||||||
|
// This source file is part of the MarvelService open source project
|
||||||
|
//
|
||||||
|
// Copyright (c) 2025 Röck+Cöde VoF. and the MarvelService project authors
|
||||||
|
// Licensed under the EUPL 1.2 or later.
|
||||||
|
//
|
||||||
|
// See LICENSE for license information
|
||||||
|
// See CONTRIBUTORS for the list of MarvelService project authors
|
||||||
|
//
|
||||||
|
//===----------------------------------------------------------------------===
|
||||||
|
|
||||||
|
import Testing
|
||||||
|
|
||||||
|
import struct Foundation.URL
|
||||||
|
import struct Foundation.URLComponents
|
||||||
|
import struct HTTPTypes.HTTPRequest
|
||||||
|
import struct HTTPTypes.HTTPResponse
|
||||||
|
import struct MarvelService.AuthMiddleware
|
||||||
|
|
||||||
|
@Suite("Auth Middleware", .tags(.middleware))
|
||||||
|
struct AuthMiddlewareTest {
|
||||||
|
|
||||||
|
// MARK: Functions
|
||||||
|
|
||||||
|
#if swift(>=6.2)
|
||||||
|
@Test(arguments: Input.pathRequests)
|
||||||
|
func `intercept`(path: String?) async throws {
|
||||||
|
try await assertIntercept(path: path)
|
||||||
|
}
|
||||||
|
#else
|
||||||
|
@Test("intercept", arguments: Input.pathRequests)
|
||||||
|
func intercept(path: String?) async throws {
|
||||||
|
try await assertIntercept(path: path)
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
// MARK: - Assertions
|
||||||
|
|
||||||
|
private extension AuthMiddlewareTest {
|
||||||
|
|
||||||
|
// MARK: Functions
|
||||||
|
|
||||||
|
/// Asserts the interception of a request to add authentication parameters in it.
|
||||||
|
/// - Parameter path: A URI path for a request.
|
||||||
|
/// - Throws: An error in case
|
||||||
|
func assertIntercept(path: String?) async throws {
|
||||||
|
// GIVEN
|
||||||
|
let baseURL: URL = .baseURL
|
||||||
|
let request: HTTPRequest = .init(path: path)
|
||||||
|
|
||||||
|
let middleware: AuthMiddleware = .init(
|
||||||
|
privateKey: .Key.private,
|
||||||
|
publicKey: .Key.public
|
||||||
|
)
|
||||||
|
|
||||||
|
// WHEN
|
||||||
|
_ = try await confirmation { confirmation in
|
||||||
|
try await middleware.intercept(
|
||||||
|
request,
|
||||||
|
body: nil,
|
||||||
|
baseURL: baseURL,
|
||||||
|
operationID: .operationId
|
||||||
|
) { request, _, _ in
|
||||||
|
// THEN
|
||||||
|
if path != nil {
|
||||||
|
let pathRequest = try #require(request.path)
|
||||||
|
let urlComponents = try #require(URLComponents(string: pathRequest))
|
||||||
|
let queryItems = try #require(urlComponents.queryItems)
|
||||||
|
|
||||||
|
#expect(queryItems.count >= 3)
|
||||||
|
#expect(queryItems.contains(where: { $0.name == "ts" }))
|
||||||
|
#expect(queryItems.contains(where: { $0.name == "apikey" }))
|
||||||
|
#expect(queryItems.contains(where: { $0.name == "hash" }))
|
||||||
|
} else {
|
||||||
|
#expect(request.path == nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
confirmation()
|
||||||
|
|
||||||
|
return (.init(status: .ok) , nil)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
// MARK: - Helpers
|
||||||
|
|
||||||
|
private extension HTTPRequest {
|
||||||
|
|
||||||
|
// MARK: Initializers
|
||||||
|
|
||||||
|
/// Initializes a HTTP request with a method and a path.
|
||||||
|
/// - Parameters:
|
||||||
|
/// - method: The request method.
|
||||||
|
/// - path: The value of the “:path” pseudo header field.
|
||||||
|
init(
|
||||||
|
method: HTTPRequest.Method = .get,
|
||||||
|
path: String?
|
||||||
|
) {
|
||||||
|
self.init(
|
||||||
|
method: method,
|
||||||
|
scheme: nil,
|
||||||
|
authority: nil,
|
||||||
|
path: path
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
// MARK: - Constants
|
||||||
|
|
||||||
|
private extension Input {
|
||||||
|
/// A list of URI path to a resource for a request.
|
||||||
|
static let pathRequests: [String?] = [
|
||||||
|
nil,
|
||||||
|
"/path/to/resource",
|
||||||
|
"/path/to/resource?boolean",
|
||||||
|
"/path/to/resource?query=value",
|
||||||
|
"/path/to/resource?query=value&anotherQuery=anotherValue"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
private extension String {
|
||||||
|
/// An operation ID sample.
|
||||||
|
static let operationId = "SomeOperationId"
|
||||||
|
}
|
||||||
|
|
||||||
|
private extension URL {
|
||||||
|
/// A base URL sample.
|
||||||
|
static let baseURL = URL(string: "https://sample.domain.com")!
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
//===----------------------------------------------------------------------===
|
||||||
|
//
|
||||||
|
// This source file is part of the MarvelService open source project
|
||||||
|
//
|
||||||
|
// Copyright (c) 2025 Röck+Cöde VoF. and the MarvelService project authors
|
||||||
|
// Licensed under the EUPL 1.2 or later.
|
||||||
|
//
|
||||||
|
// See LICENSE for license information
|
||||||
|
// See CONTRIBUTORS for the list of MarvelService project authors
|
||||||
|
//
|
||||||
|
//===----------------------------------------------------------------------===
|
||||||
|
|
||||||
|
extension String {
|
||||||
|
/// A namespace assigned for Marvel API key samples.
|
||||||
|
enum Key {
|
||||||
|
/// A Marvel API private key sample.
|
||||||
|
static let `private` = "SomePrivateKey"
|
||||||
|
/// A Marvel API public key sample.
|
||||||
|
static let `public` = "SomePublicKey"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -19,6 +19,9 @@ extension Tag {
|
|||||||
/// A flag that indicates tests for a type extension.
|
/// A flag that indicates tests for a type extension.
|
||||||
@Tag static var `extension`: Self
|
@Tag static var `extension`: Self
|
||||||
|
|
||||||
|
/// A flag that indicates tests for a middleware type.
|
||||||
|
@Tag static var middleware: Self
|
||||||
|
|
||||||
/// A flag that indicates tests for a use case type.
|
/// A flag that indicates tests for a use case type.
|
||||||
@Tag static var useCase: Self
|
@Tag static var useCase: Self
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user