Add IP risk field

Author: oschwald

src/main/java/com/maxmind/minfraud/request/Billing.java

@@ -3,7 +3,7 @@
 /**
  * The billing information for the transaction.
  */
-public class Billing extends AbstractLocation {
+public final class Billing extends AbstractLocation {
     private Billing(Billing.Builder builder) {
         super(builder);
     }

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

@@ -7,7 +7,7 @@
 /**
  * The device information for the transaction.
  */
-public class Device {
+public final class Device {
     @JsonProperty("ip_address")
     private final InetAddress ipAddress;
 

src/main/java/com/maxmind/minfraud/request/Event.java

@@ -8,7 +8,7 @@
 import java.util.Date;
 import java.util.TimeZone;
 
-public class Event {
+public final class Event {
 
     @JsonProperty("transaction_id")
     private final String transactionId;
@@ -119,7 +119,7 @@ public final String getShopId() {
      */
     @JsonIgnore
     public final Date getTime() throws ParseException {
-        return time == null ? null : this.dateFormat.parse(time);
+        return (time == null) ? null : this.dateFormat.parse(time);
     }
 
     /**

src/main/java/com/maxmind/minfraud/request/Payment.java

@@ -5,7 +5,7 @@
 /**
  * The payment information for the transaction.
  */
-public class Payment {
+public final class Payment {
     @JsonProperty("processor")
     private final Processor processor;
     @JsonProperty("was_authorized")

src/main/java/com/maxmind/minfraud/request/ShoppingCartItem.java

@@ -7,7 +7,7 @@
 /**
  * An item in the shopping cart.
  */
-public class ShoppingCartItem {
+public final class ShoppingCartItem {
     @JsonProperty
     private final String category;
 

src/main/java/com/maxmind/minfraud/request/Transaction.java

@@ -43,7 +43,6 @@ public final class Transaction {
     @JsonProperty("shopping_cart")
     private final List<ShoppingCartItem> shoppingCart;
 
-    @SuppressWarnings("unchecked")
     protected Transaction(Transaction.Builder builder) {
         account = builder.account;
         billing = builder.billing;
@@ -61,7 +60,6 @@ protected Transaction(Transaction.Builder builder) {
      * {@code Builder} creates instances of the parent class from values set
      * by the builder's methods.
      */
-    @SuppressWarnings("unchecked")
     public static class Builder {
         Account account;
         Billing billing;

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

@@ -6,8 +6,8 @@
  * This class provides a model for the minFraud Insights response.
  */
 public final class InsightsResponse extends ScoreResponse {
-    @JsonProperty("ip_location")
-    protected IpLocation ipLocation;
+    @JsonProperty("ip_address")
+    protected IpAddress ipAddress;
 
     @JsonProperty("credit_card")
     protected CreditCard creditCard = new CreditCard();
@@ -19,10 +19,10 @@ public final class InsightsResponse extends ScoreResponse {
     protected BillingAddress billingAddress = new BillingAddress();
 
     /**
-     * @return The {@code IpLocation} model object.
+     * @return The {@code IpAddress} model object.
      */
-    public final IpLocation getIpLocation() {
-        return ipLocation;
+    public final IpAddress getIpAddress() {
+        return ipAddress;
     }
 
     /**
@@ -53,7 +53,7 @@ public String toString() {
         sb.append(", id='").append(this.id).append('\'');
         sb.append(", riskScore=").append(this.riskScore);
         sb.append(", warnings=").append(this.warnings);
-        sb.append(", ipLocation=").append(this.ipLocation);
+        sb.append(", ipAddress=").append(this.ipAddress);
         sb.append(", creditCard=").append(this.creditCard);
         sb.append(", shippingAddress=").append(this.shippingAddress);
         sb.append(", billingAddress=").append(this.billingAddress);

…axmind/minfraud/response/IpLocation.java …maxmind/minfraud/response/IpAddress.javasrc/main/java/com/maxmind/minfraud/response/IpLocation.java renamed to src/main/java/com/maxmind/minfraud/response/IpAddress.java src/main/java/com/maxmind/minfraud/response/IpLocation.java renamed to src/main/java/com/maxmind/minfraud/response/IpAddress.java

@@ -6,11 +6,13 @@
 /**
  * This class contains minFraud response data related to the IP location
  */
-public final class IpLocation extends InsightsResponse {
+public final class IpAddress extends InsightsResponse {
     @JsonProperty("country")
     private final GeoIp2Country country = new GeoIp2Country();
     @JsonProperty("location")
     private final GeoIp2Location location = new GeoIp2Location();
+    @JsonProperty("risk")
+    protected Double risk;
 
     /**
      * @return Country record for the requested IP address. This object
@@ -28,10 +30,21 @@ public final GeoIp2Location getLocation() {
         return location;
     }
 
+
+    /**
+     * @return The risk associated with the IP address. The value ranges from
+     * 0.01 to 99. A higher score indicates a higher risk.
+     */
+    public Double getRisk() {
+        return risk;
+    }
+
+
     @Override
     public String toString() {
-        StringBuilder sb = new StringBuilder("IpLocation{");
-        sb.append("country=").append(this.country);
+        StringBuilder sb = new StringBuilder("IpAddress{");
+        sb.append("risk=").append(this.risk);
+        sb.append(", country=").append(this.country);
         sb.append(", location=").append(this.location);
         sb.append(", super:").append(super.toString());
         sb.append('}');

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

@@ -16,7 +16,7 @@ public void testInsights() throws Exception {
                 JSON.std
                         .composeString()
                         .startObject()
-                        .startObjectField("ip_location")
+                        .startObjectField("ip_address")
                         .startObjectField("country")
                         .put("iso_code", "US")
                         .end()
@@ -42,7 +42,7 @@ public void testInsights() throws Exception {
                         .finish()
         );
 
-        assertEquals("correct country ISO", "US", insights.getIpLocation().getCountry().getIsoCode());
+        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());
         assertTrue("correct billing address is in IP country", insights.getBillingAddress().isInIpCountry());

…nd/minfraud/response/IpLocationTest.java …ind/minfraud/response/IpAddressTest.javasrc/test/java/com/maxmind/minfraud/response/IpLocationTest.java renamed to src/test/java/com/maxmind/minfraud/response/IpAddressTest.java src/test/java/com/maxmind/minfraud/response/IpLocationTest.java renamed to src/test/java/com/maxmind/minfraud/response/IpAddressTest.java

@@ -6,17 +6,18 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 
-public class IpLocationTest extends AbstractOutputTest {
+public class IpAddressTest extends AbstractOutputTest {
 
     @Test
-    public void testIpLocation() throws Exception {
+    public void testIpAddress() throws Exception {
         String time = "2015-04-19T12:59:23-01:00";
 
-        IpLocation loc = this.deserialize(
-                IpLocation.class,
+        IpAddress address = this.deserialize(
+                IpAddress.class,
                 JSON.std
                         .composeString()
                         .startObject()
+                        .put("risk", 99)
                         .startObjectField("country")
                         .put("is_high_risk", true)
                         .end()
@@ -27,8 +28,8 @@ public void testIpLocation() throws Exception {
                         .finish()
         );
 
-        assertEquals("correct local time", time, loc.getLocation().getLocalTime());
-        assertTrue("isHighRisk", loc.getCountry().isHighRisk());
+        assertEquals("IP risk", new Double(99), address.getRisk());
+        assertEquals("correct local time", time, address.getLocation().getLocalTime());
+        assertTrue("isHighRisk", address.getCountry().isHighRisk());
     }
-
 }