chore: content types are constants

box · antusus · Jan 17, 2023 · Aug 16, 2022 · Aug 17, 2022 · Aug 17, 2022
commit f24801e48833c90cac68a77f1e15f9ef981f015e
diff --git a/src/main/java/com/box/sdk/BoxAPIResponse.java b/src/main/java/com/box/sdk/BoxAPIResponse.java
@@ -1,5 +1,6 @@
 package com.box.sdk;
 
+import static com.box.sdk.http.ContentType.APPLICATION_JSON;
 import static java.lang.String.format;
 
 import com.eclipsesource.json.Json;
@@ -32,7 +33,6 @@
  */
 public class BoxAPIResponse {
     private static final BoxLogger LOGGER = BoxLogger.defaultLogger();
-    private static final int BUFFER_SIZE = 8192;
     private final Map<String, List<String>> headers;
     private final long contentLength;
     private final String contentType;
@@ -71,7 +71,9 @@ public BoxAPIResponse() {
      * @param responseCode http response code
      * @param headers      map of headers
      */
-    public BoxAPIResponse(int responseCode, String requestMethod, String requestUrl, Map<String, List<String>> headers) {
+    public BoxAPIResponse(
+        int responseCode, String requestMethod, String requestUrl, Map<String, List<String>> headers
+    ) {
         this(responseCode, requestMethod, requestUrl, headers, null, null, 0);
     }
 
@@ -127,7 +129,7 @@ static BoxAPIResponse toBoxResponse(Response response) {
             );
         }
         if (responseBody != null && responseBody.contentType() != null) {
-            if (responseBody.contentType().toString().contains("application/json")) {
+            if (responseBody.contentType().toString().contains(APPLICATION_JSON)) {
                 String bodyAsString = "";
                 try {
                     bodyAsString = responseBody.string();

diff --git a/src/main/java/com/box/sdk/BoxFile.java b/src/main/java/com/box/sdk/BoxFile.java
@@ -1,5 +1,7 @@
 package com.box.sdk;
 
+import static com.box.sdk.http.ContentType.APPLICATION_JSON;
+import static com.box.sdk.http.ContentType.APPLICATION_JSON_PATCH;
 import static com.eclipsesource.json.Json.NULL;
 
 import com.box.sdk.http.HttpMethod;
@@ -1349,7 +1351,7 @@ public Metadata updateMetadata(Metadata metadata) {
 
         URL url = METADATA_URL_TEMPLATE.buildAlpha(this.getAPI().getBaseURL(), this.getID(),
             scope, metadata.getTemplateName());
-        BoxJSONRequest request = new BoxJSONRequest(this.getAPI(), url, "PUT", "application/json-patch+json");
+        BoxJSONRequest request = new BoxJSONRequest(this.getAPI(), url, "PUT", APPLICATION_JSON_PATCH);
         request.setBody(metadata.getPatch());
         BoxJSONResponse response = request.send();
         return new Metadata(Json.parse(response.getJSON()).asObject());
@@ -1446,7 +1448,7 @@ public BoxFileUploadSession.Info createUploadSession(long fileSize) {
         URL url = UPLOAD_SESSION_URL_TEMPLATE.build(this.getAPI().getBaseUploadURL(), this.getID());
 
         BoxJSONRequest request = new BoxJSONRequest(this.getAPI(), url, "POST");
-        request.addHeader("Content-Type", "application/json");
+        request.addHeader("Content-Type", APPLICATION_JSON);
 
         JsonObject body = new JsonObject();
         body.add("file_size", fileSize);

diff --git a/src/main/java/com/box/sdk/BoxFolder.java b/src/main/java/com/box/sdk/BoxFolder.java
@@ -3,6 +3,7 @@
 import static com.box.sdk.PagingParameters.DEFAULT_LIMIT;
 import static com.box.sdk.PagingParameters.marker;
 import static com.box.sdk.PagingParameters.offset;
+import static com.box.sdk.http.ContentType.APPLICATION_JSON_PATCH;
 
 import com.box.sdk.internal.utils.Parsers;
 import com.box.sdk.sharedlink.BoxSharedLinkRequest;
@@ -578,10 +579,10 @@ public BoxFile.Info uploadFile(FileUploadParams uploadParams) {
 
         BoxJSONResponse response;
         if (uploadParams.getProgressListener() == null) {
-            // uppload files sends multipart request but response is JSON
+            // upload files sends multipart request but response is JSON
             response = (BoxJSONResponse) request.send();
         } else {
-            // uppload files sends multipart request but response is JSON
+            // upload files sends multipart request but response is JSON
             response = (BoxJSONResponse) request.send(uploadParams.getProgressListener());
         }
         JsonObject collection = Json.parse(response.getJSON()).asObject();
@@ -1034,7 +1035,7 @@ public Metadata getMetadata(String templateName, String scope) {
     public Metadata updateMetadata(Metadata metadata) {
         URL url = METADATA_URL_TEMPLATE.buildAlpha(this.getAPI().getBaseURL(), this.getID(), metadata.getScope(),
             metadata.getTemplateName());
-        BoxJSONRequest request = new BoxJSONRequest(this.getAPI(), url, "PUT", "application/json-patch+json");
+        BoxJSONRequest request = new BoxJSONRequest(this.getAPI(), url, "PUT", APPLICATION_JSON_PATCH);
         request.setBody(metadata.getPatch());
         BoxJSONResponse response = request.send();
         return new Metadata(Json.parse(response.getJSON()).asObject());

diff --git a/src/main/java/com/box/sdk/BoxJSONRequest.java b/src/main/java/com/box/sdk/BoxJSONRequest.java
@@ -1,5 +1,7 @@
 package com.box.sdk;
 
+import static com.box.sdk.http.ContentType.APPLICATION_JSON;
+
 import com.box.sdk.http.HttpMethod;
 import com.eclipsesource.json.Json;
 import com.eclipsesource.json.JsonObject;
@@ -27,7 +29,7 @@ protected BoxJSONRequest(BoxAPIConnection api, URL url, String method, String me
      * @param method the HTTP method of the request.
      */
     public BoxJSONRequest(BoxAPIConnection api, URL url, String method) {
-        this(api, url, method, "application/json");
+        this(api, url, method, APPLICATION_JSON);
     }
 
     /**

diff --git a/src/main/java/com/box/sdk/http/ContentType.java b/src/main/java/com/box/sdk/http/ContentType.java
@@ -20,6 +20,11 @@ public final class ContentType {
      */
     public static final String APPLICATION_FORM_URLENCODED = "application/x-www-form-urlencoded";
 
+    /**
+     * It is used when the HTTP request content type is application/json-patch+json.
+     */
+    public static final String APPLICATION_JSON_PATCH = "application/json-patch+json";
+
     //Prevents instantiation
     private ContentType() {
     }

diff --git a/src/test/java/com/box/sdk/BoxAPIConnectionTest.java b/src/test/java/com/box/sdk/BoxAPIConnectionTest.java
@@ -1,5 +1,6 @@
 package com.box.sdk;
 
+import static com.box.sdk.http.ContentType.APPLICATION_JSON;
 import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
 import static com.github.tomakehurst.wiremock.client.WireMock.post;
 import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo;
@@ -184,7 +185,7 @@ public void revokeTokenCallsCorrectEndpoint() {
         wireMockRule.stubFor(post(urlPathEqualTo("/oauth2/revoke"))
             .withRequestBody(WireMock.equalTo("token=fakeAccessToken&client_id=fakeID&client_secret=fakeSecret"))
             .willReturn(aResponse()
-                .withHeader("Content-Type", "application/json")
+                .withHeader("Content-Type", APPLICATION_JSON)
                 .withBody("{}")));
 
         api.revokeToken();
@@ -642,7 +643,7 @@ private void mockAndAssertRevoke(String token, String clientID, String clientSec
                 )
             ))
             .willReturn(aResponse()
-                .withHeader("Content-Type", "application/json")
+                .withHeader("Content-Type", APPLICATION_JSON)
                 .withBody(
                     "{\"refresh_token\":\"refresh-token\", \"access_token\":\"access-token\", \"expires_in\": 1}"
                 )));
@@ -656,7 +657,7 @@ private void mockAndAssertAuthentication(String clientId, String clientSecret, S
                 )
             ))
             .willReturn(aResponse()
-                .withHeader("Content-Type", "application/json")
+                .withHeader("Content-Type", APPLICATION_JSON)
                 .withBody(
                     "{\"refresh_token\":\"refresh-token\", \"access_token\":\"access-token\", \"expires_in\": 1}"
                 )));

diff --git a/src/test/java/com/box/sdk/BoxAPIRequestTest.java b/src/test/java/com/box/sdk/BoxAPIRequestTest.java
@@ -1,5 +1,6 @@
 package com.box.sdk;
 
+import static com.box.sdk.http.ContentType.APPLICATION_JSON;
 import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
 import static com.github.tomakehurst.wiremock.client.WireMock.get;
 import static com.github.tomakehurst.wiremock.client.WireMock.getRequestedFor;
@@ -107,7 +108,7 @@ public void requestSendsXBoxUAHeader() throws MalformedURLException {
 
         stubFor(get(urlEqualTo("/")).willReturn(aResponse()
             .withStatus(202)
-            .withHeader("Content-Type", "application/json")
+            .withHeader("Content-Type", APPLICATION_JSON)
             .withBody("{}")));
 
         BoxAPIRequest request = new BoxAPIRequest(new BoxAPIConnection(""), boxMockUrl(), "GET");
@@ -166,7 +167,7 @@ public void whenJsonCannotBeParseExceptionIsThrown() throws IOException {
         stubFor(get(urlEqualTo("/")).willReturn(
             aResponse()
                 .withStatus(200)
-                .withHeader("content-type", "application/json")
+                .withHeader("content-type", APPLICATION_JSON)
                 .withBody("Not a Json".getBytes(UTF_8))
         ));
         try {

diff --git a/src/test/java/com/box/sdk/BoxAPIResponseExceptionTest.java b/src/test/java/com/box/sdk/BoxAPIResponseExceptionTest.java
@@ -1,5 +1,6 @@
 package com.box.sdk;
 
+import static com.box.sdk.http.ContentType.APPLICATION_JSON;
 import static com.github.tomakehurst.wiremock.client.WireMock.aResponse;
 import static com.github.tomakehurst.wiremock.client.WireMock.post;
 import static com.github.tomakehurst.wiremock.client.WireMock.stubFor;
@@ -17,7 +18,6 @@
 import com.eclipsesource.json.JsonObject;
 import com.github.tomakehurst.wiremock.client.WireMock;
 import com.github.tomakehurst.wiremock.junit.WireMockRule;
-import java.io.IOException;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.util.HashMap;
@@ -72,7 +72,7 @@ public void testAPIResponseExceptionReturnsCorrectErrorMessage() throws Malforme
         stubFor(post(urlEqualTo("/folders"))
             .willReturn(aResponse()
                 .withStatus(409)
-                .withHeader("Content-Type", "application/json")
+                .withHeader("Content-Type", APPLICATION_JSON)
                 .withBody(fakeJSONResponse.toString())));
 
         BoxAPIRequest request = new BoxAPIRequest(api, foldersUrl(), "POST");
@@ -112,7 +112,7 @@ public void testAPIResponseExceptionMissingFieldsReturnsCorrectErrorMessage() th
         stubFor(post(urlEqualTo("/folders"))
             .willReturn(aResponse()
                 .withStatus(409)
-                .withHeader("Content-Type", "application/json")
+                .withHeader("Content-Type", APPLICATION_JSON)
                 .withBody(fakeJSONResponse.toString())));
 
         BoxAPIRequest request = new BoxAPIRequest(api, foldersUrl(), "POST");
@@ -190,7 +190,7 @@ public void testResponseExceptionHeadersIsCaseInsensitive() {
     }
 
     @Test
-    public void testGetResponseHeadersWithNoRequestID() throws IOException {
+    public void testGetResponseHeadersWithNoRequestID() {
         final String userURL = "/2.0/users/12345";
 
         String result = TestUtils.getFixture("BoxException/BoxResponseException403");
@@ -211,7 +211,7 @@ public void testGetResponseHeadersWithNoRequestID() throws IOException {
 
 
     @Test
-    public void testGetResponseExceptionCorrectlyWithAllID() throws IOException {
+    public void testGetResponseExceptionCorrectlyWithAllID() {
         final String userURL = "/2.0/users/12345";
 
         String result = TestUtils.getFixture("BoxException/BoxResponseException403WithRequestID");
@@ -231,7 +231,7 @@ public void testGetResponseExceptionCorrectlyWithAllID() throws IOException {
     }
 
     @Test
-    public void testGetResponseExceptionErrorAndErrorDescription() throws IOException {
+    public void testGetResponseExceptionErrorAndErrorDescription() {
         final String userURL = "/2.0/users/12345";
 
         String result = TestUtils.getFixture("BoxException/BoxResponseException400WithErrorAndErrorDescription");

diff --git a/src/test/java/com/box/sdk/BoxCollaborationAllowlistExemptTargetTest.java b/src/test/java/com/box/sdk/BoxCollaborationAllowlistExemptTargetTest.java
@@ -1,12 +1,12 @@
 package com.box.sdk;
 
+import static com.box.sdk.http.ContentType.APPLICATION_JSON;
 import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
 import static java.lang.String.format;
 
 import com.eclipsesource.json.JsonObject;
 import com.github.tomakehurst.wiremock.client.WireMock;
 import com.github.tomakehurst.wiremock.junit.WireMockRule;
-import java.io.IOException;
 import java.util.Iterator;
 import org.junit.Assert;
 import org.junit.Before;
@@ -26,7 +26,7 @@ public void setUpBaseUrl() {
     }
 
     @Test
-    public void testCreateAllowlistForAUserSucceedsAndSendsCorrectJson() throws IOException {
+    public void testCreateAllowlistForAUserSucceedsAndSendsCorrectJson() {
         final String allowlistURL = "/2.0/collaboration_whitelist_exempt_targets";
         final String userToAllowlistID = "1111";
         final String userToAllowlistLogin = "test@user.com";
@@ -46,7 +46,7 @@ public void testCreateAllowlistForAUserSucceedsAndSendsCorrectJson() throws IOEx
         wireMockRule.stubFor(WireMock.post(WireMock.urlPathEqualTo(allowlistURL))
             .withRequestBody(WireMock.equalToJson(userOuterObject.toString()))
             .willReturn(WireMock.aResponse()
-                .withHeader("Content-Type", "application/json")
+                .withHeader("Content-Type", APPLICATION_JSON)
                 .withBody(result)));
 
         BoxCollaborationAllowlistExemptTarget.Info userAllowlistInfo =
@@ -60,7 +60,7 @@ public void testCreateAllowlistForAUserSucceedsAndSendsCorrectJson() throws IOEx
     }
 
     @Test
-    public void testGetAllowlistInfoForAUser() throws IOException {
+    public void testGetAllowlistInfoForAUser() {
         final String allowlistID = "12345";
         final String allowlistURL = "/2.0/collaboration_whitelist_exempt_targets/" + allowlistID;
         final String allowlistedUserID = "1111";
@@ -72,7 +72,7 @@ public void testGetAllowlistInfoForAUser() throws IOException {
 
         wireMockRule.stubFor(WireMock.get(WireMock.urlPathEqualTo(allowlistURL))
             .willReturn(WireMock.aResponse()
-                .withHeader("Content-Type", "application/json")
+                .withHeader("Content-Type", APPLICATION_JSON)
                 .withBody(result)));
 
         BoxCollaborationAllowlistExemptTarget.Info userAllowlistInfo = new
@@ -86,7 +86,7 @@ public void testGetAllowlistInfoForAUser() throws IOException {
     }
 
     @Test
-    public void testGetAllowlistInfoForAllUsers() throws IOException {
+    public void testGetAllowlistInfoForAllUsers() {
         final String allowlistExemptUserURL = "/2.0/collaboration_whitelist_exempt_targets";
         final String firstAllowlistType = "collaboration_whitelist_exempt_target";
         final String firstAllowlistID = "1234";
@@ -95,7 +95,7 @@ public void testGetAllowlistInfoForAllUsers() throws IOException {
 
         wireMockRule.stubFor(WireMock.get(WireMock.urlPathEqualTo(allowlistExemptUserURL))
             .willReturn(WireMock.aResponse()
-                .withHeader("Content-Type", "application/json")
+                .withHeader("Content-Type", APPLICATION_JSON)
                 .withBody(result)));
 
         Iterator<BoxCollaborationAllowlistExemptTarget.Info> allowlistInfo =
@@ -114,7 +114,7 @@ public void testDeleteCollaborationAllowlistForUser() {
 
         wireMockRule.stubFor(WireMock.delete(WireMock.urlPathEqualTo(deleteAllowlistURL))
             .willReturn(WireMock.aResponse()
-                .withHeader("Content-Type", "application/json")
+                .withHeader("Content-Type", APPLICATION_JSON)
                 .withStatus(204)));
 
         new BoxCollaborationAllowlistExemptTarget(this.api, allowlistID).delete();

diff --git a/src/test/java/com/box/sdk/BoxCollaborationAllowlistTest.java b/src/test/java/com/box/sdk/BoxCollaborationAllowlistTest.java
@@ -1,13 +1,13 @@
 package com.box.sdk;
 
+import static com.box.sdk.http.ContentType.APPLICATION_JSON;
 import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
 import static java.lang.String.format;
 import static org.junit.Assert.assertEquals;
 
 import com.eclipsesource.json.JsonObject;
 import com.github.tomakehurst.wiremock.client.WireMock;
 import com.github.tomakehurst.wiremock.junit.WireMockRule;
-import java.io.IOException;
 import java.util.Arrays;
 import java.util.Iterator;
 import java.util.List;
@@ -35,14 +35,14 @@ public void testDeleteAllowlistForDomainSucceeds() {
 
         wireMockRule.stubFor(WireMock.delete(WireMock.urlPathEqualTo(deleteAllowlistURL))
             .willReturn(WireMock.aResponse()
-                .withHeader("Content-Type", "application/json")
+                .withHeader("Content-Type", APPLICATION_JSON)
                 .withStatus(204)));
 
         new BoxCollaborationAllowlist(this.api, whitelistID).delete();
     }
 
     @Test
-    public void testGetAllowlistInfoForAllDomainsSucceeds() throws IOException {
+    public void testGetAllowlistInfoForAllDomainsSucceeds() {
         final String whitelistURL = "/2.0/collaboration_whitelist_entries";
         final String firstAllowlistID = "1111";
         final String firstAllowlistDomain = "test.com";
@@ -52,7 +52,7 @@ public void testGetAllowlistInfoForAllDomainsSucceeds() throws IOException {
 
         wireMockRule.stubFor(WireMock.get(WireMock.urlPathEqualTo(whitelistURL))
             .willReturn(WireMock.aResponse()
-                .withHeader("Content-Type", "application/json")
+                .withHeader("Content-Type", APPLICATION_JSON)
                 .withBody(result)));
 
         Iterator<BoxCollaborationAllowlist.Info> iterator = BoxCollaborationAllowlist.getAll(this.api).iterator();
@@ -64,7 +64,7 @@ public void testGetAllowlistInfoForAllDomainsSucceeds() throws IOException {
     }
 
     @Test
-    public void testGetAllowlistInfoForADomainSucceeds() throws IOException {
+    public void testGetAllowlistInfoForADomainSucceeds() {
         final String whitelistID = "12345";
         final String getAllowlistInfoURL = "/2.0/collaboration_whitelist_entries/" + whitelistID;
         final String whitelistDomain = "example.com";
@@ -74,7 +74,7 @@ public void testGetAllowlistInfoForADomainSucceeds() throws IOException {
 
         wireMockRule.stubFor(WireMock.get(WireMock.urlPathEqualTo(getAllowlistInfoURL))
             .willReturn(WireMock.aResponse()
-                .withHeader("Content-Type", "application/json")
+                .withHeader("Content-Type", APPLICATION_JSON)
                 .withBody(result)));
 
         BoxCollaborationAllowlist.Info whitelistInfo = new BoxCollaborationAllowlist(this.api, whitelistID).getInfo();
@@ -85,7 +85,7 @@ public void testGetAllowlistInfoForADomainSucceeds() throws IOException {
     }
 
     @Test
-    public void testCreateAllowlistForDomainSucceedsAndSendsCorrectJson() throws IOException {
+    public void testCreateAllowlistForDomainSucceedsAndSendsCorrectJson() {
         final String whitelistURL = "/2.0/collaboration_whitelist_entries";
         final String domainToAllowlist = "example.com";
         final String whitelistDirection = "both";
@@ -102,7 +102,7 @@ public void testCreateAllowlistForDomainSucceedsAndSendsCorrectJson() throws IOE
         wireMockRule.stubFor(WireMock.post(WireMock.urlPathEqualTo(whitelistURL))
             .withRequestBody(WireMock.equalToJson(whitelistObject.toString()))
             .willReturn(WireMock.aResponse()
-                .withHeader("Content-Type", "application/json")
+                .withHeader("Content-Type", APPLICATION_JSON)
                 .withBody(result)));
 
         BoxCollaborationAllowlist.Info collabAllowlistInfo = BoxCollaborationAllowlist.create(this.api,