Merge pull request #6 from maxmind/greg/mf-factors

Add Factors. Add IP risk to Score.

Author: 2shortplanks

CHANGELOG.md

@@ -1,11 +1,16 @@
 CHANGELOG
 =========
 
-0.3.1 (2016-XX-XX)
+0.4.0 (2016-XX-XX)
 ------------------
 
+* Added support for the minFraud Factors.
+* Added IP address risk to the minFraud Score model.
+* Handle `PERMISSION_REQUIRED` errors by throwing a
+  `PermissionRequiredException`.
+* Updated dependency.
 * Added the following new values to the `Payment.Processor` enum:
-  `CCNOW`, `DALPAY`, `EPAY` (repaces `EPAYEU`), `PAYPLUS`, `PINPAYMENTS`,
+  `CCNOW`, `DALPAY`, `EPAY` (replaces `EPAYEU`), `PAYPLUS`, `PINPAYMENTS`,
   `QUICKPAY`, and `VERAPAY
 
 0.3.0 (2016-01-22)

README.md

@@ -1,18 +1,18 @@
-# MaxMind minFraud Score and Insights Java API
+# MaxMind minFraud Score, Insights, and Factors Java API
 
 ## Beta Note ##
 
 This is a beta release. The API may change before the first production
 release.
 
-You may find information on the changes in minFraud Score and minFraud
-Insights in our [What's New
+You may find information on the changes in minFraud Score, Insights, and Factors
+in our [What's New
 documentation](https://dev.maxmind.com/minfraud/whats-new-in-minfraud-score-and-minfraud-insights/).
 
 ## Description ##
 
-This package provides an API for the [MaxMind minFraud Score and Insights
-web services](http://dev.maxmind.com/minfraud-score-and-insights-api-documentation).
+This package provides an API for the [MaxMind minFraud Score, Insights, and
+Factors web services](http://dev.maxmind.com/minfraud-score-and-insights-api-documentation).
 
 ## Installation ##
 
@@ -57,13 +57,19 @@ After creating the transaction object, send a Score request by calling the
 `score` method:
 
 ```java
-Score score = client.score(transaction);
+ScoreResponse score = client.score(transaction);
 ```
 
-or an Insights request by calling `insights` method:
+an Insights request by calling `insights` method:
 
 ```java
-Insights score = client.insights(transaction);
+InsightsResponse insights = client.insights(transaction);
+```
+
+an Factors request by calling `factors` method:
+
+```java
+FactorsResponse factors = client.factors(transaction);
 ```
 
 If the request succeeds, a model object will be returned for the endpoint.
@@ -81,20 +87,18 @@ Runtime exceptions:
 
 Checked exceptions:
 
-* `AuthenticationException` - This will be thrown by `score(transaction)` or
-  `insights(transaction)` on `WebServiceClient` when the server is unable to
+* `AuthenticationException` - This will be thrown when the server is unable to
   authenticate the request, e.g., if the license key or user ID is invalid.
-* `InsufficientFundsException` - This will be thrown by `score(transaction)` or
-  `insights(transaction)` on `WebServiceClient` when your account is out of funds.
-* `InvalidRequestException` - This will be thrown by `score(transaction)` or
-  `insights(transaction)` on `WebServiceClient` when the server rejects the
+* `InsufficientFundsException` - This will be thrown when your account is out of
+  funds.
+* `InvalidRequestException` - This will be thrown when the server rejects the
   request for another reason such as invalid JSON in the POST.
-* `MinFraudException` - This will be thrown by `score(transaction)` or
-  `insights(transaction)` on `WebServiceClient` when the server returns an
+* `PermissionRequiredException` - This will be thrown when permission is
+  required to use the service.
+* `MinFraudException` - This will be thrown when the server returns an
   unexpected response. This also serves as the base class for the above
   checked exceptions.
-* `HttpException` -This will be thrown by `score(transaction)` or
-  `insights(transaction)` on `WebServiceClient` when an unexpected HTTP error
+* `HttpException` -This will be thrown when an unexpected HTTP error
   occurs such as an internal server error or other unexpected status code.
 
 ## Example
@@ -220,6 +224,6 @@ This API uses [Semantic Versioning](http://semver.org/).
 
 ## Copyright and License ##
 
-This software is Copyright (c) 2016 by MaxMind, Inc.
+This software is Copyright (c) 2015-2016 by MaxMind, Inc.
 
 This is free software, licensed under the Apache License, Version 2.0.

pom.xml

@@ -39,15 +39,36 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
     <dependencies>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-core</artifactId>
+            <version>2.7.3</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.7.3</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-annotations</artifactId>
+            <version>2.7.3</version>
+        </dependency>
         <dependency>
             <groupId>com.maxmind.geoip2</groupId>
             <artifactId>geoip2</artifactId>
-            <version>2.6.0</version>
+            <version>2.7.0</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>com.google.http-client</groupId>
+                    <artifactId>google-http-client</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
         <dependency>
             <groupId>org.apache.httpcomponents</groupId>
             <artifactId>httpclient</artifactId>
-            <version>4.5.1</version>
+            <version>4.5.2</version>
         </dependency>
         <dependency>
             <groupId>commons-validator</groupId>
@@ -63,7 +84,7 @@
         <dependency>
             <groupId>com.github.tomakehurst</groupId>
             <artifactId>wiremock</artifactId>
-            <version>2.0.8-beta</version>
+            <version>2.0.10-beta</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -75,19 +96,19 @@
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-simple</artifactId>
-            <version>1.7.13</version>
+            <version>1.7.21</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.jr</groupId>
             <artifactId>jackson-jr-objects</artifactId>
-            <version>2.7.0</version>
+            <version>2.7.4</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>pl.pragmatists</groupId>
             <artifactId>JUnitParams</artifactId>
-            <version>1.0.4</version>
+            <version>1.0.5</version>
             <scope>test</scope>
         </dependency>
         <dependency>

src/main/java/com/maxmind/minfraud/AbstractModel.java

@@ -0,0 +1,37 @@
+package com.maxmind.minfraud;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.MapperFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+
+import java.io.IOException;
+
+public abstract class AbstractModel {
+
+    /**
+     * @return JSON representation of this object.
+     * @throws IOException if there is an error serializing the object to JSON.
+     */
+    public final String toJson() throws IOException {
+        ObjectMapper mapper = new ObjectMapper();
+        mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+        mapper.setSerializationInclusion(JsonInclude.Include.NON_EMPTY);
+        mapper.enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING);
+        mapper.disable(MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS);
+        mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
+
+        return mapper.writeValueAsString(this);
+    }
+
+    @Override
+    public String toString() {
+        // This exception should never happen. If it does happen, we did
+        // something wrong.
+        try {
+            return getClass().getName() + " [ " + toJson() + " ]";
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
+    }
+}