introduce PMD/category/java/codestyle.xml/FieldNamingConventions rule

kullfar · kullfar · commit d67a7a69014b · 2019-03-29T18:21:34.000+03:00
diff --git a/pmd.xml b/pmd.xml
@@ -37,4 +37,5 @@
     <rule ref="category/java/codestyle.xml/DontImportJavaLang" />
     <rule ref="category/java/codestyle.xml/DuplicateImports" />
     <rule ref="category/java/codestyle.xml/ExtendsObject" />
+    <rule ref="category/java/codestyle.xml/FieldNamingConventions" />
 </ruleset>
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
@@ -21,7 +21,7 @@ public static FreelancerApi instance() {
 
     @Override
     public OAuth1SignatureType getSignatureType() {
-        return OAuth1SignatureType.QueryString;
+        return OAuth1SignatureType.QUERY_STRING;
     }
 
     @Override
diff --git a/scribejava-apis/src/main/java/com/github/scribejava/apis/fitbit/FitBitJsonTokenExtractor.java b/scribejava-apis/src/main/java/com/github/scribejava/apis/fitbit/FitBitJsonTokenExtractor.java
@@ -39,7 +39,7 @@ public void generateError(String response) {
 
         OAuth2AccessTokenErrorResponse.ErrorCode errorCode;
         try {
-            errorCode = OAuth2AccessTokenErrorResponse.ErrorCode.valueOf(errorInString);
+            errorCode = OAuth2AccessTokenErrorResponse.ErrorCode.parseFrom(errorInString);
         } catch (IllegalArgumentException iaE) {
             //non oauth standard error code
             errorCode = null;
diff --git a/scribejava-apis/src/test/java/com/github/scribejava/apis/fitbit/FitBitJsonTokenExtractorTest.java b/scribejava-apis/src/test/java/com/github/scribejava/apis/fitbit/FitBitJsonTokenExtractorTest.java
@@ -28,7 +28,7 @@ public void testErrorExtraction() {
         final FitBitJsonTokenExtractor extractor = new FitBitJsonTokenExtractor();
 
         thrown.expect(OAuth2AccessTokenErrorResponse.class);
-        thrown.expect(new ErrorCodeFeatureMatcher(ErrorCode.invalid_grant));
+        thrown.expect(new ErrorCodeFeatureMatcher(ErrorCode.INVALID_GRANT));
         thrown.expect(new ErrorDescriptionFeatureMatcher(ERROR_DESCRIPTION));
 
         extractor.generateError(ERROR_JSON);
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
@@ -85,7 +85,7 @@ public SignatureService getSignatureService() {
      * @return the signature type, choose between header, querystring, etc. Defaults to Header
      */
     public OAuth1SignatureType getSignatureType() {
-        return OAuth1SignatureType.Header;
+        return OAuth1SignatureType.HEADER;
     }
 
     /**
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
@@ -2,6 +2,6 @@
 
 public enum OAuth1SignatureType {
 
-    Header,
-    QueryString
+    HEADER,
+    QUERY_STRING
 }
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/extractors/OAuth2AccessTokenJsonExtractor.java b/scribejava-core/src/main/java/com/github/scribejava/core/extractors/OAuth2AccessTokenJsonExtractor.java
@@ -66,7 +66,7 @@ public void generateError(String response) {
 
         OAuth2AccessTokenErrorResponse.ErrorCode errorCode;
         try {
-            errorCode = OAuth2AccessTokenErrorResponse.ErrorCode.valueOf(errorInString);
+            errorCode = OAuth2AccessTokenErrorResponse.ErrorCode.parseFrom(errorInString);
         } catch (IllegalArgumentException iaE) {
             //non oauth standard error code
             errorCode = null;
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/model/OAuth2AccessTokenErrorResponse.java b/scribejava-core/src/main/java/com/github/scribejava/core/model/OAuth2AccessTokenErrorResponse.java
@@ -12,11 +12,31 @@ public class OAuth2AccessTokenErrorResponse extends OAuthException {
     private static final long serialVersionUID = 2309424849700276816L;
 
     public enum ErrorCode {
-        invalid_request, invalid_client, invalid_grant, unauthorized_client, unsupported_grant_type, invalid_scope,
+        INVALID_REQUEST("invalid_request"),
+        INVALID_CLIENT("invalid_client"),
+        INVALID_GRANT("invalid_grant"),
+        UNAUTHORIZED_CLIENT("unauthorized_client"),
+        UNSUPPORTED_GRANT_TYPE("unsupported_grant_type"),
+        INVALID_SCOPE("invalid_scope"),
         /**
          * @see <a href="https://tools.ietf.org/html/rfc7009#section-2.2.1">RFC 7009, 2.2.1. Error Response</a>
          */
-        unsupported_token_type
+        UNSUPPORTED_TOKEN_TYPE("unsupported_token_type");
+
+        private final String errorCodeString;
+
+        ErrorCode(String errorCodeString) {
+            this.errorCodeString = errorCodeString;
+        }
+
+        public static ErrorCode parseFrom(String errorCodeString) {
+            for (ErrorCode errorCode : ErrorCode.values()) {
+                if (errorCode.errorCodeString.equals(errorCodeString)) {
+                    return errorCode;
+                }
+            }
+            throw new IllegalArgumentException("there is no knowlege about '" + errorCodeString + "' ErrorCode");
+        }
     }
 
     private final ErrorCode errorCode;
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
@@ -171,13 +171,13 @@ private String getSignature(OAuthRequest request, String tokenSecret) {
     protected void appendSignature(OAuthRequest request) {
         final OAuth1SignatureType signatureType = api.getSignatureType();
         switch (signatureType) {
-            case Header:
+            case HEADER:
                 log("using Http Header signature");
 
                 final String oauthHeader = api.getHeaderExtractor().extract(request);
                 request.addHeader(OAuthConstants.HEADER, oauthHeader);
                 break;
-            case QueryString:
+            case QUERY_STRING:
                 log("using Querystring signature");
 
                 for (Map.Entry<String, String> oauthParameter : request.getOauthParameters().entrySet()) {
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
@@ -355,7 +355,7 @@ protected OAuthRequest createRevokeTokenRequest(String tokenToRevoke, TokenTypeH
 
         request.addParameter("token", tokenToRevoke);
         if (tokenTypeHint != null) {
-            request.addParameter("token_type_hint", tokenTypeHint.toString());
+            request.addParameter("token_type_hint", tokenTypeHint.getValue());
         }
         return request;
     }
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/pkce/PKCECodeChallengeMethod.java b/scribejava-core/src/main/java/com/github/scribejava/core/pkce/PKCECodeChallengeMethod.java
@@ -15,7 +15,7 @@ public String transform2CodeChallenge(String codeVerifier) throws NoSuchAlgorith
                     MessageDigest.getInstance("SHA-256").digest(codeVerifier.getBytes(StandardCharsets.US_ASCII)));
         }
     },
-    plain {
+    PLAIN {
         @Override
         public String transform2CodeChallenge(String codeVerifier) {
             return codeVerifier;
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/pkce/PKCEService.java b/scribejava-core/src/main/java/com/github/scribejava/core/pkce/PKCEService.java
@@ -51,9 +51,9 @@ public PKCE generatePKCE(byte[] randomBytes) {
         try {
             pkce.setCodeChallenge(pkce.getCodeChallengeMethod().transform2CodeChallenge(codeVerifier));
         } catch (NoSuchAlgorithmException nsaE) {
-            pkce.setCodeChallengeMethod(PKCECodeChallengeMethod.plain);
+            pkce.setCodeChallengeMethod(PKCECodeChallengeMethod.PLAIN);
             try {
-                pkce.setCodeChallenge(PKCECodeChallengeMethod.plain.transform2CodeChallenge(codeVerifier));
+                pkce.setCodeChallenge(PKCECodeChallengeMethod.PLAIN.transform2CodeChallenge(codeVerifier));
             } catch (NoSuchAlgorithmException unrealE) {
                 throw new IllegalStateException("It's just cannot be", unrealE);
             }
diff --git a/scribejava-core/src/main/java/com/github/scribejava/core/revoke/TokenTypeHint.java b/scribejava-core/src/main/java/com/github/scribejava/core/revoke/TokenTypeHint.java
@@ -8,5 +8,17 @@
  * @see <a href="https://tools.ietf.org/html/rfc7009#section-2.1">RFC 7009, 2.1. Revocation Request</a>
  */
 public enum TokenTypeHint {
-    access_token, refresh_token
+    ACCESS_TOKEN("access_token"),
+    REFRESH_TOKEN("refresh_token");
+
+    private final String value;
+
+    TokenTypeHint(String value) {
+        this.value = value;
+    }
+
+    public String getValue() {
+        return value;
+    }
+
 }
diff --git a/scribejava-core/src/test/java/com/github/scribejava/core/extractors/OAuth2AccessTokenJsonExtractorTest.java b/scribejava-core/src/test/java/com/github/scribejava/core/extractors/OAuth2AccessTokenJsonExtractorTest.java
@@ -65,7 +65,7 @@ public void shouldThrowExceptionIfResponseIsError() throws IOException {
             extractor.extract(error(body));
             fail();
         } catch (OAuth2AccessTokenErrorResponse oaer) {
-            assertEquals(OAuth2AccessTokenErrorResponse.ErrorCode.invalid_grant, oaer.getErrorCode());
+            assertEquals(OAuth2AccessTokenErrorResponse.ErrorCode.INVALID_GRANT, oaer.getErrorCode());
             assertEquals("unknown, invalid, or expired refresh token", oaer.getErrorDescription());
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public static FreelancerApi instance() {`
`21`	`21`
`22`	`22`	`@Override`
`23`	`23`	`public OAuth1SignatureType getSignatureType() {`
`24`		`- return OAuth1SignatureType.QueryString;`
	`24`	`+ return OAuth1SignatureType.QUERY_STRING;`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ public SignatureService getSignatureService() {`
`85`	`85`	`* @return the signature type, choose between header, querystring, etc. Defaults to Header`
`86`	`86`	`*/`
`87`	`87`	`public OAuth1SignatureType getSignatureType() {`
`88`		`- return OAuth1SignatureType.Header;`
	`88`	`+ return OAuth1SignatureType.HEADER;`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,6 @@`
`2`	`2`
`3`	`3`	`public enum OAuth1SignatureType {`
`4`	`4`
`5`		`- Header,`
`6`		`- QueryString`
	`5`	`+ HEADER,`
	`6`	`+ QUERY_STRING`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -355,7 +355,7 @@ protected OAuthRequest createRevokeTokenRequest(String tokenToRevoke, TokenTypeH`
`355`	`355`
`356`	`356`	`request.addParameter("token", tokenToRevoke);`
`357`	`357`	`if (tokenTypeHint != null) {`
`358`		`- request.addParameter("token_type_hint", tokenTypeHint.toString());`
	`358`	`+ request.addParameter("token_type_hint", tokenTypeHint.getValue());`
`359`	`359`	`}`
`360`	`360`	`return request;`
`361`	`361`	`}`