Added the ability to update a Dataset

src/it/java/io/github/jpmorganchase/fusion/packaging/DatasetOperationsIT.java

@@ -144,6 +144,37 @@ public void testCreateDatasetOverrideDefaultCatalog() {
         //TODO :: Contract for response of dataset.create() needs to be decided
     }
 
+    @Test
+    public void testUpdateDatasetRetrievedFromListDatasets() {
+        // Given
+        wireMockRule.stubFor(WireMock.get(WireMock.urlEqualTo("/catalogs/common/datasets"))
+                .willReturn(WireMock.aResponse()
+                        .withHeader("Content-Type", "application/json")
+                        .withStatus(200)
+                        .withBodyFile("dataset/multiple-dataset-response.json")));
+
+        wireMockRule.stubFor(WireMock.put(WireMock.urlEqualTo("/catalogs/common/datasets/SD0001"))
+                .withRequestBody(equalToJson(TestUtils.loadJsonForIt("dataset/dataset-SD0001-update-request.json")))
+                .willReturn(WireMock.aResponse()
+                        .withHeader("Content-Type", "application/json")
+                        .withStatus(200)
+                        .withBodyFile("dataset/dataset-create-response.json")));
+
+        Map<String, Dataset> datasets = sdk.listDatasets("common", "SD0001", true);
+        Dataset originalDataset = datasets.get("SD0001");
+
+        // When
+        Dataset amendedDataset = originalDataset
+                .toBuilder()
+                .description("Updated Sample dataset description 1")
+                .build();
+
+        amendedDataset.update();
+
+        // Then Verify the response
+        //TODO :: Contract for response of dataset.create() needs to be decided
+    }
+
     @Test
     public void testListDatasets() {
         // Given

src/main/java/io/github/jpmorganchase/fusion/Fusion.java

@@ -4,6 +4,7 @@
 
 import io.github.jpmorganchase.fusion.api.APIManager;
 import io.github.jpmorganchase.fusion.api.FusionAPIManager;
+import io.github.jpmorganchase.fusion.api.context.APIContext;
 import io.github.jpmorganchase.fusion.api.exception.APICallException;
 import io.github.jpmorganchase.fusion.api.exception.ApiInputValidationException;
 import io.github.jpmorganchase.fusion.api.exception.FileDownloadException;
@@ -52,12 +53,13 @@ public class Fusion {
     private String defaultPath;
     private String rootURL;
 
-    @Builder.Default
-    private APIResponseParser responseParser = new GsonAPIResponseParser();
+    private APIResponseParser responseParser;
 
     @Builder.Default
     private APIRequestSerializer requestSerializer = new GsonAPIRequestSerializer();
 
+    private APIContext apiContext;
+
     /**
      * Get the default download path - Please see default {@link FusionConfiguration}
      */
@@ -808,6 +810,10 @@ public static class FusionBuilder {
         protected FusionConfiguration configuration =
                 FusionConfiguration.builder().build();
 
+        protected APIResponseParser responseParser;
+        protected APIRequestSerializer requestSerializer;
+        protected APIContext apiContext;
+
         public FusionBuilder configuration(FusionConfiguration configuration) {
             this.configuration = configuration;
             return this;
@@ -856,6 +862,10 @@ private FusionBuilder defaultCatalog(String defaultCatalog) {
         private FusionBuilder defaultPath(String defaultPath) {
             return this;
         }
+
+        private FusionBuilder apiContext(APIContext apiContext) {
+            return this;
+        }
     }
 
     private static class CustomFusionBuilder extends FusionBuilder {
@@ -894,6 +904,16 @@ public Fusion build() {
                         .build();
             }
 
+            apiContext = APIContext.builder()
+                    .apiManager(api)
+                    .rootUrl(rootURL)
+                    .defaultCatalog(defaultCatalog)
+                    .build();
+
+            if (Objects.isNull(responseParser)) {
+                responseParser = new GsonAPIResponseParser(apiContext);
+            }
+
             return super.build();
         }
     }

src/main/java/io/github/jpmorganchase/fusion/api/APIManager.java

@@ -25,4 +25,14 @@ public interface APIManager extends APIDownloadOperations, APIUploadOperations {
      * @throws APICallException if the response status indicates an error or the request fails
      */
     String callAPIToPost(String apiPath, CatalogResource catalogResource);
+
+    /**
+     * Sends a PUT request to the specified API endpoint with the provided catalog resource.
+     *
+     * @param apiPath         the API endpoint path to which the PUT request will be sent
+     * @param catalogResource the resource object to be serialized and sent as the request body
+     * @return the response body as a {@code String} if the request is successful
+     * @throws APICallException if the response status indicates an error or the request fails
+     */
+    String callAPIToPut(String apiPath, CatalogResource catalogResource);
 }

src/main/java/io/github/jpmorganchase/fusion/api/FusionAPIManager.java

@@ -87,6 +87,24 @@ public String callAPIToPost(String apiPath, CatalogResource catalogResource) thr
         return response.getBody();
     }
 
+    /**
+     * Sends a PUT request to the specified API endpoint with the provided catalog resource.
+     *
+     * @param apiPath         the API endpoint path to which the PUT request will be sent
+     * @param catalogResource the resource object to be serialized and sent as the request body
+     * @return the response body as a {@code String} if the request is successful
+     * @throws APICallException if the response status indicates an error or the request fails
+     */
+    @Override
+    public String callAPIToPut(String apiPath, CatalogResource catalogResource) {
+        Map<String, String> requestHeaders = new HashMap<>();
+        requestHeaders.put("Authorization", "Bearer " + tokenProvider.getSessionBearerToken());
+
+        HttpResponse<String> response = httpClient.put(apiPath, serializer.serialize(catalogResource), requestHeaders);
+        checkResponseStatus(response);
+        return response.getBody();
+    }
+
     @Override
     public void callAPIFileDownload(
             String apiPath, String fileName, String catalog, String dataset, Map<String, String> headers)

src/main/java/io/github/jpmorganchase/fusion/api/context/APIContext.java

@@ -0,0 +1,18 @@
+package io.github.jpmorganchase.fusion.api.context;
+
+import io.github.jpmorganchase.fusion.api.APIManager;
+import lombok.Builder;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+import lombok.Value;
+
+@Value
+@Builder
+@EqualsAndHashCode
+@ToString
+public class APIContext {
+
+    APIManager apiManager;
+    String rootUrl;
+    String defaultCatalog;
+}

src/main/java/io/github/jpmorganchase/fusion/http/Client.java

@@ -13,5 +13,7 @@ public interface Client {
 
     HttpResponse<String> put(String path, Map<String, String> headers, InputStream body);
 
+    HttpResponse<String> put(String path, String body, Map<String, String> headers);
+
     HttpResponse<String> delete(String path, Map<String, String> headers, String body);
 }

src/main/java/io/github/jpmorganchase/fusion/http/JdkClient.java

@@ -38,6 +38,11 @@ public HttpResponse<String> post(String path, Map<String, String> headers, Strin
         return executeMethod(METHOD_POST, path, headers, body);
     }
 
+    @Override
+    public HttpResponse<String> put(String path, String body, Map<String, String> headers) {
+        return executeMethod(METHOD_PUT, path, headers, body);
+    }
+
     @Override
     public HttpResponse<String> put(String path, Map<String, String> headers, InputStream body) {
         if (body == null) {

src/main/java/io/github/jpmorganchase/fusion/model/CatalogResource.java

@@ -16,7 +16,6 @@ public abstract class CatalogResource {
 
     private final String identifier;
 
-    @Setter
     private Map<String, Object> varArgs;
 
     @Expose(serialize = false, deserialize = false)
@@ -26,6 +25,7 @@ public abstract class CatalogResource {
     private final String rootUrl;
 
     @Expose(serialize = false, deserialize = false)
+    @Getter
     private final String catalogIdentifier;
 
     public CatalogResource(
@@ -45,6 +45,10 @@ public String create() {
         return this.apiManager.callAPIToPost(getApiPath(), this);
     }
 
+    public String update() {
+        return this.apiManager.callAPIToPut(getApiPath(), this);
+    }
+
     /**
      * Returns the API path used to perform operations on this catalog resource.
      * This path is utilized for creating, reading, updating, and deleting the resource.

src/main/java/io/github/jpmorganchase/fusion/model/Dataset.java

@@ -22,13 +22,13 @@ public class Dataset extends CatalogResource {
     String title;
     String frequency;
 
-    @Builder
+    @Builder(toBuilder = true)
     public Dataset(
-            String identifier,
-            Map<String, Object> varArgs,
-            APIManager apiManager,
-            String rootUrl,
-            String catalogIdentifier,
+            @Builder.ObtainVia(method = "getIdentifier") String identifier,
+            @Builder.ObtainVia(method = "getVarArgs") Map<String, Object> varArgs,
+            @Builder.ObtainVia(method = "getApiManager") APIManager apiManager,
+            @Builder.ObtainVia(method = "getRootUrl") String rootUrl,
+            @Builder.ObtainVia(method = "getCatalogIdentifier") String catalogIdentifier,
             String description,
             String linkedEntity,
             String title,

src/main/java/io/github/jpmorganchase/fusion/parsing/APIResponseParser.java

@@ -2,6 +2,7 @@
 
 import io.github.jpmorganchase.fusion.api.response.UploadedPart;
 import io.github.jpmorganchase.fusion.model.*;
+import io.github.jpmorganchase.fusion.serializing.mutation.ResourceMutationFactory;
 import java.util.Map;
 
 public interface APIResponseParser {
@@ -20,7 +21,7 @@ public interface APIResponseParser {
     <T extends CatalogResource> Map<String, T> parseResourcesFromResponse(String json, Class<T> resourceClass);
 
     <T extends CatalogResource> Map<String, T> parseResourcesWithVarArgsFromResponse(
-            String json, Class<T> resourceClass);
+            String json, Class<T> resourceClass, ResourceMutationFactory<T> mutator);
 
     Map<String, Map<String, Object>> parseResourcesUntyped(String json);
 

src/main/java/io/github/jpmorganchase/fusion/parsing/GsonAPIResponseParser.java

@@ -2,8 +2,11 @@
 
 import com.google.gson.*;
 import com.google.gson.reflect.TypeToken;
+import io.github.jpmorganchase.fusion.api.context.APIContext;
 import io.github.jpmorganchase.fusion.api.response.UploadedPart;
 import io.github.jpmorganchase.fusion.model.*;
+import io.github.jpmorganchase.fusion.serializing.mutation.MutationContext;
+import io.github.jpmorganchase.fusion.serializing.mutation.ResourceMutationFactory;
 import java.lang.invoke.MethodHandles;
 import java.lang.reflect.Field;
 import java.lang.reflect.Type;
@@ -22,16 +25,22 @@ public class GsonAPIResponseParser implements APIResponseParser {
             LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
     private final Gson gson;
+    private final APIContext apiContext;
 
     public GsonAPIResponseParser() {
+        this(APIContext.builder().build());
+    }
+
+    public GsonAPIResponseParser(APIContext apiContext) {
         GsonBuilder gsonBuilder = new GsonBuilder();
-        // TODO: need to add a serializer as well once we get to update operations
         gsonBuilder.registerTypeAdapter(LocalDate.class, new LocalDateDeserializer());
-        gson = gsonBuilder.create();
+        this.gson = gsonBuilder.create();
+        this.apiContext = apiContext;
     }
 
-    public GsonAPIResponseParser(Gson gson) {
+    public GsonAPIResponseParser(Gson gson, APIContext apiContext) {
         this.gson = gson;
+        this.apiContext = apiContext;
     }
 
     @Override
@@ -41,7 +50,12 @@ public Map<String, Catalog> parseCatalogResponse(String json) {
 
     @Override
     public Map<String, Dataset> parseDatasetResponse(String json) {
-        return parseResourcesWithVarArgsFromResponse(json, Dataset.class);
+        return parseResourcesWithVarArgsFromResponse(json, Dataset.class, (resource, mc) -> resource.toBuilder()
+                .varArgs(mc.getVarArgs())
+                .apiManager(mc.getApiContext().getApiManager())
+                .rootUrl(mc.getApiContext().getRootUrl())
+                .catalogIdentifier(mc.getApiContext().getDefaultCatalog())
+                .build());
     }
 
     @Override
@@ -76,23 +90,22 @@ public UploadedPart parseUploadPartResponse(String json) {
 
     @Override
     public <T extends CatalogResource> Map<String, T> parseResourcesWithVarArgsFromResponse(
-            String json, Class<T> resourceClass) {
+            String json, Class<T> resourceClass, ResourceMutationFactory<T> mutator) {
 
         Map<String, Map<String, Object>> untypedResources = parseResourcesUntyped(json);
         JsonArray resources = getResources(json);
 
         Set<String> excludes = varArgsExclusions(resourceClass);
         List<T> resourceList = new ArrayList<>();
         for (JsonElement element : resources) {
-            resourceList.add(parseResourceWithVarArgs(resourceClass, excludes, element, untypedResources));
+            resourceList.add(parseResourceWithVarArgs(resourceClass, excludes, element, untypedResources, mutator));
         }
 
         return collectMapOfUniqueResources(resourceList);
     }
 
     @Override
     public <T extends CatalogResource> Map<String, T> parseResourcesFromResponse(String json, Class<T> resourceClass) {
-        // TODO: handle varArgs
 
         JsonArray resources = getResources(json);
 
@@ -146,13 +159,17 @@ private <T extends CatalogResource> T parseResourceWithVarArgs(
             Class<T> resourceClass,
             Set<String> excludes,
             JsonElement element,
-            Map<String, Map<String, Object>> untypedResources) {
+            Map<String, Map<String, Object>> untypedResources,
+            ResourceMutationFactory<T> mutator) {
         T obj = gson.fromJson(element, resourceClass);
 
         Map<String, Object> varArgs = getVarArgsToInclude(untypedResources.get(obj.getIdentifier()), excludes);
-
-        obj.setVarArgs(varArgs);
-        return obj;
+        return mutator.mutate(
+                obj,
+                MutationContext.builder()
+                        .varArgs(varArgs)
+                        .apiContext(apiContext)
+                        .build());
     }
 
     private Map<String, Object> getVarArgsToInclude(Map<String, Object> untypedResource, Set<String> exclusionList) {

src/main/java/io/github/jpmorganchase/fusion/serializing/mutation/MutationContext.java

@@ -0,0 +1,18 @@
+package io.github.jpmorganchase.fusion.serializing.mutation;
+
+import io.github.jpmorganchase.fusion.api.context.APIContext;
+import java.util.Map;
+import lombok.Builder;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+import lombok.Value;
+
+@Value
+@Builder
+@EqualsAndHashCode
+@ToString
+public class MutationContext {
+
+    APIContext apiContext;
+    Map<String, Object> varArgs;
+}

src/main/java/io/github/jpmorganchase/fusion/serializing/mutation/ResourceMutationFactory.java

@@ -0,0 +1,8 @@
+package io.github.jpmorganchase.fusion.serializing.mutation;
+
+import io.github.jpmorganchase.fusion.model.CatalogResource;
+
+@FunctionalInterface
+public interface ResourceMutationFactory<T extends CatalogResource> {
+    T mutate(T resource, MutationContext mc);
+}