Update the request object with sensible defaults and access methods, issue #13

Author: diegoc-am

README.md

@@ -77,13 +77,9 @@ try {
 `POST /your/api/{param}/call` with headers, query parameters and a request body.
 
 ```java
-Map<String,String> requestHeaders = new HashMap<String, String>();
-requestHeaders.put("Authorization", "Bearer YOUR_API_KEY");
-request.headers = requestHeaders;
-Map<String,String> queryParams = new HashMap<String, String>();
-queryParams.put("limit", "100");
-queryParams.put("offset", "0");
-request.queryParams = queryParams;
+request.getHeaders().put("Authorization", "Bearer YOUR_API_KEY");
+request.getQueryParams().put("limit", "100");
+request.getQueryParams().put("offset", "0");
 request.body ="{\"name\": \"My Request Body\"}";
 request.method = Method.POST;
 String param = "param";

examples/Example.java

@@ -18,19 +18,15 @@ public static void main(String[] args) throws IOException {
 
     Request request = new Request();
     request.baseUri = "api.sendgrid.com";
-    Map<String,String> requestHeaders = new HashMap<String, String>();
-    requestHeaders.put("Authorization", "Bearer " + System.getenv("SENDGRID_API_KEY"));
-    request.headers = requestHeaders;
+    request.getHeaders().put("Authorization", "Bearer " + System.getenv("SENDGRID_API_KEY"));
 
     Response response = new Response();
 
     // GET Collection
     request.method = Method.GET;
     request.endpoint = "/v3/api_keys";
-    Map<String,String> queryParams = new HashMap<String, String>();
-    queryParams.put("limit", "100");
-    queryParams.put("offset", "0");
-    request.queryParams = queryParams;
+    request.getQueryParams().put("limit", "100");
+    request.getQueryParams().put("offset", "0");
     try {
       response = client.api(request);
       System.out.println(response.statusCode);
@@ -39,7 +35,7 @@ public static void main(String[] args) throws IOException {
     } catch (IOException ex) {
       throw ex;
     }
-    request.queryParams = null;
+    request.getQueryParams().clear();
 
     // POST
     request.method = Method.POST;

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

@@ -148,14 +148,14 @@ public Response get(Request request) throws URISyntaxException, IOException {
 		HttpGet httpGet = null;
 
 		try {
-			uri = buildUri(request.baseUri, request.endpoint, request.queryParams);
+			uri = buildUri(request.baseUri, request.endpoint, request.getQueryParams());
 			httpGet = new HttpGet(uri.toString());
 		} catch (URISyntaxException ex) {
 			throw ex;
 		}
 
-		if (request.headers != null) {
-			for (Map.Entry<String, String> entry : request.headers.entrySet()) {
+		if (request.getHeaders() != null) {
+			for (Map.Entry<String, String> entry : request.getHeaders().entrySet()) {
 				httpGet.setHeader(entry.getKey(), entry.getValue());
 			}
 		}
@@ -171,14 +171,14 @@ public Response post(Request request) throws URISyntaxException, IOException {
 		HttpPost httpPost = null;
 
 		try {
-			uri = buildUri(request.baseUri, request.endpoint, request.queryParams);
+			uri = buildUri(request.baseUri, request.endpoint, request.getQueryParams());
 			httpPost = new HttpPost(uri.toString());
 		} catch (URISyntaxException ex) {
 			throw ex;
 		}
 
-		if (request.headers != null) {
-			for (Map.Entry<String, String> entry : request.headers.entrySet()) {
+		if (request.getHeaders() != null) {
+			for (Map.Entry<String, String> entry : request.getHeaders().entrySet()) {
 				httpPost.setHeader(entry.getKey(), entry.getValue());
 			}
 		}
@@ -200,14 +200,14 @@ public Response patch(Request request) throws URISyntaxException, IOException {
 		HttpPatch httpPatch = null;
 
 		try {
-			uri = buildUri(request.baseUri, request.endpoint, request.queryParams);
+			uri = buildUri(request.baseUri, request.endpoint, request.getQueryParams());
 			httpPatch = new HttpPatch(uri.toString());
 		} catch (URISyntaxException ex) {
 			throw ex;
 		}
 
-		if (request.headers != null) {
-			for (Map.Entry<String, String> entry : request.headers.entrySet()) {
+		if (request.getHeaders() != null) {
+			for (Map.Entry<String, String> entry : request.getHeaders().entrySet()) {
 				httpPatch.setHeader(entry.getKey(), entry.getValue());
 			}
 		}
@@ -228,14 +228,14 @@ public Response put(Request request) throws URISyntaxException, IOException {
 		HttpPut httpPut = null;
 
 		try {
-			uri = buildUri(request.baseUri, request.endpoint, request.queryParams);
+			uri = buildUri(request.baseUri, request.endpoint, request.getQueryParams());
 			httpPut = new HttpPut(uri.toString());
 		} catch (URISyntaxException ex) {
 			throw ex;
 		}
 
-		if (request.headers != null) {
-			for (Map.Entry<String, String> entry : request.headers.entrySet()) {
+		if (request.getHeaders() != null) {
+			for (Map.Entry<String, String> entry : request.getHeaders().entrySet()) {
 				httpPut.setHeader(entry.getKey(), entry.getValue());
 			}
 		}
@@ -256,14 +256,14 @@ public Response delete(Request request) throws URISyntaxException, IOException {
 		HttpDeleteWithBody httpDelete = null;
 
 		try {
-			uri = buildUri(request.baseUri, request.endpoint, request.queryParams);
+			uri = buildUri(request.baseUri, request.endpoint, request.getQueryParams());
 			httpDelete = new HttpDeleteWithBody(uri.toString());
 		} catch (URISyntaxException ex) {
 			throw ex;
 		}
 
-		if (request.headers != null) {
-			for (Map.Entry<String, String> entry : request.headers.entrySet()) {
+		if (request.getHeaders() != null) {
+			for (Map.Entry<String, String> entry : request.getHeaders().entrySet()) {
 				httpDelete.setHeader(entry.getKey(), entry.getValue());
 			}
 		}
@@ -287,7 +287,7 @@ private Response executeApiCall(HttpRequestBase httpPost) throws IOException {
 				//throwing IOException here to not break API behavior.
 				throw new IOException("Request returned status Code "+statusLine.getStatusCode()+"Body:"+(response!=null?response.body:null));
 			}
-	
+
 		} finally {
 			if (serverResponse != null) {
 				serverResponse.close();

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

@@ -1,6 +1,7 @@
 package com.sendgrid;
 
 import java.util.Map;
+import java.util.HashMap;
 
 /**
   * Class Response provides a standard interface to an API's HTTP request.
@@ -10,10 +11,12 @@ public class Request {
   public String baseUri;
   public String endpoint;
   public String body;
-  public Map<String,String> headers;
-  public Map<String,String> queryParams;
+  private final Map<String, String> headers;
+  private final Map<String, String> queryParams;
 
   public Request() {
+    this.headers = new HashMap<String, String>();
+    this.queryParams = new HashMap<String, String>();
     this.reset();
   }
 
@@ -25,7 +28,15 @@ public void reset() {
     this.baseUri = "";
     this.endpoint = "";
     this.body = "";
-    this.headers = null;
-    this.queryParams = null;
+    this.headers.clear();
+    this.queryParams.clear();
+  }
+
+  public Map<String, String> getHeaders() {
+    return this.headers;
+  }
+
+  public Map<String, String> getQueryParams() {
+    return this.queryParams;
   }
 }

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

@@ -129,9 +129,7 @@ public void testMethod(Method method, int statusCode) {
         request.body = "{\"test\":\"testResult\"}";
       }
       request.endpoint = "/test";
-      Map<String,String> requestHeaders = new HashMap<String, String>();
-      requestHeaders.put("Authorization", "Bearer XXXX");
-      request.headers = requestHeaders;
+      request.getHeaders().put("Authorization", "Bearer XXXX");
       Client client = new Client(httpClient);
       testResponse = client.get(request);
     } catch (URISyntaxException | IOException ex) {