add more information to be stored within the AccessToken (#101)

Author: Christophe Pache

akka-http-oauth2-provider/src/main/scala/scalaoauth2/provider/OAuth2Provider.scala

@@ -4,22 +4,21 @@ import akka.http.scaladsl.model.StatusCodes._
 import akka.http.scaladsl.server.Directives
 import akka.http.scaladsl.server.directives.Credentials
 import scalaoauth2.provider.OAuth2Provider.TokenResponse
-import spray.json.DefaultJsonProtocol
+import spray.json.{ JsValue, DefaultJsonProtocol }
 
 import scala.concurrent.ExecutionContext.Implicits.global
 import scala.concurrent.Future
 import scala.util.{ Failure, Success }
 
 trait OAuth2Provider[U] extends Directives with DefaultJsonProtocol {
-  import OAuth2Provider.tokenResponseFormat
   import akka.http.scaladsl.marshallers.sprayjson.SprayJsonSupport._
 
   val oauth2DataHandler: DataHandler[U]
 
   val tokenEndpoint: TokenEndpoint
 
-  def grantResultToTokenResponse(grantResult: GrantHandlerResult[U]): TokenResponse =
-    TokenResponse(grantResult.tokenType, grantResult.accessToken, grantResult.expiresIn.getOrElse(1L), grantResult.refreshToken.getOrElse(""))
+  def grantResultToTokenResponse(grantResult: GrantHandlerResult[U]): JsValue =
+    OAuth2Provider.tokenResponseFormat.write(TokenResponse(grantResult.tokenType, grantResult.accessToken, grantResult.expiresIn.getOrElse(1L), grantResult.refreshToken.getOrElse("")))
 
   def oauth2Authenticator(credentials: Credentials): Future[Option[AuthInfo[U]]] =
     credentials match {
@@ -39,7 +38,7 @@ trait OAuth2Provider[U] extends Directives with DefaultJsonProtocol {
             case Success(maybeGrantResponse) =>
               maybeGrantResponse.fold(
                 oauthError => complete(Unauthorized),
-                grantResult => complete(tokenResponseFormat.write(grantResultToTokenResponse(grantResult)))
+                grantResult => complete(grantResultToTokenResponse(grantResult))
               )
             case Failure(ex) => complete(InternalServerError, s"An error occurred: ${ex.getMessage}")
           }

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

@@ -22,7 +22,8 @@ class OAuth2ProviderSpec extends FlatSpec {
         accessToken = "access_token",
         expiresIn = Some(3600),
         refreshToken = None,
-        scope = None
+        scope = None,
+        params = Map.empty
       )
     )
     map.get("token_type") should contain(JsString("Bearer"))

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

@@ -15,8 +15,9 @@ trait DataHandler[U] extends AuthorizationHandler[U] with ProtectedResourceHandl
  * @param scope Inform the client of the scope of the access token issued.
  * @param lifeSeconds Life of the access token since its creation. In seconds.
  * @param createdAt Access token is created date.
+ * @param params Additional parameters to add information/restriction on given Access token.
  */
-case class AccessToken(token: String, refreshToken: Option[String], scope: Option[String], lifeSeconds: Option[Long], createdAt: Date) {
+case class AccessToken(token: String, refreshToken: Option[String], scope: Option[String], lifeSeconds: Option[Long], createdAt: Date, params: Map[String, String] = Map.empty[String, String]) {
   def isExpired: Boolean = expirationTimeInMilis.exists { expTime =>
     expTime <= System.currentTimeMillis
   }

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

@@ -8,7 +8,8 @@ case class GrantHandlerResult[U](
   accessToken: String,
   expiresIn: Option[Long],
   refreshToken: Option[String],
-  scope: Option[String]
+  scope: Option[String],
+  params: Map[String, String]
 )
 
 trait GrantHandler {
@@ -44,7 +45,8 @@ trait GrantHandler {
     accessToken.token,
     accessToken.expiresIn,
     accessToken.refreshToken,
-    accessToken.scope
+    accessToken.scope,
+    accessToken.params
   )
 
 }