Rename HBAuthRequestContext types (#28)

hummingbird-project · Jan 31, 2024 · 9867667 · 9867667
1 parent 4f04aab
commit 9867667
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 18 deletions.
diff --git a/Sources/HummingbirdAuth/Authenticator/AuthRequestContext.swift b/Sources/HummingbirdAuth/Authenticator/AuthRequestContext.swift
@@ -18,13 +18,13 @@ import NIOCore
 
 /// Protocol that all request contexts should conform to if they want to support
 /// authentication middleware
-public protocol HBAuthRequestContextProtocol: HBRequestContext {
+public protocol HBAuthRequestContext: HBRequestContext {
     /// Login cache
     var auth: HBLoginCache { get set }
 }
 
 /// Implementation of a basic request context that supports everything the Hummingbird library needs
-public struct HBAuthRequestContext: HBAuthRequestContextProtocol {
+public struct HBBasicAuthRequestContext: HBAuthRequestContext {
     /// core context
     public var coreContext: HBCoreRequestContext
     /// Login cache

diff --git a/Sources/HummingbirdAuth/Authenticator/Authenticator.swift b/Sources/HummingbirdAuth/Authenticator/Authenticator.swift
@@ -55,7 +55,7 @@ public protocol HBAuthenticatable: Sendable {}
 ///     }
 /// }
 /// ```
-public protocol HBAuthenticator: HBMiddlewareProtocol where Context: HBAuthRequestContextProtocol {
+public protocol HBAuthenticator: HBMiddlewareProtocol where Context: HBAuthRequestContext {
     /// type to be authenticated
     associatedtype Value: HBAuthenticatable
     /// Called by middleware to see if request can authenticate.

diff --git a/Sources/HummingbirdAuth/Middleware/IsAuthenticateMiddleware.swift b/Sources/HummingbirdAuth/Middleware/IsAuthenticateMiddleware.swift
@@ -15,7 +15,7 @@
 import Hummingbird
 
 /// Middleware returning 404 for unauthenticated requests
-public struct IsAuthenticatedMiddleware<Auth: HBAuthenticatable, Context: HBAuthRequestContextProtocol>: HBMiddlewareProtocol {
+public struct IsAuthenticatedMiddleware<Auth: HBAuthenticatable, Context: HBAuthRequestContext>: HBMiddlewareProtocol {
     public init(_: Auth.Type) {}
 
     public func handle(_ request: HBRequest, context: Context, next: (HBRequest, Context) async throws -> HBResponse) async throws -> HBResponse { guard context.auth.has(Auth.self) else { throw HBHTTPError(.unauthorized) }

diff --git a/Tests/HummingbirdAuthTests/AuthTests.swift b/Tests/HummingbirdAuthTests/AuthTests.swift
@@ -50,7 +50,7 @@ final class AuthTests: XCTestCase {
     }
 
     func testBearer() async throws {
-        let router = HBRouter(context: HBAuthRequestContext.self)
+        let router = HBRouter(context: HBBasicAuthRequestContext.self)
         router.get { request, _ -> String? in
             return request.headers.bearer?.token
         }
@@ -67,7 +67,7 @@ final class AuthTests: XCTestCase {
     }
 
     func testBasic() async throws {
-        let router = HBRouter(context: HBAuthRequestContext.self)
+        let router = HBRouter(context: HBBasicAuthRequestContext.self)
         router.get { request, _ -> String? in
             return request.headers.basic.map { "\($0.username):\($0.password)" }
         }
@@ -82,7 +82,7 @@ final class AuthTests: XCTestCase {
 
     func testBcryptThread() async throws {
         let persist = HBMemoryPersistDriver()
-        let router = HBRouter(context: HBAuthRequestContext.self)
+        let router = HBRouter(context: HBBasicAuthRequestContext.self)
         router.put { request, _ -> HTTPResponse.Status in
             guard let basic = request.headers.basic else { throw HBHTTPError(.unauthorized) }
             let hash = try await NIOThreadPool.singleton.runIfActive {
@@ -118,7 +118,7 @@ final class AuthTests: XCTestCase {
         struct User: HBAuthenticatable {
             let name: String
         }
-        let router = HBRouter(context: HBAuthRequestContext.self)
+        let router = HBRouter(context: HBBasicAuthRequestContext.self)
         router.get { _, context -> HTTPResponse.Status in
             var context = context
             context.auth.login(User(name: "Test"))
@@ -142,12 +142,12 @@ final class AuthTests: XCTestCase {
         struct User: HBAuthenticatable {
             let name: String
         }
-        struct HBTestAuthenticator<Context: HBAuthRequestContextProtocol>: HBAuthenticator {
+        struct HBTestAuthenticator<Context: HBAuthRequestContext>: HBAuthenticator {
             func authenticate(request: HBRequest, context: Context) async throws -> User? {
                 User(name: "Adam")
             }
         }
-        let router = HBRouter(context: HBAuthRequestContext.self)
+        let router = HBRouter(context: HBBasicAuthRequestContext.self)
         router.middlewares.add(HBTestAuthenticator())
         router.get { _, context -> HTTPResponse.Status in
             guard context.auth.has(User.self) else { return .unauthorized }
@@ -166,12 +166,12 @@ final class AuthTests: XCTestCase {
         struct User: HBAuthenticatable {
             let name: String
         }
-        struct HBTestAuthenticator<Context: HBAuthRequestContextProtocol>: HBAuthenticator {
+        struct HBTestAuthenticator<Context: HBAuthRequestContext>: HBAuthenticator {
             func authenticate(request: HBRequest, context: Context) async throws -> User? {
                 User(name: "Adam")
             }
         }
-        let router = HBRouter(context: HBAuthRequestContext.self)
+        let router = HBRouter(context: HBBasicAuthRequestContext.self)
         router.group()
             .add(middleware: HBTestAuthenticator())
             .add(middleware: IsAuthenticatedMiddleware(User.self))
@@ -199,14 +199,14 @@ final class AuthTests: XCTestCase {
         struct User: HBAuthenticatable {
             let name: String
         }
-        struct MySessionAuthenticator<Context: HBAuthRequestContextProtocol>: HBSessionAuthenticator {
+        struct MySessionAuthenticator<Context: HBAuthRequestContext>: HBSessionAuthenticator {
             let sessionStorage: HBSessionStorage
 
             func getValue(from session: Int, request: HBRequest, context: Context) async throws -> User? {
                 return User(name: "Adam")
             }
         }
-        let router = HBRouter(context: HBAuthRequestContext.self)
+        let router = HBRouter(context: HBBasicAuthRequestContext.self)
         let persist = HBMemoryPersistDriver()
         let sessions = HBSessionStorage(persist)
 

diff --git a/Tests/HummingbirdAuthTests/SessionTests.swift b/Tests/HummingbirdAuthTests/SessionTests.swift
@@ -24,13 +24,13 @@ final class SessionTests: XCTestCase {
         struct User: HBAuthenticatable {
             let name: String
         }
-        struct MySessionAuthenticator<Context: HBAuthRequestContextProtocol>: HBSessionAuthenticator {
+        struct MySessionAuthenticator<Context: HBAuthRequestContext>: HBSessionAuthenticator {
             let sessionStorage: HBSessionStorage
             func getValue(from session: Int, request: HBRequest, context: Context) async throws -> User? {
                 return User(name: "Adam")
             }
         }
-        let router = HBRouter(context: HBAuthRequestContext.self)
+        let router = HBRouter(context: HBBasicAuthRequestContext.self)
         let persist = HBMemoryPersistDriver()
         let sessions = HBSessionStorage(persist)
         router.put("session") { _, _ -> HBResponse in
@@ -64,7 +64,7 @@ final class SessionTests: XCTestCase {
             let name: String
         }
 
-        let router = HBRouter(context: HBAuthRequestContext.self)
+        let router = HBRouter(context: HBBasicAuthRequestContext.self)
         let persist = HBMemoryPersistDriver()
         let sessions = HBSessionStorage(persist)
         router.post("save") { request, _ -> HBResponse in
@@ -105,7 +105,7 @@ final class SessionTests: XCTestCase {
     }
 
     func testSessionUpdateError() async throws {
-        let router = HBRouter(context: HBAuthRequestContext.self)
+        let router = HBRouter(context: HBBasicAuthRequestContext.self)
         let persist = HBMemoryPersistDriver()
         let sessions = HBSessionStorage(persist)