add OAuth2Service signRequest method accepting just String, not OAuth2 Access Token Object. Remove signRequest from abstract OAuthService. 2.0 and 1.0a will be a bit more different now.

kullfar · kullfar · commit 8d18844ca6a5 · 2017-11-14T19:49:10.000+03:00
diff --git a/changelog b/changelog
@@ -7,6 +7,8 @@
    (2.3.  Client Authentication) https://tools.ietf.org/html/rfc6749#section-2.3 Can be overrided in API class
  * add support for client_credentials grant type (thanks to https://github.com/vivin)
  * add support for RFC 7009 OAuth 2.0 Token Revocation (thanks to https://github.com/vivin)
+ * add OAuth2Service signRequest method accepting just String, not OAuth2 Access Token Object.
+   Remove signRequest from abstract OAuthService. 2.0 and 1.0a will be a bit more different now.
 
 [4.2.0]
  * DELETE in JdkClient permits, but not requires payload (thanks to https://github.com/miguelD73)
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/service/ImgurOAuthServiceImpl.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/service/ImgurOAuthServiceImpl.java
@@ -2,7 +2,6 @@
 
 import com.github.scribejava.apis.ImgurApi;
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.model.OAuth2AccessToken;
 import com.github.scribejava.core.model.OAuthConfig;
 import com.github.scribejava.core.model.OAuthConstants;
 import com.github.scribejava.core.model.OAuthRequest;
@@ -33,9 +32,8 @@ protected OAuthRequest createAccessTokenRequest(String oauthVerifier) {
     }
 
     @Override
-    public void signRequest(OAuth2AccessToken accessToken, OAuthRequest request) {
+    public void signRequest(String accessToken, OAuthRequest request) {
         request.addHeader("Authorization",
-                accessToken == null
-                        ? "Client-ID " + getConfig().getApiKey() : "Bearer " + accessToken.getAccessToken());
+                accessToken == null ? "Client-ID " + getConfig().getApiKey() : "Bearer " + accessToken);
     }
 }
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/service/MailruOAuthServiceImpl.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/service/MailruOAuthServiceImpl.java
@@ -7,7 +7,6 @@
 import org.apache.commons.codec.CharEncoding;
 import static org.apache.commons.codec.digest.DigestUtils.md5Hex;
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.model.OAuth2AccessToken;
 import com.github.scribejava.core.model.OAuthConfig;
 import com.github.scribejava.core.model.OAuthRequest;
 import com.github.scribejava.core.oauth.OAuth20Service;
@@ -20,9 +19,9 @@ public MailruOAuthServiceImpl(DefaultApi20 api, OAuthConfig config) {
     }
 
     @Override
-    public void signRequest(OAuth2AccessToken accessToken, OAuthRequest request) {
+    public void signRequest(String accessToken, OAuthRequest request) {
         // sig = md5(params + secret_key)
-        request.addQuerystringParameter("session_key", accessToken.getAccessToken());
+        request.addQuerystringParameter("session_key", accessToken);
         request.addQuerystringParameter("app_id", getConfig().getApiKey());
         final String completeUrl = request.getCompleteUrl();
 
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/service/OdnoklassnikiServiceImpl.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/service/OdnoklassnikiServiceImpl.java
@@ -1,7 +1,6 @@
 package com.github.scribejava.apis.service;
 
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.model.OAuth2AccessToken;
 import com.github.scribejava.core.model.OAuthConfig;
 import com.github.scribejava.core.model.OAuthRequest;
 import com.github.scribejava.core.model.Parameter;
@@ -25,10 +24,10 @@ public OdnoklassnikiServiceImpl(DefaultApi20 api, OAuthConfig config) {
     }
 
     @Override
-    public void signRequest(OAuth2AccessToken accessToken, OAuthRequest request) {
+    public void signRequest(String accessToken, OAuthRequest request) {
         //sig = lower(md5( sorted_request_params_composed_string + md5(access_token + application_secret_key)))
         try {
-            final String tokenDigest = md5Hex(accessToken.getAccessToken() + getConfig().getApiSecret());
+            final String tokenDigest = md5Hex(accessToken + getConfig().getApiSecret());
 
             final ParameterList queryParams = request.getQueryStringParams();
             queryParams.addAll(request.getBodyParams());
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/service/TutByOAuthServiceImpl.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/service/TutByOAuthServiceImpl.java
@@ -1,7 +1,6 @@
 package com.github.scribejava.apis.service;
 
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.model.OAuth2AccessToken;
 import com.github.scribejava.core.model.OAuthConfig;
 import com.github.scribejava.core.model.OAuthConstants;
 import com.github.scribejava.core.model.OAuthRequest;
@@ -14,7 +13,7 @@ public TutByOAuthServiceImpl(DefaultApi20 api, OAuthConfig config) {
     }
 
     @Override
-    public void signRequest(OAuth2AccessToken accessToken, OAuthRequest request) {
-        request.addQuerystringParameter(OAuthConstants.TOKEN, accessToken.getAccessToken());
+    public void signRequest(String accessToken, OAuthRequest request) {
+        request.addQuerystringParameter(OAuthConstants.TOKEN, accessToken);
     }
 }
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
@@ -137,7 +137,7 @@ public ServiceBuilder debug() {
      * @param api will build Service for this API
      * @return fully configured {@link S}
      */
-    public <S extends OAuthService<?>> S build(BaseApi<S> api) {
+    public <S extends OAuthService> S build(BaseApi<S> api) {
         return api.createService(new OAuthConfig(apiKey, apiSecret, callback, scope, debugStream, state, responseType,
                 userAgent, httpClientConfig, httpClient));
     }
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/builder/api/BaseApi.java b/scribejava-core/src/main/java/com/github/scribejava/core/builder/api/BaseApi.java
@@ -3,7 +3,7 @@
 import com.github.scribejava.core.model.OAuthConfig;
 import com.github.scribejava.core.oauth.OAuthService;
 
-public interface BaseApi<T extends OAuthService<?>> {
+public interface BaseApi<T extends OAuthService> {
 
     T createService(OAuthConfig config);
 }
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/builder/api/OAuth2SignatureType.java b/scribejava-core/src/main/java/com/github/scribejava/core/builder/api/OAuth2SignatureType.java
@@ -10,8 +10,8 @@ public enum OAuth2SignatureType {
      */
     BEARER_AUTHORIZATION_REQUEST_HEADER_FIELD {
         @Override
-        public void signRequest(OAuth2AccessToken accessToken, OAuthRequest request) {
-            request.addHeader("Authorization", "Bearer " + accessToken.getAccessToken());
+        public void signRequest(String accessToken, OAuthRequest request) {
+            request.addHeader("Authorization", "Bearer " + accessToken);
         }
 
     },
@@ -20,11 +20,22 @@ public void signRequest(OAuth2AccessToken accessToken, OAuthRequest request) {
      */
     BEARER_URI_QUERY_PARAMETER {
         @Override
-        public void signRequest(OAuth2AccessToken accessToken, OAuthRequest request) {
-            request.addQuerystringParameter(OAuthConstants.ACCESS_TOKEN, accessToken.getAccessToken());
+        public void signRequest(String accessToken, OAuthRequest request) {
+            request.addQuerystringParameter(OAuthConstants.ACCESS_TOKEN, accessToken);
         }
 
     };
 
-    public abstract void signRequest(OAuth2AccessToken accessToken, OAuthRequest request);
+    /**
+     *
+     * @param accessToken accessToken
+     * @param request request
+     * @deprecated use {@link #signRequest(java.lang.String, com.github.scribejava.core.model.OAuthRequest)}
+     */
+    @Deprecated
+    public void signRequest(OAuth2AccessToken accessToken, OAuthRequest request) {
+        signRequest(accessToken == null ? null : accessToken.getAccessToken(), request);
+    }
+
+    public abstract void signRequest(String accessToken, OAuthRequest request);
 }
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/oauth/OAuth10aService.java b/scribejava-core/src/main/java/com/github/scribejava/core/oauth/OAuth10aService.java
@@ -16,7 +16,7 @@
 /**
  * OAuth 1.0a implementation of {@link OAuthService}
  */
-public class OAuth10aService extends OAuthService<OAuth1AccessToken> {
+public class OAuth10aService extends OAuthService {
 
     private static final String VERSION = "1.0";
     private final DefaultApi10a api;
@@ -124,7 +124,6 @@ protected OAuthRequest prepareAccessTokenRequest(OAuth1RequestToken requestToken
         return request;
     }
 
-    @Override
     public void signRequest(OAuth1AccessToken token, OAuthRequest request) {
         final OAuthConfig config = getConfig();
         config.log("signing request: " + request.getCompleteUrl());
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/oauth/OAuth20Service.java b/scribejava-core/src/main/java/com/github/scribejava/core/oauth/OAuth20Service.java
@@ -20,7 +20,7 @@
 import java.util.concurrent.ExecutionException;
 import revoke.TokenTypeHint;
 
-public class OAuth20Service extends OAuthService<OAuth2AccessToken> {
+public class OAuth20Service extends OAuthService {
 
     private static final String VERSION = "2.0";
     private static final PKCEService PKCE_SERVICE = new PKCEService();
@@ -243,11 +243,14 @@ public String getVersion() {
         return VERSION;
     }
 
-    @Override
-    public void signRequest(OAuth2AccessToken accessToken, OAuthRequest request) {
+    public void signRequest(String accessToken, OAuthRequest request) {
         api.getSignatureType().signRequest(accessToken, request);
     }
 
+    public final void signRequest(OAuth2AccessToken accessToken, OAuthRequest request) {
+        signRequest(accessToken == null ? null : accessToken.getAccessToken(), request);
+    }
+
     public final AuthorizationUrlWithPKCE getAuthorizationUrlWithPKCE() {
         return getAuthorizationUrlWithPKCE(null);
     }
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/oauth/OAuthService.java b/scribejava-core/src/main/java/com/github/scribejava/core/oauth/OAuthService.java
@@ -9,21 +9,14 @@
 import com.github.scribejava.core.model.OAuthConfig;
 import com.github.scribejava.core.model.OAuthRequest;
 import com.github.scribejava.core.model.Response;
-import com.github.scribejava.core.model.Token;
 import java.io.File;
 
 import java.io.IOException;
 import java.util.ServiceLoader;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Future;
 
-/**
- * The main ScribeJava object.
- *
- * A facade responsible for the retrieval of request and access tokens and for the signing of HTTP requests.
- * @param <T> type of token used to sign the request
- */
-public abstract class OAuthService<T extends Token> implements AutoCloseable {
+public abstract class OAuthService implements AutoCloseable {
 
     private final OAuthConfig config;
     private final HttpClient httpClient;
@@ -66,8 +59,6 @@ public OAuthConfig getConfig() {
      */
     public abstract String getVersion();
 
-    public abstract void signRequest(T token, OAuthRequest request);
-
     public Future<Response> executeAsync(OAuthRequest request) {
         return execute(request, null);
     }
diff --git a/scribejava-httpclient-okhttp/src/test/java/com/github/scribejava/httpclient/okhttp/OkHttpHttpClientTest.java b/scribejava-httpclient-okhttp/src/test/java/com/github/scribejava/httpclient/okhttp/OkHttpHttpClientTest.java
@@ -21,7 +21,7 @@
 import static org.junit.Assert.assertEquals;
 
 public class OkHttpHttpClientTest {
-    private OAuthService<?> oAuthService;
+    private OAuthService oAuthService;
 
     @Before
     public void setUp() {

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@`
`2`	`2`
`3`	`3`	`import com.github.scribejava.apis.ImgurApi;`
`4`	`4`	`import com.github.scribejava.core.builder.api.DefaultApi20;`
`5`		`-import com.github.scribejava.core.model.OAuth2AccessToken;`
`6`	`5`	`import com.github.scribejava.core.model.OAuthConfig;`
`7`	`6`	`import com.github.scribejava.core.model.OAuthConstants;`
`8`	`7`	`import com.github.scribejava.core.model.OAuthRequest;`
`@@ -33,9 +32,8 @@ protected OAuthRequest createAccessTokenRequest(String oauthVerifier) {`
`33`	`32`	`}`
`34`	`33`
`35`	`34`	`@Override`
`36`		`- public void signRequest(OAuth2AccessToken accessToken, OAuthRequest request) {`
	`35`	`+ public void signRequest(String accessToken, OAuthRequest request) {`
`37`	`36`	`request.addHeader("Authorization",`
`38`		`- accessToken == null`
`39`		`- ? "Client-ID " + getConfig().getApiKey() : "Bearer " + accessToken.getAccessToken());`
	`37`	`+ accessToken == null ? "Client-ID " + getConfig().getApiKey() : "Bearer " + accessToken);`
`40`	`38`	`}`
`41`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`package com.github.scribejava.apis.service;`
`2`	`2`
`3`	`3`	`import com.github.scribejava.core.builder.api.DefaultApi20;`
`4`		`-import com.github.scribejava.core.model.OAuth2AccessToken;`
`5`	`4`	`import com.github.scribejava.core.model.OAuthConfig;`
`6`	`5`	`import com.github.scribejava.core.model.OAuthConstants;`
`7`	`6`	`import com.github.scribejava.core.model.OAuthRequest;`
`@@ -14,7 +13,7 @@ public TutByOAuthServiceImpl(DefaultApi20 api, OAuthConfig config) {`
`14`	`13`	`}`
`15`	`14`
`16`	`15`	`@Override`
`17`		`- public void signRequest(OAuth2AccessToken accessToken, OAuthRequest request) {`
`18`		`- request.addQuerystringParameter(OAuthConstants.TOKEN, accessToken.getAccessToken());`
	`16`	`+ public void signRequest(String accessToken, OAuthRequest request) {`
	`17`	`+ request.addQuerystringParameter(OAuthConstants.TOKEN, accessToken);`
`19`	`18`	`}`
`20`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -137,7 +137,7 @@ public ServiceBuilder debug() {`
`137`	`137`	`* @param api will build Service for this API`
`138`	`138`	`* @return fully configured {@link S}`
`139`	`139`	`*/`
`140`		`- public <S extends OAuthService<?>> S build(BaseApi<S> api) {`
	`140`	`+ public <S extends OAuthService> S build(BaseApi<S> api) {`
`141`	`141`	`return api.createService(new OAuthConfig(apiKey, apiSecret, callback, scope, debugStream, state, responseType,`
`142`	`142`	`userAgent, httpClientConfig, httpClient));`
`143`	`143`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`import com.github.scribejava.core.model.OAuthConfig;`
`4`	`4`	`import com.github.scribejava.core.oauth.OAuthService;`
`5`	`5`
`6`		`-public interface BaseApi<T extends OAuthService<?>> {`
	`6`	`+public interface BaseApi<T extends OAuthService> {`
`7`	`7`
`8`	`8`	`T createService(OAuthConfig config);`
`9`	`9`	`}`