❇️ Create classes and interfaces for the Product submodule (#46)

* ➕ update .gitignore

* 💻 Create all the classes and interfaces needed for the product subsection

* 🔧 Effect requested changes

* 💄 refactor and clean up

Author: Doctor-Vee

.gitignore

@@ -4,10 +4,7 @@ target/
 !**/src/test/**/target/
 
 ### IntelliJ IDEA ###
-.idea/modules.xml
-.idea/jarRepositories.xml
-.idea/compiler.xml
-.idea/libraries/
+.idea/
 *.iws
 *.iml
 *.ipr

paystack-clients-spring-boot-starter/src/main/java/com/chrisworks/paystackclients/definitions/Constants.java

@@ -7,4 +7,5 @@ private Constants() {}
     static final String PLAN_CLIENT = "plan-client";
     static final String APPLE_PAY_CLIENT = "apple-pay-client";
     static final String TRANSACTION_CLIENT = "transaction-client";
+    static final String PRODUCT_CLIENT = "product-client";
 }

paystack-clients-spring-boot-starter/src/main/java/com/chrisworks/paystackclients/definitions/ProductClient.java

@@ -0,0 +1,37 @@
+package com.chrisworks.paystackclients.definitions;
+
+import com.chrisworks.paystackclient.domain.product.CreateOrUpdateProductRequest;
+import com.chrisworks.paystackclient.domain.product.ProductResponse;
+import com.chrisworks.paystackclient.domain.request.QueryParamConstants;
+import com.maciejwalkowiak.spring.http.annotation.HttpClient;
+import org.springframework.lang.NonNull;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.service.annotation.GetExchange;
+import org.springframework.web.service.annotation.PostExchange;
+import org.springframework.web.service.annotation.PutExchange;
+
+import java.math.BigInteger;
+import java.time.ZonedDateTime;
+
+@HttpClient(Constants.PRODUCT_CLIENT)
+public interface ProductClient {
+
+    @PostExchange
+    ProductResponse.Single createProduct(@RequestBody CreateOrUpdateProductRequest body);
+
+    @GetExchange
+    ProductResponse.Multiple listProducts(
+            @RequestParam(name = QueryParamConstants.PAGE) @NonNull BigInteger page,
+            @RequestParam(name = QueryParamConstants.PER_PAGE) @NonNull BigInteger perPage,
+            @RequestParam(name = QueryParamConstants.FROM, required = false)ZonedDateTime from,
+            @RequestParam(name = QueryParamConstants.TO, required = false)ZonedDateTime to
+            );
+
+    @GetExchange("/{id}")
+    ProductResponse.Single fetchProduct(@PathVariable String id);
+
+    @PutExchange("/{id}")
+    ProductResponse.Multiple updateProduct(@PathVariable String id);
+}

paystack-clients-spring-boot-starter/src/main/resources/application-paystack-clients-config.yml

@@ -18,6 +18,12 @@ http:
 
     transaction-client:
       url: "${base-url}/transaction"
+      headers:
+        Content-Type: "application/json"
+        Authorization: "Bearer ${paystack-client.secret-key}"
+
+    product-client:
+      url: "${base-url}/product"
       headers:
         Content-Type: "application/json"
         Authorization: "Bearer ${paystack-client.secret-key}"

paystack-clients/src/main/java/com/chrisworks/paystackclient/PaystackClient.java

@@ -2,6 +2,7 @@
 
 import com.chrisworks.paystackclient.definitions.ApplePayClient;
 import com.chrisworks.paystackclient.definitions.PlanClient;
+import com.chrisworks.paystackclient.definitions.ProductClient;
 import com.chrisworks.paystackclient.definitions.TransactionClient;
 import okhttp3.OkHttpClient;
 
@@ -10,6 +11,7 @@ public interface PaystackClient {
     ApplePayClient applePay();
     PlanClient plan();
     TransactionClient transaction();
+    ProductClient product();
 
     final class Impl extends WithConfiguredHttpClient implements PaystackClient {
         Impl(OkHttpClient httpClient) {
@@ -30,5 +32,10 @@ public PlanClient plan() {
         public TransactionClient transaction() {
             return new TransactionClient.Impl(httpClient);
         }
+
+        @Override
+        public ProductClient product() {
+            return new ProductClient.Impl(httpClient);
+        }
     }
 }

paystack-clients/src/main/java/com/chrisworks/paystackclient/definitions/ProductClient.java

@@ -0,0 +1,70 @@
+package com.chrisworks.paystackclient.definitions;
+
+import com.chrisworks.paystackclient.ExecutionSpec;
+import com.chrisworks.paystackclient.WithConfiguredHttpClient;
+import com.chrisworks.paystackclient.domain.Routes;
+import com.chrisworks.paystackclient.domain.product.CreateOrUpdateProductRequest;
+import com.chrisworks.paystackclient.domain.product.ProductListQueryParam;
+import com.chrisworks.paystackclient.domain.product.ProductResponse;
+import okhttp3.OkHttpClient;
+import okhttp3.Request;
+import okhttp3.RequestBody;
+import org.jetbrains.annotations.NotNull;
+
+public interface ProductClient {
+
+    ExecutionSpec<ProductResponse.Single> createProduct(CreateOrUpdateProductRequest body);
+
+    ExecutionSpec<ProductResponse.Multiple> listProducts(ProductListQueryParam queryParam);
+
+    ExecutionSpec<ProductResponse.Single> fetchProduct(@NotNull String id);
+
+    ExecutionSpec<ProductResponse.Single> updateProduct(@NotNull String id, CreateOrUpdateProductRequest body);
+
+    final class Impl extends WithConfiguredHttpClient implements ProductClient {
+
+        public Impl(OkHttpClient httpClient) {
+            super(httpClient);
+        }
+
+        @Override
+        public ExecutionSpec<ProductResponse.Single> createProduct(CreateOrUpdateProductRequest body) {
+            final Request request = new Request.Builder()
+                    .url(Routes.Product.BASE_URL)
+                    .post(RequestBody.create(body.json(), applicationJson))
+                    .build();
+
+            return execSpec(request, ProductResponse.Single.class);
+        }
+
+        @Override
+        public ExecutionSpec<ProductResponse.Multiple> listProducts(ProductListQueryParam queryParam) {
+            final Request request = new Request.Builder()
+                    .url(Routes.Product.BASE_URL + safeExtractQueryParams(queryParam))
+                    .get()
+                    .build();
+
+            return execSpec(request, ProductResponse.Multiple.class);
+        }
+
+        @Override
+        public ExecutionSpec<ProductResponse.Single> fetchProduct(@NotNull String id) {
+            final Request request = new Request.Builder()
+                    .url(Routes.Product.BY_ID.apply(id))
+                    .get()
+                    .build();
+
+            return execSpec(request, ProductResponse.Single.class);
+        }
+
+        @Override
+        public ExecutionSpec<ProductResponse.Single> updateProduct(@NotNull String id, CreateOrUpdateProductRequest body) {
+            final Request request = new Request.Builder()
+                    .url(Routes.Product.BY_ID.apply(id))
+                    .put(RequestBody.create(body.json(), applicationJson))
+                    .build();
+
+            return execSpec(request, ProductResponse.Single.class);
+        }
+    }
+}

paystack-domain/src/main/java/com/chrisworks/paystackclient/domain/Routes.java

@@ -32,4 +32,10 @@ private Transaction() {}
         public static final UnaryOperator<String> VIEW_TIMELINE_URL = (BASE_URL + "/timeline/%s")::formatted;
         public static final UnaryOperator<String> VERIFY_TRANSACTION_URL = (BASE_URL + "/verify/%s")::formatted;
     }
+
+    public static final class Product {
+        private Product(){}
+        public static final String BASE_URL = Routes.BASE_URL + "/product";
+        public static final UnaryOperator<String> BY_ID = (BASE_URL + "/%s")::formatted;
+    }
 }

paystack-domain/src/main/java/com/chrisworks/paystackclient/domain/product/CreateOrUpdateProductRequest.java

@@ -0,0 +1,54 @@
+package com.chrisworks.paystackclient.domain.product;
+
+import com.chrisworks.paystackclient.domain.Amount;
+import com.chrisworks.paystackclient.domain.request.RequestBody;
+
+public class CreateOrUpdateProductRequest implements RequestBody<CreateOrUpdateProductRequest> {
+    private final String name;
+    private final String description;
+    private final String price;
+    private final String currency;
+    private boolean unlimited;
+    private Integer quantity;
+
+    public CreateOrUpdateProductRequest(String name, String description, Amount price){
+        this.name = name;
+        this.description = description;
+        this.price = price.getUnitValue();
+        this.currency = price.getCurrency().name();
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public String getPrice() {
+        return price;
+    }
+
+    public String getCurrency() {
+        return currency;
+    }
+
+    public boolean isUnlimited() {
+        return unlimited;
+    }
+
+    public Integer getQuantity() {
+        return quantity;
+    }
+
+    public CreateOrUpdateProductRequest unlimited(boolean unlimited) {
+        this.unlimited = unlimited;
+        return this;
+    }
+
+    public CreateOrUpdateProductRequest quantity(Integer quantity) {
+        this.quantity = quantity;
+        return this;
+    }
+}

paystack-domain/src/main/java/com/chrisworks/paystackclient/domain/product/ProductListQueryParam.java

@@ -0,0 +1,28 @@
+package com.chrisworks.paystackclient.domain.product;
+
+import com.chrisworks.paystackclient.domain.request.PaystackListPagedQueryParam;
+import com.chrisworks.paystackclient.domain.request.QueryParamConstants;
+
+import java.math.BigInteger;
+import java.time.ZonedDateTime;
+
+public final class ProductListQueryParam extends PaystackListPagedQueryParam {
+
+    public ProductListQueryParam(BigInteger perPage, BigInteger page) {
+        super(perPage, page);
+    }
+
+    public ProductListQueryParam(){
+        super();
+    }
+
+    public ProductListQueryParam from(ZonedDateTime from){
+        params.put(QueryParamConstants.FROM, from.toString());
+        return this;
+    }
+
+    public ProductListQueryParam to(ZonedDateTime to){
+        params.put(QueryParamConstants.TO, to.toString());
+        return this;
+    }
+}

paystack-domain/src/main/java/com/chrisworks/paystackclient/domain/product/ProductResponse.java

@@ -0,0 +1,31 @@
+package com.chrisworks.paystackclient.domain.product;
+
+import com.chrisworks.paystackclient.domain.Amount;
+import com.chrisworks.paystackclient.domain.Currency;
+import com.chrisworks.paystackclient.domain.response.PaystackMultiResponse;
+import com.chrisworks.paystackclient.domain.response.PaystackSingleResponse;
+
+import java.math.BigInteger;
+import java.time.ZonedDateTime;
+import java.util.List;
+
+public record ProductResponse(String name, String description, Currency currency, Amount.MoneyValue price,
+                              Integer quantity, boolean is_shippable, boolean unlimited, BigInteger integration,
+                              String domain, Object metadata, String slug, String product_code, Integer quantity_sold,
+                              String type, Object shipping_fields, boolean active, boolean in_stock,
+                              Integer minimum_orderable, Integer maximum_orderable, boolean low_stock_alert,
+                              BigInteger id, ZonedDateTime createdAt, ZonedDateTime updatedAt) {
+
+    public Amount getPrice() {
+        return this.price.ofCurrency(this.currency);
+    }
+
+    public record Single(boolean status, String message, ProductResponse data)
+            implements PaystackSingleResponse<ProductResponse> {
+    }
+
+    public record Multiple(boolean status, String message, List<ProductResponse> data, PageMetaInfo.Impl meta)
+            implements PaystackMultiResponse<ProductResponse> {
+    }
+
+}