Adjust formatting and update documentation

README.md

@@ -19,6 +19,3 @@
 <br>
 
 Imperial is a Federated Login service, allowing you to easily integrate your Vapor applications with OAuth providers to handle your apps authentication.
-
-## Attribution
-Author(s): @calebkleveter, @rafiki270

Sources/Imperial/Services/DeviantArt/DeviantArtRouter.swift

@@ -21,8 +21,10 @@ public class DeviantArtRouter: FederatedServiceRouter {
         } else {
             scope = ""
         }
-        return "https://www.deviantart.com/oauth2/authorize?" + "client_id=\(self.tokens.clientID)&"
-            + "redirect_uri=\(self.callbackURL)&\(scope)" + "response_type=code"
+        return "https://www.deviantart.com/oauth2/authorize?"
+            + "client_id=\(self.tokens.clientID)&"
+            + "redirect_uri=\(self.callbackURL)&\(scope)"
+            + "response_type=code"
     }
 
     public func fetchToken(from request: Request) throws -> Future<String> {

Sources/ImperialCore/Helpers/Request+Imperial.swift

@@ -15,10 +15,7 @@ extension Request {
             throw ServiceError.noServiceEndpoint(model.serviceKey)
         }
 
-        let token =
-            try service.tokenPrefix
-            + req
-            .accessToken()
+        let token = try service.tokenPrefix + req.accessToken()
 
         let response = try await req.client.get(URI(string: url), headers: ["Authorization": token])
         let instance = try await model.init(from: response)

Sources/ImperialCore/Services/FederatedService.swift

@@ -5,26 +5,32 @@ import Vapor
 /// Usage:
 ///
 /// ```swift
-/// import HTTP
+/// import ImperialCore
+/// import Vapor
 ///
 /// public class Service: FederatedService {
-///     public var tokens: FederatedServiceTokens
-///     public var router: FederatedServiceRouter
+///     public var tokens: any FederatedServiceTokens
+///     public var router: any FederatedServiceRouter
 ///
 ///     @discardableResult
-///     public required init(authenticate: String, callback: String, scope: [String] = [], completion: @escaping (String) -> (ResponseRepresentable)) throws {
-///         self.router = try ServiceRouter(callback: callback, completion: completion)
+///     public required init(
+///         routes: some RoutesBuilder,
+///         authenticate: String,
+///         authenticateCallback: (@Sendable (Request) async throws -> Void)?,
+///         callback: String,
+///         scope: [String] = [],
+///         completion: @escaping @Sendable (Request, String) async throws -> some AsyncResponseEncodable
+///     ) throws {
+///         self.router = try ServiceRouter(callback: callback, scope: scope, completion: completion)
 ///         self.tokens = self.router.tokens
 ///
-///         self.router.scope = scope
-///         try self.router.configureRoutes(withAuthURL: authenticate, authenticateCallback: authenticateCallback, on: router)
+///         try self.router.configureRoutes(withAuthURL: authenticate, authenticateCallback: authenticateCallback, on: routes)
 ///
-///         Service.register(.service)
+///         OAuthService.services[OAuthService.service.name] = .service
 ///     }
 /// }
 /// ```
 public protocol FederatedService {
-
     /// The service's token model for getting the client ID and secret.
     var tokens: any FederatedServiceTokens { get }
 
@@ -41,7 +47,11 @@ public protocol FederatedService {
     ///   - completion: The completion handler that will fire at the end of the callback route. The access token is passed into the callback and the response that is returned will be returned from the callback route. This will usually be a redirect back to the app.
     /// - Throws: Any errors that occur in the implementation.
     init(
-        routes: some RoutesBuilder, authenticate: String, authenticateCallback: (@Sendable (Request) async throws -> Void)?,
-        callback: String, scope: [String], completion: @escaping @Sendable (Request, String) async throws -> some AsyncResponseEncodable)
-        throws
+        routes: some RoutesBuilder,
+        authenticate: String,
+        authenticateCallback: (@Sendable (Request) async throws -> Void)?,
+        callback: String,
+        scope: [String],
+        completion: @escaping @Sendable (Request, String) async throws -> some AsyncResponseEncodable
+    ) throws
 }

Sources/ImperialKeycloak/KeycloakRouter.swift

@@ -22,8 +22,11 @@ final public class KeycloakRouter: FederatedServiceRouter {
     }
 
     public func authURL(_ request: Request) throws -> String {
-        return "\(keycloakTokens.authURL)/auth?" + "client_id=\(self.tokens.clientID)&" + "redirect_uri=\(self.callbackURL)&"
-            + "scope=\(scope.joined(separator: "%20"))&" + "response_type=code"
+        return "\(keycloakTokens.authURL)/auth?"
+            + "client_id=\(self.tokens.clientID)&"
+            + "redirect_uri=\(self.callbackURL)&"
+            + "scope=\(scope.joined(separator: "%20"))&"
+            + "response_type=code"
     }
 
     public func callbackBody(with code: String) -> any AsyncResponseEncodable {

Sources/ImperialShopify/ShopifyRouter.swift

@@ -7,6 +7,7 @@ final public class ShopifyRouter: FederatedServiceRouter {
     public let callbackURL: String
     // `accessTokenURL` used to be set inside `authURL` and read by `fetchToken`
     // now `fetchToken` creates the `accessTokenURL` itself from the shop domain in the request
+    // but the property is still required by the protocol, so it's set to an empty string
     public let accessTokenURL: String = ""
     public let service: OAuthService = .shopify
 
@@ -25,8 +26,11 @@ final public class ShopifyRouter: FederatedServiceRouter {
         let nonce = String(UUID().uuidString.prefix(6))
         try request.session.setNonce(nonce)
 
-        return "https://\(shop)/admin/oauth/authorize?" + "client_id=\(tokens.clientID)&" + "scope=\(scope.joined(separator: ","))&"
-            + "redirect_uri=\(callbackURL)&" + "state=\(nonce)"
+        return "https://\(shop)/admin/oauth/authorize?"
+            + "client_id=\(tokens.clientID)&"
+            + "scope=\(scope.joined(separator: ","))&"
+            + "redirect_uri=\(callbackURL)&"
+            + "state=\(nonce)"
     }
 
     public func callbackBody(with code: String) -> any AsyncResponseEncodable {