Merge pull request #248 from trebol-ecommerce/feature/put-and-patch-api

Feature/put and patch api
trebol-ecommerce · May 27, 2023 · 68cce0e · 68cce0e
2 parents 931c11e + 8816396
commit 68cce0e
Show file tree

Hide file tree

Showing 8 changed files with 78 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,8 +8,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Support for partial update
-  - Meant to be, but not yet mapped as PATCH methods
+- Support for partial updates using `PATCH` request in these endpoints
+    - `/data/products`
+    - `/data/sales`
+    - `/data/users`
+    - `/data/images`
+    - `/data/product_categories`
+    - `/data/shippers`
+    - `/data/product_lists`
 
 ### Changed
 

diff --git a/README.md b/README.md
@@ -21,17 +21,16 @@
 
 ## Current Status 📓
 
-This project's artifact, group and version have changed recently, as I decided that the conditions it must meet to reach a proper `v1.0` have changed.
+Implementing [Trébol API v1.7.2](https://github.com/trebol-ecommerce/api/blob/v1.7.2/src/trebol-api.json).
 
-Please take a look at the `CHANGELOG.md` file to review this and other recent changes and additions.
-
-Currently bound to and implementing [Trébol API v1.5.0](https://github.com/trebol-ecommerce/api/blob/v1.5.0/trebol-api.json).
+Please take a look at the `CHANGELOG.md` file to review the most recent changes and additions to the codebase.
 
 ## Features 🚀
 
-* Exposes a [RESTful API](https://github.com/trebol-ecommerce/trebol-api) and supports all of the operations described by the document, such as
+* Exposes a [RESTful API](https://github.com/trebol-ecommerce/trebol-api) and supports all the operations described by the document, such as
   * CRUD operations on all declared data types
     * Can filter, sort and paginate through query params
+    * Some endpoints support partial updates using `PATCH` requests
   * Login, registration and optionally, guest customer accounts
   * Checking out as a registered user or a guest (when enabled)
 * Uses [Project Lombok](https://projectlombok.org) in all of its API models and JPA entities

diff --git a/src/main/java/org/trebol/api/controllers/DataImagesController.java b/src/main/java/org/trebol/api/controllers/DataImagesController.java
@@ -25,6 +25,7 @@
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PatchMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -86,6 +87,16 @@ public void update(@RequestBody ImagePojo input, @RequestParam Map<String, Strin
     super.update(input, requestParams);
   }
 
+  @Override
+  @PatchMapping({"", "/"})
+  @PreAuthorize("hasAuthority('images:update')")
+  public void partialUpdate(
+    @RequestBody Map<String, Object> input,
+    @RequestParam Map<String, String> requestParams
+  ) throws BadInputException, EntityNotFoundException {
+    super.partialUpdate(input, requestParams);
+  }
+
   @Override
   @DeleteMapping({"", "/"})
   @PreAuthorize("hasAuthority('images:delete')")

diff --git a/src/main/java/org/trebol/api/controllers/DataProductCategoriesController.java b/src/main/java/org/trebol/api/controllers/DataProductCategoriesController.java
@@ -25,6 +25,7 @@
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PatchMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -87,6 +88,16 @@ public void update(@Valid @RequestBody ProductCategoryPojo input, @RequestParam
     super.update(input, requestParams);
   }
 
+  @Override
+  @PatchMapping({"", "/"})
+  @PreAuthorize("hasAuthority('product_categories:update')")
+  public void partialUpdate(
+    @RequestBody Map<String, Object> input,
+    @RequestParam Map<String, String> requestParams
+  ) throws BadInputException, EntityNotFoundException {
+    super.partialUpdate(input, requestParams);
+  }
+
   @Override
   @DeleteMapping({"", "/"})
   @PreAuthorize("hasAuthority('product_categories:delete')")

diff --git a/src/main/java/org/trebol/api/controllers/DataProductListsController.java b/src/main/java/org/trebol/api/controllers/DataProductListsController.java
@@ -25,6 +25,7 @@
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PatchMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -84,6 +85,16 @@ public void update(@RequestBody ProductListPojo input, @RequestParam Map<String,
     super.update(input, requestParams);
   }
 
+  @Override
+  @PatchMapping({"", "/"})
+  @PreAuthorize("hasAuthority('product_lists:update')")
+  public void partialUpdate(
+    @RequestBody Map<String, Object> input,
+    @RequestParam Map<String, String> requestParams
+  ) throws BadInputException, EntityNotFoundException {
+    super.partialUpdate(input, requestParams);
+  }
+
   @Override
   @DeleteMapping({"", "/"})
   @PreAuthorize("hasAuthority('product_lists:delete')")

diff --git a/src/main/java/org/trebol/api/controllers/DataProductsController.java b/src/main/java/org/trebol/api/controllers/DataProductsController.java
@@ -25,6 +25,7 @@
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PatchMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -84,6 +85,16 @@ public void update(@RequestBody ProductPojo input, @RequestParam Map<String, Str
     super.update(input, requestParams);
   }
 
+  @Override
+  @PatchMapping({"", "/"})
+  @PreAuthorize("hasAuthority('products:update')")
+  public void partialUpdate(
+    @RequestBody Map<String, Object> input,
+    @RequestParam Map<String, String> requestParams
+  ) throws BadInputException, EntityNotFoundException {
+    super.partialUpdate(input, requestParams);
+  }
+
   @Override
   @DeleteMapping({"", "/"})
   @PreAuthorize("hasAuthority('products:delete')")

diff --git a/src/main/java/org/trebol/api/controllers/DataSalesController.java b/src/main/java/org/trebol/api/controllers/DataSalesController.java
@@ -27,6 +27,7 @@
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PatchMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -116,6 +117,16 @@ public void update(@RequestBody SellPojo input, @RequestParam Map<String, String
     super.update(input, requestParams);
   }
 
+  @Override
+  @PatchMapping({"", "/"})
+  @PreAuthorize("hasAuthority('sales:update')")
+  public void partialUpdate(
+    @RequestBody Map<String, Object> input,
+    @RequestParam Map<String, String> requestParams
+  ) throws BadInputException, EntityNotFoundException {
+    super.partialUpdate(input, requestParams);
+  }
+
   @Override
   @DeleteMapping({"", "/"})
   @PreAuthorize("hasAuthority('sales:delete')")

diff --git a/src/main/java/org/trebol/api/controllers/DataShippersController.java b/src/main/java/org/trebol/api/controllers/DataShippersController.java
@@ -25,6 +25,7 @@
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PatchMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -84,6 +85,16 @@ public void update(@RequestBody ShipperPojo input, @RequestParam Map<String, Str
     super.update(input, requestParams);
   }
 
+  @Override
+  @PatchMapping({"", "/"})
+  @PreAuthorize("hasAuthority('shippers:update')")
+  public void partialUpdate(
+    @RequestBody Map<String, Object> input,
+    @RequestParam Map<String, String> requestParams
+  ) throws BadInputException, EntityNotFoundException {
+    super.partialUpdate(input, requestParams);
+  }
+
   @Override
   @DeleteMapping({"", "/"})
   @PreAuthorize("hasAuthority('shippers:delete')")