Add setters and getters for all the variables in the request object, issue #13

Author: diegoc-am

README.md

@@ -59,10 +59,10 @@ Here is a quick example:
 Client client = new Client();
 
 Request request = new Request();
-request.baseUri = "api.test.com";
-request.method = Method.GET;
+request.setBaseUri("api.test.com");
+request.setMethod(Method.GET);
 String param = "param";
-request.endpoint = "/your/api/" + param + "/call";
+request.setEndpoint("/your/api/" + param + "/call");
 
 try {
     Response response = client.api(request);
@@ -77,9 +77,9 @@ try {
 `POST /your/api/{param}/call` with headers, query parameters and a request body.
 
 ```java
-request.getHeaders().put("Authorization", "Bearer YOUR_API_KEY");
-request.getQueryParams().put("limit", "100");
-request.getQueryParams().put("offset", "0");
+request.addHeader("Authorization", "Bearer YOUR_API_KEY");
+request.addQueryParam("limit", "100");
+request.addQueryParam("offset", "0");
 request.body ="{\"name\": \"My Request Body\"}";
 request.method = Method.POST;
 String param = "param";

examples/Example.java

@@ -17,16 +17,16 @@ public static void main(String[] args) throws IOException {
     Client client = new Client();
 
     Request request = new Request();
-    request.baseUri = "api.sendgrid.com";
-    request.getHeaders().put("Authorization", "Bearer " + System.getenv("SENDGRID_API_KEY"));
+    request.setBaseUri("api.sendgrid.com");
+    request.addHeader("Authorization", "Bearer " + System.getenv("SENDGRID_API_KEY"));
 
     Response response = new Response();
 
     // GET Collection
-    request.method = Method.GET;
-    request.endpoint = "/v3/api_keys";
-    request.getQueryParams().put("limit", "100");
-    request.getQueryParams().put("offset", "0");
+    request.setMethod(Method.GET);
+    request.setEndpoint("/v3/api_keys");
+    request.addQueryParam("limit", "100");
+    request.addQueryParam("offset", "0");
     try {
       response = client.api(request);
       System.out.println(response.statusCode);
@@ -35,13 +35,13 @@ public static void main(String[] args) throws IOException {
     } catch (IOException ex) {
       throw ex;
     }
-    request.getQueryParams().clear();
+    request.clearQueryParams();
 
     // POST
-    request.method = Method.POST;
-    request.endpoint = "/v3/api_keys";
-    request.body =
-        "{\"name\": \"My api Key\",\"scopes\": [\"mail.send\",\"alerts.create\",\"alerts.read\"]}";
+    request.setMethod(Method.POST);
+    request.setEndpoint("/v3/api_keys");
+    request.setBody("{\"name\": \"My api Key\",\"scopes\": [\"mail.send\",\"alerts.create\",\"alerts.read\"]}");
+
     try {
       response = client.api(request);
       System.out.println(response.statusCode);
@@ -58,11 +58,11 @@ public static void main(String[] args) throws IOException {
     } catch (IOException ex) {
       throw ex;
     }
-    request.body = "";
+    request.clearBody();
 
     // GET Single
-    request.method = Method.GET;
-    request.endpoint = "/v3/api_keys/" + apiKeyId;
+    request.setMethod(Method.GET);
+    request.setEndpoint("/v3/api_keys/" + apiKeyId);
     try {
       response = client.api(request);
       System.out.println(response.statusCode);
@@ -73,8 +73,8 @@ public static void main(String[] args) throws IOException {
     }
 
     // PATCH
-    request.method = Method.PATCH;
-    request.body = "{\"name\": \"A New Hope\"}";
+    request.setMethod(Method.PATCH);
+    request.setBody("{\"name\": \"A New Ho}");
     try {
       response = client.api(request);
       System.out.println(response.statusCode);
@@ -83,12 +83,11 @@ public static void main(String[] args) throws IOException {
     } catch (IOException ex) {
       throw ex;
     }
-    request.body = "";
+    request.clearBody();
 
     // PUT
-    request.method = Method.PUT;
-    request.body =
-          "{\"name\": \"A New Hope\",\"scopes\": [\"user.profile.read\",\"user.profile.update\"]}";
+    request.setMethod(Method.PUT);
+    request.setBody("{\"name\": \"A New Hope\",\"scopes\": [\"user.profile.read\",\"user.profile.update\"]}");
     try {
       response = client.api(request);
       System.out.println(response.statusCode);
@@ -97,10 +96,10 @@ public static void main(String[] args) throws IOException {
     } catch (IOException ex) {
       throw ex;
     }
-    request.body = "";
+    request.clearBody();
 
     // DELETE
-    request.method = Method.DELETE;
+    request.setMethod(Method.DELETE);
     try {
       response = client.api(request);
       System.out.println(response.statusCode);

src/main/java/com/sendgrid/Client.java

@@ -148,7 +148,7 @@ public Response get(Request request) throws URISyntaxException, IOException {
 		HttpGet httpGet = null;
 
 		try {
-			uri = buildUri(request.baseUri, request.endpoint, request.getQueryParams());
+			uri = buildUri(request.getBaseUri(), request.getEndpoint(), request.getQueryParams());
 			httpGet = new HttpGet(uri.toString());
 		} catch (URISyntaxException ex) {
 			throw ex;
@@ -171,7 +171,7 @@ public Response post(Request request) throws URISyntaxException, IOException {
 		HttpPost httpPost = null;
 
 		try {
-			uri = buildUri(request.baseUri, request.endpoint, request.getQueryParams());
+			uri = buildUri(request.getBaseUri(), request.getEndpoint(), request.getQueryParams());
 			httpPost = new HttpPost(uri.toString());
 		} catch (URISyntaxException ex) {
 			throw ex;
@@ -183,8 +183,8 @@ public Response post(Request request) throws URISyntaxException, IOException {
 			}
 		}
 
-		httpPost.setEntity(new StringEntity(request.body, Charset.forName("UTF-8")));
-		if (request.body != "") {
+		httpPost.setEntity(new StringEntity(request.getBody(), Charset.forName("UTF-8")));
+		if (request.getBody() != "") {
 			httpPost.setHeader("Content-Type", "application/json");
 		}
 
@@ -200,7 +200,7 @@ public Response patch(Request request) throws URISyntaxException, IOException {
 		HttpPatch httpPatch = null;
 
 		try {
-			uri = buildUri(request.baseUri, request.endpoint, request.getQueryParams());
+			uri = buildUri(request.getBaseUri(), request.getEndpoint(), request.getQueryParams());
 			httpPatch = new HttpPatch(uri.toString());
 		} catch (URISyntaxException ex) {
 			throw ex;
@@ -212,8 +212,8 @@ public Response patch(Request request) throws URISyntaxException, IOException {
 			}
 		}
 
-		httpPatch.setEntity(new StringEntity(request.body, Charset.forName("UTF-8")));
-		if (request.body != "") {
+		httpPatch.setEntity(new StringEntity(request.getBody(), Charset.forName("UTF-8")));
+		if (request.getBody() != "") {
 			httpPatch.setHeader("Content-Type", "application/json");
 		}
 		return executeApiCall(httpPatch);
@@ -228,7 +228,7 @@ public Response put(Request request) throws URISyntaxException, IOException {
 		HttpPut httpPut = null;
 
 		try {
-			uri = buildUri(request.baseUri, request.endpoint, request.getQueryParams());
+			uri = buildUri(request.getBaseUri(), request.getEndpoint(), request.getQueryParams());
 			httpPut = new HttpPut(uri.toString());
 		} catch (URISyntaxException ex) {
 			throw ex;
@@ -240,8 +240,8 @@ public Response put(Request request) throws URISyntaxException, IOException {
 			}
 		}
 
-		httpPut.setEntity(new StringEntity(request.body, Charset.forName("UTF-8")));
-		if (request.body != "") {
+		httpPut.setEntity(new StringEntity(request.getBody(), Charset.forName("UTF-8")));
+		if (request.getBody() != "") {
 			httpPut.setHeader("Content-Type", "application/json");
 		}
 
@@ -256,7 +256,7 @@ public Response delete(Request request) throws URISyntaxException, IOException {
 		HttpDeleteWithBody httpDelete = null;
 
 		try {
-			uri = buildUri(request.baseUri, request.endpoint, request.getQueryParams());
+			uri = buildUri(request.getBaseUri(), request.getEndpoint(), request.getQueryParams());
 			httpDelete = new HttpDeleteWithBody(uri.toString());
 		} catch (URISyntaxException ex) {
 			throw ex;
@@ -268,8 +268,8 @@ public Response delete(Request request) throws URISyntaxException, IOException {
 			}
 		}
 
-		httpDelete.setEntity(new StringEntity(request.body, Charset.forName("UTF-8")));
-		if (request.body != "") {
+		httpDelete.setEntity(new StringEntity(request.getBody(), Charset.forName("UTF-8")));
+		if (request.getBody() != "") {
 			httpDelete.setHeader("Content-Type", "application/json");
 		}
 
@@ -301,10 +301,10 @@ private Response executeApiCall(HttpRequestBase httpPost) throws IOException {
 	 */
 	public Response api(Request request) throws IOException {
 		try {
-			if (request.method == null) {
+			if (request.getMethod() == null) {
 				throw new IOException("We only support GET, PUT, PATCH, POST and DELETE.");
 			}
-			switch (request.method) {
+			switch (request.getMethod()) {
 			case GET:
 				return get(request);
 			case POST:

src/main/java/com/sendgrid/Request.java

@@ -7,10 +7,10 @@
   * Class Response provides a standard interface to an API's HTTP request.
   */
 public class Request {
-  public Method method;
-  public String baseUri;
-  public String endpoint;
-  public String body;
+  private Method method;
+  private String baseUri;
+  private String endpoint;
+  private String body;
   private final Map<String, String> headers;
   private final Map<String, String> queryParams;
 
@@ -24,12 +24,44 @@ public Request() {
   * Place the object into an empty state.
   */
   public void reset() {
-    this.method = null;
-    this.baseUri = "";
-    this.endpoint = "";
-    this.body = "";
-    this.headers.clear();
-    this.queryParams.clear();
+    this.clearMethod();
+    this.clearBaseUri();
+    this.clearEndpoint();
+    this.clearBody();
+    this.clearHeaders();
+    this.clearQueryParams();
+  }
+
+  public void addQueryParam(String key, String value) {
+    this.queryParams.put(key, value);
+  }
+
+  public void addHeader(String key, String value) {
+    this.headers.put(key, value);
+  }
+
+  public String removeQueryParam(String key) {
+    return this.queryParams.remove(key);
+  }
+
+  public String removeHeader(String key) {
+    return this.headers.remove(key);
+  }
+
+  public void setMethod(Method method) {
+    this.method = method;
+  }
+
+  public void setBaseUri(String baseUri) {
+    this.baseUri = baseUri;
+  }
+
+  public void setEndpoint(String endpoint) {
+    this.endpoint = endpoint;
+  }
+
+  public void setBody(String body) {
+    this.body = body;
   }
 
   public Map<String, String> getHeaders() {
@@ -39,4 +71,44 @@ public Map<String, String> getHeaders() {
   public Map<String, String> getQueryParams() {
     return this.queryParams;
   }
+
+  public Method getMethod() {
+    return this.method;
+  }
+
+  public String getBaseUri() {
+    return this.baseUri;
+  }
+
+  public String getEndpoint() {
+    return this.endpoint;
+  }
+
+  public String getBody() {
+    return this.body;
+  }
+
+  public void clearMethod() {
+    this.method = null;
+  }
+
+  public void clearBaseUri() {
+    this.baseUri = "";
+  }
+
+  public void clearEndpoint() {
+    this.endpoint = "";
+  }
+
+  public void clearBody() {
+    this.body = "";
+  }
+
+  public void clearQueryParams() {
+    this.queryParams.clear();
+  }
+
+  public void clearHeaders() {
+    this.headers.clear();
+  }
 }

src/test/java/com/sendgrid/ClientTest.java

@@ -124,12 +124,12 @@ public void testMethod(Method method, int statusCode) {
       mockedHeaders = new Header[] { new BasicHeader("headerA", "valueA") };
       when(response.getAllHeaders()).thenReturn(mockedHeaders);
       when(httpClient.execute(Matchers.any(HttpGet.class))).thenReturn(response);
-      request.method = method;
+      request.setMethod(method);
       if ((method == Method.POST) || (method == Method.PATCH) || (method == Method.PUT)) {
-        request.body = "{\"test\":\"testResult\"}";
+        request.setBody("{\"test\":\"testResult\"}");
       }
-      request.endpoint = "/test";
-      request.getHeaders().put("Authorization", "Bearer XXXX");
+      request.setEndpoint("/test");
+      request.addHeader("Authorization", "Bearer XXXX");
       Client client = new Client(httpClient);
       testResponse = client.get(request);
     } catch (URISyntaxException | IOException ex) {