Add device, emailLocalPart and shipping subscores

Author: oalders

CHANGELOG.md

@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+* Added support for three new Factors outputs: `/subscores/device` (the risk
+  associated with the device), `/subscores/email_local_part` (the risk
+  associated with the part of the email address before the @ symbol) and
+  `/subscores/shipping_address` (the risk associated with the shipping
+  address).
+
 1.15.0
 -------------------
 

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

@@ -15,13 +15,16 @@ public final class Subscores {
     private final Double country;
     private final Double countryMismatch;
     private final Double cvvResult;
+    private final Double device;
     private final Double emailAddress;
     private final Double emailDomain;
+    private final Double emailLocalPart;
     private final Double emailTenure;
     private final Double ipTenure;
     private final Double issuerIdNumber;
     private final Double orderAmount;
     private final Double phoneNumber;
+    private final Double shippingAddress;
     private final Double shippingAddressDistanceToIpLocation;
     private final Double timeOfDay;
 
@@ -34,13 +37,16 @@ public Subscores(
             @JsonProperty("country") Double country,
             @JsonProperty("country_mismatch") Double countryMismatch,
             @JsonProperty("cvv_result") Double cvvResult,
+            @JsonProperty("device") Double device,
             @JsonProperty("email_address") Double emailAddress,
             @JsonProperty("email_domain") Double emailDomain,
+            @JsonProperty("email_local_part") Double emailLocalPart,
             @JsonProperty("email_tenure") Double emailTenure,
             @JsonProperty("ip_tenure") Double ipTenure,
             @JsonProperty("issuer_id_number") Double issuerIdNumber,
             @JsonProperty("order_amount") Double orderAmount,
             @JsonProperty("phone_number") Double phoneNumber,
+            @JsonProperty("shipping_address") Double shippingAddress,
             @JsonProperty("shipping_address_distance_to_ip_location") Double shippingAddressDistanceToIpLocation,
             @JsonProperty("time_of_day") Double timeOfDay
     ) {
@@ -52,20 +58,50 @@ public Subscores(
         this.country = country;
         this.countryMismatch = countryMismatch;
         this.cvvResult = cvvResult;
+        this.device = device;
         this.emailAddress = emailAddress;
         this.emailDomain = emailDomain;
+        this.emailLocalPart = emailLocalPart;
         this.emailTenure = emailTenure;
         this.ipTenure = ipTenure;
         this.issuerIdNumber = issuerIdNumber;
         this.orderAmount = orderAmount;
         this.phoneNumber = phoneNumber;
+        this.shippingAddress = shippingAddress;
         this.shippingAddressDistanceToIpLocation = shippingAddressDistanceToIpLocation;
         this.timeOfDay = timeOfDay;
     }
 
+    // This method is for backwards compatibility. We should remove it when we
+    // do a major release.
+    public Subscores(
+            Double avsResult,
+            Double billingAddress,
+            Double billingAddressDistanceToIpLocation,
+            Double browser,
+            Double chargeback,
+            Double country,
+            Double countryMismatch,
+            Double cvvResult,
+            Double emailAddress,
+            Double emailDomain,
+            Double emailTenure,
+            Double ipTenure,
+            Double issuerIdNumber,
+            Double orderAmount,
+            Double phoneNumber,
+            Double shippingAddressDistanceToIpLocation,
+            Double timeOfDay
+    ) {
+        this(avsResult, billingAddress, billingAddressDistanceToIpLocation, browser, chargeback,
+        country, countryMismatch, cvvResult, null, emailAddress, emailDomain, null, emailTenure,
+        ipTenure, issuerIdNumber, orderAmount, phoneNumber, null, shippingAddressDistanceToIpLocation,
+        timeOfDay);
+    }
+
     public Subscores() {
         this(null, null, null, null, null, null, null, null, null, null, null, null,
-                null, null, null, null, null);
+                null, null, null, null, null, null, null, null);
     }
 
     /**
@@ -145,6 +181,15 @@ public Double getCvvResult() {
         return cvvResult;
     }
 
+    /**
+     * @return The risk associated with the device. If present, this is a value in
+     * the range 0.01 to 99.
+     */
+    @JsonProperty("device")
+    public Double getDevice() {
+        return device;
+    }
+
     /**
      * @return The risk associated with the particular email address. If
      * present, this is a value in the range 0.01 to 99.
@@ -163,6 +208,16 @@ public Double getEmailDomain() {
         return emailDomain;
     }
 
+    /**
+     * @return The risk associated with the email address local part (the part
+     *  of the email address before the @ symbol). If present, this is a value
+     *  in the range 0.01 to 99.
+     */
+    @JsonProperty("email_local_part")
+    public Double getEmailLocalPart() {
+        return emailLocalPart;
+    }
+
     /**
      * @return The risk associated with the issuer ID number on the email
      * domain. If present, this is a value in the range 0.01 to 99.
@@ -218,6 +273,15 @@ public Double getPhoneNumber() {
         return phoneNumber;
     }
 
+    /**
+     * @return The risk associated with the shipping address. If present, this is
+     * a value in the range 0.01 to 99.
+     */
+    @JsonProperty("shipping_address")
+    public Double getShippingAddress() {
+        return shippingAddress;
+    }
+
     /**
      * @return The risk associated with the distance between the shipping
      * address and the IP location for the given IP address. If present, this is

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

@@ -26,13 +26,16 @@ public void testFactors() throws Exception {
                         .put("country", 0.06)
                         .put("country_mismatch", 0.07)
                         .put("cvv_result", 0.08)
+                        .put("device", 0.18)
                         .put("email_address", 0.09)
                         .put("email_domain", 0.10)
+                        .put("email_local_part", 0.19)
                         .put("email_tenure", 0.11)
                         .put("ip_tenure", 0.12)
                         .put("issuer_id_number", 0.13)
                         .put("order_amount", 0.14)
                         .put("phone_number", 0.15)
+                        .put("shipping_address", 0.2)
                         .put("shipping_address_distance_to_ip_location", 0.16)
                         .put("time_of_day", 0.17)
                         .end()
@@ -52,13 +55,16 @@ public void testFactors() throws Exception {
         assertEquals("country", Double.valueOf(0.06), factors.getSubscores().getCountry());
         assertEquals("country_mismatch", Double.valueOf(0.07), factors.getSubscores().getCountryMismatch());
         assertEquals("cvv_result", Double.valueOf(0.08), factors.getSubscores().getCvvResult());
+        assertEquals("device", Double.valueOf(0.18), factors.getSubscores().getDevice());
         assertEquals("email_address", Double.valueOf(0.09), factors.getSubscores().getEmailAddress());
         assertEquals("email_domain", Double.valueOf(0.10), factors.getSubscores().getEmailDomain());
+        assertEquals("email_local_part", Double.valueOf(0.19), factors.getSubscores().getEmailLocalPart());
         assertEquals("email_tenure", Double.valueOf(0.11), factors.getSubscores().getEmailTenure());
         assertEquals("ip_tenure", Double.valueOf(0.12), factors.getSubscores().getIpTenure());
         assertEquals("issuer_id_number", Double.valueOf(0.13), factors.getSubscores().getIssuerIdNumber());
         assertEquals("order_amount", Double.valueOf(0.14), factors.getSubscores().getOrderAmount());
         assertEquals("phone_number", Double.valueOf(0.15), factors.getSubscores().getPhoneNumber());
+        assertEquals("shipping_address", Double.valueOf(0.2), factors.getSubscores().getShippingAddress());
         assertEquals("shipping_address_distance_to_ip_location", Double.valueOf(0.16), factors.getSubscores().getShippingAddressDistanceToIpLocation());
         assertEquals("time_of_day", Double.valueOf(0.17), factors.getSubscores().getTimeOfDay());
         assertEquals("correct funnds remaining", Double.valueOf(1.20), factors.getFundsRemaining());

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

@@ -156,13 +156,16 @@
     "country": 0.06,
     "country_mismatch": 0.07,
     "cvv_result": 0.08,
+    "device": 0.18,
     "email_address": 0.09,
     "email_domain": 0.10,
     "email_tenure": 0.11,
+    "email_local_part": 0.19,
     "ip_tenure": 0.12,
     "issuer_id_number": 0.13,
     "order_amount": 0.14,
     "phone_number": 0.15,
+    "shipping_address": 0.2,
     "shipping_address_distance_to_ip_location": 0.16,
     "time_of_day": 0.17
   },