Merge pull request #74 from neo4j-php/authentication

Small authentication improvements

Author: transistive

src/Bolt.php

@@ -200,14 +200,14 @@ private function packProtocolVersions(): string
      *
      * @return bool
      * @throws Exception
-     * @deprecated The usage of $user, $password, $routing and $metadata is deprecated. Please use helpers\Auth to generate an authentication strategy as an array.
+     * @note The usage of $user, $password, $routing and $metadata is deprecated. Please use helpers\Auth to generate an authentication strategy as an array.
      *
      * @version <3
      */
     public function init($userAgentOrExtra, string $user = '', string $password = '', $routing = false, array &$metadata = []): bool
     {
         if (is_string($userAgentOrExtra)) {
-            Auth::$userAgent = $userAgentOrExtra;
+            Auth::$defaultUserAgent = $userAgentOrExtra;
             $userAgentOrExtra = empty($user) && empty($password) ? Auth::none() : Auth::basic($user, $password);
             if ($routing !== false)
                 $userAgentOrExtra['routing'] = $routing;
@@ -235,7 +235,7 @@ public function init($userAgentOrExtra, string $user = '', string $password = ''
      *
      * @return bool
      * @throws Exception
-     * @deprecated The usage of $user, $password, $routing and $metadata is deprecated. Please use helpers\Auth to generate an authentication strategy as an array.
+     * @note The usage of $user, $password, $routing and $metadata is deprecated. Please use helpers\Auth to generate an authentication strategy as an array.
      *
      * @version >=3
      */

src/helpers/Auth.php

@@ -15,16 +15,16 @@ class Auth
     /**
      * @var string
      */
-    public static $userAgent = 'bolt-php';
+    public static $defaultUserAgent = 'bolt-php';
 
     /**
      * None authorization
      * @return array
      */
-    public static function none(): array
+    public static function none(?string $userAgent = null): array
     {
         return [
-            'user_agent' => self::$userAgent,
+            'user_agent' => $userAgent ?? self::$defaultUserAgent,
             'scheme' => 'none'
         ];
     }
@@ -35,10 +35,10 @@ public static function none(): array
      * @param string $password
      * @return array
      */
-    public static function basic(string $username, string $password): array
+    public static function basic(string $username, string $password, ?string $userAgent = null): array
     {
         return [
-            'user_agent' => self::$userAgent,
+            'user_agent' => $userAgent ?? self::$defaultUserAgent,
             'scheme' => 'basic',
             'principal' => $username,
             'credentials' => $password
@@ -50,10 +50,10 @@ public static function basic(string $username, string $password): array
      * @param string $token
      * @return array
      */
-    public static function bearer(string $token): array
+    public static function bearer(string $token, ?string $userAgent = null): array
     {
         return [
-            'user_agent' => self::$userAgent,
+            'user_agent' => $userAgent ?? self::$defaultUserAgent,
             'scheme' => 'bearer',
             'credentials' => $token
         ];

tests/protocol/V1Test.php

@@ -27,7 +27,7 @@ class V1Test extends \Bolt\tests\ATest
      */
     public function test__construct()
     {
-        \Bolt\helpers\Auth::$userAgent = 'Test/1.0';
+        \Bolt\helpers\Auth::$defaultUserAgent = 'Test/1.0';
         $cls = new V1(new \Bolt\PackStream\v1\Packer, new \Bolt\PackStream\v1\Unpacker, $this->mockConnection());
         $this->assertInstanceOf(V1::class, $cls);
         return $cls;

tests/protocol/V4_1Test.php

@@ -24,7 +24,7 @@ class V4_1Test extends \Bolt\tests\ATest
      */
     public function test__construct()
     {
-        \Bolt\helpers\Auth::$userAgent = 'Test/1.0';
+        \Bolt\helpers\Auth::$defaultUserAgent = 'Test/1.0';
         $cls = new V4_1(new \Bolt\PackStream\v1\Packer, new \Bolt\PackStream\v1\Unpacker, $this->mockConnection());
         $this->assertInstanceOf(V4_1::class, $cls);
         return $cls;