Merge pull request #1 from langleyfoxall/feature/driving-directions

Directions functionality

Author: DivineOmega

.gitignore

@@ -1,4 +1,5 @@
 /vendor/
 composer.lock
 /cache/
-.idea
+.idea
+out.txt

.styleci.yml

@@ -0,0 +1,6 @@
+preset: psr2
+
+risky: false
+
+enabled:
+  - no_blank_lines_before_namespace

README.md

@@ -1,5 +1,7 @@
 # PHP Simple Google Maps
 
+[![StyleCI](https://github.styleci.io/repos/159809368/shield?branch=master)](https://github.styleci.io/repos/159809368)
+
 This package provides a simple PHP client for various Google Maps APIs.
 
 ## Installation
@@ -67,3 +69,63 @@ $address = $simpleGoogleMaps->reverseGeocode(new LatLong(51.5033635, -0.1276248)
 This method will return a string containing the address found at the specified coordinates. If no address
 could be found, `null` will be returned.
 
+### Directions
+
+To find the directions between two points, use the `directions` method. The methods expects
+three parameters, the origin, the destination, and optionally the travel mode as defined by the
+`TravelMode` enum.
+
+See the example usage below.
+
+```php
+$address1 = "10 Downing St, Westminster, London SW1A UK";
+$address2 = "Schott House, Drummond Rd, Stafford ST16 3EL";
+
+$journey = $simpleGoogleMaps->directions($address1, $address2, TravelMode::DRIVING);
+
+foreach($journey as $step) {
+    echo $step->duration.' secs  ';
+    echo "\t";
+    echo $step->distance.' m    ';
+    echo "\t";
+    echo $step->description;
+    echo PHP_EOL;
+}
+
+echo 'Totals: '.$journey->duration().' secs, '.$journey->distance().' km';
+echo PHP_EOL;
+```
+
+This will produce output similar to the following.
+
+```
+134 secs        452 m           Head north on Whitehall / A3212 toward Horse Guards Ave May be closed at certain times or days 
+203 secs        1029 m          At the roundabout, take the 1st exit onto The Mall Parts of this road may be closed at certain times or days 
+121 secs        688 m           Turn right onto Constitution Hill 
+34 secs         141 m           Turn left onto Duke of Wellington Pl Leaving toll zone 
+20 secs         83 m            Turn right onto Grosvenor Pl 
+21 secs         107 m           Slight right onto Piccadilly May be closed at certain times or days 
+164 secs        1244 m          Slight left onto Park Ln / A4202 
+35 secs         199 m           Slight left onto Cumberland Gate 
+16 secs         68 m            Turn right onto Bayswater Rd 
+92 secs         410 m           Slight left onto Edgware Rd / A5 Entering toll zone in 280 m at Upper Berkeley St Leaving toll zone in 300 m at Stourcliffe St 
+48 secs         177 m           Turn right onto George St Entering toll zone 
+152 secs        531 m           Turn left onto Seymour Pl 
+46 secs         231 m           Turn left onto Marylebone Rd / A501 Leaving toll zone 
+722 secs        9209 m          Keep right to continue on Marylebone Flyover / A40 Continue to follow A40 
+708 secs        14581 m         Keep right to continue on Western Ave / A40 
+4636 secs       140047 m        Keep right to continue on M40 , follow signs for M25 / Birmingham / Oxford / Beaconsfield 
+49 secs         1164 m          At junction 3A , take the M42 / Railway Station / Airport exit to M1 / M6 / Birmingham (E, N & C) / Solihull / N.E.C. 
+856 secs        22091 m         Merge onto M42 
+14 secs         375 m           Keep right at the fork to continue on M6 Toll 
+1121 secs       33363 m         Keep right at the fork to stay on M6 Toll Toll road 
+756 secs        19905 m         Continue onto M6 
+23 secs         206 m           At junction 14 , take the A34 exit to Stone / Stafford (N) 
+103 secs        1213 m          At the roundabout, take the 3rd exit onto A34 Go through 1 roundabout 
+80 secs         925 m           At the roundabout, take the 2nd exit onto Beaconside / A513 
+128 secs        1550 m          Turn right onto Common Rd 
+13 secs         123 m           Turn left onto Astonfields Rd 
+76 secs         395 m           Turn left onto Drummond Rd Destination will be on the left 
+Totals: 10371 secs, 250507 km
+```
+

composer.json

@@ -5,6 +5,7 @@
         "guzzlehttp/guzzle": "^6.2",
         "DivineOmega/DO-File-Cache": "^2.0",
         "divineomega/php-distance": "^1.0",
+        "illuminate/support": "^5.1",
         "ext-json": "*",
         "php": ">=7.0"
     },

src/Factories/SimpleGoogleMapsFactory.php

@@ -1,21 +1,17 @@
-<?php
-namespace LangleyFoxall\SimpleGoogleMaps\Factories;
-
-use LangleyFoxall\SimpleGoogleMaps\Objects\SimpleGoogleMaps;
-
-abstract class SimpleGoogleMapsFactory
-{
-    public static function getByKey($key)
-    {
-      return new SimpleGoogleMaps($key,null,null);
-    }
-
-    public static function getByClientNameAndCryptKey($clientName,$cryptKey)
-    {
-      return new SimpleGoogleMaps(null,$clientName,$cryptKey);
-    }
-}
-
-
-
-?>
+<?php
+namespace LangleyFoxall\SimpleGoogleMaps\Factories;
+
+use LangleyFoxall\SimpleGoogleMaps\Objects\SimpleGoogleMaps;
+
+abstract class SimpleGoogleMapsFactory
+{
+    public static function getByKey($key)
+    {
+        return new SimpleGoogleMaps($key, null, null);
+    }
+
+    public static function getByClientNameAndCryptKey($clientName, $cryptKey)
+    {
+        return new SimpleGoogleMaps(null, $clientName, $cryptKey);
+    }
+}

src/Interfaces/ApiAuthInterface.php

@@ -1,9 +1,7 @@
-<?php
-namespace LangleyFoxall\SimpleGoogleMaps\Interfaces;
-
-
-interface ApiAuthInterface
-{
-    public function applyToUrl($url);
-}
-?>
+<?php
+namespace LangleyFoxall\SimpleGoogleMaps\Interfaces;
+
+interface ApiAuthInterface
+{
+    public function applyToUrl($url);
+}

src/Interfaces/CacheDriverInterface.php

@@ -4,6 +4,8 @@
 interface CacheDriverInterface
 {
     public function set($key, $value);
+
     public function get($key);
+
     public function delete($key);
-}
+}

src/Objects/ApiAuthDrivers/BasicApiAuthDriver.php

@@ -1,44 +1,44 @@
-<?php
-namespace LangleyFoxall\SimpleGoogleMaps\Objects\ApiAuthDrivers;
-
-use LangleyFoxall\SimpleGoogleMaps\Interfaces\ApiAuthInterface;
-use Exception;
-
-/**
- * Class BasicApiAuthDriver
- * @package LangleyFoxall\SimpleGoogleMaps\Objects\ApiAuthDrivers
- */
-class BasicApiAuthDriver implements ApiAuthInterface
-{
-    /**
-     * @var string API Key
-     */
-    private $key;
-
-    /**
-     * BasicApiAuthDriver constructor.
-     * @param $key
-     * @throws Exception
-     */
-    public function __construct($key)
-    {
-        if(!$key){
-            throw new Exception("No key set");
-        }
-        $this->key = $key;
-    }
-
-    /**
-     * @param $url
-     * @return string
-     */
-    public function applyToUrl($url)
-    {
-        $authString= "&key=".$this->key;
-        $appendedUrl = $url.$authString;
-
-        return $appendedUrl;
-    }
-}
-
-?>
+<?php
+namespace LangleyFoxall\SimpleGoogleMaps\Objects\ApiAuthDrivers;
+
+use Exception;
+use LangleyFoxall\SimpleGoogleMaps\Interfaces\ApiAuthInterface;
+
+/**
+ * Class BasicApiAuthDriver.
+ */
+class BasicApiAuthDriver implements ApiAuthInterface
+{
+    /**
+     * @var string API Key
+     */
+    private $key;
+
+    /**
+     * BasicApiAuthDriver constructor.
+     *
+     * @param $key
+     *
+     * @throws Exception
+     */
+    public function __construct($key)
+    {
+        if (!$key) {
+            throw new Exception('No key set');
+        }
+        $this->key = $key;
+    }
+
+    /**
+     * @param $url
+     *
+     * @return string
+     */
+    public function applyToUrl($url)
+    {
+        $authString = '&key='.$this->key;
+        $appendedUrl = $url.$authString;
+
+        return $appendedUrl;
+    }
+}

src/Objects/ApiAuthDrivers/EnterpriseApiAuthDriver.php

@@ -1,64 +1,64 @@
-<?php
-namespace LangleyFoxall\SimpleGoogleMaps\Objects\ApiAuthDrivers;
-
-use LangleyFoxall\SimpleGoogleMaps\Interfaces\ApiAuthInterface;
-use Exception;
-
-/**
- * Class EnterpriseApiAuthDriver
- * @package LangleyFoxall\SimpleGoogleMaps\Objects\ApiAuthDrivers
- */
-class EnterpriseApiAuthDriver implements ApiAuthInterface
-{
-    /**
-     * @var string API client name
-     */
-    private $clientName;
-    /**
-     * @var string API crypt key
-     */
-    private $cryptKey;
-
-    /**
-     * EnterpriseApiAuthDriver constructor.
-     * @param $clientName
-     * @param $cryptKey
-     * @throws Exception
-     */
-    public function __construct($clientName, $cryptKey)
-    {  
-        if(!$clientName){
-            throw new Exception("ClientName not set");
-        }
-
-        if(!$cryptKey){
-               throw new Exception("CryptKey not set");
-        }
-        $this->clientName = $clientName;
-        $this->cryptKey = $cryptKey;   
-    }
-
-    /**
-     * @param $url
-     * @return string
-     */
-    public function applyToUrl($url)
-    {
-        $urlWithClient = $url."&client=".$this->clientName;
-
-        $parsedUrl = parse_url($urlWithClient);
-
-        $urlToEncode = $parsedUrl['path'].'?'.$parsedUrl['query'];
-        $baseKey = base64_decode(str_replace(array('-', '_'), array('+', '/'), $this->cryptKey));
-
-        $signature = hash_hmac('sha1', $urlToEncode, $baseKey, true);
-
-        $encodedSignature = str_replace(array('+', '/'), array('-', '_'), base64_encode($signature));
-
-        $appendedUrl = $urlWithClient."&signature=".$encodedSignature;
-
-        return $appendedUrl;
-    }
-}
-
-?>
+<?php
+namespace LangleyFoxall\SimpleGoogleMaps\Objects\ApiAuthDrivers;
+
+use Exception;
+use LangleyFoxall\SimpleGoogleMaps\Interfaces\ApiAuthInterface;
+
+/**
+ * Class EnterpriseApiAuthDriver.
+ */
+class EnterpriseApiAuthDriver implements ApiAuthInterface
+{
+    /**
+     * @var string API client name
+     */
+    private $clientName;
+    /**
+     * @var string API crypt key
+     */
+    private $cryptKey;
+
+    /**
+     * EnterpriseApiAuthDriver constructor.
+     *
+     * @param $clientName
+     * @param $cryptKey
+     *
+     * @throws Exception
+     */
+    public function __construct($clientName, $cryptKey)
+    {
+        if (!$clientName) {
+            throw new Exception('ClientName not set');
+        }
+
+        if (!$cryptKey) {
+            throw new Exception('CryptKey not set');
+        }
+        $this->clientName = $clientName;
+        $this->cryptKey = $cryptKey;
+    }
+
+    /**
+     * @param $url
+     *
+     * @return string
+     */
+    public function applyToUrl($url)
+    {
+        $urlWithClient = $url.'&client='.$this->clientName;
+
+        $parsedUrl = parse_url($urlWithClient);
+
+        $urlToEncode = $parsedUrl['path'].'?'.$parsedUrl['query'];
+        $baseKey = base64_decode(str_replace(['-', '_'], ['+', '/'], $this->cryptKey));
+
+        $signature = hash_hmac('sha1', $urlToEncode, $baseKey, true);
+
+        $encodedSignature = str_replace(['+', '/'], ['-', '_'], base64_encode($signature));
+
+        $appendedUrl = $urlWithClient.'&signature='.$encodedSignature;
+
+        return $appendedUrl;
+    }
+}