Introduce AbstractHttpProvider

Fix #359

Author: willdurand

src/Geocoder/HttpAdapter/GeoIP2Adapter.php renamed to src/Geocoder/Adapter/GeoIP2Adapter.php

@@ -8,7 +8,7 @@
  * @license    MIT License
  */
 
-namespace Geocoder\HttpAdapter;
+namespace Geocoder\Adapter;
 
 use Geocoder\Exception\InvalidArgument;
 use Geocoder\Exception\UnsupportedOperation;
@@ -41,10 +41,8 @@ class GeoIP2Adapter
     protected $locale;
 
     /**
-     * @param  \GeoIp2\ProviderInterface                $geoIpProvider
-     * @param  string                                   $geoIP2Model   (e.g. self::GEOIP2_MODEL_CITY)
-     * @throws \Geocoder\Exception\UnsupportedOperation
-     * @internal param string $dbFile
+     * @param \GeoIp2\ProviderInterface $geoIpProvider
+     * @param string                    $geoIP2Model   (e.g. self::GEOIP2_MODEL_CITY)
      */
     public function __construct(ProviderInterface $geoIpProvider, $geoIP2Model = self::GEOIP2_MODEL_CITY)
     {
@@ -60,8 +58,8 @@ public function __construct(ProviderInterface $geoIpProvider, $geoIP2Model = sel
     }
 
     /**
-     * @param  string $locale
-     * @return $this
+     * @param  string        $locale
+     * @return GeoIP2Adapter
      */
     public function setLocale($locale)
     {
@@ -81,9 +79,7 @@ public function getLocale()
     /**
      * Returns the content fetched from a given resource.
      *
-     * @param  string                                   $url (e.g. file://database?127.0.0.1)
-     * @throws \Geocoder\Exception\UnsupportedOperation
-     * @throws \Geocoder\Exception\InvalidArgument
+     * @param  string $url (e.g. file://database?127.0.0.1)
      * @return string
      */
     public function getContent($url)

src/Geocoder/Provider/AbstractHttpProvider.php

@@ -0,0 +1,44 @@
+<?php
+
+/**
+ * This file is part of the Geocoder package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Geocoder\Provider;
+
+use Ivory\HttpAdapter\HttpAdapterInterface;
+
+/**
+ * @author William Durand <[email protected]>
+ */
+class AbstractHttpProvider extends AbstractProvider
+{
+    /**
+     * @var HttpAdapterInterface
+     */
+    private $adapter;
+
+    /**
+     * @param HttpAdapterInterface $adapter An HTTP adapter
+     */
+    public function __construct(HttpAdapterInterface $adapter)
+    {
+        parent::__construct();
+
+        $this->adapter = $adapter;
+    }
+
+    /**
+     * Returns the HTTP adapter.
+     *
+     * @return HttpAdapterInterface
+     */
+    public function getAdapter()
+    {
+        return $this->adapter;
+    }
+}

src/Geocoder/Provider/AbstractProvider.php

@@ -12,17 +12,12 @@
 
 use Geocoder\Geocoder;
 use Geocoder\Model\AddressFactory;
-use Ivory\HttpAdapter\HttpAdapterInterface;
 
 /**
  * @author William Durand <[email protected]>
  */
 abstract class AbstractProvider
 {
-    /**
-     * @var HttpAdapterInterface
-     */
-    private $adapter;
 
     /**
      * @var AddressFactory
@@ -34,12 +29,8 @@ abstract class AbstractProvider
      */
     private $limit = Provider::MAX_RESULTS;
 
-    /**
-     * @param HttpAdapterInterface|null $adapter An HTTP adapter
-     */
-    public function __construct(HttpAdapterInterface $adapter = null)
+    public function __construct()
     {
-        $this->adapter = $adapter;
         $this->factory = new AddressFactory();
     }
 
@@ -61,16 +52,6 @@ public function getLimit()
         return $this->limit;
     }
 
-    /**
-     * Returns the HTTP adapter.
-     *
-     * @return HttpAdapterInterface
-     */
-    public function getAdapter()
-    {
-        return $this->adapter;
-    }
-
     /**
      * Returns the default results.
      *

src/Geocoder/Provider/ArcGISOnline.php

@@ -17,7 +17,7 @@
 /**
  * @author ALKOUM Dorian <[email protected]>
  */
-class ArcGISOnline extends AbstractProvider implements Provider
+class ArcGISOnline extends AbstractHttpProvider implements Provider
 {
     /**
      * @var string

src/Geocoder/Provider/BingMaps.php

@@ -18,7 +18,7 @@
 /**
  * @author David Guyon <[email protected]>
  */
-class BingMaps extends AbstractProvider implements LocaleAwareProvider
+class BingMaps extends AbstractHttpProvider implements LocaleAwareProvider
 {
     /**
      * @var string

src/Geocoder/Provider/FreeGeoIp.php

@@ -16,7 +16,7 @@
 /**
  * @author William Durand <[email protected]>
  */
-class FreeGeoIp extends AbstractProvider implements Provider
+class FreeGeoIp extends AbstractHttpProvider implements Provider
 {
     /**
      * @var string

src/Geocoder/Provider/GeoIP2.php

@@ -10,9 +10,9 @@
 
 namespace Geocoder\Provider;
 
+use Geocoder\Adapter\GeoIP2Adapter;
 use Geocoder\Exception\NoResult;
 use Geocoder\Exception\UnsupportedOperation;
-use Geocoder\HttpAdapter\GeoIP2Adapter;
 use GeoIp2\Exception\AddressNotFoundException;
 use GeoIp2\Model\City;
 
@@ -33,7 +33,7 @@ class GeoIP2 extends AbstractProvider implements LocaleAwareProvider
 
     public function __construct(GeoIP2Adapter $adapter, $locale = 'en')
     {
-        parent::__construct(null);
+        parent::__construct();
 
         $this->adapter = $adapter;
         $this->locale  = $locale;

src/Geocoder/Provider/GeoIPs.php

@@ -23,7 +23,7 @@
  *
  * @link http://www.geoips.com/en/developer/api-guide
  */
-class GeoIPs extends AbstractProvider implements Provider
+class GeoIPs extends AbstractHttpProvider implements Provider
 {
     /**
      * @var string

src/Geocoder/Provider/GeoPlugin.php

@@ -16,7 +16,7 @@
 /**
  * @author Andrea Cristaudo <[email protected]>
  */
-class GeoPlugin extends AbstractProvider implements Provider
+class GeoPlugin extends AbstractHttpProvider implements Provider
 {
     /**
      * @var string

src/Geocoder/Provider/Geoip.php

@@ -15,9 +15,9 @@
 use Geocoder\Exception\UnsupportedOperation;
 
 /**
- * @see http://php.net/manual/ref.geoip.php
- *
  * @author William Durand <[email protected]>
+ *
+ * @link http://php.net/manual/ref.geoip.php
  */
 class Geoip extends AbstractProvider implements Provider
 {