move OAuth1 SignatureType to ServiceBuilder to API

kullfar · kullfar · commit 4cd58302f9e2 · 2017-04-04T16:09:11.000+03:00
diff --git a/changelog b/changelog
@@ -1,4 +1,5 @@
 [SNAPSHOT]
+ * move OAuth1 SignatureType to ServiceBuilder to API
  * add body for PATCH HTTP method
 
 [4.0.0]
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/BoxApi20.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/BoxApi20.java
@@ -1,7 +1,7 @@
 package com.github.scribejava.apis;
 
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.builder.api.SignatureType;
+import com.github.scribejava.core.builder.api.OAuth2SignatureType;
 
 /**
  * Box.com Api
@@ -31,7 +31,7 @@ protected String getAuthorizationBaseUrl() {
     }
 
     @Override
-    public SignatureType getSignatureType() {
-        return SignatureType.BEARER_URI_QUERY_PARAMETER;
+    public OAuth2SignatureType getSignatureType() {
+        return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;
     }
 }
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/Foursquare2Api.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/Foursquare2Api.java
@@ -1,7 +1,7 @@
 package com.github.scribejava.apis;
 
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.builder.api.SignatureType;
+import com.github.scribejava.core.builder.api.OAuth2SignatureType;
 import com.github.scribejava.core.model.Verb;
 
 public class Foursquare2Api extends DefaultApi20 {
@@ -33,7 +33,7 @@ protected String getAuthorizationBaseUrl() {
     }
 
     @Override
-    public SignatureType getSignatureType() {
-        return SignatureType.BEARER_URI_QUERY_PARAMETER;
+    public OAuth2SignatureType getSignatureType() {
+        return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;
     }
 }
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/FreelancerApi.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/FreelancerApi.java
@@ -1,6 +1,7 @@
 package com.github.scribejava.apis;
 
 import com.github.scribejava.core.builder.api.DefaultApi10a;
+import com.github.scribejava.core.builder.api.OAuth1SignatureType;
 import com.github.scribejava.core.model.OAuth1RequestToken;
 import com.github.scribejava.core.model.Verb;
 
@@ -19,6 +20,11 @@ public static FreelancerApi instance() {
         return InstanceHolder.INSTANCE;
     }
 
+    @Override
+    public OAuth1SignatureType getSignatureType() {
+        return OAuth1SignatureType.QueryString;
+    }
+
     @Override
     public String getAccessTokenEndpoint() {
         return "http://api.freelancer.com/RequestAccessToken/requestAccessToken.xml?";
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/KaixinApi20.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/KaixinApi20.java
@@ -1,7 +1,7 @@
 package com.github.scribejava.apis;
 
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.builder.api.SignatureType;
+import com.github.scribejava.core.builder.api.OAuth2SignatureType;
 import com.github.scribejava.core.model.Verb;
 
 /**
@@ -36,7 +36,7 @@ protected String getAuthorizationBaseUrl() {
     }
 
     @Override
-    public SignatureType getSignatureType() {
-        return SignatureType.BEARER_URI_QUERY_PARAMETER;
+    public OAuth2SignatureType getSignatureType() {
+        return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;
     }
 }
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/LinkedInApi20.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/LinkedInApi20.java
@@ -2,7 +2,7 @@
 
 import com.github.scribejava.apis.service.LinkedIn20ServiceImpl;
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.builder.api.SignatureType;
+import com.github.scribejava.core.builder.api.OAuth2SignatureType;
 import com.github.scribejava.core.model.OAuthConfig;
 import com.github.scribejava.core.oauth.OAuth20Service;
 
@@ -35,7 +35,7 @@ public OAuth20Service createService(OAuthConfig config) {
     }
 
     @Override
-    public SignatureType getSignatureType() {
-        return SignatureType.BEARER_URI_QUERY_PARAMETER;
+    public OAuth2SignatureType getSignatureType() {
+        return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;
     }
 }
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/LiveApi.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/LiveApi.java
@@ -1,7 +1,7 @@
 package com.github.scribejava.apis;
 
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.builder.api.SignatureType;
+import com.github.scribejava.core.builder.api.OAuth2SignatureType;
 import com.github.scribejava.core.model.Verb;
 
 public class LiveApi extends DefaultApi20 {
@@ -33,7 +33,7 @@ protected String getAuthorizationBaseUrl() {
     }
 
     @Override
-    public SignatureType getSignatureType() {
-        return SignatureType.BEARER_URI_QUERY_PARAMETER;
+    public OAuth2SignatureType getSignatureType() {
+        return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;
     }
 }
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/MisfitApi.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/MisfitApi.java
@@ -1,7 +1,7 @@
 package com.github.scribejava.apis;
 
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.builder.api.SignatureType;
+import com.github.scribejava.core.builder.api.OAuth2SignatureType;
 
 public class MisfitApi extends DefaultApi20 {
 
@@ -28,7 +28,7 @@ protected String getAuthorizationBaseUrl() {
     }
 
     @Override
-    public SignatureType getSignatureType() {
-        return SignatureType.BEARER_URI_QUERY_PARAMETER;
+    public OAuth2SignatureType getSignatureType() {
+        return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;
     }
 }
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/NaverApi.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/NaverApi.java
@@ -1,7 +1,7 @@
 package com.github.scribejava.apis;
 
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.builder.api.SignatureType;
+import com.github.scribejava.core.builder.api.OAuth2SignatureType;
 
 public class NaverApi extends DefaultApi20 {
     protected NaverApi() {
@@ -29,7 +29,7 @@ protected String getAuthorizationBaseUrl() {
     }
 
     @Override
-    public SignatureType getSignatureType() {
-        return SignatureType.BEARER_URI_QUERY_PARAMETER;
+    public OAuth2SignatureType getSignatureType() {
+        return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;
     }
 }
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/OdnoklassnikiApi.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/OdnoklassnikiApi.java
@@ -2,7 +2,7 @@
 
 import com.github.scribejava.apis.service.OdnoklassnikiServiceImpl;
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.builder.api.SignatureType;
+import com.github.scribejava.core.builder.api.OAuth2SignatureType;
 import com.github.scribejava.core.model.OAuthConfig;
 import com.github.scribejava.core.oauth.OAuth20Service;
 
@@ -35,7 +35,7 @@ public OAuth20Service createService(OAuthConfig config) {
     }
 
     @Override
-    public SignatureType getSignatureType() {
-        return SignatureType.BEARER_URI_QUERY_PARAMETER;
+    public OAuth2SignatureType getSignatureType() {
+        return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;
     }
 }
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/PinterestApi.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/PinterestApi.java
@@ -1,7 +1,7 @@
 package com.github.scribejava.apis;
 
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.builder.api.SignatureType;
+import com.github.scribejava.core.builder.api.OAuth2SignatureType;
 
 public class PinterestApi extends DefaultApi20 {
 
@@ -27,7 +27,7 @@ protected String getAuthorizationBaseUrl() {
     }
 
     @Override
-    public SignatureType getSignatureType() {
-        return SignatureType.BEARER_URI_QUERY_PARAMETER;
+    public OAuth2SignatureType getSignatureType() {
+        return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;
     }
 }
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/RenrenApi.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/RenrenApi.java
@@ -1,7 +1,7 @@
 package com.github.scribejava.apis;
 
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.builder.api.SignatureType;
+import com.github.scribejava.core.builder.api.OAuth2SignatureType;
 import com.github.scribejava.core.model.Verb;
 
 /**
@@ -36,7 +36,7 @@ protected String getAuthorizationBaseUrl() {
     }
 
     @Override
-    public SignatureType getSignatureType() {
-        return SignatureType.BEARER_URI_QUERY_PARAMETER;
+    public OAuth2SignatureType getSignatureType() {
+        return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;
     }
 }
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/SinaWeiboApi20.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/SinaWeiboApi20.java
@@ -1,7 +1,7 @@
 package com.github.scribejava.apis;
 
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.builder.api.SignatureType;
+import com.github.scribejava.core.builder.api.OAuth2SignatureType;
 
 /**
  * SinaWeibo OAuth 2.0 api.
@@ -30,7 +30,7 @@ protected String getAuthorizationBaseUrl() {
     }
 
     @Override
-    public SignatureType getSignatureType() {
-        return SignatureType.BEARER_URI_QUERY_PARAMETER;
+    public OAuth2SignatureType getSignatureType() {
+        return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;
     }
 }
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/StackExchangeApi.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/StackExchangeApi.java
@@ -1,7 +1,7 @@
 package com.github.scribejava.apis;
 
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.builder.api.SignatureType;
+import com.github.scribejava.core.builder.api.OAuth2SignatureType;
 import com.github.scribejava.core.extractors.OAuth2AccessTokenExtractor;
 import com.github.scribejava.core.extractors.TokenExtractor;
 import com.github.scribejava.core.model.OAuth2AccessToken;
@@ -39,7 +39,7 @@ public TokenExtractor<OAuth2AccessToken> getAccessTokenExtractor() {
     }
 
     @Override
-    public SignatureType getSignatureType() {
-        return SignatureType.BEARER_URI_QUERY_PARAMETER;
+    public OAuth2SignatureType getSignatureType() {
+        return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;
     }
 }
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/ViadeoApi.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/ViadeoApi.java
@@ -1,7 +1,7 @@
 package com.github.scribejava.apis;
 
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.builder.api.SignatureType;
+import com.github.scribejava.core.builder.api.OAuth2SignatureType;
 import com.github.scribejava.core.model.Verb;
 
 public class ViadeoApi extends DefaultApi20 {
@@ -33,7 +33,7 @@ protected String getAuthorizationBaseUrl() {
     }
 
     @Override
-    public SignatureType getSignatureType() {
-        return SignatureType.BEARER_URI_QUERY_PARAMETER;
+    public OAuth2SignatureType getSignatureType() {
+        return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;
     }
 }
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/VkontakteApi.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/VkontakteApi.java
@@ -1,7 +1,7 @@
 package com.github.scribejava.apis;
 
 import com.github.scribejava.core.builder.api.DefaultApi20;
-import com.github.scribejava.core.builder.api.SignatureType;
+import com.github.scribejava.core.builder.api.OAuth2SignatureType;
 import com.github.scribejava.core.model.Verb;
 
 public class VkontakteApi extends DefaultApi20 {
@@ -33,7 +33,7 @@ protected String getAuthorizationBaseUrl() {
     }
 
     @Override
-    public SignatureType getSignatureType() {
-        return SignatureType.BEARER_URI_QUERY_PARAMETER;
+    public OAuth2SignatureType getSignatureType() {
+        return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;
     }
 }
diff --git a/scribejava-apis/src/test/java/com/github/scribejava/apis/examples/FreelancerExample.java b/scribejava-apis/src/test/java/com/github/scribejava/apis/examples/FreelancerExample.java
@@ -7,7 +7,6 @@
 import com.github.scribejava.core.model.OAuth1RequestToken;
 import com.github.scribejava.core.model.OAuthRequest;
 import com.github.scribejava.core.model.Response;
-import com.github.scribejava.core.model.SignatureType;
 import com.github.scribejava.core.model.Verb;
 import com.github.scribejava.core.oauth.OAuth10aService;
 import java.io.IOException;
@@ -26,7 +25,6 @@ private FreelancerExample() {
 
     public static void main(String... args) throws IOException, InterruptedException, ExecutionException {
         final OAuth10aService service = new ServiceBuilder()
-                .signatureType(SignatureType.QueryString)
                 .apiKey("your client id")
                 .apiSecret("your client secret")
                 .scope(SCOPE)
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
@@ -5,7 +5,7 @@
 import com.github.scribejava.core.httpclient.HttpClientConfig;
 import com.github.scribejava.core.model.OAuthConfig;
 import com.github.scribejava.core.model.OAuthConstants;
-import com.github.scribejava.core.model.SignatureType;
+import com.github.scribejava.core.builder.api.OAuth1SignatureType;
 import com.github.scribejava.core.oauth.OAuthService;
 import com.github.scribejava.core.utils.Preconditions;
 
@@ -21,7 +21,12 @@ public class ServiceBuilder {
     private String apiSecret;
     private String scope;
     private String state;
-    private SignatureType signatureType;
+    /**
+     * @deprecated override or change in Pull Request
+     * {@link com.github.scribejava.core.builder.api.DefaultApi10a#getSignatureType()}
+     */
+    @Deprecated
+    private OAuth1SignatureType signatureType;
     private OutputStream debugStream;
     private String responseType = "code";
     private String userAgent;
@@ -31,7 +36,6 @@ public class ServiceBuilder {
 
     public ServiceBuilder() {
         callback = OAuthConstants.OUT_OF_BAND;
-        signatureType = SignatureType.Header;
     }
 
     /**
@@ -95,13 +99,18 @@ public ServiceBuilder state(String state) {
     }
 
     /**
-     * Configures the signature type, choose between header, querystring, etc. Defaults to Header
+     * Configures the signature type, choose between header, querystring, etc. Defaults to null.<br>
+     * 'null' means to use default for API
+     * {@link com.github.scribejava.core.builder.api.DefaultApi10a#getSignatureType()}
      *
-     * @param signatureType SignatureType
+     * @param signatureType OAuth1SignatureType
      * @return the {@link ServiceBuilder} instance for method chaining
+     *
+     * @deprecated override or change in Pull Request
+     * {@link com.github.scribejava.core.builder.api.DefaultApi10a#getSignatureType()}
      */
-    public ServiceBuilder signatureType(SignatureType signatureType) {
-        Preconditions.checkNotNull(signatureType, "Signature type can't be null");
+    @Deprecated
+    public ServiceBuilder signatureType(OAuth1SignatureType signatureType) {
         this.signatureType = signatureType;
         return this;
     }
@@ -149,6 +158,7 @@ public void checkPreconditions() {
         Preconditions.checkEmptyString(apiKey, "You must provide an api key");
     }
 
+    @SuppressWarnings("deprecation")
     private OAuthConfig createConfig() {
         checkPreconditions();
         return new OAuthConfig(apiKey, apiSecret, callback, signatureType, scope, debugStream, state, responseType,
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/builder/api/DefaultApi10a.java b/scribejava-core/src/main/java/com/github/scribejava/core/builder/api/DefaultApi10a.java
@@ -77,6 +77,13 @@ public SignatureService getSignatureService() {
         return new HMACSha1SignatureService();
     }
 
+    /**
+     * @return the signature type, choose between header, querystring, etc. Defaults to Header
+     */
+    public OAuth1SignatureType getSignatureType() {
+        return OAuth1SignatureType.Header;
+    }
+
     /**
      * Returns the timestamp service.
      *
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/builder/api/DefaultApi20.java b/scribejava-core/src/main/java/com/github/scribejava/core/builder/api/DefaultApi20.java
@@ -91,7 +91,7 @@ public OAuth20Service createService(OAuthConfig config) {
         return new OAuth20Service(this, config);
     }
 
-    public SignatureType getSignatureType() {
-        return SignatureType.BEARER_AUTHORIZATION_REQUEST_HEADER_FIELD;
+    public OAuth2SignatureType getSignatureType() {
+        return OAuth2SignatureType.BEARER_AUTHORIZATION_REQUEST_HEADER_FIELD;
     }
 }
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/builder/api/OAuth1SignatureType.java b/scribejava-core/src/main/java/com/github/scribejava/core/builder/api/OAuth1SignatureType.java
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
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/builder/api/SignatureType.java b/scribejava-core/src/main/java/com/github/scribejava/core/builder/api/SignatureType.java
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/model/OAuthConfig.java b/scribejava-core/src/main/java/com/github/scribejava/core/model/OAuthConfig.java
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/model/SignatureType.java b/scribejava-core/src/main/java/com/github/scribejava/core/model/SignatureType.java
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
diff --git a/scribejava-core/src/test/java/com/github/scribejava/core/builder/ServiceBuilderTest.java b/scribejava-core/src/test/java/com/github/scribejava/core/builder/ServiceBuilderTest.java
diff --git a/scribejava-core/src/test/java/com/github/scribejava/core/oauth/OAuth20ApiUnit.java b/scribejava-core/src/test/java/com/github/scribejava/core/oauth/OAuth20ApiUnit.java
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

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`[SNAPSHOT]`
	`2`	`+ * move OAuth1 SignatureType to ServiceBuilder to API`
`2`	`3`	`* add body for PATCH HTTP method`
`3`	`4`
`4`	`5`	`[4.0.0]`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`package com.github.scribejava.apis;`
`2`	`2`
`3`	`3`	`import com.github.scribejava.core.builder.api.DefaultApi20;`
`4`		`-import com.github.scribejava.core.builder.api.SignatureType;`
	`4`	`+import com.github.scribejava.core.builder.api.OAuth2SignatureType;`
`5`	`5`
`6`	`6`	`/**`
`7`	`7`	`* Box.com Api`
`@@ -31,7 +31,7 @@ protected String getAuthorizationBaseUrl() {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`@Override`
`34`		`- public SignatureType getSignatureType() {`
`35`		`- return SignatureType.BEARER_URI_QUERY_PARAMETER;`
	`34`	`+ public OAuth2SignatureType getSignatureType() {`
	`35`	`+ return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;`
`36`	`36`	`}`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`import com.github.scribejava.apis.service.LinkedIn20ServiceImpl;`
`4`	`4`	`import com.github.scribejava.core.builder.api.DefaultApi20;`
`5`		`-import com.github.scribejava.core.builder.api.SignatureType;`
	`5`	`+import com.github.scribejava.core.builder.api.OAuth2SignatureType;`
`6`	`6`	`import com.github.scribejava.core.model.OAuthConfig;`
`7`	`7`	`import com.github.scribejava.core.oauth.OAuth20Service;`
`8`	`8`
`@@ -35,7 +35,7 @@ public OAuth20Service createService(OAuthConfig config) {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`@Override`
`38`		`- public SignatureType getSignatureType() {`
`39`		`- return SignatureType.BEARER_URI_QUERY_PARAMETER;`
	`38`	`+ public OAuth2SignatureType getSignatureType() {`
	`39`	`+ return OAuth2SignatureType.BEARER_URI_QUERY_PARAMETER;`
`40`	`40`	`}`
`41`	`41`	`}`