Add JAX-RS PATCH annotation

CHANGELOG.md

@@ -7,13 +7,12 @@
 
 ### Enhancements
 * Disable the stagemonitor web widget in the service generated by the archetype, as the default configuration.
+* Added toString implementation to DelegatingGenericResponse and BuiltGenericResponse.
+* Added a PATCH annotation.
 
 ### Defects Corrected
 * Cleaned up dependencies and fixed few minor issues with generated code in archetype.
 
-### Enhancements
-* Added toString implementation to DelegatingGenericResponse and BuiltGenericResponse.
-
 ## 2.4 - 16 Feb 2017
 
 ### Additions

CONTRIBUTORS.md

@@ -12,6 +12,7 @@
 * Jason Gassel [@jpeg][jason-gassel]
 * Andy Nelson [@anelson425][andy-nelson]
 * Bryan Baugher [@bbaugher][bryan-baugher]
+* Eric Christensen [@EricChristensen][eric-christensen]
 
 [john-leacox]: https://github.com/johnlcox
 [jacob-williams]: https://github.com/brokensandals
@@ -25,3 +26,4 @@
 [jason-gassel]: https://github.com/jpeg
 [andy-nelson]: https://github.com/anelson425
 [bryan-baugher]: https://github.com/bbaugher
+[eric-christensen]: https://github.com/EricChristensen

checkstyle-suppressions.xml

@@ -4,4 +4,5 @@
     <suppress files="generated-sources" checks=".*"/>
     <suppress files="generated-test-sources" checks=".*"/>
     <suppress files="com.cerner.beadledom.client.resteasy.ApacheHttpClient4Dot3Engine" checks=".*"/>
+    <suppress files="com.cerner.beadledom.jaxrs.PATCH" checks="AbbreviationAsWordInName" />
 </suppressions>

jaxrs/src/main/java/com/cerner/beadledom/jaxrs/PATCH.java

@@ -0,0 +1,14 @@
+package com.cerner.beadledom.jaxrs;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import javax.ws.rs.HttpMethod;
+
+@Target({ElementType.METHOD})
+@Retention(RetentionPolicy.RUNTIME)
+@HttpMethod("PATCH")
+public @interface PATCH {
+}

jaxrs/src/test/java/com/cerner/beadledom/jaxrs/provider/FakeModel.java

@@ -28,6 +28,10 @@ public class FakeModel {
   @JsonProperty("inner_models")
   public List<FakeInnerModel> innerModels;
 
+  public FakeModel() {
+
+  }
+
   public FakeModel(
       String id, String name, int times, List<String> tags, List<FakeInnerModel> innerModels) {
     this.id = id;
@@ -37,6 +41,32 @@ public FakeModel(
     this.innerModels = innerModels;
   }
 
+  public FakeModel setId(String id) {
+    this.id = id;
+    return this;
+  }
+
+  public FakeModel setName(String name) {
+    this.name = name;
+    return this;
+  }
+
+  public FakeModel setTimes(int times) {
+    this.times = times;
+    return this;
+  }
+
+  public FakeModel setTags(List<String> tags) {
+    this.tags = tags;
+    return this;
+  }
+
+  public FakeModel setInnerModels(
+      List<FakeInnerModel> innerModels) {
+    this.innerModels = innerModels;
+    return this;
+  }
+
   @JsonProperty("id")
   public String getId() {
     return id;

jaxrs/src/test/java/com/cerner/beadledom/jaxrs/provider/FakeResource.java

@@ -0,0 +1,24 @@
+package com.cerner.beadledom.jaxrs.provider;
+
+import com.cerner.beadledom.jaxrs.PATCH;
+
+import javax.ws.rs.Consumes;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+
+@Path("/fakeResource")
+public class FakeResource {
+
+  @PATCH
+  @Path("/Patch")
+  @Produces(MediaType.APPLICATION_JSON)
+  @Consumes(MediaType.APPLICATION_JSON)
+  public Response fakePatch(FakeModel model) {
+    model.setId("newId");
+    model.setName("newName");
+    return Response.ok(model).build();
+  }
+
+}

jaxrs/src/test/scala/com/cerner/beadledom/jaxrs/PATCHSpec.scala

@@ -0,0 +1,77 @@
+package com.cerner.beadledom.jaxrs
+
+import com.cerner.beadledom.jaxrs.provider.{FakeModel, FakeResource}
+
+import com.fasterxml.jackson.databind.ObjectMapper
+import com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider
+
+import org.jboss.resteasy.core.Dispatcher
+import org.jboss.resteasy.mock.{MockDispatcherFactory, MockHttpRequest, MockHttpResponse}
+import org.jboss.resteasy.plugins.server.resourcefactory.POJOResourceFactory
+import org.scalatest._
+import org.scalatest.mock.MockitoSugar
+
+import java.io._
+
+import scala.collection.JavaConverters._
+import javax.ws.rs.core.MediaType
+
+/**
+  * Spec tests for {@link PATCH}.
+  *
+  * @author Eric Christensen
+  */
+class PATCHSpec extends FunSpec with BeforeAndAfterAll with ShouldMatchers with MockitoSugar {
+
+    val dispatcher: Dispatcher = MockDispatcherFactory.createDispatcher()
+    val noDefaults: POJOResourceFactory = new POJOResourceFactory(classOf[FakeResource])
+    dispatcher.getRegistry.addResourceFactory(noDefaults)
+    dispatcher.getProviderFactory.registerProvider(classOf[JacksonJsonProvider])
+
+    describe("PATCH") {
+      it("calls PATCH resource without error") {
+
+        val model = new FakeModel()
+            .setId("id")
+            .setName("name")
+            .setTimes(10)
+            .setTags(List.empty[String].asJava)
+            .setInnerModels(List.empty[FakeModel.FakeInnerModel].asJava)
+
+        val mapper = new ObjectMapper
+        val request: MockHttpRequest = MockHttpRequest.create("PATCH", "/fakeResource/Patch")
+        request.contentType(MediaType.APPLICATION_JSON)
+        request.content(new ByteArrayInputStream(mapper.writeValueAsBytes(model)))
+
+        val response: MockHttpResponse = new MockHttpResponse()
+        dispatcher.invoke(request, response)
+
+        response.getStatus shouldBe 200
+      }
+
+      it("should change the request model fields") {
+
+        val model = new FakeModel()
+            .setId("id")
+            .setName("name")
+            .setTimes(10)
+            .setTags(List.empty[String].asJava)
+            .setInnerModels(List.empty[FakeModel.FakeInnerModel].asJava)
+
+        val mapper = new ObjectMapper
+        val request: MockHttpRequest = MockHttpRequest.create("PATCH", "/fakeResource/Patch")
+        request.contentType(MediaType.APPLICATION_JSON)
+        request.content(new ByteArrayInputStream(mapper.writeValueAsBytes(model)))
+
+        val response: MockHttpResponse = new MockHttpResponse()
+        dispatcher.invoke(request, response)
+
+        response.getStatus shouldBe 200
+
+        val newModel: FakeModel = mapper.readValue(response.getContentAsString, classOf[FakeModel])
+        newModel.name shouldBe "newName"
+        newModel.id shouldBe "newId"
+        newModel.times shouldBe 10
+      }
+    }
+}