JSON Encoder and examples

Author: repejota

examples/encodedping.php

@@ -1,18 +1,17 @@
 <?php
-require_once __DIR__ . "/../../vendor/autoload.php";
+require_once __DIR__.'/../../vendor/autoload.php';
 
-$encoder = new \Nats\Encoders\JSONEncoder();
+$encoder           = new \Nats\Encoders\JSONEncoder();
 $connectionOptions = new \Nats\ConnectionOptions();
-$connectionOptions
-    ->setHost('localhost')
-    ->setPort(4222);
+
+$connectionOptions->setHost('localhost')->setPort(4222);
 $c = new Nats\EncodedConnection($connectionOptions, $encoder);
 $c->connect();
 
 $c->reconnect();
 
-$c->publish("foo", "bar");
-$c->publish("foo", "bar");
-$c->publish("foo", "bar");
-$c->publish("foo", "bar");
-$c->publish("foo", "bar");
+$c->publish('foo', 'bar');
+$c->publish('foo', 'bar');
+$c->publish('foo', 'bar');
+$c->publish('foo', 'bar');
+$c->publish('foo', 'bar');

examples/pubsub/jsonencodedpub.php

@@ -1,19 +1,18 @@
 <?php
-require_once __DIR__ . "/../../vendor/autoload.php";
+require_once __DIR__.'/../../vendor/autoload.php';
 
-$encoder = new \Nats\Encoders\JSONEncoder();
+$encoder           = new \Nats\Encoders\JSONEncoder();
 $connectionOptions = new \Nats\ConnectionOptions();
-$connectionOptions
-    ->setHost('localhost')
-    ->setPort(4222);
+
+$connectionOptions->setHost('localhost')->setPort(4222);
 $c = new Nats\EncodedConnection($connectionOptions, $encoder);
 $c->connect();
 
 $callback = function ($payload) {
     printf("Data: %s\r\n", $payload);
 };
 
-$sid = $c->subscribe("foo", $callback);
+$sid = $c->subscribe('foo', $callback);
 
 $c->wait(2);
 

examples/pubsub/jsonencodedsub.php

@@ -33,7 +33,7 @@ function it_has_default_lang_value_as_php() {
     }
 
     function it_has_default_version_value_as_null() {
-        $this->getVersion()->shouldEqual("0.8.0");
+        $this->getVersion()->shouldEqual("0.8.2");
     }
 
     function it_has_default_verbose_value_as_null() {

spec/Nats/ConnectionOptionsSpec.php

@@ -6,21 +6,23 @@
 
 /**
  * Connection Class.
+ *
+ * Handles the connection to a NATS server or cluster of servers.
  */
 class Connection
 {
 
     /**
-     * Number of PINGS.
+     * Number of PINGs.
      *
-     * @var int number of pings
+     * @var integer number of pings.
      */
     private $pings = 0;
 
     /**
-     * Chunk size in bytes to use when reading with fread.
+     * Chunk size in bytes to use when reading an stream of data.
      *
-     * @var integer
+     * @var integer size of chunk.
      */
     private $chunkSize = 1500;
 

src/Nats/Connection.php

@@ -3,69 +3,95 @@
 
 /**
  * Class EncodedConnection
+ *
  * @package Nats
  */
-class EncodedConnection extends Connection {
+class EncodedConnection extends Connection
+{
 
     /**
-     * @var Encoder|null
+     * Encoder for this connection.
+     *
+     * @var \Nats\Encoders\Encoder|null
      */
     private $encoder = null;
 
+
     /**
      * EncodedConnection constructor.
-     * @param ConnectionOptions|null $options
-     * @param Encoder|null $encoder
+     *
+     * @param ConnectionOptions           $options Connection options object.
+     * @param \Nats\Encoders\Encoder|null $encoder Encoder to use with the payload.
      */
-    public function __construct(ConnectionOptions $options = null, \Nats\Encoders\Encoder $encoder = null) {
+    public function __construct(ConnectionOptions $options = null, \Nats\Encoders\Encoder $encoder = null)
+    {
         $this->encoder = $encoder;
         parent::__construct($options);
     }
 
     /**
-     * @param string $subject
-     * @param string $payload
-     * @param mixed $callback
-     * @param int $wait
+     * Request does a request and executes a callback with the response.
+     *
+     * @param string  $subject  Message topic.
+     * @param string  $payload  Message data.
+     * @param mixed   $callback Closure to be executed as callback.
+     * @param integer $wait     Number of messages to wait for.
+     *
+     * @return void
      */
-    public function request($subject, $payload, $callback, $wait = 1) {
-        $payload = $this->encoder->encode($payload);
-        $decode_callback = function ($payload) use ($callback) {
+    public function request($subject, $payload, $callback, $wait = 1)
+    {
+        $payload        = $this->encoder->encode($payload);
+        $decodeCallback = function ($payload) use ($callback) {
             $callback($this->encoder->decode($payload));
         };
-        parent::request($subject, $payload, $decode_callback, $wait);
+        parent::request($subject, $payload, $decodeCallback, $wait);
     }
 
     /**
-     * @param string $subject
-     * @param null $payload
+     * Publish publishes the data argument to the given subject.
+     *
+     * @param string $subject Message topic.
+     * @param string $payload Message data.
+     *
+     * @return void
      */
-    public function publish($subject, $payload = null) {
+    public function publish($subject, $payload = null)
+    {
         $payload = $this->encoder->encode($payload);
         parent::publish($subject, $payload);
     }
 
     /**
-     * @param string $subject
-     * @param \Closure $callback
+     * Subscribes to an specific event given a subject.
+     *
+     * @param string   $subject  Message topic.
+     * @param \Closure $callback Closure to be executed as callback.
+     *
+     * @return string
      */
-    public function subscribe($subject, \Closure $callback) {
-        $decode_callback = function ($payload) use ($callback) {
+    public function subscribe($subject, \Closure $callback)
+    {
+        $decodeCallback = function ($payload) use ($callback) {
             $callback($this->encoder->decode($payload));
         };
-        parent::subscribe($subject, $decode_callback);
+        return parent::subscribe($subject, $decodeCallback);
     }
 
     /**
-     * @param string $subject
-     * @param string $queue
-     * @param \Closure $callback
+     * Subscribes to an specific event given a subject and a queue.
+     *
+     * @param string   $subject  Message topic.
+     * @param string   $queue    Queue name.
+     * @param \Closure $callback Closure to be executed as callback.
+     *
+     * @return string
      */
-    public function queueSubscribe($subject, $queue, \Closure $callback) {
-        $decode_callback = function ($payload) use ($callback) {
+    public function queueSubscribe($subject, $queue, \Closure $callback)
+    {
+        $decodeCallback = function ($payload) use ($callback) {
             $callback($this->encoder->decode($payload));
         };
-        parent::queueSubscribe($subject, $queue, $decode_callback);
+        return parent::queueSubscribe($subject, $queue, $decodeCallback);
     }
-
-}
+}

src/Nats/EncodedConnection.php

@@ -3,16 +3,27 @@
 
 /**
  * Interface Encoder
+ *
  * @package Nats\Encoders
  */
 interface Encoder
 {
+
+
     /**
+     * Encodes a message.
+     *
+     * @param string $payload Message to decode.
+     *
      * @return mixed
      */
     public function encode($payload);
 
     /**
+     * Decodes a message.
+     *
+     * @param string $payload Message to decode.
+     *
      * @return mixed
      */
     public function decode($payload);

src/Nats/Encoders/Encoder.php

@@ -3,17 +3,38 @@
 
 /**
  * Class JSONEncoder
+ *
+ * Encodes and decodes messages in JSON format.
+ *
  * @package Nats
  */
-class JSONEncoder implements \Nats\Encoders\Encoder {
+class JSONEncoder implements \Nats\Encoders\Encoder
+{
 
-    public function encode($payload) {
+
+    /**
+     * Encodes a message to JSON.
+     *
+     * @param string $payload Message to decode.
+     *
+     * @return mixed
+     */
+    public function encode($payload)
+    {
         $payload = json_encode($payload);
         return $payload;
     }
 
-    public function decode($payload) {
+    /**
+     * Decodes a message from JSON.
+     *
+     * @param string $payload Message to decode.
+     *
+     * @return mixed
+     */
+    public function decode($payload)
+    {
         $payload = json_decode($payload);
         return $payload;
     }
-}
+}

src/Nats/Encoders/JSONEncoder.php

@@ -62,7 +62,7 @@ public function testSettersAndGettersWithoutCredentials()
     public function testStringRepresentation()
     {
         $options = new ConnectionOptions();
-        $this->assertEquals('{"lang":"php","version":"0.8.0","verbose":false,"pedantic":false}', $options->__toString());
+        $this->assertEquals('{"lang":"php","version":"0.8.2","verbose":false,"pedantic":false}', $options->__toString());
     }
 
 
@@ -76,6 +76,6 @@ public function testStringRepresentationWithCredentials()
         $options = new ConnectionOptions();
         $options->setUser('username');
         $options->setPass('password');
-        $this->assertEquals('{"lang":"php","version":"0.8.0","verbose":false,"pedantic":false,"user":"username","pass":"password"}', $options->__toString());
+        $this->assertEquals('{"lang":"php","version":"0.8.2","verbose":false,"pedantic":false,"user":"username","pass":"password"}', $options->__toString());
     }
 }