Merge pull request #10 from maxmind/greg/more-device-outputs

More device outputs

Author: mateu

CHANGELOG.md

@@ -9,6 +9,7 @@ CHANGELOG
 * Added `getQueriesRemaining()` and `getFundsRemaining()`. Note that
   `getFundsRemaining()` will not be returned by the web service until our new
   credit system is in place.
+* Added `getLastSeen()` and `getConfidence()` to the `Device` response model.
 * This API now throws an `IllegalArgumentException` when `null` values are
   passed to constructors or methods that require non-null values.
 

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

@@ -8,17 +8,17 @@
  * Billing and Shipping.
  */
 public abstract class AbstractLocation extends AbstractModel {
-    protected String firstName;
-    protected String lastName;
-    protected String company;
-    protected String address;
-    protected String address2;
-    protected String city;
-    protected String region;
-    protected String country;
-    protected String postal;
-    protected String phoneNumber;
-    protected String phoneCountryCode;
+    private final String firstName;
+    private final String lastName;
+    private final String company;
+    private final String address;
+    private final String address2;
+    private final String city;
+    private final String region;
+    private final String country;
+    private final String postal;
+    private final String phoneNumber;
+    private final String phoneCountryCode;
 
     protected AbstractLocation(AbstractLocation.Builder builder) {
         firstName = builder.firstName;

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

@@ -3,7 +3,6 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.maxmind.minfraud.AbstractModel;
 
-import java.text.ParseException;
 import java.text.SimpleDateFormat;
 import java.util.Date;
 
@@ -30,7 +29,6 @@ public static final class Builder {
         String shopId;
         Date time;
         Type type;
-        SimpleDateFormat dateFormat;
 
         /**
          * @param id Your internal ID for the transaction. We can use this to

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

@@ -11,7 +11,7 @@ public final class Payment extends AbstractModel {
     private final Boolean wasAuthorized;
     private final String declineCode;
 
-    public Payment(Payment.Builder builder) {
+    private Payment(Payment.Builder builder) {
         processor = builder.processor;
         wasAuthorized = builder.wasAuthorized;
         declineCode = builder.declineCode;

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

@@ -21,7 +21,7 @@ public final class Transaction extends AbstractModel {
     private final Shipping shipping;
     private final List<ShoppingCartItem> shoppingCart;
 
-    protected Transaction(Transaction.Builder builder) {
+    private Transaction(Transaction.Builder builder) {
         account = builder.account;
         billing = builder.billing;
         creditCard = builder.creditCard;
@@ -48,7 +48,7 @@ public static class Builder {
         Order order;
         Payment payment;
         Shipping shipping;
-        List<ShoppingCartItem> shoppingCart = new ArrayList<>();
+        final List<ShoppingCartItem> shoppingCart = new ArrayList<>();
 
         /**
          * The constructor for {@code Builder}

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

@@ -7,24 +7,57 @@
 
 /**
  * This class contains minFraud response data related to the device.
+ *
+ *  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>
+
  */
 public final class Device extends AbstractModel {
+    private final Double confidence;
     private final UUID id;
+    private final String lastSeen;
 
     public Device(
-            @JsonProperty("id") UUID id
+            @JsonProperty("confidence") Double confidence,
+            @JsonProperty("id") UUID id,
+            @JsonProperty("last_seen") String lastSeen
     ) {
+        this.confidence = confidence;
         this.id = id;
+        this.lastSeen = lastSeen;
     }
 
     public Device() {
-        this(null);
+        this(null, null, null);
+    }
+
+    /**
+     * @return a number representing the confidence that the device ID refers
+     * to a unique device as opposed to a cluster of similar devices. A
+     * confidence of 0.01 indicates very low confidence that the device is
+     * unique, whereas 99 indicates very high confidence.
+     */
+    public Double getConfidence() {
+        return confidence;
     }
 
     /**
-     * @return The device id.
+     * @return A UUID identifying the device associated with this IP address.
+     * Note that many devices cannot be uniquely identified because they are too
+     * common (for example, all iPhones of a given model and OS release).
      */
     public UUID getId() {
         return id;
     }
+
+    /**
+     * @return The date and time of the last sighting of the device. This is an
+     * RFC 3339 date-time.
+     */
+    @JsonProperty("last_seen")
+    public String getLastSeen() {
+        return lastSeen;
+    }
 }

src/test/java/com/maxmind/minfraud/WebServiceClientTest.java

@@ -23,10 +23,10 @@
 public class WebServiceClientTest {
 
     @Rule
-    public ExpectedException thrown = ExpectedException.none();
+    public final ExpectedException thrown = ExpectedException.none();
 
     @Rule
-    public WireMockRule wireMockRule = new WireMockRule(0); // 0 picks random port
+    public final WireMockRule wireMockRule = new WireMockRule(0); // 0 picks random port
 
     @Test
     public void testFullScoreTransaction() throws Exception {

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

@@ -16,11 +16,15 @@ public void testDevice() throws Exception {
                 JSON.std
                         .composeString()
                         .startObject()
+                        .put("confidence", 99)
                         .put("id", "C8D3BE1A-BE26-11E5-8C50-1B575C37265F")
+                        .put("last_seen", "2016-06-08T14:16:38Z")
                         .end()
                         .finish()
         );
 
+        assertEquals(99.0, device.getConfidence(), 1e-15);
         assertEquals(UUID.fromString("C8D3BE1A-BE26-11E5-8C50-1B575C37265F"), device.getId());
+        assertEquals("2016-06-08T14:16:38Z", device.getLastSeen());
     }
 }

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

@@ -9,8 +9,6 @@ public class SubscoresTest extends AbstractOutputTest {
 
     @Test
     public void testSubscores() throws Exception {
-        String phone = "132-342-2131";
-
         Subscores subscores = this.deserialize(
                 Subscores.class,
                 JSON.std

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

@@ -111,7 +111,9 @@
     "type": "credit"
   },
   "device": {
-    "id": "7835b099-d385-4e5b-969e-7df26181d73b"
+    "confidence": 99,
+    "id": "7835b099-d385-4e5b-969e-7df26181d73b",
+    "last_seen": "2016-06-08T14:16:38Z"
   },
   "email": {
     "is_free": true,