Updated changes to implement different types of auth.

Author: stefanak-michal

phpunit.xml

@@ -13,7 +13,7 @@
             <directory suffix=".php">src/connection</directory>
             <directory suffix=".php">src/PackStream</directory>
             <directory suffix=".php">src/protocol</directory>
-            <directory suffix=".php">src/auth</directory>
+            <directory suffix=".php">src/helpers</directory>
             <file>src/Bolt.php</file>
         </whitelist>
     </filter>

src/Bolt.php

@@ -185,35 +185,33 @@ private function packProtocolVersions(): string
 
     /**
      * Send INIT message
-     * @param auth\Auth $auth
-     * @return bool|array
+     * @param array $extra You can use helpers\Auth to generate required array
+     * @return array
      * @throws Exception
      * @version <3
      */
-    public function init(\Bolt\auth\Auth $auth)
+    public function init(array $extra)
     {
-        if (!$this->connection->connect())
-            return false;
-
-        if (!$this->handshake())
-            return false;
-
-        if (self::$debug)
-            echo 'INIT';
+        if ($this->connection->connect() && $this->handshake()) {
+            if (self::$debug)
+                echo 'INIT';
+            return $this->protocol->init($extra, $this->routing);
+        }
 
-        return $this->protocol->init($auth->getCredentials(), $this->routing) ?? false;
+        // I don't think it will reach this point, but otherwise I've to end method with return
+        throw new Exception('INIT message wasn\'t successful');
     }
 
     /**
      * Send HELLO message
-     * @param auth\Auth $auth
-     * @return bool|array
+     * @param array $extra You can use helpers\Auth to generate required array
+     * @return array
      * @throws Exception
      * @version >=3
      */
-    public function hello(\Bolt\auth\Auth $auth)
+    public function hello(array $extra)
     {
-        return $this->init($auth);
+        return $this->init($extra);
     }
 
     /**

src/auth/Auth.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace Bolt\helpers;
+
+/**
+ * Class Auth
+ * Helper to generate array of extra parameters for INIT/HELLO message
+ *
+ * @author Michal Stefanak
+ * @link https://github.com/neo4j-php/Bolt
+ * @package Bolt\helpers
+ */
+class Auth
+{
+    /**
+     * @var string
+     */
+    public static $userAgent = 'bolt-php';
+
+    /**
+     * None authorization
+     * @return array
+     */
+    public static function none(): array
+    {
+        return [
+            'user_agent' => self::$userAgent,
+            'scheme' => 'none'
+        ];
+    }
+
+    /**
+     * Basic authorization with username and password
+     * @param string $username
+     * @param string $password
+     * @return array
+     */
+    public static function basic(string $username, string $password): array
+    {
+        return [
+            'user_agent' => self::$userAgent,
+            'scheme' => 'basic',
+            'principal' => $username,
+            'credentials' => $password
+        ];
+    }
+
+    /**
+     * OIDC authorization with token
+     * @param string $token
+     * @return array
+     */
+    public static function bearer(string $token): array
+    {
+        return [
+            'user_agent' => self::$userAgent,
+            'scheme' => 'bearer',
+            'credentials' => $token
+        ];
+    }
+}

src/auth/Basic.php

@@ -17,7 +17,7 @@ interface IProtocol
      * @param mixed ...$args
      * @return array
      */
-    public function init(...$args): ?array;
+    public function init(...$args): array;
 
     /**
      * Send RUN message

src/auth/Bearer.php

@@ -18,11 +18,12 @@ class V1 extends AProtocol
 {
 
     /**
+     * Send INIT message
      * @param mixed ...$args
      * @return array
      * @throws Exception
      */
-    public function init(...$args): ?array
+    public function init(...$args): array
     {
         if (count($args) < 1) {
             throw new PackException('Wrong arguments count');
@@ -40,10 +41,11 @@ public function init(...$args): ?array
             throw new MessageException($output['message'] . ' (' . $output['code'] . ')');
         }
 
-        return $signature == self::SUCCESS ? $output : null;
+        return $output;
     }
 
     /**
+     * Send RUN message
      * @param mixed ...$args
      * @return array
      * @throws Exception
@@ -66,6 +68,7 @@ public function run(...$args): array
     }
 
     /**
+     * Send PULL_ALL message
      * @param mixed ...$args
      * @return array
      * @throws Exception
@@ -90,6 +93,7 @@ public function pullAll(...$args): array
     }
 
     /**
+     * Send DISCARD_ALL message
      * @param mixed ...$args
      * @return bool
      * @throws Exception
@@ -119,6 +123,9 @@ private function ackFailure(): bool
     }
 
     /**
+     * Send RESET message
+     * The RESET message requests that the connection should be set back to its initial READY state, as if an INIT had just successfully completed.
+     *
      * @return bool
      * @throws Exception
      */

src/auth/None.php

@@ -18,22 +18,22 @@ class V3 extends V2
 {
 
     /**
-     * @param mixed ...$args
-     * @return array
-     * @throws Exception
+     * @inheritDoc
+     * @deprecated Replaced with HELLO message
      */
-    public function init(...$args): ?array
+    public function init(...$args): array
     {
         $args[] = null;
         return $this->hello(...$args);
     }
 
     /**
+     * Send HELLO message
      * @param mixed ...$args
      * @return array
      * @throws Exception
      */
-    public function hello(...$args): ?array
+    public function hello(...$args): array
     {
         if (count($args) < 1) {
             throw new PackException('Wrong arguments count');
@@ -46,7 +46,7 @@ public function hello(...$args): ?array
             throw new MessageException($output['message'] . ' (' . $output['code'] . ')');
         }
 
-        return $signature == self::SUCCESS ? $output : null;
+        return $output;
     }
 
     /**