added to be able to get authInfo on issue access token

Author: tsuyoshizawa

play2-oauth2-provider/src/main/scala/scalaoauth2/provider/OAuth2Provider.scala

@@ -63,7 +63,7 @@ trait OAuth2BaseProvider extends Results {
 
   }
 
-  protected[scalaoauth2] def responseAccessToken(r: GrantHandlerResult) = {
+  protected[scalaoauth2] def responseAccessToken[U](r: GrantHandlerResult[U]) = {
     Map[String, JsValue](
       "token_type" -> JsString(r.tokenType),
       "access_token" -> JsString(r.accessToken)

play2-oauth2-provider/src/test/scala/scalaoauth2/provider/OAuth2ProviderSpec.scala

@@ -8,12 +8,23 @@ import play.api.test.{ FakeHeaders, FakeRequest }
 
 class OAuth2ProviderSpec extends FlatSpec {
 
+  case class User(id: Long, name: String)
+
   object TestOAuthProvider extends OAuth2Provider {
-    override def responseAccessToken(r: GrantHandlerResult) = super.responseAccessToken(r) ++ Map("custom_key" -> JsString("custom_value"))
+    override def responseAccessToken[U](r: GrantHandlerResult[U]) = super.responseAccessToken(r) ++ Map("custom_key" -> JsString("custom_value"))
   }
 
   it should "return including access token" in {
-    val map = TestOAuthProvider.responseAccessToken(GrantHandlerResult(tokenType = "Bearer", accessToken = "access_token", expiresIn = Some(3600), refreshToken = None, scope = None))
+    val map = TestOAuthProvider.responseAccessToken(
+      GrantHandlerResult(
+        authInfo = AuthInfo[User](user = User(0L, "name"), Some("client_id"), None, None),
+        tokenType = "Bearer",
+        accessToken = "access_token",
+        expiresIn = Some(3600),
+        refreshToken = None,
+        scope = None
+      )
+    )
     map.get("token_type") should contain(JsString("Bearer"))
     map.get("access_token") should contain(JsString("access_token"))
     map.get("expires_in") should contain(JsNumber(3600))

scala-oauth2-core/src/main/scala/scalaoauth2/provider/GrantHandler.scala

@@ -3,7 +3,13 @@ package scalaoauth2.provider
 import scala.concurrent.Future
 import scala.concurrent.ExecutionContext.Implicits.global
 
-case class GrantHandlerResult(tokenType: String, accessToken: String, expiresIn: Option[Long], refreshToken: Option[String], scope: Option[String])
+case class GrantHandlerResult[U](
+  authInfo: AuthInfo[U],
+  tokenType: String,
+  accessToken: String,
+  expiresIn: Option[Long],
+  refreshToken: Option[String],
+  scope: Option[String])
 
 trait GrantHandler {
   /**
@@ -13,12 +19,12 @@ trait GrantHandler {
    */
   def clientCredentialRequired = true
 
-  def handleRequest[U](request: AuthorizationRequest, authorizationHandler: AuthorizationHandler[U]): Future[GrantHandlerResult]
+  def handleRequest[U](request: AuthorizationRequest, authorizationHandler: AuthorizationHandler[U]): Future[GrantHandlerResult[U]]
 
   /**
    * Returns valid access token.
    */
-  protected def issueAccessToken[U](handler: AuthorizationHandler[U], authInfo: AuthInfo[U]): Future[GrantHandlerResult] = {
+  protected def issueAccessToken[U](handler: AuthorizationHandler[U], authInfo: AuthInfo[U]): Future[GrantHandlerResult[U]] = {
     handler.getStoredAccessToken(authInfo).flatMap {
       case Some(token) if shouldRefreshAccessToken(token) => token.refreshToken.map {
         handler.refreshAccessToken(authInfo, _)
@@ -27,12 +33,13 @@ trait GrantHandler {
       }
       case Some(token) => Future.successful(token)
       case None => handler.createAccessToken(authInfo)
-    }.map(createGrantHandlerResult)
+    }.map(createGrantHandlerResult(authInfo, _))
   }
 
   protected def shouldRefreshAccessToken(token: AccessToken) = token.isExpired
 
-  protected def createGrantHandlerResult(accessToken: AccessToken) = GrantHandlerResult(
+  protected def createGrantHandlerResult[U](authInfo: AuthInfo[U], accessToken: AccessToken) = GrantHandlerResult(
+    authInfo,
     "Bearer",
     accessToken.token,
     accessToken.expiresIn,
@@ -44,7 +51,7 @@ trait GrantHandler {
 
 class RefreshToken extends GrantHandler {
 
-  override def handleRequest[U](request: AuthorizationRequest, handler: AuthorizationHandler[U]): Future[GrantHandlerResult] = {
+  override def handleRequest[U](request: AuthorizationRequest, handler: AuthorizationHandler[U]): Future[GrantHandlerResult[U]] = {
     val refreshTokenRequest = new RefreshTokenRequest(request)
     val clientCredential = refreshTokenRequest.clientCredential.getOrElse(throw new InvalidRequest("Client credential is required"))
     val refreshToken = refreshTokenRequest.refreshToken
@@ -55,14 +62,14 @@ class RefreshToken extends GrantHandler {
         throw new InvalidClient
       }
 
-      handler.refreshAccessToken(authInfo, refreshToken).map(createGrantHandlerResult)
+      handler.refreshAccessToken(authInfo, refreshToken).map(createGrantHandlerResult(authInfo, _))
     }
   }
 }
 
 class Password extends GrantHandler {
 
-  override def handleRequest[U](request: AuthorizationRequest, handler: AuthorizationHandler[U]): Future[GrantHandlerResult] = {
+  override def handleRequest[U](request: AuthorizationRequest, handler: AuthorizationHandler[U]): Future[GrantHandlerResult[U]] = {
     val passwordRequest = new PasswordRequest(request)
     if (clientCredentialRequired && passwordRequest.clientCredential.isEmpty) {
       throw new InvalidRequest("Client credential is required")
@@ -81,7 +88,7 @@ class Password extends GrantHandler {
 
 class ClientCredentials extends GrantHandler {
 
-  override def handleRequest[U](request: AuthorizationRequest, handler: AuthorizationHandler[U]): Future[GrantHandlerResult] = {
+  override def handleRequest[U](request: AuthorizationRequest, handler: AuthorizationHandler[U]): Future[GrantHandlerResult[U]] = {
     val clientCredentialsRequest = new ClientCredentialsRequest(request)
     val clientCredential = clientCredentialsRequest.clientCredential.getOrElse(throw new InvalidRequest("Client credential is required"))
     val scope = clientCredentialsRequest.scope
@@ -98,7 +105,7 @@ class ClientCredentials extends GrantHandler {
 
 class AuthorizationCode extends GrantHandler {
 
-  override def handleRequest[U](request: AuthorizationRequest, handler: AuthorizationHandler[U]): Future[GrantHandlerResult] = {
+  override def handleRequest[U](request: AuthorizationRequest, handler: AuthorizationHandler[U]): Future[GrantHandlerResult[U]] = {
     val authorizationCodeRequest = new AuthorizationCodeRequest(request)
     val clientCredential = authorizationCodeRequest.clientCredential.getOrElse(throw new InvalidRequest("Client credential is required"))
     val clientId = clientCredential.clientId
@@ -125,7 +132,7 @@ class AuthorizationCode extends GrantHandler {
 
 class Implicit extends GrantHandler {
 
-  override def handleRequest[U](request: AuthorizationRequest, handler: AuthorizationHandler[U]): Future[GrantHandlerResult] = {
+  override def handleRequest[U](request: AuthorizationRequest, handler: AuthorizationHandler[U]): Future[GrantHandlerResult[U]] = {
     val implicitRequest = new ImplicitRequest(request)
     val clientCredential = implicitRequest.clientCredential.getOrElse(throw new InvalidRequest("Client credential is required"))
 
@@ -146,6 +153,7 @@ class Implicit extends GrantHandler {
   /**
    * Implicit grant must not return refresh token
    */
-  protected override def createGrantHandlerResult(accessToken: AccessToken) = super.createGrantHandlerResult(accessToken).copy(refreshToken = None)
+  protected override def createGrantHandlerResult[U](authInfo: AuthInfo[U], accessToken: AccessToken) =
+    super.createGrantHandlerResult(authInfo, accessToken).copy(refreshToken = None)
 
 }

scala-oauth2-core/src/main/scala/scalaoauth2/provider/TokenEndpoint.scala

@@ -1,14 +1,12 @@
 package scalaoauth2.provider
 
-import scala.concurrent.Future
 import scala.concurrent.ExecutionContext.Implicits.global
-
-import scalaoauth2.provider.OAuthGrantType._
+import scala.concurrent.Future
 
 trait TokenEndpoint {
   val handlers = Map.empty[String, GrantHandler]
 
-  def handleRequest[U](request: AuthorizationRequest, handler: AuthorizationHandler[U]): Future[Either[OAuthError, GrantHandlerResult]] = try {
+  def handleRequest[U](request: AuthorizationRequest, handler: AuthorizationHandler[U]): Future[Either[OAuthError, GrantHandlerResult[U]]] = try {
     val grantType = request.grantType
     val grantHandler = handlers.getOrElse(grantType, throw new UnsupportedGrantType(s"${grantType} is not supported"))