add ScopeBuilder to easily specify multiple scopes while requesting OAuth2.0 Access Tokens

kullfar · kullfar · commit 54407f0e6103 · 2021-01-12T11:23:31.000+03:00
diff --git a/changelog b/changelog
@@ -1,3 +1,6 @@
+[SNAPSHOT]
+ * add ScopeBuilder to easily specify multiple scopes while requesting OAuth2.0 Access Tokens
+
 [8.1.0]
  * add raw Response (with HTTP response code and body) as member to the OAuth2AccessTokenErrorResponse
  * add possibility to set "" (empty string) as apiSecret
diff --git a/pom.xml b/pom.xml
@@ -54,7 +54,7 @@
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-databind</artifactId>
-            <version>2.12.0</version>
+            <version>2.12.1</version>
         </dependency>
         <dependency>
             <groupId>junit</groupId>
@@ -104,7 +104,7 @@
                         <dependency>
                             <groupId>com.puppycrawl.tools</groupId>
                             <artifactId>checkstyle</artifactId>
-                            <version>8.38</version>
+                            <version>8.39</version>
                         </dependency>
                     </dependencies>
                 </plugin>
@@ -188,6 +188,7 @@
                     <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
                     <encoding>UTF-8</encoding>
                     <additionalOptions>-html5</additionalOptions>
+                    <doclint>all,-missing</doclint>
                 </configuration>
                 <executions>
                     <execution>
diff --git a/scribejava-apis/src/test/java/com/github/scribejava/apis/examples/LinkedIn20Example.java b/scribejava-apis/src/test/java/com/github/scribejava/apis/examples/LinkedIn20Example.java
@@ -3,6 +3,7 @@
 import java.util.Scanner;
 import com.github.scribejava.core.builder.ServiceBuilder;
 import com.github.scribejava.apis.LinkedInApi20;
+import com.github.scribejava.core.builder.ScopeBuilder;
 import com.github.scribejava.core.model.OAuth2AccessToken;
 import com.github.scribejava.core.model.OAuthRequest;
 import com.github.scribejava.core.model.Response;
@@ -29,7 +30,7 @@ public static void main(String... args) throws IOException, InterruptedException
         final String clientSecret = "your client secret";
         final OAuth20Service service = new ServiceBuilder(clientId)
                 .apiSecret(clientSecret)
-                .defaultScope("r_liteprofile r_emailaddress") // replace with desired scope
+                .defaultScope(new ScopeBuilder("r_liteprofile", "r_emailaddress")) // replace with desired scope
                 .callback("http://example.com/callback")
                 .build(LinkedInApi20.instance());
         final Scanner in = new Scanner(System.in);
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/builder/ScopeBuilder.java b/scribejava-core/src/main/java/com/github/scribejava/core/builder/ScopeBuilder.java
@@ -0,0 +1,56 @@
+package com.github.scribejava.core.builder;
+
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * OAuth2.0 Scope Builder. It allows specifying multiple scopes one by one. It will combine them in the single
+ * space-delimited string. OAuth 2.0 standard specifies space as a delimiter for scopes
+ * (https://tools.ietf.org/html/rfc6749#section-3.3). If you found API, that do not support spaces, but support
+ * something else, let ScribeJava know (submit the issue here https://github.com/scribejava/scribejava/issues) and use
+ * your own concatenated string as a temporary workaround.
+ */
+public class ScopeBuilder {
+
+    private final Set<String> scopes = new HashSet<>();
+
+    public ScopeBuilder() {
+    }
+
+    public ScopeBuilder(String scope) {
+        withScope(scope);
+    }
+
+    public ScopeBuilder(String... scopes) {
+        withScopes(scopes);
+    }
+
+    public ScopeBuilder(Collection<String> scopes) {
+        withScopes(scopes);
+    }
+
+    public final ScopeBuilder withScope(String scope) {
+        scopes.add(scope);
+        return this;
+    }
+
+    public final ScopeBuilder withScopes(String... scopes) {
+        this.scopes.addAll(Arrays.asList(scopes));
+        return this;
+    }
+
+    public final ScopeBuilder withScopes(Collection<String> scopes) {
+        this.scopes.addAll(scopes);
+        return this;
+    }
+
+    public String build() {
+        final StringBuilder scopeBuilder = new StringBuilder();
+        for (String scope : scopes) {
+            scopeBuilder.append(' ').append(scope);
+        }
+        return scopeBuilder.substring(1);
+    }
+}
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/builder/ServiceBuilder.java b/scribejava-core/src/main/java/com/github/scribejava/core/builder/ServiceBuilder.java
@@ -68,6 +68,11 @@ public ServiceBuilderOAuth20 defaultScope(String defaultScope) {
         return setScope(defaultScope);
     }
 
+    @Override
+    public ServiceBuilderOAuth20 defaultScope(ScopeBuilder scopeBuilder) {
+        return setScope(scopeBuilder.build());
+    }
+
     @Override
     public ServiceBuilderOAuth10a withScope(String scope) {
         return setScope(scope);
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/builder/ServiceBuilderOAuth20.java b/scribejava-core/src/main/java/com/github/scribejava/core/builder/ServiceBuilderOAuth20.java
@@ -51,5 +51,7 @@ public interface ServiceBuilderOAuth20 extends ServiceBuilderCommon {
      */
     ServiceBuilderOAuth20 defaultScope(String defaultScope);
 
+    ServiceBuilderOAuth20 defaultScope(ScopeBuilder scopeBuilder);
+
     OAuth20Service build(DefaultApi20 api);
 }
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/oauth/AccessTokenRequestParams.java b/scribejava-core/src/main/java/com/github/scribejava/core/oauth/AccessTokenRequestParams.java
@@ -1,6 +1,9 @@
 package com.github.scribejava.core.oauth;
 
+import com.github.scribejava.core.builder.ScopeBuilder;
+
 public class AccessTokenRequestParams {
+
     private final String code;
     private String pkceCodeVerifier;
     private String scope;
@@ -23,6 +26,11 @@ public AccessTokenRequestParams scope(String scope) {
         return this;
     }
 
+    public AccessTokenRequestParams scope(ScopeBuilder scope) {
+        this.scope = scope.build();
+        return this;
+    }
+
     public String getCode() {
         return code;
     }
diff --git a/scribejava-httpclient-ahc/pom.xml b/scribejava-httpclient-ahc/pom.xml
@@ -23,7 +23,7 @@
         <dependency>
             <groupId>org.asynchttpclient</groupId>
             <artifactId>async-http-client</artifactId>
-            <version>2.12.1</version>
+            <version>2.12.2</version>
         </dependency>
         <dependency>
             <groupId>com.github.scribejava</groupId>

Original file line number	Diff line number	Diff line change
`@@ -51,5 +51,7 @@ public interface ServiceBuilderOAuth20 extends ServiceBuilderCommon {`
`51`	`51`	`*/`
`52`	`52`	`ServiceBuilderOAuth20 defaultScope(String defaultScope);`
`53`	`53`
	`54`	`+ ServiceBuilderOAuth20 defaultScope(ScopeBuilder scopeBuilder);`
	`55`	`+`
`54`	`56`	`OAuth20Service build(DefaultApi20 api);`
`55`	`57`	`}`