Merge pull request #4 from maxmind/dave/new-minfraud-outputs

Updates for the upcoming new Insights outputs

Author: oschwald

CHANGELOG.md

@@ -1,6 +1,19 @@
 CHANGELOG
 =========
 
+0.3.0 ()
+
+* Added support for new minFraud Insights outputs. These are:
+    * `/credit_card/brand`
+    * `/credit_card/type`
+    * `/device/id`
+    * `/email/is_free`
+    * `/emai/is_high_risk`
+* The `Warning.getInput` getter has been replaced by
+  `Warning.getInputPointer`, which returns a JSON Pointer rather than array.
+* The `ScoreResponse.getId` and `InsightsResponse.getId` getters now return
+  `UUID` objects instead of strings.
+
 0.2.0 (2016-01-15)
 ------------------
 

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

@@ -1,31 +1,38 @@
 package com.maxmind.minfraud.response;
 
-import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonValue;
 
 /**
  * This class contains minFraud response data related to the credit card.
  */
 public final class CreditCard {
     private final Issuer issuer;
+    private final String brand;
     private final String country;
     private final Boolean isIssuedInBillingAddressCountry;
     private final Boolean isPrepaid;
+    private final String type;
 
     public CreditCard(
+            @JsonProperty("brand") String brand,
             @JsonProperty("country") String country,
             @JsonProperty("is_issued_in_billing_address_country") Boolean isIssuedInBillingAddressCountry,
             @JsonProperty("is_prepaid") Boolean isPrepaid,
-            @JsonProperty("issuer") Issuer issuer
+            @JsonProperty("issuer") Issuer issuer,
+            @JsonProperty("type") String type
     ) {
+        this.brand = brand;
         this.country = country;
         this.isIssuedInBillingAddressCountry = isIssuedInBillingAddressCountry;
         this.isPrepaid = isPrepaid;
         this.issuer = issuer == null ? new Issuer() : issuer;
+        this.type = type;
     }
 
     public CreditCard() {
-        this(null, null, null, null);
+        this(null, null, null, null, null, null);
     }
 
     /**
@@ -35,6 +42,13 @@ public Issuer getIssuer() {
         return issuer;
     }
 
+    /**
+     * @return The credit card brand.
+     */
+    public String getBrand() {
+        return brand;
+    }
+
     /**
      * @return The two letter <a href="http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">
      * ISO 3166-1 alpha-2</a> country code associated with the location
@@ -67,13 +81,22 @@ public Boolean isPrepaid() {
         return isPrepaid;
     }
 
+    /**
+     * @return The credit card type.
+     */
+    public String getType() {
+        return type;
+    }
+
     @Override
     public String toString() {
         StringBuilder sb = new StringBuilder("CreditCard{");
         sb.append("issuer=").append(this.issuer);
+        sb.append(", brand='").append(this.brand).append('\'');
         sb.append(", country='").append(this.country).append('\'');
         sb.append(", isIssuedInBillingAddressCountry=").append(this.isIssuedInBillingAddressCountry);
         sb.append(", isPrepaid=").append(this.isPrepaid);
+        sb.append(", type='").append(this.type).append('\'');
         sb.append('}');
         return sb.toString();
     }

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

@@ -0,0 +1,37 @@
+package com.maxmind.minfraud.response;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.util.UUID;
+
+/**
+ * This class contains minFraud response data related to the device.
+ */
+public final class Device {
+    private final UUID id;
+
+    public Device(
+            @JsonProperty("id") UUID id
+    ) {
+        this.id = id;
+    }
+
+    public Device() {
+        this(null);
+    }
+
+    /**
+     * @return The device id.
+     */
+    public UUID getId() {
+        return id;
+    }
+
+    @Override
+    public String toString() {
+        StringBuilder sb = new StringBuilder("Device{");
+        sb.append("id=").append(this.id);
+        sb.append('}');
+        return sb.toString();
+    }
+}

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

@@ -0,0 +1,48 @@
+package com.maxmind.minfraud.response;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * This class contains minFraud response data related to the email address.
+ */
+public final class Email {
+    private final Boolean isFree;
+    private final Boolean isHighRisk;
+
+    public Email(
+            @JsonProperty("is_free") Boolean isFree,
+            @JsonProperty("is_high_risk") Boolean isHighRisk
+    ) {
+        this.isFree = isFree;
+        this.isHighRisk = isHighRisk;
+    }
+
+    public Email() {
+        this(null, null);
+    }
+
+    /**
+     * @return True if the email address is for a free email service provider.
+     */
+    @JsonProperty("is_free")
+    public Boolean isFree() {
+        return isFree;
+    }
+
+    /**
+     * @return True if the email address is associated with fraud.
+     */
+    @JsonProperty("is_high_risk")
+    public Boolean isHighRisk() {
+        return isHighRisk;
+    }
+
+    @Override
+    public String toString() {
+        StringBuilder sb = new StringBuilder("Email{");
+        sb.append("is_free=").append(this.isFree);
+        sb.append(", is_high_risk=").append(this.isHighRisk);
+        sb.append('}');
+        return sb.toString();
+    }
+}

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

@@ -3,21 +3,26 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 import java.util.List;
+import java.util.UUID;
 
 /**
  * This class provides a model for the minFraud Insights response.
  */
 public final class InsightsResponse extends ScoreResponse {
     private final IpAddress ipAddress;
     private final CreditCard creditCard;
+    private final Device device;
+    private final Email email;
     private final ShippingAddress shippingAddress;
     private final BillingAddress billingAddress;
 
     public InsightsResponse(
             @JsonProperty("billing_address") BillingAddress billingAddress,
             @JsonProperty("credit_card")  CreditCard creditCard,
+            @JsonProperty("device")  Device device,
+            @JsonProperty("email")  Email email,
             @JsonProperty("credits_remaining") Integer creditsRemaining,
-            @JsonProperty("id") String id,
+            @JsonProperty("id") UUID id,
             @JsonProperty("ip_address") IpAddress ipAddress,
             @JsonProperty("risk_score") Double riskScore,
             @JsonProperty("shipping_address") ShippingAddress shippingAddress,
@@ -27,6 +32,8 @@ public InsightsResponse(
         super(creditsRemaining, id, riskScore, warnings);
         this.billingAddress = billingAddress == null ? new BillingAddress() : billingAddress;
         this.creditCard = creditCard == null ? new CreditCard() : creditCard;
+        this.device = device == null ? new Device() : device;
+        this.email = email == null ? new Email() : email;
         this.ipAddress = ipAddress == null ? new IpAddress() : ipAddress;
         this.shippingAddress = shippingAddress == null ? new ShippingAddress() : shippingAddress;
     }
@@ -47,6 +54,20 @@ public CreditCard getCreditCard() {
         return creditCard;
     }
 
+    /**
+     * @return The {@code Device} model object.
+     */
+    public Device getDevice() {
+        return device;
+    }
+
+    /**
+     * @return The {@code Email} model object.
+     */
+    public Email getEmail() {
+        return email;
+    }
+
     /**
      * @return The {@code ShippingAddress} model object.
      */
@@ -72,6 +93,8 @@ public String toString() {
         sb.append(", warnings=").append(this.warnings);
         sb.append(", ipAddress=").append(this.ipAddress);
         sb.append(", creditCard=").append(this.creditCard);
+        sb.append(", device=").append(this.device);
+        sb.append(", email=").append(this.email);
         sb.append(", shippingAddress=").append(this.shippingAddress);
         sb.append(", billingAddress=").append(this.billingAddress);
         sb.append('}');

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

@@ -9,19 +9,20 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import java.util.UUID;
 
 /**
  * This class represents the minFraud Score response.
  */
 public class ScoreResponse {
     protected final Integer creditsRemaining;
-    protected final String id;
+    protected final UUID id;
     protected final Double riskScore;
     protected final List<Warning> warnings;
 
     public ScoreResponse(
             @JsonProperty("credits_remaining") Integer creditsRemaining,
-            @JsonProperty("id") String id,
+            @JsonProperty("id") UUID id,
             @JsonProperty("risk_score") Double riskScore,
             @JsonProperty("warnings") List<Warning> warnings
     ) {
@@ -43,7 +44,7 @@ public final Integer getCreditsRemaining() {
     /**
      * @return This is a UUID that identifies the minFraud request.
      */
-    public final String getId() {
+    public final UUID getId() {
         return id;
     }
 

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

@@ -13,16 +13,16 @@
 public final class Warning {
     private final String code;
     private final String warning;
-    private final List<String> input;
+    private final String inputPointer;
 
     public Warning(
             @JsonProperty("code") String code,
-            @JsonProperty("input") List<String> input,
-            @JsonProperty("warning") String warning
+            @JsonProperty("warning") String warning,
+            @JsonProperty("input_pointer") String inputPointer
     ) {
         this.code = code;
-        this.input = Collections.unmodifiableList(input == null ? new ArrayList<String>() : input);
         this.warning = warning;
+        this.inputPointer = inputPointer;
     }
 
     /**
@@ -66,21 +66,22 @@ public String getWarning() {
     }
 
     /**
-     * @return This is a list of keys representing the path to the input that
-     * the warning is associated with. For instance, if the warning was about
-     * the billing city, the list would contain "billing" followed by "city".
-     * The key is used for object and the index number for an array.
+     * @return This is a JSON Pointer to the input that the warning is
+     * associated with. For instance, if the warning was about the billing
+     * city, the value would be "/billing/city". See
+     * https://tools.ietf.org/html/rfc6901 for the JSON Pointer spec.
      */
-    public List<String> getInput() {
-        return new ArrayList<>(this.input);
+    @JsonProperty("input_pointer")
+    public String getInputPointer() {
+        return this.inputPointer;
     }
 
     @Override
     public String toString() {
         final StringBuilder sb = new StringBuilder("Warning{");
         sb.append("code='").append(code).append('\'');
         sb.append(", warning='").append(warning).append('\'');
-        sb.append(", input=").append(input);
+        sb.append(", inputPointer=").append(inputPointer);
         sb.append('}');
         return sb.toString();
     }

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

@@ -18,16 +18,21 @@ public void testCreditCard() throws Exception {
                         .startObjectField("issuer")
                         .put("name", "Bank")
                         .end()
+                        .put("brand", "Visa")
                         .put("country", "US")
                         .put("is_issued_in_billing_address_country", true)
                         .put("is_prepaid", true)
+                        .put("type", "credit")
                         .end()
                         .finish()
         );
 
         assertEquals("Bank", cc.getIssuer().getName());
         assertEquals("US", cc.getCountry());
+        assertEquals("Visa", cc.getBrand());
+        assertEquals("credit", cc.getType());
         assertTrue(cc.isPrepaid());
         assertTrue(cc.isIssuedInBillingAddressCountry());
     }
-}
+
+}

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

@@ -0,0 +1,26 @@
+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 DeviceTest extends AbstractOutputTest {
+
+    @Test
+    public void testDevice() throws Exception {
+        Device device = this.deserialize(
+                Device.class,
+                JSON.std
+                        .composeString()
+                        .startObject()
+                        .put("id", "C8D3BE1A-BE26-11E5-8C50-1B575C37265F")
+                        .end()
+                        .finish()
+        );
+
+        assertEquals(UUID.fromString("C8D3BE1A-BE26-11E5-8C50-1B575C37265F"), device.getId());
+    }
+}