Amendments to operations to the upport the ReQL API argument expected…

… type
tbolier · Feb 13, 2018 · 8686875 · 8686875
1 parent 2f6a1ea
commit 8686875
Show file tree

Hide file tree

Showing 77 changed files with 361 additions and 477 deletions.
diff --git a/src/Connection/Connection.php b/src/Connection/Connection.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Connection;
 
@@ -155,7 +155,13 @@ public function continueQuery(int $token): ResponseInterface
      */
     public function expr(string $string): ResponseInterface
     {
-        return $this->run(new ExprMessage(QueryType::START, 'foo'));
+        $response = $this->run(new ExprMessage(QueryType::START, 'foo'));
+
+        if ($response instanceof ResponseInterface) {
+            return $response;
+        }
+
+        return new Response();
     }
 
     /**
@@ -179,7 +185,7 @@ public function run(MessageInterface $message, $raw = false)
             $this->writeQuery($token, $message);
 
             if ($this->noReply) {
-                return null;
+                return new Response();
             }
 
             $response = $this->receiveResponse($token, $message);
@@ -277,9 +283,9 @@ public function writeQuery(int $token, MessageInterface $message): int
         }
 
         $requestSize = pack('V', \strlen($request));
-        $binaryToken = pack('V', $token) . pack('V', 0);
+        $binaryToken = pack('V', $token).pack('V', 0);
 
-        return $this->stream->write($binaryToken . $requestSize . $request);
+        return $this->stream->write($binaryToken.$requestSize.$request);
     }
 
     /**
@@ -385,27 +391,27 @@ private function validateResponse(
         int $token,
         MessageInterface $message
     ): void {
-        if (!$response->getType()) {
+        if ($response->getType() === null) {
             throw new ConnectionException('Response message has no type.');
         }
 
         if ($response->getType() === ResponseType::CLIENT_ERROR) {
-            throw new ConnectionException('Client error: ' . $response->getData()[0] . ' jsonQuery: ' . json_encode($message));
+            throw new ConnectionException('Client error: '.$response->getData()[0].' jsonQuery: '.json_encode($message));
         }
 
         if ($responseToken !== $token) {
             throw new ConnectionException(
                 'Received wrong token. Response does not match the request. '
-                . 'Expected ' . $token . ', received ' . $responseToken
+                . 'Expected '.$token.', received '.$responseToken
             );
         }
 
         if ($response->getType() === ResponseType::COMPILE_ERROR) {
-            throw new ConnectionException('Compile error: ' . $response->getData()[0] . ', jsonQuery: ' . json_encode($message));
+            throw new ConnectionException('Compile error: '.$response->getData()[0].', jsonQuery: '.json_encode($message));
         }
 
         if ($response->getType() === ResponseType::RUNTIME_ERROR) {
-            throw new ConnectionException('Runtime error: ' . $response->getData()[0] . ', jsonQuery: ' . json_encode($message));
+            throw new ConnectionException('Runtime error: '.$response->getData()[0].', jsonQuery: '.json_encode($message));
         }
     }
 }
diff --git a/src/Connection/ConnectionCursorInterface.php b/src/Connection/ConnectionCursorInterface.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Connection;
 
@@ -10,7 +10,7 @@ interface ConnectionCursorInterface extends ConnectionQueryInterface
 {
     /**
      * @param MessageInterface $message
-     * @return ResponseInterface
+     * @return Iterable|ResponseInterface
      * @throws ConnectionException
      */
     public function rewindFromCursor(MessageInterface $message): ResponseInterface;

diff --git a/src/Connection/ConnectionException.php b/src/Connection/ConnectionException.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Connection;
 

diff --git a/src/Connection/ConnectionInterface.php b/src/Connection/ConnectionInterface.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Connection;
 

diff --git a/src/Connection/ConnectionQueryInterface.php b/src/Connection/ConnectionQueryInterface.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Connection;
 

diff --git a/src/Connection/Options.php b/src/Connection/Options.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Connection;
 

diff --git a/src/Connection/OptionsInterface.php b/src/Connection/OptionsInterface.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Connection;
 

diff --git a/src/Connection/Registry.php b/src/Connection/Registry.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Connection;
 

diff --git a/src/Connection/RegistryInterface.php b/src/Connection/RegistryInterface.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Connection;
 

diff --git a/src/Connection/Socket/Exception.php b/src/Connection/Socket/Exception.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Connection\Socket;
 

diff --git a/src/Connection/Socket/Handshake.php b/src/Connection/Socket/Handshake.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 /**
  * @license http://www.apache.org/licenses/ Apache License 2.0
@@ -113,7 +113,6 @@ public function hello(StreamInterface $stream): void
             $stream->close();
             throw $e;
         }
-
     }
 
     /**
@@ -123,9 +122,11 @@ public function hello(StreamInterface $stream): void
      */
     private function nextMessage(string $response = null): ?string
     {
+        if ($response === null) {
+            return $this->createHandshakeMessage();
+        }
+
         switch ($this->state) {
-            case 0:
-                return $this->createHandshakeMessage($response);
             case 1:
                 return $this->verifyProtocol($response);
             case 2:
@@ -145,7 +146,7 @@ private function nextMessage(string $response = null): ?string
      */
     private function pkbdf2Hmac(string $password, string $salt, int $iterations): string
     {
-        $t = hash_hmac('sha256', $salt . "\x00\x00\x00\x01", $password, true);
+        $t = hash_hmac('sha256', $salt."\x00\x00\x00\x01", $password, true);
         $u = $t;
         for ($i = 0; $i < $iterations - 1; ++$i) {
             $t = hash_hmac('sha256', $t, $password, true);
@@ -156,15 +157,12 @@ private function pkbdf2Hmac(string $password, string $salt, int $iterations): st
     }
 
     /**
-     * @param null|string $response
      * @return string
      */
-    private function createHandshakeMessage(?string $response): string
+    private function createHandshakeMessage(): string
     {
-        $response === null or die('Illegal handshake state');
-
         $this->myR = base64_encode(openssl_random_pseudo_bytes(18));
-        $this->clientFirstMessage = 'n=' . $this->username . ',r=' . $this->myR;
+        $this->clientFirstMessage = 'n='.$this->username.',r='.$this->myR;
 
         $binaryVersion = pack('V', $this->version);
 
@@ -176,7 +174,7 @@ private function createHandshakeMessage(?string $response): string
                 [
                     'protocol_version' => $this->protocolVersion,
                     'authentication_method' => 'SCRAM-SHA-256',
-                    'authentication' => 'n,,' . $this->clientFirstMessage,
+                    'authentication' => 'n,,'.$this->clientFirstMessage,
                 ]
             )
             . \chr(0);
@@ -199,7 +197,7 @@ private function verifyProtocol(?string $response): string
 
         $json = json_decode($response, true);
         if ($json['success'] === false) {
-            throw new Exception('Handshake failed: ' . $json["error"]);
+            throw new Exception('Handshake failed: '.$json["error"]);
         }
         if ($this->protocolVersion > $json['max_protocol_version']
             || $this->protocolVersion < $json['min_protocol_version']) {
@@ -220,7 +218,7 @@ private function createAuthenticationMessage($response): string
     {
         $json = json_decode($response, true);
         if ($json['success'] === false) {
-            throw new Exception('Handshake failed: ' . $json['error']);
+            throw new Exception('Handshake failed: '.$json['error']);
         }
         $serverFirstMessage = $json['authentication'];
         $authentication = [];
@@ -233,15 +231,15 @@ private function createAuthenticationMessage($response): string
             throw new Exception('Invalid nonce from server.');
         }
         $salt = base64_decode($authentication['s']);
-        $iterations = (int)$authentication['i'];
+        $iterations = (int) $authentication['i'];
 
-        $clientFinalMessageWithoutProof = 'c=biws,r=' . $serverR;
+        $clientFinalMessageWithoutProof = 'c=biws,r='.$serverR;
         $saltedPassword = $this->pkbdf2Hmac($this->password, $salt, $iterations);
         $clientKey = hash_hmac('sha256', 'Client Key', $saltedPassword, true);
         $storedKey = hash('sha256', $clientKey, true);
 
         $authMessage =
-            $this->clientFirstMessage . ',' . $serverFirstMessage . ',' . $clientFinalMessageWithoutProof;
+            $this->clientFirstMessage.','.$serverFirstMessage.','.$clientFinalMessageWithoutProof;
 
         $clientSignature = hash_hmac('sha256', $authMessage, $storedKey, true);
 
@@ -256,7 +254,7 @@ private function createAuthenticationMessage($response): string
         return
             json_encode(
                 [
-                    'authentication' => $clientFinalMessageWithoutProof . ',p=' . base64_encode($clientProof),
+                    'authentication' => $clientFinalMessageWithoutProof.',p='.base64_encode($clientProof),
                 ]
             )
             . \chr(0);
@@ -271,7 +269,7 @@ private function verifyAuthentication(string $response): string
     {
         $json = json_decode($response, true);
         if ($json['success'] === false) {
-            throw new Exception('Handshake failed: ' . $json['error']);
+            throw new Exception('Handshake failed: '.$json['error']);
         }
         $authentication = [];
         foreach (explode(',', $json['authentication']) as $var) {

diff --git a/src/Connection/Socket/HandshakeInterface.php b/src/Connection/Socket/HandshakeInterface.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Connection\Socket;
 

diff --git a/src/Connection/Socket/Socket.php b/src/Connection/Socket/Socket.php
@@ -1,10 +1,11 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Connection\Socket;
 
 use Psr\Http\Message\StreamInterface;
 use TBolier\RethinkQL\Connection\OptionsInterface;
+use TBolier\RethinkQL\Connection\Socket\Exception;
 
 class Socket implements StreamInterface
 {
@@ -25,11 +26,12 @@ class Socket implements StreamInterface
 
     /**
      * @param OptionsInterface $options
+     * @throws Exception
      */
     public function __construct(OptionsInterface $options)
     {
         $this->openStream(
-            ($options->isSsl() ? 'ssl' : 'tcp') . '://' . $options->getHostname() . ':' . $options->getPort(),
+            ($options->isSsl() ? 'ssl' : 'tcp').'://'.$options->getHostname().':'.$options->getPort(),
             $options->getTimeout(),
             $options->getTimeoutStream()
         );
@@ -39,17 +41,23 @@ public function __construct(OptionsInterface $options)
      * @param string $remote_socket
      * @param float $timeout
      * @param int $timeoutStream
+     * @throws Exception
      */
     private function openStream(string $remote_socket, float $timeout, int $timeoutStream): void
     {
-        $this->stream = stream_socket_client(
+        $stream = stream_socket_client(
             $remote_socket,
             $errno,
             $errstr,
             $timeout,
             STREAM_CLIENT_CONNECT
         );
 
+        if (!$stream) {
+            throw new Exception('Failed to create a socket stream.');
+        }
+
+        $this->stream = $stream;
         stream_set_timeout($this->stream, $timeoutStream);
     }
 

diff --git a/src/Message/ExprMessage.php b/src/Message/ExprMessage.php
@@ -89,7 +89,7 @@ public function toArray(): array
         return [
             $this->queryType,
             $this->query,
-            (object)$this->getOptions(),
+            (object) $this->getOptions(),
         ];
     }
 

diff --git a/src/Message/Message.php b/src/Message/Message.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Message;
 
@@ -90,7 +90,7 @@ public function toArray(): array
         return [
             $this->queryType,
             $this->query,
-            (object)$this->getOptions()
+            (object) $this->getOptions()
         ];
     }
 

diff --git a/src/Message/MessageInterface.php b/src/Message/MessageInterface.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Message;
 

diff --git a/src/Query/AbstractQuery.php b/src/Query/AbstractQuery.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Query;
 

diff --git a/src/Query/Builder.php b/src/Query/Builder.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Query;
 
@@ -40,7 +40,7 @@ public function __construct(RethinkInterface $rethink, MessageInterface $message
 
     /**
      * @param string $name
-     * @return Table
+     * @return TableInterface
      */
     public function table(string $name): TableInterface
     {

diff --git a/src/Query/BuilderInterface.php b/src/Query/BuilderInterface.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types=1);
+declare(strict_types = 1);
 
 namespace TBolier\RethinkQL\Query;
 
@@ -8,7 +8,7 @@ interface BuilderInterface
     /**
      * @param string $name
      *
-     * @return Table
+     * @return TableInterface
      */
     public function table(string $name): TableInterface;