Merge pull request #208 from steve-donovan/master

tsolakoua · web-flow · commit b8888ead37ab · 2022-09-08T12:56:26.000+02:00
sonar cloud warnings - verbs to enum
diff --git a/src/main/java/com/amadeus/Constants.java b/src/main/java/com/amadeus/Constants.java
@@ -11,11 +11,6 @@
  * </pre>
  */
 public final class Constants {
-  // HTTP verbs
-  public static final String GET = "GET";
-  public static final String POST = "POST";
-  public static final String PUT = "PUT";
-  public static final String DELETE = "DELETE";
 
 
   public static final String HTTPS = "https";
@@ -62,4 +57,4 @@ public final class Constants {
   private Constants() {
     throw new AssertionError();
   }
-}
+}
diff --git a/src/main/java/com/amadeus/HTTPClient.java b/src/main/java/com/amadeus/HTTPClient.java
@@ -37,7 +37,7 @@ protected HTTPClient(Configuration configuration) {
    * @see Amadeus#get(String, Params)
    */
   public Response get(String path) throws ResponseException {
-    return request(Constants.GET, path, null,null);
+    return request(HttpVerbs.GET, path, null,null);
   }
 
   /**
@@ -64,7 +64,7 @@ public Response get(String path) throws ResponseException {
    * @return a Response object containing the status code, body, and parsed data.
    */
   public Response get(String path, Params params) throws ResponseException {
-    return request(Constants.GET, path, params, null);
+    return request(HttpVerbs.GET, path, params, null);
   }
 
   /**
@@ -91,7 +91,7 @@ public Response get(String path, Params params) throws ResponseException {
    * @return a Response object containing the status code, body, and parsed data.
    */
   public Response delete(String path, Params params) throws ResponseException {
-    return request(Constants.DELETE, path, params, null);
+    return request(HttpVerbs.DELETE, path, params, null);
   }
 
   /**
@@ -101,7 +101,7 @@ public Response delete(String path, Params params) throws ResponseException {
    * @see Amadeus#delete(String, Params)
    */
   public Response delete(String path) throws ResponseException {
-    return request(Constants.DELETE, path, null,null);
+    return request(HttpVerbs.DELETE, path, null,null);
   }
 
   /**
@@ -111,7 +111,7 @@ public Response delete(String path) throws ResponseException {
    * @see Amadeus#post(String, Params)
    */
   public Response post(String path) throws ResponseException {
-    return request(Constants.POST, path, null, null);
+    return request(HttpVerbs.POST, path, null, null);
   }
 
   /**
@@ -138,7 +138,7 @@ public Response post(String path) throws ResponseException {
    * @return a Response object containing the status code, body, and parsed data.
    */
   public Response post(String path, Params params) throws ResponseException {
-    return request(Constants.POST, path, params, null);
+    return request(HttpVerbs.POST, path, params, null);
   }
 
   /**
@@ -165,7 +165,7 @@ public Response post(String path, Params params) throws ResponseException {
    * @return a Response object containing the status code, body, and parsed data.
    */
   public Response post(String path, String body) throws ResponseException {
-    return request(Constants.POST, path, null, body);
+    return request(HttpVerbs.POST, path, null, body);
   }
 
   /**
@@ -188,7 +188,7 @@ public Response post(String path, String body) throws ResponseException {
    * @return a Response object containing the status code, body, and parsed data.
    */
   public Response post(String path, JsonObject body) throws ResponseException {
-    return request(Constants.POST, path, null, body.toString());
+    return request(HttpVerbs.POST, path, null, body.toString());
   }
 
   /**
@@ -212,7 +212,7 @@ public Response post(String path, JsonObject body) throws ResponseException {
    * @return a Response object containing the status code, body, and parsed data.
    */
   public Response post(String path, Params params, JsonObject body) throws ResponseException {
-    return request(Constants.POST, path, params, body.toString());
+    return request(HttpVerbs.POST, path, params, body.toString());
   }
 
   /**
@@ -236,7 +236,7 @@ public Response post(String path, Params params, JsonObject body) throws Respons
    * @return a Response object containing the status code, body, and parsed data.
    */
   public Response post(String path, Params params, String body) throws ResponseException {
-    return request(Constants.POST, path, params, body);
+    return request(HttpVerbs.POST, path, params, body);
   }
 
   /**
@@ -246,7 +246,7 @@ public Response post(String path, Params params, String body) throws ResponseExc
    *
    * @hides as only used internally
    */
-  public Response unauthenticatedRequest(String verb, String path, Params params, String body,
+  public Response unauthenticatedRequest(HttpVerbs verb, String path, Params params, String body,
       String bearerToken) throws ResponseException {
     Request request = buildRequest(verb, path, params, body, bearerToken);
     log(request);
@@ -334,13 +334,13 @@ public Resource[] last(Resource resource) throws ResponseException {
   }
 
   // A generic method for making requests of any verb.
-  protected Response request(String verb, String path, Params params, String body)
+  protected Response request(HttpVerbs verb, String path, Params params, String body)
       throws ResponseException {
     return unauthenticatedRequest(verb, path, params, body, accessToken.getBearerToken());
   }
 
   // Builds a request
-  protected Request buildRequest(String verb, String path, Params params, String body,
+  protected Request buildRequest(HttpVerbs verb, String path, Params params, String body,
       String bearerToken) {
     return new Request(verb, path, params, body, bearerToken, this);
   }
@@ -378,7 +378,7 @@ private Request fetch(Request request) throws NetworkException {
   private void write(Request request) throws IOException {
 
     // POST with access token + body + URL parameters
-    if (request.getVerb() == Constants.POST && request.getParams() != null
+    if (request.getVerb() == HttpVerbs.POST && request.getParams() != null
             && request.getBearerToken() != null) {
       OutputStream os = request.getConnection().getOutputStream();
       BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(os, "UTF-8"));
@@ -392,7 +392,7 @@ private void write(Request request) throws IOException {
     }
 
     // POST with access without token (authentication call)
-    if (request.getVerb() == Constants.POST && request.getParams() != null
+    if (request.getVerb() == HttpVerbs.POST && request.getParams() != null
             && request.getBearerToken() == null) {
       OutputStream os = request.getConnection().getOutputStream();
       BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(os, "UTF-8"));
@@ -403,7 +403,7 @@ private void write(Request request) throws IOException {
     }
 
     // POST with access token + body
-    if (request.getVerb() == Constants.POST && request.getParams() == null) {
+    if (request.getVerb() == HttpVerbs.POST && request.getParams() == null) {
       OutputStream os = request.getConnection().getOutputStream();
       BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(os, "UTF-8"));
       if (request.getBody() != null) {
diff --git a/src/main/java/com/amadeus/HttpVerbs.java b/src/main/java/com/amadeus/HttpVerbs.java
@@ -0,0 +1,9 @@
+package com.amadeus;
+
+public enum HttpVerbs {
+  // HTTP verbs
+  GET,
+  POST,
+  PUT,
+  DELETE
+}
diff --git a/src/main/java/com/amadeus/Request.java b/src/main/java/com/amadeus/Request.java
@@ -22,7 +22,7 @@ public class Request {
   /**
    * The HTTPClient verb to use for API calls.
    */
-  private @Getter String verb;
+  private @Getter HttpVerbs verb;
   /**
    * The scheme to use for API calls.
    */
@@ -83,7 +83,7 @@ public class Request {
   // The connection used to make the API call.
   private @Getter HttpURLConnection connection;
 
-  protected Request(String verb, String path, Params params, String body, String bearerToken,
+  protected Request(HttpVerbs verb, String path, Params params, String body, String bearerToken,
                  HTTPClient client) {
     Configuration config = client.getConfiguration();
 
@@ -108,9 +108,9 @@ protected Request(String verb, String path, Params params, String body, String b
   // Builds a HttpURLConnection using all the data for this request.
   protected void establishConnection() throws IOException {
     this.connection = (HttpURLConnection) new URL(uri).openConnection();
-    connection.setRequestMethod(verb);
+    connection.setRequestMethod(verb.name());
     connection.setDoInput(true);
-    if (verb == Constants.POST || verb == Constants.PUT) {
+    if (verb == HttpVerbs.POST || verb == HttpVerbs.PUT) {
       connection.setDoOutput(true);
     }
     for (Map.Entry<String, String> entry : headers.entrySet()) {
@@ -140,8 +140,8 @@ private void prepareHeaders() {
       headers.put(Constants.CONTENT_TYPE, "application/vnd.amadeus+json");
 
       // Checks if the request needs an X-Http-Method-Override header
-      if (Constants.APIS_WITH_EXTRA_HEADER.contains(path) && Objects.equals(verb, Constants.POST)) {
-        headers.put(Constants.X_HTTP_METHOD_OVERRIDE, Constants.GET);
+      if (Constants.APIS_WITH_EXTRA_HEADER.contains(path) && verb == HttpVerbs.POST) {
+        headers.put(Constants.X_HTTP_METHOD_OVERRIDE, HttpVerbs.GET.name());
       }
 
     }
diff --git a/src/main/java/com/amadeus/client/AccessToken.java b/src/main/java/com/amadeus/client/AccessToken.java
@@ -3,6 +3,7 @@
 import com.amadeus.Configuration;
 import com.amadeus.Constants;
 import com.amadeus.HTTPClient;
+import com.amadeus.HttpVerbs;
 import com.amadeus.Params;
 import com.amadeus.Response;
 import com.amadeus.exceptions.ResponseException;
@@ -65,7 +66,7 @@ private boolean needsRefresh() {
   private Response fetchAccessToken() throws ResponseException {
     Configuration config = client.getConfiguration();
     return client.unauthenticatedRequest(
-           Constants.POST,
+           HttpVerbs.POST,
            Constants.AUTH_URL,
             Params.with(Constants.GRANT_TYPE, Constants.CLIENT_CREDENTIALS)
                   .and(Constants.CLIENT_ID, config.getClientId())
diff --git a/src/test/java/com/amadeus/AccessTokenTest.java b/src/test/java/com/amadeus/AccessTokenTest.java
@@ -35,7 +35,7 @@ public class AccessTokenTest {
     json.addProperty("expires_in", 600);
     when(response.getResult()).thenReturn(json);
 
-    when(client.unauthenticatedRequest("POST",
+    when(client.unauthenticatedRequest(HttpVerbs.POST,
             "/v1/security/oauth2/token", Params
                     .with("grant_type", "client_credentials")
                     .and("client_id", "client_id")
@@ -53,7 +53,7 @@ public class AccessTokenTest {
     accessToken.getBearerToken();
 
     verify(client, times(1))
-        .unauthenticatedRequest(anyString(), anyString(),
+        .unauthenticatedRequest(any(HttpVerbs.class), anyString(),
             any(Params.class), isNull(), isNull());
   }
 
@@ -65,7 +65,7 @@ public class AccessTokenTest {
     accessToken.getBearerToken();
 
     verify(client, times(2))
-            .unauthenticatedRequest(anyString(), anyString(),
+            .unauthenticatedRequest(any(HttpVerbs.class), anyString(),
                 any(Params.class), isNull(), isNull());
   }
 }
diff --git a/src/test/java/com/amadeus/HTTPClientTest.java b/src/test/java/com/amadeus/HTTPClientTest.java
diff --git a/src/test/java/com/amadeus/RequestTest.java b/src/test/java/com/amadeus/RequestTest.java
