fluent method signatures and version bump

Author: splatEric

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).
 
+1.1.0
+=====
++ Fluent method signatures where appropriate on Fax and Document objects.
++ Distinct Test namespace to ensure individual test file running is supported.
+
 1.0.3
 =====
 + Documentation correction for the outbound fax status retrieval.

README.md

@@ -379,7 +379,7 @@ $document = $client->documents->create($filename, filesize($filename), $params);
 ### Upload chunk
 
 ```php
-$document->upload($start, $end, $data);
+$document->upload($start, $end, $data); // returns the document object.
 ```
 
 Note no verification of data takes place - an exception wil be raised if values do not match appropriately.
@@ -402,7 +402,7 @@ $document->uri;
 
 ### Cancel document
 
-`$document->cancel();`
+`$document->cancel(); //returns the $document instance`
 
 Can be done prior to completion or afterward
 
@@ -415,11 +415,13 @@ The `Interfax\Outbound\Fax` class wraps the details of any fax sent, and is retu
 It offers several methods to manage or retrieve information about the fax.
 
 ```php
+// fluent methods that return the $fax instance
 $fax->refresh(); // refreshes the data on the fax object
 $fax->cancel(); // cancel the fax, returns true on success
+$fax->hide(); // hides the faxes from the fax lists
+
 $image = $fax->image(); // returns Interfax\Image
 $new_fax = $fax->resend('+1111111'); // returns a new Interfax\Outbound\Fax
-$fax->hide();
 $fax->attributes(); // hash array of fax data properties - see details below
 ```
 
@@ -452,10 +454,12 @@ Status should always be available. The values of the status codes are [Documente
 The incoming equivalent of the outbound fax class, the ```Interfax\Inbound\Fax``` class wraps the details of any incoming fax, and is returned by the ```Interfax\Inbound``` methods where appropriate.
 
 ```php
+// fluent methods that return the $fax instance for method chaining
 $fax->refresh(); // reload properties of the inbound fax
 $fax->markRead(); // mark the fax read - returns true or throws exception
 $fax->markUnread(); // mark the fax unread - returns true or throws exception
 $fax->resend();
+
 $image = $fax->image(); // Returns a Interfax\Image for this fax
 $email_array = $fax->emails(); // see below for details on the structure of this array
 $fax->attributes(); // hash array of properties

src/Interfax/Client.php

@@ -20,7 +20,7 @@
 
 class Client
 {
-    const VERSION = '1.0.3';
+    const VERSION = '1.1.0';
 
     /**
      * @var GenericFactory

src/Interfax/Document.php

@@ -20,7 +20,7 @@ class Document extends Resource
      * @param $start
      * @param $end
      * @param $data
-     * @return bool
+     * @return self
      * @throws \Interfax\Exception\RequestException
      */
     public function upload($start, $end, $data)
@@ -35,17 +35,17 @@ public function upload($start, $end, $data)
 
         $this->client->post($this->resource_uri, $params);
 
-        return true;
+        return $this;
     }
 
     /**
-     * @return bool
+     * @return self
      */
     public function cancel()
     {
         $this->client->delete($this->resource_uri);
         $this->record = [];
-        return true;
+        return $this;
     }
 
     public function getHeaderLocation()

src/Interfax/Inbound/Fax.php

@@ -23,19 +23,18 @@ class Fax extends Resource
 
     /**
      * @param bool $unread
-     * @return bool
+     * @return self
      * @throws RequestException
      */
     protected function mark($unread = true)
     {
         $this->client->post($this->resource_uri, ['query' => ['unread' => $unread]]);
 
-        // lack of exception indicates success
-        return true;
+        return $this;
     }
 
     /**
-     * @return bool
+     * @return self
      * @throws RequestException
      */
     public function markRead()
@@ -44,7 +43,7 @@ public function markRead()
     }
 
     /**
-     * @return bool
+     * @return self
      * @throws RequestException
      */
     public function markUnread()
@@ -54,7 +53,7 @@ public function markUnread()
 
     /**
      * @param string $email
-     * @return bool
+     * @return self
      * @throws RequestException
      */
     public function resend($email = null)
@@ -65,8 +64,7 @@ public function resend($email = null)
         }
         $this->client->post($this->resource_uri . '/resend', $params);
 
-        // lack of exception indicates success
-        return true;
+        return $this;
     }
 
     /**

src/Interfax/Outbound/Fax.php

@@ -52,25 +52,25 @@ public function resend($fax_number = null)
     }
 
     /**
-     * @return bool
+     * @return self
      * @throws RequestException
      */
     public function cancel()
     {
         $this->client->post($this->resource_uri . '/cancel');
 
-        return true;
+        return $this;
     }
 
     /**
-     * @return bool
+     * @return self
      * @throws RequestException
      */
     public function hide()
     {
         $this->client->post($this->resource_uri . '/hide');
 
-        return true;
+        return $this;
     }
 
     /**