From 167433de0c3b0dc0e72ce4b9c53206ececedefe9 Mon Sep 17 00:00:00 2001
From: Gregory Oschwald <goschwald@maxmind.com>
Date: Wed, 2 Oct 2013 06:54:03 -0700
Subject: [PATCH] Added iterface for Reader/Client.

It could use a better name.
---
 src/GeoIp2/Database/Reader.php   |  3 ++-
 src/GeoIp2/ProviderInterface.php | 34 ++++++++++++++++++++++++++++++++
 src/GeoIp2/WebService/Client.php |  3 ++-
 3 files changed, 38 insertions(+), 2 deletions(-)
 create mode 100644 src/GeoIp2/ProviderInterface.php

diff --git a/src/GeoIp2/Database/Reader.php b/src/GeoIp2/Database/Reader.php
index 1b0f88f..31ee3c2 100644
--- a/src/GeoIp2/Database/Reader.php
+++ b/src/GeoIp2/Database/Reader.php
@@ -7,6 +7,7 @@ use GeoIp2\Model\City;
 use GeoIp2\Model\CityIspOrg;
 use GeoIp2\Model\Country;
 use GeoIp2\Model\Omni;
+use GeoIp2\ProviderInterface;
 use MaxMind\Db\Reader as DbReader;
 
 /**
@@ -38,7 +39,7 @@ use MaxMind\Db\Reader as DbReader;
  * will be thrown.
  *
  */
-class Reader
+class Reader implements ProviderInterface
 {
     private $dbReader;
     private $languages;
diff --git a/src/GeoIp2/ProviderInterface.php b/src/GeoIp2/ProviderInterface.php
new file mode 100644
index 0000000..ed2f34e
--- /dev/null
+++ b/src/GeoIp2/ProviderInterface.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace GeoIp2;
+
+interface ProviderInterface
+{
+    /**
+     * @param ipAddress
+     *            IPv4 or IPv6 address to lookup.
+     * @return A Country model for the requested IP address.
+     */
+    public function country($ipAddress);
+
+    /**
+     * @param ipAddress
+     *            IPv4 or IPv6 address to lookup.
+     * @return A City model for the requested IP address.
+     */
+    public function city($ipAddress);
+
+    /**
+     * @param ipAddress
+     *            IPv4 or IPv6 address to lookup.
+     * @return A CityIspOrg model for the requested IP address.
+     */
+    public function cityIspOrg($ipAddress);
+
+    /**
+     * @param ipAddress
+     *            IPv4 or IPv6 address to lookup.
+     * @return An Omni model for the requested IP address.
+     */
+    public function omni($ipAddress);
+}
diff --git a/src/GeoIp2/WebService/Client.php b/src/GeoIp2/WebService/Client.php
index 55410db..09e30ad 100644
--- a/src/GeoIp2/WebService/Client.php
+++ b/src/GeoIp2/WebService/Client.php
@@ -12,6 +12,7 @@ use GeoIp2\Model\City;
 use GeoIp2\Model\CityIspOrg;
 use GeoIp2\Model\Country;
 use GeoIp2\Model\Omni;
+use GeoIp2\ProviderInterface;
 use Guzzle\Http\Client as GuzzleClient;
 use Guzzle\Common\Exception\RuntimeException;
 use Guzzle\Http\Exception\ClientErrorResponseException;
@@ -48,7 +49,7 @@ use Guzzle\Http\Exception\ServerErrorResponseException;
  *
  * If the request fails, the client class throws an exception.
  */
-class Client
+class Client implements ProviderInterface
 {
     private $userId;
     private $licenseKey;