Documentation updates

Author: dcarbone

README.md

@@ -24,12 +24,17 @@ First, construct a [Config](./src/Config.php) object:
 $config = new \DCarbone\PHPConsulAPI\Config(['Address' => 'address of your consul agent']);
 ```
 
+See the [configuration documentation](./docs/CONFIG.md) for more information on this object.
+
 Next, construct a [Consul](./src/Consul.php) object:
 
 ```php
 $consul = new \DCarbone\PHPConsulAPI\Consul($config);
 ```
 
+*NOTE* If you do not create your own config object, [Consul](./src/Consu.php) will create it's own
+using [Config::newDefaultConfig()](../src/Config.php#L47).
+
 Once constructed, you interact with each Consul API via it's corresponding Client class:
 
 ```php
@@ -51,6 +56,7 @@ var_dump($kv_list);
 - [Event](./docs/EVENT.md)
 - [Coordinate](./docs/COORDINATE.md)
 - [Health](./docs/HEALTH.md)
+- [Session](./docs/SESSION.md)
 
 More will be added as time goes on!
 

docs/CONFIG.md

@@ -0,0 +1,38 @@
+# PHP Consul API Configuration
+
+This class is modeled quite closely after the
+[Config Struct](https://github.com/hashicorp/consul/blob/master/api/api.go#L101) present in the 
+[Consul API Subpackage](https://github.com/hashicorp/consul/tree/master/api).
+
+The primary difference is that the HTTP client is not stored within the config object.  This is a possible future
+feature.
+
+## Default Configuration
+
+If you have defined some of the [Consul Environment Variables](https://www.consul.io/docs/agent/options.html)
+on your hosts then it would probably be easiest to simply execute the following:
+
+```php
+$config = \DCarbone\PHPConsulAPI\Config::newDefaultConfig();
+```
+
+You can see what this ultimately does [in the method definition](../src/Config.php#L47).
+ 
+## Advanced Configuration
+
+You may alternatively define values yourself:
+
+```php
+$config = new \DCarbone\PHPConsulAPI\Config([
+    'Address' => 'address of server', // REQUIRED 
+    'Scheme' => 'http or https', // REQUIRED
+    'Datacenter' => 'name of datacenter', // OPTIONAL
+    'HttpAuth' => 'user:pass', // OPTIONAL,
+    'WaitTime' => 30, // OPTIONAL, not used yet
+    'Token' => 'auth token', // OPTIONAL
+    'CAFile' => 'path to ca', // OPTIONAL
+    'CertFile' => 'path to cert', // OPTIONAL
+    'KeyFile' => 'path to key', // OPTIONAL
+    'InsecureSkipVerify' => false, // OPTIONAL
+]);
+```

docs/SESSION.md

@@ -0,0 +1,85 @@
+# PHP Consul API Session
+
+ALl interactions with the [`v1/session`](https://www.consul.io/docs/agent/http/session.html) endpoint
+are done via the [SessionClient](../src/Session/SessionClient.php) class.
+
+If you have constructed a [Consul](../src/Consul.php) object, this is done as so:
+
+```php
+$session = $consul->Session;
+```
+
+## Actions
+
+### Create
+
+In order to initialize a new session, you must first create a [SessionEntry](../src/Session/SessionEntry.php) object.
+
+Below is a quick example:
+
+```php
+$sessionEntry = new \DCarbone\PHPConsulAPI\Session\SessionEntry(
+    array(
+        'LockDelay' => '10s',
+        'Name' => 'my-test-lock',
+        'Behavior' => 'release',
+        'TTL' => '15s',
+    )
+);
+
+list($sid, $wm, $err) = $consul-Session->create($sessionEntry);
+if (null !== $err)
+    die($err);
+
+var_dump($id, $wm);
+```
+
+### Destroy
+
+```php
+list($wm, $err) = $consul->Session->destroy($sid);
+if (null !== $err)
+    die($err);
+
+var_dump($wm);
+```
+
+### Renew
+
+```php
+list($sessions, $wm, $err) = $consul->Session->renew($sid);
+if (null !== $err)
+    die($err);
+
+var_dump($sessions, $wm);
+```
+
+### Info
+
+```php
+list($sessions, $qm, $err) = $consul->Session->info($sid);
+if (null !== $err)
+    die($err);
+
+var_dump($seesions, $qm);
+```
+
+### List sessions belonging to a specific node
+
+```php
+list($sessions, $qm, $err) = $consul->Session->node($node);
+if (null !== $err)
+    die($err);
+
+var_dump($sessions, $qm);
+```
+
+### List all sessions
+
+```php
+list($sessions, $qm, $err) = $consul->Session->listSessions();
+if (null !== $err)
+    die($err);
+
+var_dump($sessions, $qm);
+```

docs/STATUS.md

@@ -3,7 +3,7 @@
 All interactions with the [`v1/status`](https://www.consul.io/docs/agent/http/status.html) endpoint
 are done via the [StatusClient](../src/Status/StatusClient.php) class.
 
-If you have constructed a [Client../src/Consul.php) object, this is done as so:
+If you have constructed a [Consul](../src/Consul.php) object, this is done as so:
 
 ```php
 $status = $consul->Status;

src/Config.php

@@ -162,7 +162,7 @@ public function setHttpAuth($httpAuth)
         throw new \InvalidArgumentException(sprintf(
             '%s::setHttpAuth - Value is expected to be string of "username:password" or instance of "ConsulHttpAuth", %s seen.',
             get_class($this),
-            gettype($httpAuth)
+            is_string($httpAuth) ? $httpAuth : gettype($httpAuth)
         ));
     }
 
@@ -279,7 +279,25 @@ public function setInsecureSkipVerify($insecureSkipVerify)
      */
     public function compileAddress()
     {
-        return sprintf('%s://%s', $this->getScheme(), $this->getAddress());
+        if ('' === ($scheme = $this->getScheme()))
+        {
+            throw new \LogicException(sprintf(
+                '%s - "Scheme" was left undefined in this config object. Definition: %s',
+                get_class($this),
+                json_encode($this)
+            ));
+        }
+
+        if ('' === ($addr = $this->getAddress()))
+        {
+            throw new \LogicException(sprintf(
+                '%s - "Address" was left undefined in this config object. Definition: %s',
+                get_class($this),
+                json_encode($this)
+            ));
+        }
+
+        return sprintf('%s://%s', $scheme, $addr);
     }
 
     /**
@@ -326,4 +344,18 @@ protected static function _tryGetEnvParam($param)
 
         return false;
     }
+
+    /**
+     * Specify data which should be serialized to JSON
+     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
+     * @return mixed data which can be serialized by json_encode, which is a value of any type other than a resource.
+     */
+    public function jsonSerialize()
+    {
+        $data = parent::jsonSerialize();
+        if (isset($data['HttpAuth']))
+            unset($data['HttpAuth']);
+
+        return $data;
+    }
 }