Merge pull request #15 from belfazt/make-request-object-have-sensible-default-13

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

Author: thinkingserious

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,17 +77,13 @@ 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.body ="{\"name\": \"My Request Body\"}";
-request.method = Method.POST;
+request.addHeader("Authorization", "Bearer YOUR_API_KEY");
+request.addQueryParam("limit", "100");
+request.addQueryParam("offset", "0");
+request.setBody("{\"name\": \"My Request Body\"}");
+request.setMethod(Method.POST);
 String param = "param";
-request.endpoint = "/your/api/" + param + "/call";
+request.setEndpoint("/your/api/" + param + "/call");
 
 try {
     Response response = client.api(request);

examples/Example.java

@@ -17,20 +17,16 @@ public static void main(String[] args) throws IOException {
     Client client = new Client();
 
     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.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";
-    Map<String,String> queryParams = new HashMap<String, String>();
-    queryParams.put("limit", "100");
-    queryParams.put("offset", "0");
-    request.queryParams = queryParams;
+    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);
@@ -39,13 +35,13 @@ public static void main(String[] args) throws IOException {
     } catch (IOException ex) {
       throw ex;
     }
-    request.queryParams = null;
+    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);
@@ -62,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);
@@ -77,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);
@@ -87,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);
@@ -101,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,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.getBaseUri(), request.getEndpoint(), 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,20 +171,20 @@ public Response post(Request request) throws URISyntaxException, IOException {
 		HttpPost httpPost = null;
 
 		try {
-			uri = buildUri(request.baseUri, request.endpoint, request.queryParams);
+			uri = buildUri(request.getBaseUri(), request.getEndpoint(), 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());
 			}
 		}
 
-		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,20 +200,20 @@ public Response patch(Request request) throws URISyntaxException, IOException {
 		HttpPatch httpPatch = null;
 
 		try {
-			uri = buildUri(request.baseUri, request.endpoint, request.queryParams);
+			uri = buildUri(request.getBaseUri(), request.getEndpoint(), 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());
 			}
 		}
 
-		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,20 +228,20 @@ public Response put(Request request) throws URISyntaxException, IOException {
 		HttpPut httpPut = null;
 
 		try {
-			uri = buildUri(request.baseUri, request.endpoint, request.queryParams);
+			uri = buildUri(request.getBaseUri(), request.getEndpoint(), 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());
 			}
 		}
 
-		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,20 +256,20 @@ public Response delete(Request request) throws URISyntaxException, IOException {
 		HttpDeleteWithBody httpDelete = null;
 
 		try {
-			uri = buildUri(request.baseUri, request.endpoint, request.queryParams);
+			uri = buildUri(request.getBaseUri(), request.getEndpoint(), 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());
 			}
 		}
 
-		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");
 		}
 
@@ -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();
@@ -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: