test build (#157)

Author: bnayah

.github/workflows/main.yml

@@ -1,26 +1,28 @@
 name: Maven CI/CD
-
 on:
   push:
     branches:
       - master
+  pull_request:
+    branches:
+      - master
+  workflow_dispatch:
 
 jobs:
   build_and_test:
-
     runs-on: ubuntu-latest
-
     steps:
       - name: Checking out
-        uses: actions/checkout@v3 ##action to give our job access to code in our repo
+        uses: actions/checkout@v4 ##action to give our job access to code in our repo
 
       - name: Cache local mvn repo
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.m2/repository
           key: v1-dependencies-{{ hashFiles('**/pom.xml') }}
           restore-keys: |
             v1-dependencies-
+
       - run: mvn dependency:go-offline
 
       - name: Configuring GPG key
@@ -29,9 +31,8 @@ jobs:
         env:
           GPG_SIGNING_KEY: ${{ secrets.SECRING_GPG_ASC_BASE64 }}
 
-
       - name: Set up JDK 8
-        uses: actions/setup-java@v2 ##this action sets up a java environment that our job can run in
+        uses: actions/setup-java@v4 ##this action sets up a java environment that our job can run in
         with:
           distribution: 'zulu'
           java-version: 8
@@ -41,6 +42,7 @@ jobs:
         run: mvn -B package --file pom.xml
 
       - name: Publish to Apache Maven Central
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
         run: GPG_TTY=$(tty); mvn -s .github/workflows/maven-release-setting.xml clean deploy -DdeployAtEnd=true -DperformRelease=true -DskipTests -Dspotbugs.skip=true
         env:
           SERVER_OSSRH_USERNAME: ${{ secrets.SERVER_OSSRH_USERNAME }}

README.md

@@ -4,11 +4,12 @@ Riskified JAVA SDK
 version: 2.3.2
 ------------------
 
-See http://apiref.riskified.com for full API documentation 
+See http://apiref.riskified.com for full API documentation
 
-see riskified-sample/ for examples on how to use this SDK. 
+see riskified-sample/ for examples on how to use this SDK.
 
 Data validation:
+
 ---------------
 The SDK includes a validation mechanism to help you catch formatting and data issues quickly.
 However, it is possible to control the level of validation, through the SDKs Validation object,
@@ -17,48 +18,58 @@ For example, you can tell the Validation engine to ignore missing values, by pas
 Validations.ignoreMissing
 
 like this:
-```
+
+```text
 RiskifiedClient client = new RiskifiedClient(domain, authToken, Environment.SANDBOX, Validation.IGNORE_MISSING);
 ```
+
 Or specify the validation type in the config file 'riskified_sdk.properties'.
 
-Available validation types: 
-*	none - disable validations
-*	ignoreMissing - validates only the data format
-*	all - validates the data format and that required fields are not missing
+Available validation types:
 
+* none - disable validations
+* ignoreMissing - validates only the data format
+* all - validates the data format and that required fields are not missing
 
 PSD2: Advise endpoint old response testing:
+
 -------------------------------------------
 Riskified changed the /advice endpoint response. To enable the old response for testing purposes, follow steps below:
-1.	Open riskified_sdk.properties file
-2.	Set "enable_old_advise_response" to "true"
 
-Riskified SDK will return the old advise response. 
+1. Open riskified_sdk.properties file
+2. Set "enable_old_advise_response" to "true"
 
+Riskified SDK will return the old advise response.
 
 Prerequisites:
+
 ---------------
-*	Java JDK-1.5 or higher
+
+* Java JDK-1.5 or higher
 
 Running the samples:
+
 --------------------------
+
 * **Build the SDK** - Run `mvn package` which will build both the SDK and the samples
-* **Configure your properties** (authKey and shopUrl) - in the riskified-sdk/src/main/resources/riskified_sdk.properties file. 
-	Your Riskified's authorization token (authKey) can be found in the [advanced settings section](https://sandbox.riskified.com/main/settings/advanced) of your Riskified sandbox environment.
+* **Configure your properties** (authKey and shopUrl) - in the riskified-sdk/src/main/resources/riskified_sdk.properties file.
+ Your Riskified's authorization token (authKey) can be found in the [advanced settings section](https://sandbox.riskified.com/main/settings/advanced) of your Riskified sandbox environment.
 
 ## Simple order creation sample
+
 This samples shows how to construct an Order model and invoke the basic api/create endpoint
 
-```
+```shell
 cd riskified-sample
 mvn exec:java -Dexec.mainClass="com.riskified.samples.orderClient.SimpleClient"
 ```
 
-## Client sample
+Client sample
+===============
+
 This samples shows how to construct an Order model and invoke each and every one of our endpoints with it
 
-```
+```shell
 cd riskified-sample
 mvn exec:java -Dexec.mainClass="com.riskified.samples.orderClient.Client"
 ```
@@ -67,7 +78,7 @@ mvn exec:java -Dexec.mainClass="com.riskified.samples.orderClient.Client"
 
 This samples shows how to construct an Order model and save it locally as a Json file, this sample is useful for early stages of the integration and for POCs
 
-```
+```shell
 cd riskified-sample
 mvn exec:java -Dexec.mainClass="com.riskified.samples.orderClient.JsonClient"
 ```
@@ -80,13 +91,14 @@ This samples shows how to bring up a notification end point
 cd riskified-sample
 mvn exec:java -Dexec.mainClass="com.riskified.samples.notificationServer.servlet.SampleServer"
 ```
+
 Then you can test the endpoint by running a curl command from another terminal
 
 ```sh
 curl -H "Content-Type: application/json" -H  "X-RISKIFIED-HMAC-SHA256: 071ef80d5790011d2f111479b75eed15e907432a4523defb4e627c6725d3b6b3" -X POST -d '{"order":{"id":"123","status":"approved","old_status":"submitted","description":"Approved by Riskified"}}' http://localhost:8080
 ```
 
-## Maven dependency excerpt:
+## Maven dependency excerpt
 
 ```xml
 <dependency>
@@ -95,5 +107,3 @@ curl -H "Content-Type: application/json" -H  "X-RISKIFIED-HMAC-SHA256: 071ef80d5
     <version>v2.3.0</version>
 </dependency>
 ```
-
-