Supported optional parameters for login

see: t2v#175
tototoshi · Jul 14, 2016 · d933dd7 · d933dd7
1 parent 41b76e8
commit d933dd7
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 25 deletions.
diff --git a/social-sample/app/views/index.scala.html b/social-sample/app/views/index.scala.html
@@ -54,7 +54,7 @@ <h2>GitHub</h2>
                             <img src="@{u.avatarUrl}">
                         </p>
                         }.getOrElse {
-                            <a href="@routes.GitHubAuthController.link("user")">link GitHub</a>
+                            <a href="@{routes.GitHubAuthController.link() + "?scope=user"}>link GitHub</a>
                         }
                     </div>
 
@@ -69,7 +69,7 @@ <h2>Facebook</h2>
                             <img src="@{u.coverUrl}">
                         </p>
                         }.getOrElse {
-                            <a href="@routes.FacebookAuthController.link("email")">link Facebook</a>
+                            <a href="@{routes.FacebookAuthController.link() + "?scope=email"}">link Facebook</a>
                         }
                     </div>
 
@@ -94,7 +94,7 @@ <h2>Slack</h2>
                             @u.accessToken
                         </p>
                         }.getOrElse {
-                            <a href="@routes.SlackAuthController.link("read")">link Slack</a>
+                            <a href="@{routes.SlackAuthController.link() + "?scope=read"}">link Slack</a>
                         }
                     </div>
 
@@ -105,10 +105,10 @@ <h2>Slack</h2>
                     <a href="@routes.TwitterAuthController.login">twitter login</a>
                 </p>
                 <p>
-                    <a href="@routes.GitHubAuthController.login("user")">github login</a>
+                    <a href="@{routes.GitHubAuthController.login() + "?scope=user"}">github login</a>
                 </p>
                 <p>
-                    <a href="@routes.FacebookAuthController.login("email")">facebook login</a>
+                    <a href="@{routes.FacebookAuthController.login() + "?scope=email"}">facebook login</a>
                 </p>
             }
         </div>

diff --git a/social-sample/conf/routes b/social-sample/conf/routes
@@ -5,13 +5,13 @@ GET        /login/twitter             controllers.TwitterAuthController.login
 GET        /link/twitter              controllers.TwitterAuthController.link
 GET        /authorize/twitter         controllers.TwitterAuthController.authorize
 
-GET        /login/github              controllers.GitHubAuthController.login(scope: String)
-GET        /link/github               controllers.GitHubAuthController.link(scope: String)
+GET        /login/github              controllers.GitHubAuthController.login()
+GET        /link/github               controllers.GitHubAuthController.link()
 GET        /authorize/github          controllers.GitHubAuthController.authorize
 
-GET        /login/facebook            controllers.FacebookAuthController.login(scope: String)
-GET        /link/facebook             controllers.FacebookAuthController.link(scope: String)
+GET        /login/facebook            controllers.FacebookAuthController.login()
+GET        /link/facebook             controllers.FacebookAuthController.link()
 GET        /authorize/facebook        controllers.FacebookAuthController.authorize
 
-GET        /link/slack                controllers.SlackAuthController.link(scope: String)
+GET        /link/slack                controllers.SlackAuthController.link()
 GET        /authorize/slack           controllers.SlackAuthController.authorize
diff --git a/social/src/main/scala/jp/t2v/lab/play2/auth/social/core/OAuth2Authenticator.scala b/social/src/main/scala/jp/t2v/lab/play2/auth/social/core/OAuth2Authenticator.scala
@@ -1,6 +1,7 @@
 package jp.t2v.lab.play2.auth.social.core
 
 import play.api.libs.ws.WSResponse
+import play.api.mvc.{ AnyContent, Request }
 
 import scala.concurrent.{ ExecutionContext, Future }
 
@@ -20,7 +21,7 @@ trait OAuth2Authenticator extends OAuthAuthenticator {
 
   def retrieveAccessToken(code: String)(implicit ctx: ExecutionContext): Future[AccessToken]
 
-  def getAuthorizationUrl(scope: String, state: String): String
+  def getAuthorizationUrl(request: Request[AnyContent], state: String): String
 
   def parseAccessTokenResponse(response: WSResponse): String
 

diff --git a/social/src/main/scala/jp/t2v/lab/play2/auth/social/core/OAuth2Controller.scala b/social/src/main/scala/jp/t2v/lab/play2/auth/social/core/OAuth2Controller.scala
@@ -17,9 +17,7 @@ trait OAuth2Controller extends Controller with OAuthController { self: OptionalA
 
   protected val OAuth2StateKey = "play.auth.social.oauth2.state"
 
-  // TODO scope is optional in some services
-  // TODO some services have more optional parameter
-  def login(scope: String) = AsyncStack(ExecutionContextKey -> OAuthExecutionContext) { implicit request =>
+  def login = AsyncStack(ExecutionContextKey -> OAuthExecutionContext) { implicit request =>
     implicit val ec = StackActionExecutionContext
     loggedIn match {
       case Some(u) =>
@@ -28,21 +26,19 @@ trait OAuth2Controller extends Controller with OAuthController { self: OptionalA
         // should be more random ?
         val state = UUID.randomUUID().toString
         Future.successful(
-          Redirect(authenticator.getAuthorizationUrl(scope, state)).withSession(
+          Redirect(authenticator.getAuthorizationUrl(request, state)).withSession(
             request.session + (OAuth2StateKey -> state)
           )
         )
     }
   }
 
-  // TODO scope is optional in some services
-  // TODO some services have more optional parameter
-  def link(scope: String) = StackAction(ExecutionContextKey -> OAuthExecutionContext) { implicit request =>
+  def link = StackAction(ExecutionContextKey -> OAuthExecutionContext) { implicit request =>
     loggedIn match {
       case Some(u) =>
         // TODO should it be more random ?
         val state = UUID.randomUUID().toString
-        Redirect(authenticator.getAuthorizationUrl(scope, state)).withSession(
+        Redirect(authenticator.getAuthorizationUrl(request, state)).withSession(
           request.session + (OAuth2StateKey -> state)
         )
       case None =>

diff --git a/...rc/main/scala/jp/t2v/lab/play2/auth/social/providers/facebook/FacebookAuthenticator.scala b/...rc/main/scala/jp/t2v/lab/play2/auth/social/providers/facebook/FacebookAuthenticator.scala
@@ -7,7 +7,7 @@ import play.api.Logger
 import play.api.Play.current
 import play.api.http.{ HeaderNames, MimeTypes }
 import play.api.libs.ws.{ WS, WSResponse }
-import play.api.mvc.Results
+import play.api.mvc.{ AnyContent, Request, Results }
 
 import scala.concurrent.{ ExecutionContext, Future }
 import scala.util.control.NonFatal
@@ -43,7 +43,8 @@ class FacebookAuthenticator extends OAuth2Authenticator {
       }
   }
 
-  def getAuthorizationUrl(scope: String, state: String): String = {
+  def getAuthorizationUrl(request: Request[AnyContent], state: String): String = {
+    val scope = request.getQueryString("scope").getOrElse("")
     val encodedClientId = URLEncoder.encode(clientId, "utf-8")
     val encodedRedirectUri = URLEncoder.encode(callbackUrl, "utf-8")
     val encodedScope = URLEncoder.encode(scope, "utf-8")

diff --git a/...al/src/main/scala/jp/t2v/lab/play2/auth/social/providers/github/GitHubAuthenticator.scala b/...al/src/main/scala/jp/t2v/lab/play2/auth/social/providers/github/GitHubAuthenticator.scala
@@ -7,7 +7,7 @@ import play.api.Logger
 import play.api.Play.current
 import play.api.http.{ HeaderNames, MimeTypes }
 import play.api.libs.ws.{ WS, WSResponse }
-import play.api.mvc.Results
+import play.api.mvc.{ AnyContent, Request, Results }
 
 import scala.concurrent.{ ExecutionContext, Future }
 import scala.util.control.NonFatal
@@ -42,7 +42,8 @@ class GitHubAuthenticator extends OAuth2Authenticator {
       }
   }
 
-  def getAuthorizationUrl(scope: String, state: String): String = {
+  def getAuthorizationUrl(request: Request[AnyContent], state: String): String = {
+    val scope = request.getQueryString("scope").getOrElse("")
     val encodedClientId = URLEncoder.encode(clientId, "utf-8")
     val encodedRedirectUri = URLEncoder.encode(callbackUrl, "utf-8")
     val encodedScope = URLEncoder.encode(scope, "utf-8")

diff --git a/social/src/main/scala/jp/t2v/lab/play2/auth/social/providers/slack/SlackAuthenticator.scala b/social/src/main/scala/jp/t2v/lab/play2/auth/social/providers/slack/SlackAuthenticator.scala
@@ -7,7 +7,7 @@ import play.api.Logger
 import play.api.http.{ HeaderNames, MimeTypes }
 import play.api.libs.ws.{ WS, WSResponse }
 import play.api.Play.current
-import play.api.mvc.Results
+import play.api.mvc.{ AnyContent, Request, Results }
 
 import scala.concurrent.{ ExecutionContext, Future }
 import scala.util.control.NonFatal
@@ -28,7 +28,8 @@ class SlackAuthenticator extends OAuth2Authenticator {
 
   override val callbackUrl: String = current.configuration.getString("slack.callbackURL").getOrElse("slack.callbackURL is missing")
 
-  def getAuthorizationUrl(scope: String, state: String): String = {
+  def getAuthorizationUrl(request: Request[AnyContent], state: String): String = {
+    val scope = request.getQueryString("scope").getOrElse("")
     val encodedClientId = URLEncoder.encode(clientId, "utf-8")
     val encodedRedirectUri = URLEncoder.encode(callbackUrl, "utf-8")
     val encodedScope = URLEncoder.encode(scope, "utf-8")