Merge pull request #1521 from maxmind/greg/eng-3706

Make code samples more idiomatic, modernize, and fix various issues

Author: oschwald

content/geoip/geolocate-an-ip/databases.md

@@ -29,15 +29,15 @@ Install-Package MaxMind.GeoIP2
 <dependency>
   <groupId>com.maxmind.geoip2</groupId>
   <artifactId>geoip2</artifactId>
-  <version>2.15.0</version>
+  <version>5.0.2</version>
 </dependency>
 
 // Or install via Gradle
 repositories {
   mavenCentral()
 }
 dependencies {
-  compile 'com.maxmind.geoip2:geoip2:2.15.0'
+  implementation 'com.maxmind.geoip2:geoip2:5.0.2'
 }
 ```
 
@@ -51,7 +51,7 @@ yarn add @maxmind/geoip2-node
 
 ```php
 # Install via Composer
-composer require geoip2/geoip2:~2.0
+composer require geoip2/geoip2:~3.0
 ```
 
 ```python
@@ -111,8 +111,8 @@ InetAddress ipAddress = InetAddress.getByName("128.101.101.101");
 
 CityResponse response = reader.city(ipAddress);
 
-Country country = response.getCountry();
-System.out.println(country.getIsoCode());
+Country country = response.country();
+System.out.println(country.isoCode());
 
 ```
 
@@ -136,7 +136,7 @@ const dbBuffer = fs.readFileSync('/path/to/maxmind-database.mmdb');
 // expensive.
 const reader = Reader.openBuffer(dbBuffer);
 
-response = reader.city('128.101.101.101');
+const response = reader.city('128.101.101.101');
 
 console.log(response.country.isoCode);
 ```
@@ -161,7 +161,7 @@ import geoip2.database
 # This reader object should be reused across lookups as creation of it is
 # expensive.
 with geoip2.database.Reader('/path/to/maxmind-database.mmdb') as reader:
-    response = reader.city('128.101.101.101');
+    response = reader.city('128.101.101.101')
     print(response.country.iso_code)
 ```
 

content/geoip/geolocate-an-ip/web-services.md

@@ -32,15 +32,15 @@ Install-Package MaxMind.GeoIP2
 <dependency>
   <groupId>com.maxmind.geoip2</groupId>
   <artifactId>geoip2</artifactId>
-  <version>2.15.0</version>
+  <version>5.0.2</version>
 </dependency>
 
 // Or install via Gradle
 repositories {
   mavenCentral()
 }
 dependencies {
-  compile 'com.maxmind.geoip2:geoip2:2.15.0'
+  implementation 'com.maxmind.geoip2:geoip2:5.0.2'
 }
 ```
 
@@ -54,7 +54,7 @@ yarn add @maxmind/geoip2-node
 
 ```php
 # Install via Composer
-composer require geoip2/geoip2:~2.0
+composer require geoip2/geoip2:~3.0
 ```
 
 ```python
@@ -122,23 +122,23 @@ const client = new WebServiceClient(accountId, licenseKey, {
 ```
 
 ```php
-<?php require_once 'vendor/autoload.php'
+<?php
+require_once 'vendor/autoload.php';
 use GeoIp2\WebService\Client;
 
-$account_id = 10;
-$license_key = 'LICENSEKEY';
+$accountId = 10;
+$licenseKey = 'LICENSEKEY';
 
-$client = new Client($account_id, $license_key);
+$client = new Client($accountId, $licenseKey);
 
 // To query the GeoLite web service, you must set the optional `host` argument.
 // The third argument specifies the language preferences when using the `->name`
 // method on the model classes that this client creates.
-$client = new Client($account_id, $license_key, ['en'], ['host' => 'geolite.info']);
+$client = new Client($accountId, $licenseKey, ['en'], ['host' => 'geolite.info']);
 ```
 
 ```python
-import asyncio # for async requests with AsyncClient
-import geoip2.webservice
+from geoip2.webservice import Client, AsyncClient
 
 account_id = 10
 license_key = 'LICENSEKEY'
@@ -150,7 +150,7 @@ client = Client(account_id, license_key)
 # to "geolite.info"
 client = Client(account_id, license_key, host='geolite.info')
 
-# Or if you want to use asynchronous requests
+# Or if you want to use asynchronous requests (requires `import asyncio`)
 async_client = AsyncClient(account_id, license_key)
 
 # To query the GeoLite web service, you must set the "host" keyword argument
@@ -227,10 +227,10 @@ try (WebServiceClient client = new WebServiceClient.Builder(accountId, licenseKe
     // `client.insights` is not available to GeoLite users
     CountryResponse response = client.country(ipAddress);
 
-    Country country = response.getCountry();
-    System.out.println(country.getIsoCode());            // 'US'
-    System.out.println(country.getName());               // 'United States'
-    System.out.println(country.getNames().get("zh-CN")); // '美国'
+    Country country = response.country();
+    System.out.println(country.isoCode());            // 'US'
+    System.out.println(country.name());               // 'United States'
+    System.out.println(country.names().get("zh-CN")); // '美国'
 }
 ```
 
@@ -239,6 +239,11 @@ const WebServiceClient = require('@maxmind/geoip2-node').WebServiceClient;
 // Typescript:
 // import { WebServiceClient } from '@maxmind/geoip2-node';
 
+const accountId = '10';
+const licenseKey = 'LICENSEKEY';
+
+const client = new WebServiceClient(accountId, licenseKey);
+
 // You can also use `client.city` or `client.insights`
 // `client.insights` is not available to GeoLite users
 client.country('142.1.1.1').then((response) => {
@@ -247,13 +252,14 @@ client.country('142.1.1.1').then((response) => {
 ```
 
 ```php
-<?php require_once 'vendor/autoload.php'
+<?php
+require_once 'vendor/autoload.php';
 use GeoIp2\WebService\Client;
 
-$account_id = 10;
-$license_key = 'LICENSEKEY';
+$accountId = 10;
+$licenseKey = 'LICENSEKEY';
 
-$client = new Client($account_id, $license_key);
+$client = new Client($accountId, $licenseKey);
 
 // You can also use `$client->city` or `$client->insights`
 // `$client->insights` is not available to GeoLite users
@@ -264,27 +270,27 @@ print($record->country->isoCode . "\n");
 
 ```python
 # Sync
-import geoip2.webservice
+from geoip2.webservice import Client
 
 account_id = 10
 license_key = 'LICENSEKEY'
 
-with geoip2.webservice.Client(account_id, license_key) as client:
+with Client(account_id, license_key) as client:
   # You can also use `client.city` or `client.insights`
   # `client.insights` is not available to GeoLite users
-  response = client.country('128.101.101.101)
+  response = client.country('128.101.101.101')
 
   print(response.country.iso_code)
 
 # Async
 import asyncio
-import geoip2.webservice
+from geoip2.webservice import AsyncClient
 
 async def main():
-  async with geoip2.webservice.AsyncClient(account_id, license_key) as client:
+  async with AsyncClient(account_id, license_key) as client:
     # You can also use `client.city` or `client.insights`
     # `client.insights` is not available to GeoLite users
-    response = await client.country('128.101.101.101)
+    response = await client.country('128.101.101.101')
 
     print(response.country.iso_code)