Prepare for 2.0.0

Remove deprecated web service methods

.gitignore

@@ -1,6 +1,7 @@
 _site
 .gh-pages
 .idea
+GeoLite2-City.mmdb
 build
 composer.lock
 composer.phar

CHANGELOG.md

@@ -1,11 +1,29 @@
 CHANGELOG
 =========
 
+2.0.0 (2014-09-22)
+------------------
+
+* First production release.
+
+0.9.0 (2014-09-15)
+------------------
+
+* IMPORTANT: The deprecated `omni()` and `cityIspOrg()` methods have been
+  removed from `GeoIp2\WebService\Client`.
+
+0.8.1 (2014-09-12)
+------------------
+
+* The check added to the `GeoIP2\Database\Reader` lookup methods in 0.8.0 did
+  not work with the GeoIP2 City Database Subset by Continent with World
+  Countries. This has been fixed. Fixes GitHub issue #23.
+
 0.8.0 (2014-09-10)
 ------------------
 
-* The `GeoIP2\Database\Reader` lookup methods (e.g., `city()`, `isp()`) now
-  throw an `BadMethodCallException` if they are used with a database that
+* The `GeoIp2\Database\Reader` lookup methods (e.g., `city()`, `isp()`) now
+  throw a `BadMethodCallException` if they are used with a database that
   does not match the method. In particular, doing a `city()` lookup on a
   GeoIP2 Country database will result in an exception, and vice versa.
 * A `metadata()` method has been added to the `GeoIP2\Database\Reader` class.
@@ -18,7 +36,7 @@ CHANGELOG
 
 * The web service client API has been updated for the v2.1 release of the web
   service. In particular, the `cityIspOrg` and `omni` methods on
-  `GeoIP2\WebService\Client` should be considered deprecated. The `city`
+  `GeoIp2\WebService\Client` should be considered deprecated. The `city`
   method now provides all of the data formerly provided by `cityIspOrg`, and
   the `omni` method has been replaced by the `insights` method.
 * Support was added for GeoIP2 Connection Type, Domain and ISP databases.

README.md

@@ -26,7 +26,7 @@ You should now have the file `composer.phar` in your project directory.
 Run in your project root:
 
 ```
-php composer.phar require geoip2/geoip2:~0.8.0
+php composer.phar require geoip2/geoip2:~2.0
 ```
 
 You should now have the files `composer.json` and `composer.lock` as well as

bin/benchmark.php

@@ -0,0 +1,26 @@
+#!/usr/bin/env php
+
+<?php
+
+require_once '../vendor/autoload.php';
+
+use GeoIp2\Database\Reader;
+use GeoIp2\Exception\AddressNotFoundException;
+
+$reader = new Reader('GeoLite2-City.mmdb');
+$count = 40000;
+$startTime = microtime(true);
+for ($i = 0; $i < $count; $i++) {
+    $ip = long2ip(rand(0, pow(2, 32) -1));
+    try {
+        $t = $reader->city($ip);
+    } catch (AddressNotFoundException $e) {
+    }
+    if ($i % 1000 == 0) {
+        print($i . ' ' . $ip . "\n");
+    }
+}
+$endTime = microtime(true);
+
+$duration = $endTime - $startTime;
+print('Requests per second: ' . $count / $duration . "\n");

composer.json

@@ -14,13 +14,13 @@
     ],
     "require": {
         "guzzle/guzzle": "3.*",
-        "maxmind-db/reader": "~0.3.2",
+        "maxmind-db/reader": "~1.0",
         "php": ">=5.3.1"
     },
     "require-dev": {
         "apigen/apigen": "~2.8.0",
         "nette/nette": "~2.1.3",
-        "phpunit/phpunit": "4.1.*",
+        "phpunit/phpunit": "4.2.*",
         "satooshi/php-coveralls": "dev-master"
     },
     "autoload": {

src/GeoIp2/Database/Reader.php

@@ -71,11 +71,7 @@ class Reader implements ProviderInterface
      */
     public function city($ipAddress)
     {
-        return $this->modelFor(
-            'City',
-            array('GeoLite2-City', 'GeoIP2-City'),
-            $ipAddress
-        );
+        return $this->modelFor('City', 'City', $ipAddress);
     }
 
     /**
@@ -92,11 +88,7 @@ class Reader implements ProviderInterface
      */
     public function country($ipAddress)
     {
-        return $this->modelFor(
-            'Country',
-            array('GeoLite2-Country', 'GeoIP2-Country'),
-            $ipAddress
-        );
+        return $this->modelFor('Country', 'Country', $ipAddress);
     }
 
     public function connectionType($ipAddress)
@@ -126,16 +118,9 @@ class Reader implements ProviderInterface
         );
     }
 
-    private function modelFor($class, $types, $ipAddress)
+    private function modelFor($class, $type, $ipAddress)
     {
-        if (!in_array($this->metadata()->databaseType, $types)) {
-            $method = lcfirst($class);
-            throw new \BadMethodCallException(
-                "The $method method cannot be used to open a "
-                . $this->metadata()->databaseType . " database"
-            );
-        }
-        $record = $this->getRecord($ipAddress);
+        $record = $this->getRecord($class, $type, $ipAddress);
 
         $record['traits']['ip_address'] = $ipAddress;
         $class = "GeoIp2\\Model\\" . $class;
@@ -145,15 +130,7 @@ class Reader implements ProviderInterface
 
     private function flatModelFor($class, $type, $ipAddress)
     {
-        if ($this->metadata()->databaseType !== $type) {
-            $method = lcfirst($class);
-            throw new \BadMethodCallException(
-                "The $method method cannot be used to open a "
-                . $this->metadata()->databaseType . " database"
-            );
-        }
-
-        $record = $this->getRecord($ipAddress);
+        $record = $this->getRecord($class, $type, $ipAddress);
 
         $record['ip_address'] = $ipAddress;
         $class = "GeoIp2\\Model\\" . $class;
@@ -161,8 +138,15 @@ class Reader implements ProviderInterface
         return new $class($record);
     }
 
-    private function getRecord($ipAddress)
+    private function getRecord($class, $type, $ipAddress)
     {
+        if (strpos($this->metadata()->databaseType, $type) === false) {
+            $method = lcfirst($class);
+            throw new \BadMethodCallException(
+                "The $method method cannot be used to open a "
+                . $this->metadata()->databaseType . " database"
+            );
+        }
         $record = $this->dbReader->get($ipAddress);
         if ($record === null) {
             throw new AddressNotFoundException(

src/GeoIp2/WebService/Client.php

@@ -111,40 +111,6 @@ class Client implements ProviderInterface
         return $this->responseFor('city', 'City', $ipAddress);
     }
 
-    /**
-     * This method calls the GeoIP2 Precision: City endpoint.
-     *
-     * @param string $ipAddress IPv4 or IPv6 address as a string. If no
-     * address is provided, the address that the web service is called
-     * from will be used.
-     *
-     * @return \GeoIp2\Model\City
-     *
-     * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
-     *   provided is not in our database (e.g., a private address).
-     * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
-     *   with the user ID or license key that you provided.
-     * @throws \GeoIp2\Exception\OutOfQueriesException if your account is out
-     *   of queries.
-     * @throws \GeoIp2\Exception\InvalidRequestException} if your request was
-     *   received by the web service but is invalid for some other reason.
-     *   This may indicate an issue with this API. Please report the error to
-     *   MaxMind.
-     * @throws \GeoIp2\Exception\HttpException if an unexpected HTTP error
-     *   code or message was returned. This could indicate a problem with the
-     *   connection between your server and the web service or that the web
-     *   service returned an invalid document or 500 error code.
-     * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent
-     *   class to the above exceptions. It will be thrown directly if a 200
-     *   status code is returned but the body is invalid.
-     *
-     * @deprecated deprecated since version 0.7.0
-     */
-    public function cityIspOrg($ipAddress = 'me')
-    {
-        return $this->city($ipAddress);
-    }
-
     /**
      * This method calls the GeoIP2 Precision: Country endpoint.
      *
@@ -203,48 +169,12 @@ class Client implements ProviderInterface
      * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent
      *   class to the above exceptions. It will be thrown directly if a 200
      *   status code is returned but the body is invalid.
-     *
-     * @deprecated deprecated since version 0.7.0
      */
     public function insights($ipAddress = 'me')
     {
         return $this->responseFor('insights', 'Insights', $ipAddress);
     }
 
-    /**
-     * This method calls the GeoIP2 Precision: Insights (prev. Omni) endpoint.
-     *
-     * @param string $ipAddress IPv4 or IPv6 address as a string. If no
-     * address is provided, the address that the web service is called
-     * from will be used.
-     *
-     * @return \GeoIp2\Model\Insights
-     *
-     * @throws \GeoIp2\Exception\AddressNotFoundException if the address you
-     *   provided is not in our database (e.g., a private address).
-     * @throws \GeoIp2\Exception\AuthenticationException if there is a problem
-     *   with the user ID or license key that you provided.
-     * @throws \GeoIp2\Exception\OutOfQueriesException if your account is out
-     *   of queries.
-     * @throws \GeoIp2\Exception\InvalidRequestException} if your request was
-     *   received by the web service but is invalid for some other reason.
-     *   This may indicate an issue with this API. Please report the error to
-     *   MaxMind.
-     * @throws \GeoIp2\Exception\HttpException if an unexpected HTTP error
-     *   code or message was returned. This could indicate a problem with the
-     *   connection between your server and the web service or that the web
-     *   service returned an invalid document or 500 error code.
-     * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent
-     *   class to the above exceptions. It will be thrown directly if a 200
-     *   status code is returned but the body is invalid.
-     *
-     * @deprecated deprecated since version 0.7.0
-     */
-    public function omni($ipAddress = 'me')
-    {
-        return $this->insights($ipAddress);
-    }
-
     private function responseFor($endpoint, $class, $ipAddress)
     {
         $uri = implode('/', array($this->baseUri(), $endpoint, $ipAddress));

tests/GeoIp2/Test/WebService/ClientTest.php

@@ -201,19 +201,16 @@ class ClientTest extends \PHPUnit_Framework_TestCase
     public function testInsights()
     {
 
-        $methods = array('omni', 'insights');
-        foreach ($methods as $method) {
-            $record = $this->client($this->getResponse('1.2.3.4'))
-                ->$method('1.2.3.4');
+        $record = $this->client($this->getResponse('1.2.3.4'))
+            ->insights('1.2.3.4');
 
-            $this->assertInstanceOf('GeoIp2\Model\Insights', $record);
+        $this->assertInstanceOf('GeoIp2\Model\Insights', $record);
 
-            $this->assertEquals(
-                42,
-                $record->continent->geonameId,
-                'continent geoname_id is 42'
-            );
-        }
+        $this->assertEquals(
+            42,
+            $record->continent->geonameId,
+            'continent geoname_id is 42'
+        );
     }
 
     public function testCity()
@@ -230,7 +227,7 @@ class ClientTest extends \PHPUnit_Framework_TestCase
 
         $this->assertInstanceOf(
             'GeoIp2\Model\City',
-            $client->cityIspOrg('me'),
+            $client->city('me'),
             'can set ip parameter to me'
         );
     }