BridgeStack completed and Documentation started.

Author: percymamedy

README.md

@@ -27,18 +27,52 @@ require 'vendor/autoload.php'
 
 use FindBrok\WatsonBridge\Bridge;
 
-//Create a new bridge Object
+// Create a new bridge Object.
 $bridge = new Bridge('username', 'password', 'baseUrl');
 
-//Simple get request
+// Simple get request.
 $queryParams = ['foo' => 'bar'];
 $response = $bridge->get('uri', $queryParams);
 
-//Simple post request
+// Simple post request.
 $dataToPost = ['foo' => 'bar'];
 $response = $bridge->post('uri', $dataToPost, 'json');
 ```
 
 The Package uses [Guzzle](http://docs.guzzlephp.org/en/latest/testing.html) to perform requests, 
 all your responses will be instances of ```GuzzleHttp\Psr7\Response```
 
+---
+### Integration with Laravel 5
+
+As of version 1.1.x, PHP Watson API bridge adds a new Service Provider which integrates easily with Laravel 5.
+
+First add the ServiceProvider to your ```app.php``` file.
+
+```php
+'providers' => [
+   ....
+   FindBrok\WatsonBridge\WatsonBridgeServiceProvider::class,
+]
+```
+
+Now publish the config file.
+
+```php
+$ php artisan vendor:publish --tag=watson-api-bridge
+```
+
+You will now have a config file ```watson-bridge.php``` in your config directory. 
+You may define in this config file your credentials, auth method to use,
+Watson Services and so on.
+
+### Services
+
+The Laravel Integration gives you 3 service classes that are bound to the IoC.
+- Bridge (The actual Bridge class for making requests to Watson)
+- Carpenter (Which can construct Bridge instances using your credentials and service URL)
+- BridgeStack (Essentially a store where you can keep all Bridges you constructed and retrieve them back.)
+
+## Bridge
+
+Bridge class will help you make requests to Watson API using the ```get```, ```post```, ```put```, ```patch``` methods

src/Facades/Bridge.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace FindBrok\WatsonBridge\Facades;
+
+use Illuminate\Support\Facades\Facade;
+use FindBrok\WatsonBridge\Bridge as Concrete;
+
+class Bridge extends Facade
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected static function getFacadeAccessor()
+    {
+        return Concrete::class;
+    }
+}

src/Facades/BridgeStack.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace FindBrok\WatsonBridge\Facades;
+
+use Illuminate\Support\Facades\Facade;
+use FindBrok\WatsonBridge\Support\BridgeStack as Concrete;
+
+class BridgeStack extends Facade
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected static function getFacadeAccessor()
+    {
+        return Concrete::class;
+    }
+}

src/Facades/Carpenter.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace FindBrok\WatsonBridge\Facades;
+
+use Illuminate\Support\Facades\Facade;
+use FindBrok\WatsonBridge\Support\Carpenter as Concrete;
+
+class Carpenter extends Facade
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected static function getFacadeAccessor()
+    {
+        return Concrete::class;
+    }
+}

src/Support/BridgeStack.php

@@ -2,7 +2,9 @@
 
 namespace FindBrok\WatsonBridge\Support;
 
+use FindBrok\WatsonBridge\Bridge;
 use Illuminate\Support\Collection;
+use FindBrok\WatsonBridge\Exceptions\WatsonBridgeException;
 
 class BridgeStack extends Collection
 {
@@ -36,7 +38,33 @@ public function __construct(Carpenter $carpenter, $items = [])
      *
      * @return $this
      */
-    public function mountBridge($name, $credential = null, $service = null, $authMethod = null)
+    public function mountBridge($name, $credential, $service = null, $authMethod = 'credentials')
     {
+        // Creates the Bridge.
+        $bridge = $this->carpenter->constructBridge($credential, $service, $authMethod);
+
+        // Save it under a name.
+        $this->put($name, $bridge);
+
+        return $this;
+    }
+
+    /**
+     * Conjures a specific Bridge to use.
+     *
+     * @param string $name
+     *
+     * @throws WatsonBridgeException
+     * @return Bridge
+     */
+    public function conjure($name)
+    {
+        // We must check if the Bridge does
+        // exists.
+        if (! $this->has($name)) {
+            throw new WatsonBridgeException('The Bridge with name "'.$name.'" does not exist.');
+        }
+
+        return $this->get($name);
     }
 }