Merge pull request #34 from maxmind/horgh/is-in-eu

oschwald · web-flow · commit 639e33a68994 · 2018-01-19T12:11:35.000-08:00
Update geoip2 dependency and add support for is_in_european_union
diff --git a/.travis.yml b/.travis.yml
@@ -15,6 +15,7 @@ language: java
 jdk:
   - openjdk7
   - oraclejdk8
+  - oraclejdk9
 env:
   global:
     - secure: ExeU8coyJzkKuZwLjeVUl8y0PgEWQ7xl3JBFcJcYyweVQbid0Av2ZDEdOrJDTiT7Vb7/Gmny0sUOCyclPDOH8RS+0ENerhA/JDgsrU8KfSDLvPDjBXPX7sEnLVbCmM0SESjRNZ8apVgZexcbODQRfv6FRgpue0TomVb35c/Jdeu577DdEhXUr3PYbgluKhayZlRoJgdEYRKGolbstlkA4Zx6hUDoq2+Wzt782bQ7SOZD/Xi4VG/X7T8sUNjbg8JpxoN2rf/1Jsa3+HGVIaArda6KQu03iNQ/nqgRMB5Q9lOMXIwoLjEFVWHrJd7mBaHaHI0AJnCem/DP7amTsyv6vjgXHTHlPS2Cf6X/127ljry1+oOwLLe7o3ofsZkKB1+0+VhalHXFM60KHwAdsgYP1wS2uP8ITfNG3GGkVp8boS586Kkd0LfGxXEnqhiKYlJlChqlCJTnHwzo/eIQGymGcAxLXQo5vYiK/CwkXyewIbeR+u1yRuXTudwXE6bQaDUTQhl4EPut4MDlovrE61quk3OtBLtS085k9gggU9M0Av8VX+LXdPke+39Z/fAFjdVoGSOkmvAKDftlaqR79TQ/ALN/dhl9d9umVd1xcxig+uQxrXR+HSdXz2ISNnacEP0ejrbOYLJbb5ph7ftZmkC/fsk8BcSt7eAncHXbASJeaM4=
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ CHANGELOG
 1.8.0
 ------------------
 
+* Updated `geoip2` dependency. This version adds the `isInEuropeanUnion()`
+  method to `com.maxmind.geoip2.record.Country` and
+  `com.maxmind.minfraud.response.GeoIp2Country`. This returns `true` if the
+  country is a member state of the European Union.
 * The web service client now correctly handles a proxy of `Proxy.NO_PROXY`.
   PR by Ernest Sadykov. GitHub #32.
 * The following payment processors were added to the `Payment.Processor` enum:
diff --git a/README.dev.md b/README.dev.md
@@ -1,18 +1,18 @@
 # 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.
-  - You need a GPG secret key. You need to publish it as well.
-    - See the section about setting up GPG.
-  - Ensure the SSH key you use on GitHub.com is available.
-    - e.g., `~/.ssh/id_rsa`.
-  - Ensure an appropriate `~/.gitconfig` is set up.
-    - The release process generates commits.
-  - Ensure you have the necessary dependencies available:
-    - e.g., `apt-get install maven openjdk-8-jdk git-core gpg`
-  - Ensure [hub](https://github.com/github.com/hub) is set up and in your
-    `PATH`.
-    - An easy way to do this is get a release tarball and run `./install`.
+- Ensure you have access to publish to the repository on
+  [Sonatype](https://oss.sonatype.org).
+  - See the section about Sonatype access.
+- You need a GPG secret key. You need to publish it as well.
+  - See the section about setting up GPG.
+- Ensure the SSH key you use on GitHub.com is available.
+  - e.g., `~/.ssh/id_rsa`.
+- Ensure an appropriate `~/.gitconfig` is set up.
+  - The release process generates commits.
+- Ensure you have the necessary dependencies available:
+  - e.g., `apt-get install maven openjdk-8-jdk git-core gpg`
+- Ensure [hub](https://github.com/github.com/hub) is set up and in your
+  `PATH`.
+  - An easy way to do this is get a release tarball and run `./install`.
 
 
 ## Setting up Sonatype access
@@ -51,9 +51,9 @@ Put this information into `~/.m2/settings.xml` (Maven settings). Your
 
 Some links about Sonatype:
 
-  * http://central.sonatype.org/pages/ossrh-guide.html
-  * http://central.sonatype.org/pages/releasing-the-deployment.html
-  * http://central.sonatype.org/pages/apache-maven.html
+* http://central.sonatype.org/pages/ossrh-guide.html
+* http://central.sonatype.org/pages/releasing-the-deployment.html
+* http://central.sonatype.org/pages/apache-maven.html
 
 
 ## Setting up GPG
@@ -94,47 +94,57 @@ Add this to ~/.gnupg/gpg-agent.conf:
 # Releasing
 
 ## Steps
-  - Ensure you can run `mvn test` and `mvn package` successfully. Run
-    `mvn clean` after.
-  - Ensure you have a clean checkout of `master` and that the subdirectory
-    `.gh-pages` either does not exist or is a clean checkout.
-    - We'll be generating commits.
-  - Set a version and a date in `CHANGELOG.md` and commit that.
-    - It gets used in the release process.
-  - Run `./dev-bin/release.sh`
-  - This will prompt you several times. Generally you need to say `y` or
-    `n`.
-  - You'll be prompted for your ssh key password, GPG key password, and
-    GitHub.com username and password several times depending on your
-    workspace.
-  - You may be prompted about "what is the next development version?". Hit
-    enter to use the default which should be fine.
-  - You may be prompted about "The following dependencies in Dependencies
-    have newer versions". See the section about updating dependencies if so.
-  - If you get HTTP 401 errors from Sonatype, you probably don't have a
-    correct `settings.xml`. Refer to the Sonatype section.
-    - If this happened, there are most likely pushed commits on GitHub.com.
-      You can potentially rebase and drop the commits and force push and
-      start over (you might want to talk about this before doing it). Note
-      you'll need to delete the release tag too:
-      `git push origin :refs/tags/vx.y.z && git tag -d vx.y.z`.
-  - If you get to this point, then a release is on GitHub.com and in the
-    staging repository on [Sonatype](https://oss.sonatype.org).
-  - Go to [Sonatype](https://oss.sonatype.org) and log in.
-  - On the left hand side, choose Staging repositories.
-  - At the bottom you should see your staged release. It will be something
-    like "commmaxmind-xxxx". Click on that.
-  - Near the top of the page there is a "Close" button. Click it.
-    - You have to close a staging release before you can release it.
-  - Wait around 30 seconds. Click Refresh near the top of the page while
-    you wait. Eventually you should see the "Activity" line in the info
-    about your repository say something like it is complete.
-  - Click Release near the top.
-  - You're done!
-  - If you want to check things over, look at the commits on GitHub.com,
-    including to the `gh-pages` branch and release tags, and do an artifact
-    search on [Sonatype](https://oss.sonatype.org) to see the version is as
-    you expect.
+- Ensure you can run `mvn test` and `mvn package` successfully. Run
+  `mvn clean` after.
+- Ensure you have a clean checkout of `master` and that the subdirectory
+  `.gh-pages` either does not exist or is a clean checkout.
+  - We'll be generating commits.
+- Review open issues and PRs to see if any can easily be fixed, closed, or
+  merged.
+- Review `CHANGELOG.md` for completeness and correctness.
+- Set a version and a date in `CHANGELOG.md` and commit that.
+  - It gets used in the release process.
+- Bump copyright year in `README.md` if appropriate.
+  - You don't need to update the version. `./dev-bin/release.sh` does this.
+- Run `./dev-bin/release.sh`
+  - This will package the release, update the gh-pages branch, bump the
+    version to the next development release, upload the release to GitHub
+    and tag it, and upload to Sonatype.
+- This will prompt you several times. Generally you need to say `y` or `n`.
+- You'll be prompted for your ssh key password, GPG key password, and
+  GitHub.com username and password several times depending on your
+  workspace.
+- You may be prompted about "what is the next development version?". Hit
+  enter to use the default which should be fine.
+- You may be prompted about "The following dependencies in Dependencies
+  have newer versions". See the section about updating dependencies if so.
+- If you get HTTP 401 errors from Sonatype, you probably don't have a
+  correct `settings.xml`. Refer to the Sonatype section.
+  - If this happened, there are most likely pushed commits on GitHub.com.
+    You can potentially rebase and drop the commits and force push and
+    start over (you might want to talk about this before doing it). Note
+    you'll need to delete the release tag too:
+    `git push origin :refs/tags/vx.y.z && git tag -d vx.y.z`.
+- If you get to this point, then a release is on GitHub.com and in the
+  staging repository on [Sonatype](https://oss.sonatype.org).
+- Go to [Sonatype](https://oss.sonatype.org) and log in.
+- On the left hand side, choose Staging repositories.
+- At the bottom you should see your staged release. It will be something
+  like "commmaxmind-xxxx". Click on that.
+- Near the top of the page there is a "Close" button. Click it.
+  - You have to close a staging release before you can release it.
+- Wait around 30 seconds. Click Refresh near the top of the page while
+  you wait. Eventually you should see the "Activity" line in the info
+  about your repository say something like it is complete.
+- Click Release near the top.
+  - This also takes a moment (you will see "operation in progress" again).
+    Refresh as usual. When it's done, you won't see the "commmaxmind-xxxx"
+    entry in the staging repositories any more.
+- You're done!
+- If you want to check things over, look at the commits on GitHub.com,
+  including to the `gh-pages` branch and release tags, and do an artifact
+  search on [Sonatype](https://oss.sonatype.org) to see the version is as
+  you expect.
 
 
 ## Updating dependencies
@@ -144,11 +154,11 @@ process (say `n` or ctrl-c out).
 
 To update them:
 
-  - Make a branch
-  - Update `pom.xml` to have the new versions you want
-  - Run `mvn test` and fix any errors
-  - Push and ensure Travis completes successfully
-  - Merge
+- Make a branch
+- Update `pom.xml` to have the new versions you want
+- Run `mvn test` and fix any errors
+- Push and ensure Travis completes successfully
+- Merge
 
 If you did this in the middle of releasing, you'll have to start that
 process over.
diff --git a/README.md b/README.md
@@ -169,7 +169,7 @@ Transaction request = new Transaction.Builder(
             .amount(new BigDecimal(Double.toString(1.1)))
             .currency("USD")
             .discountCode("10OFF")
-            .referrerUri(new URI("http://www.google.com/"))
+            .referrerUri(new URI("https://www.google.com/"))
             .subaffiliateId("saf9")
             .build()
     ).payment(
@@ -240,10 +240,10 @@ Patches and pull requests are encouraged. Please include unit tests whenever pos
 
 ## Versioning ##
 
-This API uses [Semantic Versioning](http://semver.org/).
+This API uses [Semantic Versioning](https://semver.org/).
 
 ## Copyright and License ##
 
-This software is Copyright (c) 2015-2017 by MaxMind, Inc.
+This software is Copyright (c) 2015-2018 by MaxMind, Inc.
 
 This is free software, licensed under the Apache License, Version 2.0.
diff --git a/pom.xml b/pom.xml
@@ -42,27 +42,27 @@
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-core</artifactId>
-            <version>2.9.2</version>
+            <version>2.9.3</version>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-databind</artifactId>
-            <version>2.9.2</version>
+            <version>2.9.3</version>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-annotations</artifactId>
-            <version>2.9.2</version>
+            <version>2.9.3</version>
         </dependency>
         <dependency>
             <groupId>com.maxmind.geoip2</groupId>
             <artifactId>geoip2</artifactId>
-            <version>2.10.0</version>
+            <version>2.11.0</version>
         </dependency>
         <dependency>
             <groupId>org.apache.httpcomponents</groupId>
             <artifactId>httpclient</artifactId>
-            <version>4.5.3</version>
+            <version>4.5.4</version>
         </dependency>
         <dependency>
             <groupId>commons-validator</groupId>
@@ -78,7 +78,7 @@
         <dependency>
             <groupId>com.github.tomakehurst</groupId>
             <artifactId>wiremock</artifactId>
-            <version>2.10.1</version>
+            <version>2.14.0</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -96,13 +96,13 @@
         <dependency>
             <groupId>com.fasterxml.jackson.jr</groupId>
             <artifactId>jackson-jr-objects</artifactId>
-            <version>2.9.2</version>
+            <version>2.9.3</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>pl.pragmatists</groupId>
             <artifactId>JUnitParams</artifactId>
-            <version>1.1.0</version>
+            <version>1.1.1</version>
             <scope>test</scope>
         </dependency>
         <dependency>
diff --git a/src/main/java/com/maxmind/minfraud/response/GeoIp2Country.java b/src/main/java/com/maxmind/minfraud/response/GeoIp2Country.java
@@ -14,20 +14,35 @@
 public final class GeoIp2Country extends Country {
     private final boolean isHighRisk;
 
+    // This method is for backwards compatibility. We should remove it when we
+    // do a major release.
+    public GeoIp2Country(
+            List<String> locales,
+            Integer confidence,
+            Integer geoNameId,
+            boolean isHighRisk,
+            String isoCode,
+            Map<String, String> names
+    ) {
+        this(locales, confidence, geoNameId, isHighRisk, false, isoCode, names);
+    }
+
     public GeoIp2Country(
             @JacksonInject("locales") List<String> locales,
             @JsonProperty("confidence") Integer confidence,
             @JsonProperty("geoname_id") Integer geoNameId,
             @JsonProperty("is_high_risk") boolean isHighRisk,
+            @JsonProperty("is_in_european_union") boolean isInEuropeanUnion,
             @JsonProperty("iso_code") String isoCode,
             @JsonProperty("names") Map<String, String> names
     ) {
-        super(locales, confidence, geoNameId, isoCode, names);
+        super(locales, confidence, geoNameId, isInEuropeanUnion, isoCode,
+                names);
         this.isHighRisk = isHighRisk;
     }
 
     public GeoIp2Country() {
-        this(null, null, null, false, null, null);
+        this(null, null, null, false, false, null, null);
     }
 
     /**
diff --git a/src/test/java/com/maxmind/minfraud/WebServiceClientTest.java b/src/test/java/com/maxmind/minfraud/WebServiceClientTest.java
@@ -22,6 +22,8 @@
 import static com.jcabi.matchers.RegexMatchers.matchesPattern;
 import static com.maxmind.minfraud.request.RequestTestHelper.*;
 import static org.hamcrest.core.StringStartsWith.startsWith;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
 
 @RunWith(JUnitParamsRunner.class)
 public class WebServiceClientTest {
@@ -68,6 +70,15 @@ public void testFullInsightsTransaction() throws Exception {
             // We cannot change this as it would be a breaking change to the GeoIP2 API.
             JSONAssert.assertEquals(responseContent, response.toJson(), false);
             verifyRequestFor("insights", "full-request");
+            assertTrue(
+                    "response.getIpAddress().getCountry().isInEuropeanUnion() does not return true",
+                    response.getIpAddress().getCountry().isInEuropeanUnion());
+            assertFalse(
+                    "response.getIpAddress().getRegisteredCountry().isInEuropeanUnion() does not return false",
+                    response.getIpAddress().getRegisteredCountry().isInEuropeanUnion());
+            assertTrue(
+                    "response.getIpAddress().getRepresentedCountry().isInEuropeanUnion() does not return true",
+                    response.getIpAddress().getRepresentedCountry().isInEuropeanUnion());
         }
     }
 
@@ -83,6 +94,15 @@ public void testFullFactorsTransaction() throws Exception {
             // We cannot change this as it would be a breaking change to the GeoIP2 API.
             JSONAssert.assertEquals(responseContent, response.toJson(), false);
             verifyRequestFor("factors", "full-request");
+            assertTrue(
+                    "response.getIpAddress().getCountry().isInEuropeanUnion() does not return true",
+                    response.getIpAddress().getCountry().isInEuropeanUnion());
+            assertTrue(
+                    "response.getIpAddress().getRegisteredCountry().isInEuropeanUnion() does not return true",
+                    response.getIpAddress().getRegisteredCountry().isInEuropeanUnion());
+            assertFalse(
+                    "response.getIpAddress().getRepresentedCountry().isInEuropeanUnion() does not return false",
+                    response.getIpAddress().getRepresentedCountry().isInEuropeanUnion());
         }
     }
 
diff --git a/src/test/resources/test-data/factors-response.json b/src/test/resources/test-data/factors-response.json
@@ -36,6 +36,7 @@
       "confidence": 99,
       "geoname_id": 2635167,
       "is_high_risk": false,
+      "is_in_european_union": true,
       "iso_code": "GB",
       "names": {
         "de": "Vereinigtes K\u00f6nigreich",
@@ -56,17 +57,18 @@
       "time_zone": "Europe\/London"
     },
     "registered_country": {
-      "geoname_id": 6252001,
-      "iso_code": "US",
+      "geoname_id": 2635167,
+      "is_in_european_union": true,
+      "iso_code": "GB",
       "names": {
-        "de": "USA",
-        "en": "United States",
-        "es": "Estados Unidos",
-        "fr": "\u00c9tats-Unis",
-        "ja": "\u30a2\u30e1\u30ea\u30ab\u5408\u8846\u56fd",
-        "pt-BR": "Estados Unidos",
-        "ru": "\u0421\u0428\u0410",
-        "zh-CN": "\u7f8e\u56fd"
+        "de": "Vereinigtes K\u00f6nigreich",
+        "en": "United Kingdom",
+        "es": "Reino Unido",
+        "fr": "Royaume-Uni",
+        "ja": "\u30a4\u30ae\u30ea\u30b9",
+        "pt-BR": "Reino Unido",
+        "ru": "\u0412\u0435\u043b\u0438\u043a\u043e\u0431\u0440\u0438\u0442\u0430\u043d\u0438\u044f",
+        "zh-CN": "\u82f1\u56fd"
       }
     },
     "subdivisions": [
diff --git a/src/test/resources/test-data/insights-response.json b/src/test/resources/test-data/insights-response.json
