Bumped dependencies and refactored exceptions and README.

README.md

@@ -2,31 +2,50 @@
 [![CI](https://github.com/BlinkPay/Blink-Debit-API-Client-Java/actions/workflows/maven-build.yml/badge.svg)](https://github.com/BlinkPay/Blink-Debit-API-Client-Java/actions/workflows/maven-build.yml)
 
 ---
-
-[![blink-debit-api-client-java](https://img.shields.io/maven-central/v/nz.co.blinkpay/blink-debit-api-client-java.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22nz.co.blinkpay%22%20AND%20a:%22blink-debit-api-client-java%22)
-[![Sonar](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java&metric=alert_status)](https://sonarcloud.io/dashboard?id=blink-debit-api-client-java)
-[![Snyk](https://snyk-widget.herokuapp.com/badge/mvn/nz.co.blinkpay/blink-debit-api-client-java/latest/badge.svg)](https://security.snyk.io/package/maven/nz.co.blinkpay:blink-debit-api-client-java/latest)
+## blink-debit-api-client-java
+[![Maven Central](https://img.shields.io/maven-central/v/nz.co.blinkpay/blink-debit-api-client-java.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22nz.co.blinkpay%22%20AND%20a:%22blink-debit-api-client-java%22)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=blink-debit-api-client-java)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=blink-debit-api-client-java)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=blink-debit-api-client-java)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=blink-debit-api-client-java)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java&metric=bugs)](https://sonarcloud.io/summary/new_code?id=blink-debit-api-client-java)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=blink-debit-api-client-java)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=blink-debit-api-client-java)
+[![Known Vulnerabilities](https://snyk.io/test/github/BlinkPay/Blink-Debit-API-Client-Java/badge.svg)](https://security.snyk.io/package/maven/nz.co.blinkpay:blink-debit-api-client-java)
 
 ---
-
-[![blink-debit-api-client-java-spring6](https://img.shields.io/maven-central/v/nz.co.blinkpay/blink-debit-api-client-java-spring6.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22nz.co.blinkpay%22%20AND%20a:%22blink-debit-api-client-java-spring6%22)
-[![Sonar](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java-spring6&metric=alert_status)](https://sonarcloud.io/dashboard?id=blink-debit-api-client-java-spring6)
-[![Snyk](https://snyk-widget.herokuapp.com/badge/mvn/nz.co.blinkpay/blink-debit-api-client-java-spring6/latest/badge.svg)](https://security.snyk.io/package/maven/nz.co.blinkpay:blink-debit-api-client-java-spring6/latest)
-
+## blink-debit-api-client-java-spring6
+[![Maven Central](https://img.shields.io/maven-central/v/nz.co.blinkpay/blink-debit-api-client-java-spring6.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22nz.co.blinkpay%22%20AND%20a:%22blink-debit-api-client-java-spring6%22)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java-spring6&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=blink-debit-api-client-java-spring6)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java-spring6&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=blink-debit-api-client-java-spring6)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java-spring6&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=blink-debit-api-client-java-spring6)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java-spring6&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=blink-debit-api-client-java-spring6)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java-spring6&metric=bugs)](https://sonarcloud.io/summary/new_code?id=blink-debit-api-client-java-spring6)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java-spring6&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=blink-debit-api-client-java-spring6)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=blink-debit-api-client-java-spring6&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=blink-debit-api-client-java-spring6)
+[![Known Vulnerabilities](https://snyk.io/test/github/BlinkPay/Blink-Debit-API-Client-Java/badge.svg)](https://security.snyk.io/package/maven/nz.co.blinkpay:blink-debit-api-client-java-spring6)
 
 # Table of Contents
-1. [Minimum Requirements](#minimum-requirements)
-2. [Dependency](#adding-the-dependency)
-3. [Quick Start](#quick-start)
-4. [Configuration](#configuration)
-5. [Client Creation](#client-creation)
-6. [Correlation ID](#correlation-id)
-7. [Full Examples](#full-examples)
-8. [Individual API Call Examples](#individual-api-call-examples)
-
+1. [Introduction](#introduction)
+2. [Contributing](#contributing)
+3. [Minimum Requirements](#minimum-requirements)
+4. [Dependency](#adding-the-dependency)
+5. [Quick Start](#quick-start)
+6. [Configuration](#configuration)
+7. [Client Creation](#client-creation)
+8. [Correlation ID](#correlation-id)
+9. [Full Examples](#full-examples)
+10. [Individual API Call Examples](#individual-api-call-examples)
+
+## Introduction
 This SDK allows merchants with Java-based e-commerce site to integrate with Blink PayNow and Blink AutoPay.
 
-This SDK internally uses WebClient, a reactive web client introduced in Spring Framework 5, for making API calls.
+This SDK internally uses WebClient, a reactive Web client introduced in Spring Framework 5, for making API calls.
+
+## Contributing
+We welcome contributions from the community. Your pull request will be reviewed by our team.
+
+This project is licensed under the MIT License.
 
 ## Minimum Requirements
 - Maven 3 or Gradle 7

core/pom.xml

@@ -5,12 +5,12 @@
     <parent>
         <groupId>nz.co.blinkpay</groupId>
         <artifactId>blink-debit-api-client-java-parent</artifactId>
-        <version>1.1.1</version>
+        <version>1.2.0</version>
     </parent>
 
     <modelVersion>4.0.0</modelVersion>
     <artifactId>blink-debit-api-client-java-core</artifactId>
-    <version>1.1.1</version>
+    <version>1.2.0</version>
 
     <name>blink-debit-api-client-java-core</name>
     <description>Blink Debit API Client shared library</description>

core/src/main/java/nz/co/blink/debit/exception/BlinkConsentFailureException.java

@@ -22,9 +22,9 @@
 package nz.co.blink.debit.exception;
 
 /**
- * The base checked exception for Blink Debit consents.
+ * The exception for Blink Debit consents.
  */
-public class BlinkConsentFailureException extends Exception {
+public class BlinkConsentFailureException extends BlinkServiceException {
 
     public BlinkConsentFailureException() {
         this("Consent operation failed");

core/src/main/java/nz/co/blink/debit/exception/BlinkPaymentFailureException.java

@@ -22,9 +22,9 @@
 package nz.co.blink.debit.exception;
 
 /**
- * The base checked exception for Blink Debit payments.
+ * The exception for Blink Debit payments.
  */
-public class BlinkPaymentFailureException extends Exception {
+public class BlinkPaymentFailureException extends BlinkServiceException {
 
     public BlinkPaymentFailureException() {
         this("Payment operation failure");

core/src/main/java/nz/co/blink/debit/exception/BlinkRequestTimeoutException.java → core/src/main/java/nz/co/blink/debit/exception/BlinkRetryableException.java

@@ -22,19 +22,19 @@
 package nz.co.blink.debit.exception;
 
 /**
- * The exception thrown when the request timed out (408).
+ * The exception thrown when an API call failed but can be retried.
  */
-public class BlinkRequestTimeoutException extends BlinkServiceException {
+public class BlinkRetryableException extends Exception {
 
-    public BlinkRequestTimeoutException() {
-        this("Request timed out");
+    public BlinkRetryableException() {
+        this("Operation failed and will be retried");
     }
 
-    public BlinkRequestTimeoutException(String message) {
+    public BlinkRetryableException(String message) {
         super(message);
     }
 
-    public BlinkRequestTimeoutException(String message, Throwable cause) {
+    public BlinkRetryableException(String message, Throwable cause) {
         super(message, cause);
     }
 }

java-spring6/pom.xml

@@ -5,12 +5,12 @@
     <parent>
         <groupId>nz.co.blinkpay</groupId>
         <artifactId>blink-debit-api-client-java-parent</artifactId>
-        <version>1.1.1</version>
+        <version>1.2.0</version>
     </parent>
 
     <modelVersion>4.0.0</modelVersion>
     <artifactId>blink-debit-api-client-java-spring6</artifactId>
-    <version>1.1.1</version>
+    <version>1.2.0</version>
 
     <name>blink-debit-api-client-java-spring6</name>
     <description>Blink Debit API Client for Java 17 and Spring Framework 6 / Spring Boot 3</description>
@@ -20,17 +20,17 @@
         <maven.compiler.source>17</maven.compiler.source>
         <maven.compiler.target>17</maven.compiler.target>
 
-        <core.version>1.1.1</core.version>
-        <spring.boot.version>3.0.6</spring.boot.version>
-        <spring.cloud.starter.circuitbreaker.reactor.resilience4j.version>3.0.1</spring.cloud.starter.circuitbreaker.reactor.resilience4j.version>
-        <resilience4j.version>2.0.2</resilience4j.version>
-        <swagger.version>2.2.10</swagger.version>
+        <core.version>1.2.0</core.version>
+        <spring.boot.version>3.1.1</spring.boot.version>
+        <spring.cloud.starter.circuitbreaker.reactor.resilience4j.version>3.0.2</spring.cloud.starter.circuitbreaker.reactor.resilience4j.version>
+        <resilience4j.version>2.1.0</resilience4j.version>
+        <swagger.version>2.2.15</swagger.version>
         <java.jwt.version>4.4.0</java.jwt.version>
         <slf4j.version>2.0.7</slf4j.version>
-        <logback.version>1.4.7</logback.version>
+        <logback.version>1.4.8</logback.version>
 
-        <spring.cloud.contract.wiremock.version>4.0.2</spring.cloud.contract.wiremock.version>
-        <reactor.test.version>3.5.6</reactor.test.version>
+        <spring.cloud.contract.wiremock.version>4.0.3</spring.cloud.contract.wiremock.version>
+        <reactor.test.version>3.5.8</reactor.test.version>
     </properties>
 
     <dependencies>

java-spring6/src/componentTest/java/nz/co/blink/debit/client/v1/OAuthApiClientComponentTest.java

@@ -71,7 +71,7 @@ void generateAccessToken() throws JsonProcessingException, BlinkServiceException
         AccessTokenResponse response = new AccessTokenResponse();
         response.setAccessToken(System.getenv("ACCESS_TOKEN"));
         response.setTokenType("Bearer");
-        response.setExpiresIn(86400);
+        response.setExpiresIn(3600);
         response.setScope("create:payment view:payment create:single_consent view:single_consent view:metadata create:enduring_consent view:enduring_consent revoke:enduring_consent view:transaction create:quick_payment view:quick_payment create:refund view:refund revoke:single_consent");
 
         stubFor(post(TOKEN_PATH.getValue())
@@ -88,7 +88,7 @@ void generateAccessToken() throws JsonProcessingException, BlinkServiceException
                 .extracting(AccessTokenResponse::getTokenType, AccessTokenResponse::getExpiresIn,
                         AccessTokenResponse::getRefreshToken, AccessTokenResponse::getIdToken,
                         AccessTokenResponse::getScope)
-                .containsExactly("Bearer", 86400, null, null, "create:payment view:payment create:single_consent"
+                .containsExactly("Bearer", 3600, null, null, "create:payment view:payment create:single_consent"
                         + " view:single_consent view:metadata create:enduring_consent view:enduring_consent"
                         + " revoke:enduring_consent view:transaction create:quick_payment view:quick_payment"
                         + " create:refund view:refund revoke:single_consent");

java-spring6/src/integrationTest/java/nz/co/blink/debit/client/v1/OAuthApiClientIntegrationTest.java

@@ -61,7 +61,7 @@ void generateAccessToken() throws BlinkServiceException {
                 .extracting(AccessTokenResponse::getTokenType, AccessTokenResponse::getExpiresIn,
                         AccessTokenResponse::getRefreshToken, AccessTokenResponse::getIdToken,
                         AccessTokenResponse::getScope)
-                .containsExactly("Bearer", 86400, null, null, "create:payment view:payment create:single_consent"
+                .containsExactly("Bearer", 3600, null, null, "create:payment view:payment create:single_consent"
                         + " view:single_consent view:metadata create:enduring_consent view:enduring_consent"
                         + " revoke:enduring_consent view:transaction create:quick_payment view:quick_payment"
                         + " create:refund view:refund revoke:single_consent");