#15 - Add PATCH, HEAD, TRACE verbs, bump to upper case VERB methods and deprecate the existing lower case one

Author: rbygrave

client/src/main/java/io/avaje/http/client/DHttpClientRequest.java

@@ -22,6 +22,10 @@ class DHttpClientRequest implements HttpClientRequest, HttpClientResponse {
 
   private static final String CONTENT_TYPE = "Content-Type";
   private static final String CONTENT_ENCODING = "Content-Encoding";
+  private static final String VERB_DELETE = "DELETE";
+  private static final String VERB_HEAD = "HEAD";
+  private static final String VERB_PATCH = "PATCH";
+  private static final String VERB_TRACE = "TRACE";
 
   private final DHttpClientContext context;
   private final UrlBuilder url;
@@ -211,7 +215,7 @@ private HttpRequest.BodyPublisher body() {
     } else if (formParams != null) {
       return bodyFromForm();
     } else {
-      return null;
+      return HttpRequest.BodyPublishers.noBody();
     }
   }
 
@@ -264,29 +268,47 @@ private void addHeaders() {
     }
   }
 
-  public HttpClientResponse get() {
+  @Override
+  public HttpClientResponse HEAD() {
+    httpRequest = newHead(url.build());
+    return this;
+  }
+
+  public HttpClientResponse GET() {
     httpRequest = newGet(url.build());
     return this;
   }
 
   @Override
-  public HttpClientResponse delete() {
-    httpRequest = newDelete(url.build());
+  public HttpClientResponse DELETE() {
+    httpRequest = newDelete(url.build(), body());
     return this;
   }
 
   @Override
-  public HttpClientResponse post() {
+  public HttpClientResponse POST() {
     httpRequest = newPost(url.build(), body());
     return this;
   }
 
   @Override
-  public HttpClientResponse put() {
+  public HttpClientResponse PUT() {
     httpRequest = newPut(url.build(), body());
     return this;
   }
 
+  @Override
+  public HttpClientResponse PATCH() {
+    httpRequest = newPatch(url.build(), body());
+    return this;
+  }
+
+  @Override
+  public HttpClientResponse TRACE() {
+    httpRequest = newTrace(url.build(), body());
+    return this;
+  }
+
   private void readResponseContent() {
     final HttpResponse<byte[]> response = asByteArray();
     this.httpResponse = response;
@@ -368,30 +390,39 @@ public HttpResponse<Stream<String>> asLines() {
     return withResponseHandler(HttpResponse.BodyHandlers.ofLines());
   }
 
-  protected HttpRequest.Builder newGet(String url) {
+  private HttpRequest.Builder newReq(String url) {
     return HttpRequest.newBuilder()
       .uri(URI.create(url))
-      .timeout(requestTimeout)
-      .GET();
+      .timeout(requestTimeout);
   }
 
-  protected HttpRequest.Builder newDelete(String url) {
-    return HttpRequest.newBuilder()
-      .uri(URI.create(url))
-      .timeout(requestTimeout)
-      .DELETE();
+  private HttpRequest.Builder newHead(String url) {
+    return newRequest(VERB_HEAD, url, HttpRequest.BodyPublishers.noBody());
+  }
+
+  private HttpRequest.Builder newGet(String url) {
+    return newReq(url).GET();
+  }
+
+  private HttpRequest.Builder newPost(String url, HttpRequest.BodyPublisher body) {
+    return newReq(url).POST(body);
+  }
+
+  private HttpRequest.Builder newPut(String url, HttpRequest.BodyPublisher body) {
+    return newReq(url).PUT(body);
   }
 
-  public HttpRequest.Builder newPost(String url, HttpRequest.BodyPublisher body) {
-    return newRequest("POST", url, body);
+  private HttpRequest.Builder newPatch(String url, HttpRequest.BodyPublisher body) {
+    return newRequest(VERB_PATCH, url, body);
   }
 
-  public HttpRequest.Builder newPut(String url, HttpRequest.BodyPublisher body) {
-    return newRequest("PUT", url, body);
+  private HttpRequest.Builder newDelete(String url, HttpRequest.BodyPublisher body) {
+    // allow DELETE to have a body
+    return newRequest(VERB_DELETE, url, body);
   }
 
-  public HttpRequest.Builder newPatch(String url, HttpRequest.BodyPublisher body) {
-    return newRequest("PATCH", url, body);
+  private HttpRequest.Builder newTrace(String url, HttpRequest.BodyPublisher body) {
+    return newRequest(VERB_TRACE, url, body);
   }
 
   protected HttpRequest.Builder newRequest(String method, String url, HttpRequest.BodyPublisher body) {

client/src/main/java/io/avaje/http/client/HttpClientRequest.java

@@ -228,24 +228,79 @@ public interface HttpClientRequest {
    */
   HttpClientRequest body(HttpRequest.BodyPublisher body);
 
+  /**
+   * Deprecated migrate to GET().
+   */
+  @Deprecated
+  default HttpClientResponse get() {
+    return GET();
+  }
+
+  /**
+   * Deprecated migrate to POST().
+   */
+  @Deprecated
+  default HttpClientResponse post() {
+    return POST();
+  }
+
+  /**
+   * Deprecated migrate to PUT().
+   */
+  @Deprecated
+  default HttpClientResponse put() {
+    return PUT();
+  }
+
+  /**
+   * Deprecated migrate to PATCH().
+   */
+  @Deprecated
+  default HttpClientResponse patch() {
+    return PATCH();
+  }
+
+  /**
+   * Deprecated migrate to DELETE().
+   */
+  @Deprecated
+  default HttpClientResponse delete() {
+    return DELETE();
+  }
+
   /**
    * Execute the request as a GET.
    */
-  HttpClientResponse get();
+  HttpClientResponse GET();
 
   /**
    * Execute the request as a POST.
    */
-  HttpClientResponse post();
+  HttpClientResponse POST();
 
   /**
    * Execute the request as a PUT.
    */
-  HttpClientResponse put();
+  HttpClientResponse PUT();
+
+  /**
+   * Execute the request as a PATCH.
+   */
+  HttpClientResponse PATCH();
 
   /**
    * Execute the request as a DELETE.
    */
-  HttpClientResponse delete();
+  HttpClientResponse DELETE();
+
+  /**
+   * Execute the request as a TRACE.
+   */
+  HttpClientResponse TRACE();
+
+  /**
+   * Execute the request as a HEAD.
+   */
+  HttpClientResponse HEAD();
 
 }

client/src/test/java/io/avaje/http/client/VerbTest.java

@@ -0,0 +1,115 @@
+package io.avaje.http.client;
+
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+
+import java.net.http.HttpResponse;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class VerbTest extends BaseWebTest {
+
+  private final HttpClientContext clientContext = client();
+
+  @Test
+  void post() {
+
+    HttpResponse<String> res = clientContext.request()
+      .path("post")
+      .POST()
+      .asString();
+
+    assertThat(res.body()).isEqualTo("post");
+
+    HttpResponse<String> res2 = clientContext.request()
+      .path("post")
+      .post()
+      .asString();
+
+    assertThat(res2.body()).isEqualTo("post");
+  }
+
+  @Test
+  void put() {
+
+    HttpResponse<String> res = clientContext.request()
+      .path("put")
+      .PUT()
+      .asString();
+
+    assertThat(res.body()).isEqualTo("put");
+
+    HttpResponse<String> res2 = clientContext.request()
+      .path("put")
+      .put()
+      .asString();
+
+    assertThat(res2.body()).isEqualTo("put");
+  }
+
+  @Test
+  void patch() {
+
+    HttpResponse<String> res = clientContext.request()
+      .path("patch")
+      .PATCH().asString();
+
+    assertThat(res.body()).isEqualTo("patch");
+  }
+
+  @Disabled
+  @Test()
+  void trace() {
+
+    HttpResponse<String> res = clientContext.request()
+      .path("patch")
+      .TRACE().asString();
+
+    assertThat(res.body()).isEqualTo("patch");
+  }
+
+  @Test
+  void delete() {
+
+    HttpResponse<String> res = clientContext.request()
+      .path("delete")
+      .DELETE().asString();
+
+    assertThat(res.body()).isEqualTo("delete body[]");
+  }
+
+  @Test
+  void delete_with_body() {
+
+    HttpResponse<String> res = clientContext.request()
+      .path("delete")
+      .body("dummy")
+      .DELETE().asString();
+
+    assertThat(res.body()).isEqualTo("delete body[dummy]");
+  }
+
+  @Test
+  void head() {
+
+    HttpResponse<String> res = clientContext.request()
+      .path("head")
+      .body("dummy")
+      .HEAD().asString();
+
+    assertThat(res.statusCode()).isEqualTo(200);
+    assertThat(res.body()).isEqualTo("");
+  }
+
+  @Test
+  void get() {
+
+    HttpResponse<String> res = clientContext.request()
+      .path("get")
+      .body("dummy")
+      .GET().asString();
+
+    assertThat(res.body()).isEqualTo("get");
+  }
+
+}

client/src/test/java/org/example/webserver/App.java

@@ -56,9 +56,14 @@ public static Javalin start(int port) {
       ctx.json(map);
     });
 
-    app.get("/", ctx -> {
-      ctx.result("Hello World");
-    });
+    app.get("/", ctx -> ctx.result("Hello World"));
+    app.head("/head", ctx -> ctx.result("head"));
+    app.get("/get", ctx -> ctx.result("get"));
+    app.post("/post", ctx -> ctx.result("post"));
+    app.put("/put", ctx -> ctx.result("put"));
+    app.patch("/patch", ctx -> ctx.result("patch"));
+    //app.tra("/patch", ctx -> ctx.result("patch"));
+    app.delete("/delete", ctx -> ctx.result("delete body[" + ctx.body() + "]"));
 
 //    // All WebRoutes / Controllers ... from DI Context
 //    List<WebRoutes> webRoutes = context.getBeans(WebRoutes.class);