add possibility to set "" (empty string) as apiSecret

kullfar · kullfar · commit 8f4891554e5e · 2020-12-03T12:19:44.000+03:00
diff --git a/changelog b/changelog
@@ -1,5 +1,6 @@
 [SNAPSHOT]
  * add raw Response (with HTTP repsponse code and body) as member to the OAuth2AccessTokenErrorResponse
+ * add possibility to set "" (empty string) as apiSecret
 
 [8.0.0]
  * add Kakao API (https://kakao.com/) (thanks to https://github.com/v0o0v)
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
@@ -51,6 +51,12 @@ public ServiceBuilder apiSecret(String apiSecret) {
         return this;
     }
 
+    @Override
+    public ServiceBuilder apiSecretIsEmptyStringUnsafe() {
+        apiSecret = "";
+        return this;
+    }
+
     private ServiceBuilder setScope(String scope) {
         Preconditions.checkEmptyString(scope, "Invalid OAuth scope");
         this.scope = scope;
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/builder/ServiceBuilderCommon.java b/scribejava-core/src/main/java/com/github/scribejava/core/builder/ServiceBuilderCommon.java
@@ -35,6 +35,16 @@ public interface ServiceBuilderCommon {
      */
     ServiceBuilderCommon apiSecret(String apiSecret);
 
+    /**
+     * Configures the api secret as "" (empty string).
+     *
+     * Used usually for a test environments or another strange cases. Not all providers support empty string as api key
+     * and will throw an Exception in such cases.
+     *
+     * @return the {@link ServiceBuilder} instance for method chaining
+     */
+    ServiceBuilderCommon apiSecretIsEmptyStringUnsafe();
+
     ServiceBuilderCommon httpClientConfig(HttpClientConfig httpClientConfig);
 
     /**
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/builder/ServiceBuilderOAuth10a.java b/scribejava-core/src/main/java/com/github/scribejava/core/builder/ServiceBuilderOAuth10a.java
@@ -17,6 +17,9 @@ public interface ServiceBuilderOAuth10a extends ServiceBuilderCommon {
     @Override
     ServiceBuilderOAuth10a apiSecret(String apiSecret);
 
+    @Override
+    ServiceBuilderOAuth10a apiSecretIsEmptyStringUnsafe();
+
     @Override
     ServiceBuilderOAuth10a httpClientConfig(HttpClientConfig httpClientConfig);
 
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
@@ -17,6 +17,9 @@ public interface ServiceBuilderOAuth20 extends ServiceBuilderCommon {
     @Override
     ServiceBuilderOAuth20 apiSecret(String apiSecret);
 
+    @Override
+    ServiceBuilderOAuth20 apiSecretIsEmptyStringUnsafe();
+
     @Override
     ServiceBuilderOAuth20 httpClientConfig(HttpClientConfig httpClientConfig);
 
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/services/HMACSha1SignatureService.java b/scribejava-core/src/main/java/com/github/scribejava/core/services/HMACSha1SignatureService.java
@@ -10,8 +10,7 @@
 import com.github.scribejava.core.utils.Preconditions;
 
 /**
- * HMAC-SHA1 implementation of {@link SignatureService}
- * https://tools.ietf.org/html/rfc5849#section-3.4.2
+ * HMAC-SHA1 implementation of {@link SignatureService} https://tools.ietf.org/html/rfc5849#section-3.4.2
  */
 public class HMACSha1SignatureService implements SignatureService {
 
@@ -27,8 +26,8 @@ public class HMACSha1SignatureService implements SignatureService {
     @Override
     public String getSignature(String baseString, String apiSecret, String tokenSecret) {
         try {
-            Preconditions.checkEmptyString(baseString, "Base string cant be null or empty string");
-            Preconditions.checkEmptyString(apiSecret, "Api secret cant be null or empty string");
+            Preconditions.checkEmptyString(baseString, "Base string can't be null or empty string");
+            Preconditions.checkNotNull(apiSecret, "Api secret can't be null");
             return doSign(baseString, OAuthEncoder.encode(apiSecret) + '&' + OAuthEncoder.encode(tokenSecret));
         } catch (UnsupportedEncodingException | NoSuchAlgorithmException | InvalidKeyException | RuntimeException e) {
             throw new OAuthSignatureException(baseString, e);
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/services/PlaintextSignatureService.java b/scribejava-core/src/main/java/com/github/scribejava/core/services/PlaintextSignatureService.java
@@ -17,7 +17,7 @@ public class PlaintextSignatureService implements SignatureService {
     @Override
     public String getSignature(String baseString, String apiSecret, String tokenSecret) {
         try {
-            Preconditions.checkEmptyString(apiSecret, "Api secret cant be null or empty string");
+            Preconditions.checkNotNull(apiSecret, "Api secret can't be null");
             return OAuthEncoder.encode(apiSecret) + '&' + OAuthEncoder.encode(tokenSecret);
         } catch (Exception e) {
             throw new OAuthSignatureException(baseString, e);
diff --git a/scribejava-core/src/test/java/com/github/scribejava/core/services/HMACSha1SignatureServiceTest.java b/scribejava-core/src/test/java/com/github/scribejava/core/services/HMACSha1SignatureServiceTest.java
@@ -44,8 +44,7 @@ public void shouldThrowExceptionIfApiSecretIsNull() {
         service.getSignature("base string", null, "tokenSecret");
     }
 
-    @Test(expected = OAuthException.class)
-    public void shouldThrowExceptionIfApiSecretIsEmpty() {
+    public void shouldNotThrowExceptionIfApiSecretIsEmpty() {
         service.getSignature("base string", "  ", "tokenSecret");
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -44,8 +44,7 @@ public void shouldThrowExceptionIfApiSecretIsNull() {`
`44`	`44`	`service.getSignature("base string", null, "tokenSecret");`
`45`	`45`	`}`
`46`	`46`
`47`		`- @Test(expected = OAuthException.class)`
`48`		`- public void shouldThrowExceptionIfApiSecretIsEmpty() {`
	`47`	`+ public void shouldNotThrowExceptionIfApiSecretIsEmpty() {`
`49`	`48`	`service.getSignature("base string", " ", "tokenSecret");`
`50`	`49`	`}`
`51`	`50`	`}`