feat: add ai_agent field and source value to SDK (DEV-132452) (#213)

* feat: add ai_agent field and source value to SDK (DEV-132452)

* feat(DEV-132452) - load RiskifiedClientTest shopUrl and authKey from env vars with properties fallback

Author: tomerparizer

README.md

@@ -1,7 +1,7 @@
 Riskified JAVA SDK
 =================
 
-version: 6.2.0
+version: 6.3.0
 ------------------
 
 See http://apiref.riskified.com for full API documentation
@@ -104,7 +104,7 @@ curl -H "Content-Type: application/json" -H  "X-RISKIFIED-HMAC-SHA256: 071ef80d5
 <dependency>
     <groupId>com.riskified</groupId>
     <artifactId>riskified-sdk</artifactId>
-    <version>6.2.0</version>
+    <version>6.3.0</version>
 </dependency>
 ```
 

riskified-sample/pom.xml

@@ -13,7 +13,7 @@
         <dependency>
             <groupId>com.riskified</groupId>
             <artifactId>riskified-sdk</artifactId>
-            <version>6.2.0</version>
+            <version>6.3.0</version>
         </dependency>
 
         <dependency>

riskified-sample/src/main/java/com/riskified/samples/orderClient/Client.java

@@ -223,6 +223,7 @@ private static Order decideOrder() throws ParseException {
         order.setBrowserIp("113.32.8.18");
         order.setTotalPrice(6600);
         order.setSource("web");
+        order.setAiAgent(AiAgent.chatgpt);
         order.setEmail("test@test.com");
 
 

riskified-sdk/pom.xml

@@ -4,7 +4,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.riskified</groupId>
     <artifactId>riskified-sdk</artifactId>
-    <version>6.2.0</version>
+    <version>6.3.0</version>
     <name>Riskified SDK</name>
     <description>Riskified rest api SDK for java</description>
     <url>https://www.riskified.com</url>

riskified-sdk/src/main/java/com/riskified/models/AiAgent.java

@@ -0,0 +1,16 @@
+package com.riskified.models;
+
+import com.google.gson.annotations.SerializedName;
+
+public enum AiAgent {
+
+    @SerializedName("chatgpt")
+    chatgpt,
+    @SerializedName("gemini")
+    gemini,
+    @SerializedName("copilot")
+    copilot,
+    @SerializedName("perplexity")
+    perplexity
+
+}

riskified-sdk/src/main/java/com/riskified/models/BaseOrder.java

@@ -39,6 +39,7 @@ public abstract class BaseOrder implements IValidated {
     private String landingSiteRef;
     private String locationId;
     private String source;
+    private AiAgent aiAgent;
     private String sourceIdentifier;
     private String sourceName;
     private String sourceUrl;
@@ -680,4 +681,12 @@ public void setPartnerSubMerchantId(String partnerSubMerchantId) {
         this.partnerSubMerchantId = partnerSubMerchantId;
     }
 
+    public AiAgent getAiAgent() {
+        return aiAgent;
+    }
+
+    public void setAiAgent(AiAgent aiAgent) {
+        this.aiAgent = aiAgent;
+    }
+
 }

riskified-sdk/src/main/java/com/riskified/models/Source.java

@@ -25,6 +25,8 @@ public enum Source {
     @SerializedName("unknown")
     unknown,
     @SerializedName("other")
-    other
+    other,
+    @SerializedName("ai_agent")
+    aiAgent
 
 }

riskified-sdk/src/test/java/com/riskified/RiskifiedClientTest.java

@@ -29,8 +29,12 @@ public class RiskifiedClientTest {
     public static void runOnceBeforeAnyTestCaseIsRun() throws IOException {
         Properties properties = new Properties();
         properties.load(RiskifiedClientTest.class.getClassLoader().getResourceAsStream("riskified_sdk.properties"));
-        shopUrl = "test.pass.com";
-        authKey = "ad6b6e6376fb1e3521e44ca28451d58b9605d932";
+        shopUrl = resolve("RISKIFIED_SHOP_URL", properties, "shopUrl", "test.pass.com");
+        authKey = resolve("RISKIFIED_AUTH_KEY", properties, "authKey", null);
+        if (StringUtils.isEmpty(authKey)) {
+            throw new IllegalStateException(
+                    "No auth key configured. Set the RISKIFIED_AUTH_KEY environment variable or authKey in riskified_sdk.properties");
+        }
         String validationProperty = properties.getProperty("validation");
         validation = null;
         if (StringUtils.isNotEmpty(validationProperty)) {
@@ -157,6 +161,18 @@ public void testDecisionAfterSubmitWithNoValidation() throws RiskifiedError, IOE
         assertNull(parseResponse(RiskifiedOperation.DECISION, response, order.getId()));
     }
 
+    private static String resolve(String envName, Properties properties, String propertyName, String defaultValue) {
+        String envValue = System.getenv(envName);
+        if (StringUtils.isNotEmpty(envValue)) {
+            return envValue;
+        }
+        String propertyValue = properties.getProperty(propertyName);
+        if (StringUtils.isNotEmpty(propertyValue)) {
+            return propertyValue;
+        }
+        return defaultValue;
+    }
+
     private String parseResponse(RiskifiedOperation riskifiedOperation, Response response, String orderId) {
         String detailsOfWhatWentWrong = null;
         if (response != null) {

riskified-sdk/src/test/java/com/riskified/models/OrderTest.java

@@ -40,4 +40,13 @@ public void testPartnerSubMerchantIdDeserializes() {
         Order order = gson.fromJson(json, Order.class);
         assertEquals("merchant-xyz", order.getPartnerSubMerchantId());
     }
+
+    @Test
+    public void testAiAgentSerializesWithUnderscores() {
+        Order order = new Order();
+        order.setId("order-1");
+        order.setAiAgent(AiAgent.chatgpt);
+        String json = gson.toJson(order);
+        assertTrue(json.contains("\"ai_agent\":\"chatgpt\""));
+    }
 }