Develop

.github/workflows/maven-action.yml

@@ -28,7 +28,7 @@ jobs:
           restore-keys: ${{ runner.os }}-maven-
 
       - name: Step 3 - Setup JDK 17
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
           java-version: 17

.github/workflows/release.yml

@@ -23,7 +23,7 @@ jobs:
           restore-keys: ${{ runner.os }}-maven-
 
       - name: Setup JDK 17
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
           java-version: 17
@@ -47,5 +47,10 @@ jobs:
 
       - name: Publish Client Package
         run: mvn versions:set -DnewVersion=${{ github.event.client_payload.version }} versions:commit -pl paystack-clients && mvn -B deploy -pl paystack-clients
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_PAT }}
+
+      - name: Publish Client SpringBoot Starter Package
+        run: mvn versions:set -DnewVersion=${{ github.event.client_payload.version }} versions:commit -pl paystack-clients-spring-boot-starter && mvn -B deploy -pl paystack-clients-spring-boot-starter
         env:
           GITHUB_TOKEN: ${{ secrets.GH_PAT }}

README.md

@@ -11,15 +11,8 @@ The Client comes in 3 flavors:
 3. Reactive - Responses in Mono and Flux
 
 ## Setup
-1. Add the dependency to your project
-```xml
-<dependency>
-  <groupId>com.chrisworks.paystackclient</groupId>
-  <artifactId>paystack-clients</artifactId>
-  <version>${VERSION}</version>
-</dependency>
-```
-2. Add GitHub Maven Package Repository to your POM
+
+1. Add GitHub Maven Package Repository to your POM
 ```xml
 <repositories>
     <repository>
@@ -29,8 +22,66 @@ The Client comes in 3 flavors:
 </repositories>
 ```
 
-## usage
+### 1. When Using SpringBoot
+- Add the dependency to your spring boot project:
+```xml 
+<dependency>
+    <groupId>com.chrisworks.paystackclient</groupId>
+    <artifactId>paystack-clients-spring-boot-starter</artifactId>
+    <version>${VERSION}</version>
+</dependency>
+```
+
+- Add the following property to you `applications.properties` file
+```properties
+paystack-client.secret-key=INPUT_YOUR_PAYSTACK_SECRET_KEY_HERE
+paystack-client.definition-type=(REACTIVE|NON_REACTIVE) #This property is optional, it defaults to 'NON_REACTIVE' if not specified
+```
+
+- Usage
+```java
+// Imports here
+
+import com.chrisworks.paystackclient.definitions.simple.PlanClient; //When using the non-reactive type
+import com.chrisworks.paystackclient.definitions.reactive.PlanClient; //When using the reactive type
+
+@Service
+class Example {
+
+    private final PlanClient planClient;
+
+    public Example(PlanClient planClient) {
+        this.planClient = planClient;
+    }
+
+    public void yourMethodThatDoesAndReturnsSomething() {
+
+        //A.
+        PlanResponse.Single nonReactiveRes = planClient
+                .createPlan(new CreatePlanRequest("Sample Plan 9", Interval.DAILY,
+                        Amount.actualValue(BigDecimal.valueOf(10_000)).ofCurrency(Currency.NGN)));
+
+        //Or B.
+        Mono<PlanResponse.Single> reactiveRes = planClient
+                .createPlan(new CreatePlanRequest("Sample Plan 9", Interval.DAILY,
+                        Amount.actualValue(BigDecimal.valueOf(10_000)).ofCurrency(Currency.NGN)));
+    }
+}
+```
+NB: During injection of the client, you can only inject either the REACTIVE type or the NON_REACTIVE type and never both.
+The implementation here is powered by the popular Spring WebClient which is part of the Spring Framework Project Reactor.
+
+### 2. Java/Maven Project without SpringBoot
+- Add the dependency to your project
+```xml
+<dependency>
+  <groupId>com.chrisworks.paystackclient</groupId>
+  <artifactId>paystack-clients</artifactId>
+  <version>${VERSION}</version>
+</dependency>
+```
 
+- usage
 ```java
 // Imports here
 
@@ -82,4 +133,5 @@ class Example {
                 .executeAsync();
     }
 }
-```
+```
+NB: The implementation here is powered by the popular OkHttp library.

paystack-clients-spring-boot-starter/pom.xml

@@ -27,6 +27,12 @@
             <artifactId>paystack-domain</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-configuration-processor</artifactId>
+            <version>3.1.4</version>
+            <optional>true</optional>
+        </dependency>
     </dependencies>
 
     <repositories>

paystack-clients-spring-boot-starter/src/main/java/com/chrisworks/paystackclient/PaystackClientsProperties.java

@@ -0,0 +1,27 @@
+package com.chrisworks.paystackclient;
+
+import com.chrisworks.paystackclient.definitions.DefinitionType;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+@ConfigurationProperties("paystack-client")
+public class PaystackClientsProperties {
+
+    private String secretKey;
+    private DefinitionType definitionType = DefinitionType.NON_REACTIVE;
+
+    public String getSecretKey() {
+        return secretKey;
+    }
+
+    public void setSecretKey(String secretKey) {
+        this.secretKey = secretKey;
+    }
+
+    public DefinitionType getDefinitionType() {
+        return definitionType;
+    }
+
+    public void setDefinitionType(DefinitionType definitionType) {
+        this.definitionType = definitionType;
+    }
+}

paystack-clients-spring-boot-starter/src/main/java/com/chrisworks/paystackclient/YamlPropertySourceFactory.java

@@ -0,0 +1,27 @@
+package com.chrisworks.paystackclient;
+
+import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.env.PropertiesPropertySource;
+import org.springframework.core.env.PropertySource;
+import org.springframework.core.io.support.EncodedResource;
+import org.springframework.core.io.support.PropertySourceFactory;
+import org.springframework.lang.NonNull;
+
+import java.util.Objects;
+import java.util.Properties;
+
+@Configuration
+public class YamlPropertySourceFactory implements PropertySourceFactory {
+    @NonNull
+    @Override
+    public PropertySource<?> createPropertySource(String name, EncodedResource encodedResource) {
+        YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
+        factory.setResources(encodedResource.getResource());
+
+        Properties properties = factory.getObject();
+
+        assert properties != null;
+        return new PropertiesPropertySource(Objects.requireNonNull(encodedResource.getResource().getFilename()), properties);
+    }
+}

paystack-clients-spring-boot-starter/src/main/java/com/chrisworks/paystackclient/autoconfigure/PaystackClientsAutoConfiguration.java

@@ -0,0 +1,32 @@
+package com.chrisworks.paystackclient.autoconfigure;
+
+import com.chrisworks.paystackclient.PaystackClientsProperties;
+import com.chrisworks.paystackclient.YamlPropertySourceFactory;
+import org.springframework.boot.autoconfigure.AutoConfigurationPackage;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.PropertySource;
+
+@Configuration
+@EnableConfigurationProperties(PaystackClientsProperties.class)
+@ConditionalOnProperty(prefix = "paystack-client", name = "secret-key")
+@PropertySource(value = "classpath:application-paystack-clients-config.yml", factory = YamlPropertySourceFactory.class)
+public class PaystackClientsAutoConfiguration {
+
+    /**
+     * Non Reactive Client configuration
+     */
+    @Configuration
+    @ConditionalOnProperty(prefix = "paystack-client", name = "definition-type", havingValue = "NON_REACTIVE", matchIfMissing = true)
+    @AutoConfigurationPackage(basePackages = "com.chrisworks.paystackclient.definitions.simple")
+    public static class NonReactiveClientConfiguration {}
+
+    /**
+     * Reactive Client configuration
+     */
+    @Configuration
+    @ConditionalOnProperty(prefix = "paystack-client", name = "definition-type", havingValue = "REACTIVE")
+    @AutoConfigurationPackage(basePackages = "com.chrisworks.paystackclient.definitions.reactive")
+    public static class ReactiveClientConfiguration {}
+}

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

@@ -0,0 +1,12 @@
+package com.chrisworks.paystackclient.definitions;
+
+public final class Constants {
+
+    private Constants() {}
+
+    public static final String PLAN_CLIENT = "plan-client";
+    public static final String APPLE_PAY_CLIENT = "apple-pay-client";
+    public static final String TRANSACTION_CLIENT = "transaction-client";
+    public static final String PRODUCT_CLIENT = "product-client";
+    public static final String SUB_ACCOUNT_CLIENT = "sub-account-client";
+}

paystack-clients-spring-boot-starter/src/main/java/com/chrisworks/paystackclient/definitions/DefinitionType.java

@@ -0,0 +1,6 @@
+package com.chrisworks.paystackclient.definitions;
+
+public enum DefinitionType {
+    REACTIVE,
+    NON_REACTIVE
+}

paystack-clients-spring-boot-starter/src/main/java/com/chrisworks/paystackclient/definitions/reactive/ApplePayClient.java

@@ -0,0 +1,31 @@
+package com.chrisworks.paystackclient.definitions.reactive;
+
+import com.chrisworks.paystackclient.domain.applepay.ApplePayRequest;
+import com.chrisworks.paystackclient.domain.applepay.ApplePayResponse;
+import com.chrisworks.paystackclient.domain.request.QueryParamConstants;
+import com.chrisworks.paystackclient.domain.response.EmptyDataResponse;
+import com.chrisworks.paystackclient.definitions.Constants;
+import com.maciejwalkowiak.spring.http.annotation.HttpClient;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.service.annotation.DeleteExchange;
+import org.springframework.web.service.annotation.GetExchange;
+import org.springframework.web.service.annotation.PostExchange;
+import reactor.core.publisher.Mono;
+
+@HttpClient(Constants.APPLE_PAY_CLIENT)
+public interface ApplePayClient {
+
+    @PostExchange
+    Mono<EmptyDataResponse> register(@RequestBody ApplePayRequest request);
+
+    @DeleteExchange
+    Mono<EmptyDataResponse> unregister(@RequestBody ApplePayRequest request);
+
+    @GetExchange
+    Mono<ApplePayResponse.Multiple> list(
+            @RequestParam(name = QueryParamConstants.NEXT, required = false) String next,
+            @RequestParam(name = QueryParamConstants.PREVIOUS, required = false) String previous,
+            @RequestParam(name = QueryParamConstants.USE_CURSOR, required = false) Boolean useCursor
+    );
+}

paystack-clients-spring-boot-starter/src/main/java/com/chrisworks/paystackclient/definitions/reactive/PlanClient.java

@@ -0,0 +1,40 @@
+package com.chrisworks.paystackclient.definitions.reactive;
+
+import com.chrisworks.paystackclient.domain.plan.CreatePlanRequest;
+import com.chrisworks.paystackclient.domain.plan.PlanResponse;
+import com.chrisworks.paystackclient.domain.plan.UpdatePlanRequest;
+import com.chrisworks.paystackclient.domain.request.QueryParamConstants;
+import com.chrisworks.paystackclient.definitions.Constants;
+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 reactor.core.publisher.Mono;
+
+import java.math.BigInteger;
+
+@HttpClient(Constants.PLAN_CLIENT)
+public interface PlanClient {
+
+    @PostExchange
+    Mono<PlanResponse.Single> createPlan(@RequestBody CreatePlanRequest body);
+
+    @GetExchange
+    Mono<PlanResponse.Multiple> listPlans(
+            @RequestParam(name = QueryParamConstants.PAGE) @NonNull BigInteger page,
+            @RequestParam(name = QueryParamConstants.PER_PAGE) @NonNull BigInteger perPage,
+            @RequestParam(name = QueryParamConstants.STATUS, required = false) String status,
+            @RequestParam(name = QueryParamConstants.INTERVAL, required = false) String interval,
+            @RequestParam(name = QueryParamConstants.AMOUNT, required = false) String amount
+    );
+
+    @GetExchange("/{idOrCode}")
+    Mono<PlanResponse.Single> fetchPlan(@PathVariable String idOrCode);
+
+    @PutExchange("/{idOrCode}")
+    Mono<PlanResponse.Single> updatePlan(@PathVariable String idOrCode, @RequestBody UpdatePlanRequest body);
+}

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

@@ -0,0 +1,39 @@
+package com.chrisworks.paystackclient.definitions.reactive;
+
+import com.chrisworks.paystackclient.domain.product.CreateOrUpdateProductRequest;
+import com.chrisworks.paystackclient.domain.product.ProductResponse;
+import com.chrisworks.paystackclient.domain.request.QueryParamConstants;
+import com.chrisworks.paystackclient.definitions.Constants;
+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 reactor.core.publisher.Mono;
+
+import java.math.BigInteger;
+import java.time.ZonedDateTime;
+
+@HttpClient(Constants.PRODUCT_CLIENT)
+public interface ProductClient {
+
+    @PostExchange
+    Mono<ProductResponse.Single> createProduct(@RequestBody CreateOrUpdateProductRequest body);
+
+    @GetExchange
+    Mono<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}")
+    Mono<ProductResponse.Single> fetchProduct(@PathVariable String id);
+
+    @PutExchange("/{id}")
+    Mono<ProductResponse.Multiple> updateProduct(@PathVariable String id);
+}