Add disposition output to response models

Author: oschwald

CHANGELOG.md

@@ -1,6 +1,13 @@
 CHANGELOG
 =========
 
+1.3.0 (2016-11-21)
+------------------
+
+* The disposition was added to the minFraud response models. This is used to
+  return the disposition of the transaction as set by the custom rules for the
+  account.
+
 1.2.0 (2016-11-11)
 ------------------
 

src/main/java/com/maxmind/minfraud/response/Device.java

@@ -7,12 +7,11 @@
 
 /**
  * This class contains minFraud response data related to the device.
+ * <p>
+ * In order to receive device output from minFraud Insights or minFraud
+ * Factors, you must be using the Device Tracking Add-on.
  *
- *  In order to receive device output from minFraud Insights or minFraud
- *  Factors, you must be using the Device Tracking Add-on.
- *
- *  @see <a href="https://dev.maxmind.com/minfraud/device/">Device Tracking Add-on</a>
-
+ * @see <a href="https://dev.maxmind.com/minfraud/device/">Device Tracking Add-on</a>
  */
 public final class Device extends AbstractModel {
     private final Double confidence;

src/main/java/com/maxmind/minfraud/response/Disposition.java

@@ -0,0 +1,46 @@
+package com.maxmind.minfraud.response;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.maxmind.minfraud.AbstractModel;
+
+/**
+ * This class contains the disposition set by custom rules.
+ */
+public final class Disposition extends AbstractModel {
+    private final String action;
+    private final String reason;
+
+    public Disposition(
+            @JsonProperty("action") String action,
+            @JsonProperty("reason") String reason
+    ) {
+        this.action = action;
+        this.reason = reason;
+    }
+
+    public Disposition() {
+        this(null, null);
+    }
+
+    /**
+     * @return A {@code String} with the action to take on the transaction as
+     * defined by your custom rules. The current set of values are
+     * "accept", "manual_review", and "reject". If you do not have
+     * custom rules set up, {@code null} will be returned.
+     */
+    @JsonProperty("action")
+    public String getAction() {
+        return action;
+    }
+
+    /**
+     * @return A {@code String} with the reason for the action. The current
+     * possible values are "custom_rule", "block_list", and "default".
+     * If you do not have custom rules set up, {@code null} will be
+     * returned.
+     */
+    @JsonProperty("reason")
+    public String getReason() {
+        return reason;
+    }
+}

src/main/java/com/maxmind/minfraud/response/FactorsResponse.java

@@ -17,6 +17,7 @@ public FactorsResponse(
             @JsonProperty("billing_address") BillingAddress billingAddress,
             @JsonProperty("credit_card") CreditCard creditCard,
             @JsonProperty("device") Device device,
+            @JsonProperty("disposition") Disposition disposition,
             @JsonProperty("email") Email email,
             @JsonProperty("funds_remaining") Double fundsRemaining,
             @JsonProperty("id") UUID id,
@@ -27,9 +28,9 @@ public FactorsResponse(
             @JsonProperty("subscores") Subscores subscores,
             @JsonProperty("warnings") List<Warning> warnings
     ) {
-        super(billingAddress, creditCard, device, email, fundsRemaining,
-                id, ipAddress, queriesRemaining, riskScore, shippingAddress,
-                warnings);
+        super(billingAddress, creditCard, device, disposition, email,
+                fundsRemaining, id, ipAddress, queriesRemaining, riskScore,
+                shippingAddress, warnings);
         this.subscores = subscores;
     }
 

src/main/java/com/maxmind/minfraud/response/InsightsResponse.java

@@ -20,6 +20,7 @@ public InsightsResponse(
             @JsonProperty("billing_address") BillingAddress billingAddress,
             @JsonProperty("credit_card") CreditCard creditCard,
             @JsonProperty("device") Device device,
+            @JsonProperty("disposition") Disposition disposition,
             @JsonProperty("email") Email email,
             @JsonProperty("funds_remaining") Double fundsRemaining,
             @JsonProperty("id") UUID id,
@@ -29,7 +30,7 @@ public InsightsResponse(
             @JsonProperty("shipping_address") ShippingAddress shippingAddress,
             @JsonProperty("warnings") List<Warning> warnings
     ) {
-        super(fundsRemaining, id, null, queriesRemaining, riskScore, warnings);
+        super(disposition, fundsRemaining, id, null, queriesRemaining, riskScore, warnings);
         this.billingAddress = billingAddress == null ? new BillingAddress() : billingAddress;
         this.creditCard = creditCard == null ? new CreditCard() : creditCard;
         this.device = device == null ? new Device() : device;

src/main/java/com/maxmind/minfraud/response/ScoreResponse.java

@@ -12,21 +12,24 @@
  * This class represents the minFraud Score response.
  */
 public class ScoreResponse extends AbstractModel {
-    protected final Double fundsRemaining;
-    protected final UUID id;
-    protected final Integer queriesRemaining;
-    protected final Double riskScore;
-    protected final List<Warning> warnings;
+    private final Disposition disposition;
+    private final Double fundsRemaining;
+    private final UUID id;
+    private final Integer queriesRemaining;
+    private final Double riskScore;
+    private final List<Warning> warnings;
     private final ScoreIpAddress ipAddress;
 
     public ScoreResponse(
+            @JsonProperty("disposition") Disposition disposition,
             @JsonProperty("funds_remaining") Double fundsRemaining,
             @JsonProperty("id") UUID id,
             @JsonProperty("ip_address") ScoreIpAddress ipAddress,
             @JsonProperty("queries_remaining") Integer queriesRemaining,
             @JsonProperty("risk_score") Double riskScore,
             @JsonProperty("warnings") List<Warning> warnings
     ) {
+        this.disposition = disposition == null ? new Disposition() : disposition;
         this.fundsRemaining = fundsRemaining;
         this.id = id;
         this.ipAddress = ipAddress == null ? new ScoreIpAddress() : ipAddress;
@@ -35,6 +38,15 @@ public ScoreResponse(
         this.warnings = Collections.unmodifiableList(warnings == null ? new ArrayList<Warning>() : warnings);
     }
 
+    /**
+     * @return The disposition set by your custom rules.
+     */
+    @JsonProperty("disposition")
+    public final Disposition getDisposition() {
+        return disposition;
+    }
+
+
     /**
      * @return The approximate US dollar value of the funds remaining on your
      * MaxMind account.

src/test/java/com/maxmind/minfraud/response/DispositionTest.java

@@ -0,0 +1,28 @@
+package com.maxmind.minfraud.response;
+
+import com.fasterxml.jackson.jr.ob.JSON;
+import org.junit.Test;
+
+import java.util.UUID;
+
+import static org.junit.Assert.assertEquals;
+
+public class DispositionTest extends AbstractOutputTest {
+
+    @Test
+    public void testDisposition() throws Exception {
+        Disposition disposition = this.deserialize(
+                Disposition.class,
+                JSON.std
+                        .composeString()
+                        .startObject()
+                        .put("action", "accept")
+                        .put("reason", "default")
+                        .end()
+                        .finish()
+        );
+
+        assertEquals("accept", disposition.getAction());
+        assertEquals("default", disposition.getReason());
+    }
+}

src/test/java/com/maxmind/minfraud/response/InsightsResponseTest.java

@@ -18,6 +18,9 @@ public void testInsights() throws Exception {
                 JSON.std
                         .composeString()
                         .startObject()
+                        .startObjectField("disposition")
+                        .put("action", "accept")
+                        .end()
                         .startObjectField("ip_address")
                         .startObjectField("country")
                         .put("iso_code", "US")
@@ -45,6 +48,7 @@ public void testInsights() throws Exception {
                         .finish()
         );
 
+        assertEquals("disposition", "accept", insights.getDisposition().getAction());
         assertEquals("correct country ISO", "US", insights.getIpAddress().getCountry().getIsoCode());
         assertTrue("correct credit card prepaid", insights.getCreditCard().isPrepaid());
         assertTrue("correct shipping address is in IP country", insights.getShippingAddress().isInIpCountry());

src/test/java/com/maxmind/minfraud/response/ScoreResponseTest.java

@@ -21,6 +21,9 @@ public void testScore() throws Exception {
                         .put("id", id)
                         .put("queries_remaining", 123)
                         .put("risk_score", 0.01)
+                        .startObjectField("disposition")
+                        .put("action", "manual_review")
+                        .end()
                         .startObjectField("ip_address")
                         .put("risk", 0.02)
                         .end()
@@ -37,6 +40,7 @@ public void testScore() throws Exception {
         assertEquals("correct funds remaining", Double.valueOf(1.20), score.getFundsRemaining());
         assertEquals("queries remaining", Integer.valueOf(123), score.getQueriesRemaining());
         assertEquals("risk score", Double.valueOf(0.01), score.getRiskScore());
+        assertEquals("disposition", "manual_review", score.getDisposition().getAction());
         assertEquals("IP risk", Double.valueOf(0.02), score.getIpAddress().getRisk());
         assertEquals("warning code", "INVALID_INPUT", score.getWarnings().get(0).getCode());
     }

src/test/resources/test-data/factors-response.json

@@ -115,6 +115,10 @@
     "id": "7835b099-d385-4e5b-969e-7df26181d73b",
     "last_seen": "2016-06-08T14:16:38Z"
   },
+  "disposition": {
+    "action": "reject",
+    "reason": "custom_rule"
+  },
   "email": {
     "is_free": true,
     "is_high_risk": true