Update version to 1.10.0

Add id field to attributes (more usable for api clients)

Author: devslm

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [1.10.0] - 2023-02-21
+### Changed:
+  - Add id field to attributes (more usable for api clients)
+  - Update all dependencies versions
+
 ## [1.9.0] - 2022-11-07
 ### Added:
   - Trace object with id field to meta object

README.md

@@ -16,10 +16,13 @@ Add dependency to your project:
 <dependency>
     <groupId>com.slm-dev</groupId>
     <artifactId>jsonapi-simple</artifactId>
-    <version>1.9.0</version>
+    <version>1.10.0</version>
 </dependency>
 ```
 
+> **Warning:**
+> The id field is included in the attributes because it more convenient for API clients.
+
 ### Build Response
 
 See documentation part: [response structure](https://jsonapi.org/format/#document-structure)
@@ -100,6 +103,7 @@ This produces response like:
     "type":"some-data-type",
     "id":"<random-uuid-id> or <fixed-id>",
     "attributes": {
+      "id":"<random-uuid-id> or <fixed-id>",
       "name": "Test string"
     },
     "links": {
@@ -376,6 +380,7 @@ public class Test {
     "type":"test-object",
     "id":"7a543e90-2961-480e-b1c4-51249bf0c566",
     "attributes": {
+      "id":"7a543e90-2961-480e-b1c4-51249bf0c566",
       "name":"Test string",
       "createDate":"2019-10-08T18:46:53.40297"
     }, 
@@ -433,6 +438,7 @@ public class Test {
       "type":"test-object",
       "id":"7a543e90-2961-480e-b1c4-51249bf0c566",
       "attributes": {
+        "id":"7a543e90-2961-480e-b1c4-51249bf0c566",
         "name":"Test string 1",
         "createDate":"2019-10-08T18:46:53"
       }, 
@@ -441,7 +447,8 @@ public class Test {
       }
     },
     {
-      "type":"test-object",
+      "type":"test-object", 
+      "id":"b4070518-e9fc-11e9-81b4-2a2ae2dbcce4",
       "attributes": {
         "id":"b4070518-e9fc-11e9-81b4-2a2ae2dbcce4",
         "name":"Test string 2",
@@ -602,6 +609,7 @@ public class Test {
         "type":"test-object",
         "id":"7a543e90-2961-480e-b1c4-51249bf0c566",
         "attributes": {
+            "id":"7a543e90-2961-480e-b1c4-51249bf0c566",
             "name":"Test string",
             "createDate":"2019-10-08T18:46:53.40297"
         },

pom.xml

@@ -4,7 +4,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.slm-dev</groupId>
 	<artifactId>jsonapi-simple</artifactId>
-	<version>1.9.0</version>
+	<version>1.10.0</version>
 	<name>jsonapi-simple</name>
 	<description>Simple implementation of the JSON:API specification</description>
 	<url>https://slm-dev.com/jsonapi-simple/</url>
@@ -35,22 +35,22 @@
 	<properties>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<java.version>11</java.version>
-		<spring.web.version>5.3.23</spring.web.version>
-		<spring.data.commons.version>2.7.5</spring.data.commons.version>
-		<lombok.version>1.18.24</lombok.version>
+		<spring.web.version>5.3.25</spring.web.version>
+		<spring.data.commons.version>2.7.8</spring.data.commons.version>
+		<lombok.version>1.18.26</lombok.version>
 		<lombok.maven.plugin.version>1.18.20.0</lombok.maven.plugin.version>
-		<jackson.version>2.13.4.2</jackson.version>
-		<jackson.datatype.version>2.13.4</jackson.datatype.version>
-		<sprinfox.version>3.0.0</sprinfox.version>
-		<junit.version>5.9.0</junit.version>
+		<jackson.version>2.14.2</jackson.version>
+		<jackson.datatype.version>2.14.2</jackson.datatype.version>
+		<springfox.version>3.0.0</springfox.version>
+		<junit.version>5.9.2</junit.version>
 		<hamcrest.version>2.2</hamcrest.version>
-		<mockito.version>4.8.0</mockito.version>
+		<mockito.version>5.1.1</mockito.version>
 		<maven.compiler.version>3.10.1</maven.compiler.version>
 		<maven.surefire.version>2.22.2</maven.surefire.version>
 		<maven.deploy.version>2.8.2</maven.deploy.version>
-		<nexus.staging.maven.version>1.6.12</nexus.staging.maven.version>
+		<nexus.staging.maven.version>1.6.13</nexus.staging.maven.version>
 		<maven.source.version>3.2.1</maven.source.version>
-		<maven.javadoc.version>3.4.1</maven.javadoc.version>
+		<maven.javadoc.version>3.5.0</maven.javadoc.version>
 		<maven.gpg.version>3.0.1</maven.gpg.version>
 	</properties>
 
@@ -88,7 +88,7 @@
 		<dependency>
 			<groupId>io.springfox</groupId>
 			<artifactId>springfox-swagger2</artifactId>
-			<version>${sprinfox.version}</version>
+			<version>${springfox.version}</version>
 		</dependency>
 
 		<dependency>

src/main/java/com/slmdev/jsonapi/simple/response/Data.java

@@ -1,6 +1,5 @@
 package com.slmdev.jsonapi.simple.response;
 
-import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
@@ -15,7 +14,6 @@
 public class Data<T> {
     private String type;
     private String id;
-    @JsonIgnoreProperties({"id"})
     private T attributes;
     private Link links;
 

src/test/java/com/slmdev/jsonapi/simple/response/ResponseTest.java

@@ -19,8 +19,7 @@
 import java.util.UUID;
 
 import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.is;
-import static org.hamcrest.Matchers.nullValue;
+import static org.hamcrest.Matchers.*;
 
 public class ResponseTest {
 	private static final String TEST_RESPONSE_URI = "/api/v1";
@@ -58,7 +57,7 @@ public void shouldReturnResponseWithDataAs1ObjectWithoutErrorsAndUriSpecified()
 		assertThat(response.getMeta().getPage().getMaxSize(), is(25));
 		assertThat(response.getMeta().getPage().getTotal(), is(1L));
 
-		assertThatAttributesIdFieldIsAbsentInObject(response);
+		assertThatAttributesIdFieldIsPresentInObject(response);
 	}
 
 	@Test
@@ -92,7 +91,7 @@ public void shouldReturnResponseWithDataListWithoutErrorsAndUriSpecified() {
 		assertThat(response.getMeta().getPage().getMaxSize(), is(25));
 		assertThat(response.getMeta().getPage().getTotal(), is(2L));
 
-		assertThatAttributesIdFieldIsAbsentInCollection(response);
+		assertThatAttributesIdFieldIsPresentInCollection(response);
 	}
 
 	@Test
@@ -116,7 +115,7 @@ public void shouldReturnResponseWithDataAndUriSpecifiedWithoutUriPlaceholdersAnd
 		assertThat(response.getMeta().getPage().getMaxSize(), is(25));
 		assertThat(response.getMeta().getPage().getTotal(), is(1L));
 
-		assertThatAttributesIdFieldIsAbsentInObject(response);
+		assertThatAttributesIdFieldIsPresentInObject(response);
 	}
 
 	@Test
@@ -143,7 +142,7 @@ public void shouldReturnResponseWithDataAndUriSpecifiedAndUriPlaceholdersWithout
 		assertThat(response.getMeta().getPage().getMaxSize(), is(25));
 		assertThat(response.getMeta().getPage().getTotal(), is(1L));
 
-		assertThatAttributesIdFieldIsAbsentInObject(response);
+		assertThatAttributesIdFieldIsPresentInObject(response);
 	}
 
 
@@ -373,15 +372,15 @@ public void shouldParseJsonResponseWithListData() {
 
 		assertThat(response.getData().get(0).getType(), is("cars"));
 		assertThat(response.getData().get(0).getId(), is("M5"));
-		assertThat(response.getData().get(0).getAttributes().getId(), nullValue());
 		assertThat(response.getData().get(0).getAttributes().getBrand(), is("BMW"));
 
 		assertThat(response.getData().get(1).getType(), is("cars"));
 		assertThat(response.getData().get(1).getId(), is("911"));
-		assertThat(response.getData().get(1).getAttributes().getId(), nullValue());
 		assertThat(response.getData().get(1).getAttributes().getBrand(), is("Porshe"));
 
 		assertThat(response.getMeta().getApi().getVersion(), is("1"));
+
+		assertThatAttributesIdFieldIsPresentInCollection(response);
 	}
 
 	@Test
@@ -410,10 +409,11 @@ public void shouldParseJsonResponseWithSingleObjectData() {
 
 		assertThat(response.getData().getType(), is("cars"));
 		assertThat(response.getData().getId(), is("M5"));
-		assertThat(response.getData().getAttributes().getId(), nullValue());
 		assertThat(response.getData().getAttributes().getBrand(), is("BMW"));
 
 		assertThat(response.getMeta().getApi().getVersion(), is("1"));
+
+		assertThatAttributesIdFieldIsPresentInObject(response);
 	}
 
 	@lombok.Data
@@ -519,27 +519,27 @@ private void assertErrorResponse(final @NonNull Response<?> response) {
 	}
 
 	@SuppressWarnings("unchecked")
-	private void assertThatAttributesIdFieldIsAbsentInCollection(final @NonNull Response<List<Data<TestDto>>> response) {
+	private void assertThatAttributesIdFieldIsPresentInCollection(final @NonNull Object response) {
 		final Map<String, Object> responseMap = objectMapper.convertValue(response, Map.class);
 
 		((List<Object>)responseMap.get("data")).forEach(dataItem -> {
 			final Object idAttributeField = ((Map<String, Object>)((Map<String, Object>)dataItem)
 				.get("attributes"))
 				.get("id");
 
-			assertThat(idAttributeField, nullValue());
+			assertThat(idAttributeField, notNullValue());
 		});
 	}
 
 	@SuppressWarnings("unchecked")
-	private void assertThatAttributesIdFieldIsAbsentInObject(final @NonNull Response<Data<TestDto>> response) {
+	private void assertThatAttributesIdFieldIsPresentInObject(final @NonNull Object response) {
 		final Map<String, Object> responseMap = objectMapper.convertValue(response, Map.class);
 
 		final Object idAttributeField = ((Map<String, Object>)((Map<String, Object>)responseMap
 			.get("data"))
 			.get("attributes"))
 			.get("id");
 
-		assertThat(idAttributeField, nullValue());
+		assertThat(idAttributeField, notNullValue());
 	}
 }