Initial commit Places api

Author: Steven Poelmans

README.md

@@ -1,7 +1,11 @@
 # GoogleApi
 PHP library for Google APIs
 
+# Installation
+
+composer require treeleaf/google-api
+
 # Implemented APIs
 Places API:
   - autocomplete
-
+  - details (with placeid)

src/Treeleaf/GoogleApi/Bootstrap.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Treeleaf\GoogleApi;
+
+use Treeleaf\GoogleApi\Configurator\ConfiguratorCollection;
+use Treeleaf\GoogleApi\Configurator\Places\PlacesAutoCompleteConfigurator;
+use Treeleaf\GoogleApi\Configurator\Places\PlacesDetailConfigurator;
+use Treeleaf\GoogleApi\Service\Places\PlacesApi;
+
+/**
+ * Class Bootstrap.
+ */
+class Bootstrap
+{
+    /**
+     * @param string $apiKey
+     *
+     * @return ConfiguratorCollection
+     */
+    public function getConfiguratorCollection(string $apiKey): ConfiguratorCollection
+    {
+        $collection = new ConfiguratorCollection();
+        $collection->addConfigurator(
+            PlacesApi::CONFIGURATOR_SERVICE_PLACE_AUTO_COMPLETE,
+            new PlacesAutoCompleteConfigurator($apiKey)
+        );
+        $collection->addConfigurator(
+            PlacesApi::CONFIGURATOR_SERVICE_PLACE_DETAIL,
+            new PlacesDetailConfigurator($apiKey)
+        );
+
+        return $collection;
+    }
+}

src/Treeleaf/GoogleApi/Configurator/Places/PlacesDetailConfigurator.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Treeleaf\GoogleApi\Configurator\Places;
+
+use Treeleaf\GoogleApi\Configurator\AbstractConfigurator;
+
+/**
+ * Class PlacesConfigurator.
+ */
+class PlacesDetailConfigurator extends AbstractConfigurator
+{
+    const URI_PLACE_DETAIL = '/maps/api/place/details';
+
+    /**
+     * PlacesConfigurator constructor.
+     *
+     * @param string $apiKey
+     */
+    public function __construct(string $apiKey)
+    {
+        parent::__construct($apiKey);
+    }
+
+    /**
+     * @param string $format
+     *
+     * @throws \InvalidArgumentException
+     *
+     * @return string
+     */
+    public function getUri(string $format): string
+    {
+        $this->checkFormat($format);
+
+        return sprintf("%s/%s", self::URI_PLACE_DETAIL, $format);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getRequiredParameters(): array
+    {
+        return ['key', 'placeid'];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getOptionalParameters(): array
+    {
+        return [];
+    }
+}

src/Treeleaf/GoogleApi/Service/AbstractService.php

@@ -12,6 +12,13 @@
  */
 abstract class AbstractService
 {
+    const STATUS_OK = 'OK';
+    const STATUS_ZERO_RESULTS = 'ZERO_RESULTS';
+    const STATUS_OVER_QUERY_LIMIT = 'OVER_QUERY_LIMIT';
+    const STATUS_INVALID_REQUEST = 'INVALID_REQUEST';
+    const STATUS_NOT_FOUND = 'NOT_FOUND';
+    const STATUS_UNKNOWN_ERROR = 'UNKNOWN_ERROR';
+
     /**
      * @var Client
      */

src/Treeleaf/GoogleApi/Service/Places/PlacesApi.php

@@ -2,7 +2,6 @@
 
 namespace Treeleaf\GoogleApi\Service\Places;
 
-use Treeleaf\GoogleApi\Configurator\Places\PlacesAutoCompleteConfigurator;
 use Treeleaf\GoogleApi\Service\AbstractService;
 
 /**
@@ -11,22 +10,36 @@
 class PlacesApi extends AbstractService
 {
     const CONFIGURATOR_SERVICE_PLACE_AUTO_COMPLETE = 'service.placeAutoComplete';
+    const CONFIGURATOR_SERVICE_PLACE_DETAIL = 'service.placeDetail';
 
     /**
-     * @var PlacesAutoCompleteConfigurator
+     * @param string $query
+     * @param array  $args
+     * @param string $format
+     *
+     * @return string
      */
-    protected $placesAutoCompleteConfigurator;
+    public function placeAutoComplete(string $query, array $args = [], string $format = 'json'): string
+    {
+        $configurator = $this->getConfigurator(self::CONFIGURATOR_SERVICE_PLACE_AUTO_COMPLETE);
 
+        $result = $this->makeRequest($configurator, ['input' => $query], $format, $args);
+        $response = (string) $result->getBody()->getContents();
+
+        return $response;
+    }
     /**
-     * @param string $query
+     * @param string $placeId
+     * @param array  $args
+     * @param string $format
      *
      * @return string
      */
-    public function placeAutoComplete(string $query): string
+    public function placeDetails(string $placeId, array $args = [], string $format = 'json'): string
     {
-        $configurator = $this->getConfigurator(self::CONFIGURATOR_SERVICE_PLACE_AUTO_COMPLETE);
+        $configurator = $this->getConfigurator(self::CONFIGURATOR_SERVICE_PLACE_DETAIL);
 
-        $result = $this->makeRequest($configurator, ['input' => $query]);
+        $result = $this->makeRequest($configurator, ['placeid' => $placeId], $format, $args);
         $response = (string) $result->getBody()->getContents();
 
         return $response;

tests/Treeleaf/GoogleApi/Service/Places/PlacesApiTest.php

@@ -2,7 +2,9 @@
 
 namespace Tests\Treeleaf\GoogleApi\Service\Places;
 
+use Treeleaf\GoogleApi\Bootstrap;
 use Treeleaf\GoogleApi\Configurator\AbstractConfigurator;
+use Treeleaf\GoogleApi\Configurator\Places\PlacesDetailConfigurator;
 use Treeleaf\GoogleApi\Test\AbstractBaseTestCase;
 use Treeleaf\GoogleApi\Configurator\ConfiguratorCollection;
 use Treeleaf\GoogleApi\Configurator\Places\PlacesAutoCompleteConfigurator;
@@ -48,7 +50,7 @@ public function testPlaceAutoComplete()
                 $this->equalTo('GET'),
                 $this->equalTo(sprintf("%s://%s/%s/json", AbstractConfigurator::DEFAULT_SCHEME, AbstractConfigurator::HOST_GOOGLE_MAPS, PlacesAutoCompleteConfigurator::URI_PLACE_AUTOCOMPLETE)),
                 $this->equalTo(['query' => [
-                    'key' => 'DummyKey',
+                    'key'   => 'DummyKey',
                     'input' => 'Paris'
                 ]])
             )
@@ -65,17 +67,65 @@ public function testPlaceAutoComplete()
         $this->assertJsonStringEqualsJsonFile($jsonDir . '/' . $jsonFile, $result);
     }
 
+    /**
+     * Test Place auto complete function.
+     */
+    public function testPlaceDetails()
+    {
+        $jsonDir = $this->getTestsDataDir();
+        $jsonFile = 'service.places.placesApi.placeDetails.json';
+        $json = $this->getTestDataJson($jsonFile);
+
+        $streamMock = $this->getMockBuilder('GuzzleHttp\Psr7\Stream')
+            ->disableOriginalConstructor()
+            ->setMethods(['getContents'])
+            ->getMock()
+        ;
+        $streamMock->expects($this->once())->method('getContents')->willReturn($json);
+
+        $responseMock = $this->getMockBuilder('GuzzleHttp\Psr7\Response')
+            ->disableOriginalConstructor()
+            ->setMethods(['getBody'])
+            ->getMock()
+        ;
+        $responseMock->expects($this->once())->method('getBody')->willReturn($streamMock);
+
+        $httpClientMock = $this->getMockBuilder('GuzzleHttp\Client')
+            ->disableOriginalConstructor()
+            ->setMethods(['request'])
+            ->getMock()
+        ;
+        $httpClientMock
+            ->expects($this->once())
+            ->method('request')
+            ->with(
+                $this->equalTo('GET'),
+                $this->equalTo(sprintf("%s://%s/%s/json", AbstractConfigurator::DEFAULT_SCHEME, AbstractConfigurator::HOST_GOOGLE_MAPS, PlacesDetailConfigurator::URI_PLACE_DETAIL)),
+                $this->equalTo(['query' => [
+                    'key'     => 'DummyKey',
+                    'placeid' => 'ChIJD7fiBh9u5kcRYJSMaMOCCwQ'
+                ]])
+            )
+            ->willReturn($responseMock)
+        ;
+
+        $collection = $this->getConfiguratorCollection();
+        $placesApiService = new PlacesApi($collection, $httpClientMock);
+
+
+        $result = $placesApiService->placeDetails('ChIJD7fiBh9u5kcRYJSMaMOCCwQ');
+
+
+        $this->assertJsonStringEqualsJsonFile($jsonDir . '/' . $jsonFile, $result);
+    }
+
     /**
      * @return ConfiguratorCollection
      */
     protected function getConfiguratorCollection(): ConfiguratorCollection
     {
-        $collection = new ConfiguratorCollection();
-        $collection->addConfigurator(
-            PlacesApi::CONFIGURATOR_SERVICE_PLACE_AUTO_COMPLETE,
-            new PlacesAutoCompleteConfigurator('DummyKey')
-        );
+        $bootstrap = new Bootstrap();
 
-        return $collection;
+        return $bootstrap->getConfiguratorCollection('DummyKey');
     }
 }