improve error messages

Author: tsuyoshizawa

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

@@ -39,7 +39,7 @@ object AuthHeader extends AccessTokenFetcher {
   override def fetch(request: ProtectedResourceRequest): FetchResult = {
     val header = request.requireHeader("Authorization")
     val matcher = REGEXP_AUTHORIZATION.findFirstMatchIn(header).getOrElse {
-      throw new InvalidRequest("parse() method was called when match() result was false.")
+      throw new InvalidRequest("Authorization is invalid")
     }
 
     val token = matcher.group(2)

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

@@ -144,7 +144,7 @@ trait DataHandler[U] {
   def findAuthInfoByRefreshToken(refreshToken: String): Future[Option[AuthInfo[U]]]
 
   /**
-   * Find userId by clientId and clientSecret.
+   * Find user by clientId and clientSecret.
    *
    * If you don't support Client Credentials Grant then doesn't need implementing.
    *

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

@@ -9,7 +9,6 @@ trait GrantHandler {
 
   def handleRequest[U](request: AuthorizationRequest, dataHandler: DataHandler[U]): Future[GrantHandlerResult]
 
-
   /**
    * Returns valid access token.
    *
@@ -41,11 +40,11 @@ trait GrantHandler {
 class RefreshToken(clientCredentialFetcher: ClientCredentialFetcher) extends GrantHandler {
 
   override def handleRequest[U](request: AuthorizationRequest, dataHandler: DataHandler[U]): Future[GrantHandlerResult] = {
-    val clientCredential = clientCredentialFetcher.fetch(request).getOrElse(throw new InvalidRequest("BadRequest"))
+    val clientCredential = clientCredentialFetcher.fetch(request).getOrElse(throw new InvalidRequest("Authorization header is invalid"))
     val refreshToken = request.requireRefreshToken
 
     dataHandler.findAuthInfoByRefreshToken(refreshToken).flatMap { authInfoOption =>
-      val authInfo = authInfoOption.getOrElse(throw new InvalidGrant("NotFound"))
+      val authInfo = authInfoOption.getOrElse(throw new InvalidGrant("Authorized information is not found by the refresh token"))
       if (authInfo.clientId != clientCredential.clientId) {
         throw new InvalidClient
       }
@@ -66,7 +65,7 @@ class RefreshToken(clientCredentialFetcher: ClientCredentialFetcher) extends Gra
 class Password(clientCredentialFetcher: ClientCredentialFetcher) extends GrantHandler {
 
   override def handleRequest[U](request: AuthorizationRequest, dataHandler: DataHandler[U]): Future[GrantHandlerResult] = {
-    val clientCredential = clientCredentialFetcher.fetch(request).getOrElse(throw new InvalidRequest("BadRequest"))
+    val clientCredential = clientCredentialFetcher.fetch(request).getOrElse(throw new InvalidRequest("Authorization header is invalid"))
     val username = request.requireUsername
     val password = request.requirePassword
 
@@ -84,13 +83,13 @@ class Password(clientCredentialFetcher: ClientCredentialFetcher) extends GrantHa
 class ClientCredentials(clientCredentialFetcher: ClientCredentialFetcher) extends GrantHandler {
 
   override def handleRequest[U](request: AuthorizationRequest, dataHandler: DataHandler[U]): Future[GrantHandlerResult] = {
-    val clientCredential = clientCredentialFetcher.fetch(request).getOrElse(throw new InvalidRequest("BadRequest"))
+    val clientCredential = clientCredentialFetcher.fetch(request).getOrElse(throw new InvalidRequest("Authorization header is invalid"))
     val clientSecret = clientCredential.clientSecret
     val clientId = clientCredential.clientId
     val scope = request.scope
 
     dataHandler.findClientUser(clientId, clientSecret, scope).flatMap { userOption =>
-      val user = userOption.getOrElse(throw new InvalidGrant())
+      val user = userOption.getOrElse(throw new InvalidGrant("client_id or client_secret or scope is incorrect"))
       val authInfo = AuthInfo(user, clientId, scope, None)
 
       issueAccessToken(dataHandler, authInfo)
@@ -102,13 +101,13 @@ class ClientCredentials(clientCredentialFetcher: ClientCredentialFetcher) extend
 class AuthorizationCode(clientCredentialFetcher: ClientCredentialFetcher) extends GrantHandler {
 
   override def handleRequest[U](request: AuthorizationRequest, dataHandler: DataHandler[U]): Future[GrantHandlerResult] = {
-    val clientCredential = clientCredentialFetcher.fetch(request).getOrElse(throw new InvalidRequest("BadRequest"))
+    val clientCredential = clientCredentialFetcher.fetch(request).getOrElse(throw new InvalidRequest("Authorization header is invalid"))
     val clientId = clientCredential.clientId
     val code = request.requireCode
     val redirectUri = request.redirectUri
 
     dataHandler.findAuthInfoByCode(code).flatMap { authInfoOption =>
-      val authInfo = authInfoOption.getOrElse(throw new InvalidGrant())
+      val authInfo = authInfoOption.getOrElse(throw new InvalidGrant("Authorized information is not found by the code"))
       if (authInfo.clientId != clientId) {
         throw new InvalidClient
       }

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

@@ -13,16 +13,16 @@ trait ProtectedResource {
     }.map { fetcher =>
       val result = fetcher.fetch(request)
       dataHandler.findAccessToken(result.token).flatMap { optionalToken =>
-        val token = optionalToken.getOrElse(throw new InvalidToken("Not found the access token"))
+        val token = optionalToken.getOrElse(throw new InvalidToken("The access token is not found"))
         if (dataHandler.isAccessTokenExpired(token)) {
           throw new ExpiredToken()
         }
 
-        dataHandler.findAuthInfoByAccessToken(token).map(_.map(Right(_)).getOrElse(Left(new InvalidToken("Invalid the access token"))))
+        dataHandler.findAuthInfoByAccessToken(token).map(_.map(Right(_)).getOrElse(Left(new InvalidToken("The access token is invalid"))))
       }.recover {
         case e: OAuthError => Left(e)
       }
-    }.getOrElse(throw new InvalidRequest("Access token was not specified"))
+    }.getOrElse(throw new InvalidRequest("Access token is not found"))
   } catch {
     case e: OAuthError => Future.successful(Left(e))
   }

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

@@ -15,9 +15,9 @@ trait TokenEndpoint {
   )
 
   def handleRequest[U](request: AuthorizationRequest, dataHandler: DataHandler[U]): Future[Either[OAuthError, GrantHandlerResult]] = try {
-    val grantType = request.grantType.getOrElse(throw new InvalidRequest("the grant_type is not found"))
-    val handler = handlers.get(grantType).getOrElse(throw new UnsupportedGrantType("the grant_type isn't supported"))
-    val clientCredential = fetcher.fetch(request).getOrElse(throw new InvalidRequest("client credential is not found"))
+    val grantType = request.grantType.getOrElse(throw new InvalidRequest("grant_type is not found"))
+    val handler = handlers.get(grantType).getOrElse(throw new UnsupportedGrantType("The grant_type is not supported"))
+    val clientCredential = fetcher.fetch(request).getOrElse(throw new InvalidRequest("Client credential is not found"))
 
     dataHandler.validateClient(clientCredential.clientId, clientCredential.clientSecret, grantType).flatMap { validClient =>
       if (!validClient) {

scala-oauth2-core/src/test/scala/scalaoauth2/provider/ProtectedResourceSpec.scala

@@ -85,7 +85,7 @@ class ProtectedResourceSpec extends FlatSpec with ScalaFutures {
           case _ =>
         }
       }
-      e.description should be ("Access token was not specified")
+      e.description should be ("Access token is not found")
     }
   }
 
@@ -112,7 +112,7 @@ class ProtectedResourceSpec extends FlatSpec with ScalaFutures {
           case _ =>
         }
       }
-      e.description should be ("Not found the access token")
+      e.description should be ("The access token is not found")
     }
   }
 
@@ -139,7 +139,7 @@ class ProtectedResourceSpec extends FlatSpec with ScalaFutures {
           case _ =>
         }
       }
-      e.description should be ("Invalid the access token")
+      e.description should be ("The access token is invalid")
     }
   }
 }

scala-oauth2-core/src/test/scala/scalaoauth2/provider/TokenEndPointSpec.scala

@@ -49,7 +49,7 @@ class TokenEndPointSpec extends FlatSpec with ScalaFutures {
           case _ =>
         }
       }
-      e.description should be ("the grant_type is not found")
+      e.description should be ("grant_type is not found")
     }
   }
 
@@ -69,7 +69,7 @@ class TokenEndPointSpec extends FlatSpec with ScalaFutures {
           case _ =>
         }
       }
-      e.description should be ("the grant_type isn't supported")
+      e.description should be ("The grant_type is not supported")
     }
   }
 
@@ -89,7 +89,7 @@ class TokenEndPointSpec extends FlatSpec with ScalaFutures {
           case _ =>
         }
       }
-      e.description should be ("client credential is not found")
+      e.description should be ("Client credential is not found")
     }
   }