Merge pull request #261 from maxmind/greg/module

Make a Java Module and prepare for 3.0.0 release

Author: shadromani

.github/workflows/test.yml

@@ -17,5 +17,7 @@ jobs:
         with:
           distribution: ${{ matrix.distribution }}
           java-version: ${{ matrix.version }}
-      - run: mvn javadoc:javadoc
       - run: mvn test -B
+      # This is after the test run to work around
+      # https://issues.apache.org/jira/projects/MJAVADOC/issues/MJAVADOC-736
+      - run: mvn javadoc:javadoc

CHANGELOG.md

@@ -1,6 +1,21 @@
 CHANGELOG
 =========
 
+3.0.0
+------------------
+
+* This library is now a Java module.
+* Removed deprecated `last4Digits` method on `CreditCard.Builder` and
+  `getLast4Digits` method on `CreditCard`. Use `lastDigits` and
+  `getLastDigits` instead.
+* Removed deprecated `connectTimeout(int)`, `readTimeout(int)`, and
+  `proxy(Proxy)` on `WebServiceClient.Builder`. Use
+  `connectTimeout(Duration)`, `requestTimeout(Duration)`, and
+  `proxy(ProxySelector)` instead.
+* `WebServiceClient` no longer implements `Closeable` and the `Close`
+  method has been removed. This method was deprecated when the library
+  switched to using `java.net.http.HttpClient`.
+
 2.2.0 (2022-10-31)
 ------------------
 
@@ -62,9 +77,9 @@ CHANGELOG
   * `TRUSTLY`
   * `WINDCAVE`
 * `com.maxmind.minfraud.request.CreditCard.last4Digits` has been deprecated in
-   favor of `lastDigits` and will be removed in a future release. `lastDigits`
-   / `last4Digits` also now supports two digit values in addition to the
-   previous four digit values.
+  favor of `lastDigits` and will be removed in a future release. `lastDigits`
+  / `last4Digits` also now supports two digit values in addition to the
+  previous four digit values.
 * Eight digit `com.maxmind.minfraud.request.CreditCard.issuerIdNumber` inputs are
   now supported in addition to the previously accepted six digit `issuerIdNumber`.
   In most cases, you should send the last four digits for
@@ -281,24 +296,24 @@ CHANGELOG
 
 * Added support for custom inputs. These can be set up from your account portal.
 * Added support for new Device inputs. These are:
-    * `/device/session_age`
-    * `/device/session_id`
+  * `/device/session_age`
+  * `/device/session_id`
 * Added support for new Email outputs. These are:
-    * `/email/first_seen`
+  * `/email/first_seen`
 * The following payment processors were added to the `Payment.Processor` enum:
-    * `AMERICAN_EXPRESS_PAYMENT_GATEWAY`
-    * `BLUESNAP`
-    * `COMMDOO`
-    * `CUROPAYMENTS`
-    * `EXACT`
-    * `OCEANPAYMENT`
-    * `PAYMENTWALL`
-    * `PAYZA`
-    * `SECURETRADING`
-    * `SOLIDTRUST_PAY`
-    * `VANTIV`
-    * `VERICHECK`
-    * `VPOS`
+  * `AMERICAN_EXPRESS_PAYMENT_GATEWAY`
+  * `BLUESNAP`
+  * `COMMDOO`
+  * `CUROPAYMENTS`
+  * `EXACT`
+  * `OCEANPAYMENT`
+  * `PAYMENTWALL`
+  * `PAYZA`
+  * `SECURETRADING`
+  * `SOLIDTRUST_PAY`
+  * `VANTIV`
+  * `VERICHECK`
+  * `VPOS`
 
 1.4.0 (2017-02-22)
 ------------------
@@ -377,11 +392,11 @@ CHANGELOG
 ------------------
 
 * Added support for new minFraud Insights outputs. These are:
-    * `/credit_card/brand`
-    * `/credit_card/type`
-    * `/device/id`
-    * `/email/is_free`
-    * `/email/is_high_risk`
+  * `/credit_card/brand`
+  * `/credit_card/type`
+  * `/device/id`
+  * `/email/is_free`
+  * `/email/is_high_risk`
 * The `Warning.getInput()` method has been replaced by
   `Warning.getInputPointer()`, which returns a JSON Pointer rather than array.
 * The `ScoreResponse.getId()` and `InsightsResponse.getId()` methods now

README.dev.md

@@ -1,4 +1,5 @@
 # Preparing your environment for a release
+
 - Ensure you have access to publish to the repository on
   [Sonatype](https://oss.sonatype.org).
   - See the section about Sonatype access.
@@ -14,8 +15,8 @@
   `PATH`.
   - An easy way to do this is get a release tarball and run `./install`.
 
-
 ## Setting up Sonatype access
+
 To get this access, make an account on the [Sonatype JIRA issue
 tracker](https://issues.sonatype.org/) and make an issue asking for access
 [like so](https://issues.sonatype.org/browse/OSSRH-34414).
@@ -66,14 +67,14 @@ Some links about Sonatype:
 * http://central.sonatype.org/pages/releasing-the-deployment.html
 * http://central.sonatype.org/pages/apache-maven.html
 
-
 See the following documentation for details on specifying which gpg to use for
 publishing in your local settings.xml:
 
 * https://central.sonatype.org/publish/requirements/gpg/
 * https://maven.apache.org/plugins/maven-gpg-plugin/usage.html
 
 ## Setting up GPG
+
 You need a key. It is fine to create/use your own, but you'll probably want
 one with your MaxMind email address.
 
@@ -93,8 +94,8 @@ Make sure you publish it to a keyserver. See
 [here](http://central.sonatype.org/pages/working-with-pgp-signatures.html)
 for more info about that and the process in general.
 
-
 ### gpg "inappropriate ioctl" errors
+
 You only really need to do this if you see "inappropriate ioctl" errors,
 but it shouldn't hurt to proactively do this.
 
@@ -107,10 +108,10 @@ Add this to ~/.gnupg/gpg-agent.conf:
 
     allow-loopback-pinentry
 
-
 # Releasing
 
 ## Steps
+
 - Ensure you can run `mvn test` and `mvn package` successfully. Run
   `mvn clean` after.
 - Create a release branch off `main`. Ensure you have a clean checkout and that
@@ -164,8 +165,8 @@ Add this to ~/.gnupg/gpg-agent.conf:
   search on [Sonatype](https://oss.sonatype.org) to see the version is as
   you expect.
 
-
 ## Updating dependencies
+
 Review the versions and look at what changed in their changelogs. If you
 think it is appropriate to update the dependencies, stop the release
 process (say `n` or ctrl-c out).

checkstyle-suppressions.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+
+<!DOCTYPE suppressions PUBLIC
+        "-//Checkstyle//DTD SuppressionFilter Configuration 1.0//EN"
+        "https://checkstyle.org/dtds/suppressions_1_0.dtd">
+
+<suppressions>
+    <suppress checks="Indentation" files="Email.java" lines="28-38"/>
+    <suppress checks="LineLength" files="AbstractAddress.java" lines="13"/>
+    <suppress checks="LineLength" files="AbstractLocation.java" lines="131"/>
+    <suppress checks="LineLength" files="CreditCard.java" lines="33,43,44,67,93,95,140,142"/>
+    <suppress checks="LineLength" files="Email.java" lines="93"/>
+    <suppress checks="LineLength" files="GeoIp2Location.java" lines="25"/>
+    <suppress checks="LineLength" files="IpAddress.java" lines="33,53,56"/>
+    <suppress checks="LineLength" files="ScoreResponse.java" lines="37"/>
+    <suppress checks="LineLength" files="ShoppingCartItem.java" lines="58"/>
+    <suppress checks="LineLength" files="Subscores.java" lines="32,41,46,52,66"/>
+    <suppress checks="LineLength" files="TransactionReport.java" lines="75,76,82"/>
+    <suppress checks="LineLength" files="WebServiceClient.java" lines="143,393,504"/>
+
+</suppressions>

checkstyle.xml

@@ -32,7 +32,7 @@
     <!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->
     <module name="SuppressionFilter">
         <property name="file" value="${org.checkstyle.google.suppressionfilter.config}"
-                  default="checkstyle-suppressions.xml" />
+                  default="checkstyle-suppressions.xml"/>
         <property name="optional" value="true"/>
     </module>
 
@@ -362,14 +362,14 @@
         <!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->
         <module name="SuppressionXpathFilter">
             <property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}"
-                      default="checkstyle-xpath-suppressions.xml" />
+                      default="checkstyle-xpath-suppressions.xml"/>
             <property name="optional" value="true"/>
         </module>
-        <module name="SuppressWarningsHolder" />
+        <module name="SuppressWarningsHolder"/>
         <module name="SuppressionCommentFilter">
-            <property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)" />
-            <property name="onCommentFormat" value="CHECKSTYLE.ON\: ([\w\|]+)" />
-            <property name="checkFormat" value="$1" />
+            <property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)"/>
+            <property name="onCommentFormat" value="CHECKSTYLE.ON\: ([\w\|]+)"/>
+            <property name="checkFormat" value="$1"/>
         </module>
         <module name="SuppressWithNearbyCommentFilter">
             <property name="commentFormat" value="CHECKSTYLE.SUPPRESS\: ([\w\|]+)"/>

pom.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
     <groupId>com.maxmind.minfraud</groupId>
@@ -35,13 +36,6 @@
             <email>goschwald@maxmind.com</email>
         </developer>
     </developers>
-    <properties>
-        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-            <checkstyle-maven-plugin.version>3.2.0</checkstyle-maven-plugin.version>
-            <checkstyle.version>10.3</checkstyle.version>
-            <checkstyle.config.location>checkstyle.xml</checkstyle.config.location>
-            <checkstyle.suppressions.location>suppressions.xml</checkstyle.suppressions.location>
-    </properties>
     <dependencies>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
@@ -113,34 +107,26 @@
     <build>
         <plugins>
             <plugin>
-                <groupId>org.openrewrite.maven</groupId>
-                <artifactId>rewrite-maven-plugin</artifactId>
-                <version>4.37.0</version>
-                <configuration>
-                    <activeRecipes>
-                        <recipe>org.openrewrite.java.cleanup.Cleanup</recipe>
-                    </activeRecipes>
-                </configuration>
-            </plugin>
-            <plugin>
-
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-checkstyle-plugin</artifactId>
-                <version>${checkstyle-maven-plugin.version}</version>
+                <version>3.2.0</version>
                 <configuration>
                     <consoleOutput>true</consoleOutput>
+                    <configLocation>checkstyle.xml</configLocation>
+                    <suppressionsLocation>checkstyle-suppressions.xml</suppressionsLocation>
+                    <violationSeverity>warning</violationSeverity>
                 </configuration>
                 <dependencies>
                     <dependency>
                         <groupId>com.puppycrawl.tools</groupId>
                         <artifactId>checkstyle</artifactId>
-                        <version>${checkstyle.version}</version>
+                        <version>10.5.0</version>
                     </dependency>
                 </dependencies>
                 <executions>
                     <execution>
-                        <id>validate</id>
-                        <phase>validate</phase>
+                        <id>test</id>
+                        <phase>test</phase>
                         <goals>
                             <goal>check</goal>
                         </goals>
@@ -249,7 +235,7 @@
                 <configuration>
                     <format>xml</format>
                     <maxmem>256m</maxmem>
-                    <check />
+                    <check/>
                 </configuration>
             </plugin>
             <plugin>
@@ -270,7 +256,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-checkstyle-plugin</artifactId>
-                <version>${checkstyle-maven-plugin.version}</version>
+                <version>3.2.0</version>
                 <reportSets>
                     <reportSet>
                         <reports>

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

@@ -10,16 +10,16 @@
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 
 class Mapper {
-    private static final  ObjectMapper mapper = JsonMapper.builder()
-            .addModule(new JavaTimeModule())
-            .defaultDateFormat(new StdDateFormat().withColonInTimeZone(true))
-            .enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING)
-            .disable(MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS)
-            .disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)
-            .disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS)
-            .serializationInclusion(JsonInclude.Include.NON_NULL)
-            .serializationInclusion(JsonInclude.Include.NON_EMPTY)
-            .build();
+    private static final ObjectMapper mapper = JsonMapper.builder()
+        .addModule(new JavaTimeModule())
+        .defaultDateFormat(new StdDateFormat().withColonInTimeZone(true))
+        .enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING)
+        .disable(MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS)
+        .disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)
+        .disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS)
+        .serializationInclusion(JsonInclude.Include.NON_NULL)
+        .serializationInclusion(JsonInclude.Include.NON_EMPTY)
+        .build();
 
     public static ObjectMapper get() {
         return mapper;