New Carpenter class and Rework Service provider for support of laravel 5.4

percymamedy · percymamedy · commit 9c21130914de · 2017-02-12T00:10:42.000+04:00
diff --git a/src/Bridge.php b/src/Bridge.php
@@ -76,18 +76,77 @@ class Bridge
      * @param string $password
      * @param string $endpoint
      */
-    public function __construct($username, $password, $endpoint)
+    public function __construct($username = null, $password = null, $endpoint = null)
     {
         // Set Username, Password and Endpoint.
-        $this->username = $username;
-        $this->password = $password;
-        $this->endpoint = $endpoint;
+        $this->setUsername($username);
+        $this->setPassword($password);
+        $this->setEndPoint($endpoint);
 
         // Set HttpClient.
         $this->setClient($endpoint);
 
         // Set Token.
-        $this->token = new Token($this->username);
+        $this->setToken($username);
+    }
+
+    /**
+     * Sets the Username.
+     *
+     * @param string $username
+     *
+     * @return $this
+     */
+    public function setUsername($username = null)
+    {
+        $this->username = $username;
+
+        return $this;
+    }
+
+    /**
+     * Sets the Password.
+     *
+     * @param string $password
+     *
+     * @return $this
+     */
+    public function setPassword($password = null)
+    {
+        $this->password = $password;
+
+        return $this;
+    }
+
+    /**
+     * Sets the Endpoint.
+     *
+     * @param string $endpoint
+     *
+     * @return $this
+     */
+    public function setEndPoint($endpoint = null)
+    {
+        $this->endpoint = $endpoint;
+
+        return $this;
+    }
+
+    /**
+     * Sets the Token.
+     *
+     * @param string $username
+     *
+     * @return $this
+     */
+    public function setToken($username = null)
+    {
+        // Only set Token if Username is supplied.
+        if (! is_null($username)) {
+            $this->token = new Token($username);
+        }
+
+        return $this;
     }
 
     /**
diff --git a/src/Support/BridgeStack.php b/src/Support/BridgeStack.php
@@ -0,0 +1,33 @@
+<?php
+
+namespace FindBrok\WatsonBridge\Support;
+
+use Illuminate\Support\Collection;
+
+class BridgeStack extends Collection
+{
+    /**
+     * The Carpenter instance.
+     *
+     * @var Carpenter
+     */
+    protected $carpenter;
+
+    /**
+     * BridgeStack constructor.
+     *
+     * @param Carpenter $carpenter
+     * @param array     $items
+     */
+    public function __construct(Carpenter $carpenter, $items = [])
+    {
+        $this->carpenter = $carpenter;
+
+        parent::__construct($items);
+    }
+
+    
+    public function mountBridge($name, $credential = null, $service = null, $authMethod = null)
+    {
+    }
+}
diff --git a/src/Support/Carpenter.php b/src/Support/Carpenter.php
@@ -0,0 +1,118 @@
+<?php
+
+namespace FindBrok\WatsonBridge\Support;
+
+use FindBrok\WatsonBridge\Bridge;
+use FindBrok\WatsonBridge\Exceptions\WatsonBridgeException;
+
+class Carpenter
+{
+    /**
+     * Constructs a new Bridge.
+     *
+     * @param string $credential
+     * @param string $service
+     * @param string $authMethod
+     *
+     * @throws WatsonBridgeException
+     * @return Bridge
+     */
+    public function constructBridge($credential, $service = null, $authMethod = 'credentials')
+    {
+        // Get credentials array.
+        $credentials = $this->getCredentials($credential);
+
+        // Make sure credentials information is available.
+        if (! isset($credentials['username']) || ! isset($credentials['password']) || ! isset($credentials['gateway'])) {
+            throw new WatsonBridgeException('Could not construct Bridge, missing some information in credentials.',
+                                            500);
+        }
+
+        // Make bridge.
+        $bridge = $this->makeRawBridge()
+                       ->setUsername($credentials['username'])
+                       ->setPassword($credentials['password'])
+                       ->setEndPoint($credentials['gateway'])
+                       ->setClient($credentials['gateway'])
+                       ->appendHeaders(['X-Watson-Learning-Opt-Out' => config('watson-bridge.x_watson_learning_opt_out')]);
+
+        // Add service.
+        $bridge = $this->addServiceToBridge($bridge, $service);
+
+        // Choose an auth method.
+        $bridge = $this->chooseAuthMethodForBridge($bridge, $authMethod);
+
+        return $bridge;
+    }
+
+    /**
+     * Creates and return a raw bridge.
+     *
+     * @return Bridge
+     */
+    protected function makeRawBridge()
+    {
+        return new Bridge();
+    }
+
+    /**
+     * Adds a Service to the Bridge.
+     *
+     * @param Bridge $bridge
+     * @param string $service
+     *
+     * @return Bridge
+     */
+    protected function addServiceToBridge(Bridge $bridge, $service = null)
+    {
+        // Add a service if necessary.
+        if (! is_null($service)) {
+            $bridge->usingService($service);
+        }
+
+        return $bridge;
+    }
+
+    /**
+     * Choose an Auth Method for the Bridge.
+     *
+     * @param Bridge $bridge
+     * @param string $username
+     * @param string $authMethod
+     *
+     * @return Bridge
+     */
+    protected function chooseAuthMethodForBridge(Bridge $bridge, $username, $authMethod = null)
+    {
+        // Check if an auth method is passed explicitly.
+        if (! is_null($authMethod) && collect(config('watson-bridge.auth_methods'))->contains($authMethod)) {
+            $bridge->useAuthMethodAs($authMethod);
+
+            // Auth method is token so we need to set Token.
+            if ($authMethod == 'token') {
+                $bridge->setToken($username);
+            }
+        }
+
+        return $bridge;
+    }
+
+    /**
+     * Get credentials to use.
+     *
+     * @param string $name
+     *
+     * @throws WatsonBridgeException
+     * @return array
+     */
+    protected function getCredentials($name = 'default')
+    {
+        // We must make sure that credentials exists.
+        if (! config()->has('watson-bridge.credentials.'.$name)) {
+            throw new WatsonBridgeException('Credentials "'.$name.'" does not exist, try specifying it in the watson-bridge config.',
+                                            500);
+        }
+
+        return config('watson-bridge.credentials.'.$name);
+    }
+}
diff --git a/src/Token.php b/src/Token.php
@@ -66,7 +66,8 @@ public function exists()
      */
     public function isExpired()
     {
-        return $this->hasPayLoad() && ($this->payLoad['created'] + $this->payLoad['expires_in']) < Carbon::now()->format('U');
+        return $this->hasPayLoad() && ($this->payLoad['created'] + $this->payLoad['expires_in']) < Carbon::now()
+                                                                                                         ->format('U');
     }
 
     /**
@@ -96,11 +97,12 @@ public function isValid()
      */
     public function save()
     {
-        //No payload to save
+        // No payload to save.
         if (! $this->hasPayLoad()) {
             return false;
         }
-        //Save the token
+
+        // Save the token.
         return (bool) file_put_contents($this->getFilePath(), collect($this->payLoad)->toJson(), LOCK_EX);
     }
 
@@ -121,12 +123,13 @@ public function getFilePath()
      */
     public function loadPayLoadFromFile()
     {
-        //Not found
+        // Not found.
         if (! $this->exists()) {
-            //We return empty array
+            // We return empty array.
             return [];
         }
-        //Load content from file
+
+        // Load content from file.
         return json_decode(file_get_contents($this->getFilePath()), true);
     }
 
@@ -159,13 +162,14 @@ public function getToken()
      */
     public function updateToken($token)
     {
-        //Update Payload
+        // Update Payload.
         $this->payLoad = [
             'token'      => $token,
             'expires_in' => 3600,
             'created'    => Carbon::now()->format('U'),
         ];
-        //Save token
+
+        // Save token.
         return $this->save();
     }
 }
diff --git a/src/WatsonBridgeServiceProvider.php b/src/WatsonBridgeServiceProvider.php
@@ -3,7 +3,10 @@
 namespace FindBrok\WatsonBridge;
 
 use Illuminate\Support\ServiceProvider;
-use FindBrok\WatsonBridge\Exceptions\WatsonBridgeException;
+use Illuminate\Contracts\Config\Repository;
+use FindBrok\WatsonBridge\Support\Carpenter;
+use FindBrok\WatsonBridge\Support\BridgeStack;
+use Illuminate\Contracts\Foundation\Application;
 
 class WatsonBridgeServiceProvider extends ServiceProvider
 {
@@ -30,59 +33,33 @@ public function register()
         // Merge configs.
         $this->mergeConfigFrom(__DIR__.'/config/watson-bridge.php', 'watson-bridge');
 
-        // Bind Bridge in the IOC.
-        $this->app->bind(Bridge::class, function ($app, array $args = ['use' => 'default']) {
-            return $this->constructBridge($args);
+        // The Carpenter must be an Instance because we need only one.
+        $this->app->singleton(Carpenter::class, function () {
+            return new Carpenter();
         });
-    }
-
-    /**
-     * Construct Watson Bridge.
-     *
-     * @param array $args
-     *
-     * @throws WatsonBridgeException
-     * @return Bridge
-     */
-    protected function constructBridge(array $args)
-    {
-        // A credential name is necessary.
-        if (! isset($args['use'])) {
-            $args['use'] = 'default';
-        }
 
-        // Get credentials array.
-        $credentials = $this->getCredentials($args['use']);
-
-        // Make sure credentials information is available.
-        if (! isset($credentials['username']) || ! isset($credentials['password']) || ! isset($credentials['gateway'])) {
-            throw new WatsonBridgeException('Could not construct Bridge, missing some information in credentials.',
-                                            500);
-        }
-
-        // Make bridge.
-        $bridge = new Bridge($credentials['username'], $credentials['password'], $credentials['gateway']);
-        $bridge->appendHeaders(['X-Watson-Learning-Opt-Out' => config('watson-bridge.x_watson_learning_opt_out')]);
+        // The Bridge Stack also must be the same across the entire app.
+        $this->app->singleton(BridgeStack::class, function (Application $app) {
+            return new BridgeStack($app->make(Carpenter::class), []);
+        });
 
-        return $bridge;
+        // Registers a Default Bridge.
+        $this->registerDefaultBridge();
     }
 
     /**
-     * Get credentials to use.
-     *
-     * @param string $name
-     *
-     * @throws WatsonBridgeException
-     * @return array
+     * Registers the Default Bridge.
      */
-    protected function getCredentials($name = 'default')
+    protected function registerDefaultBridge()
     {
-        // We must make sure that credentials exists.
-        if (! config()->has('watson-bridge.credentials.'.$name)) {
-            throw new WatsonBridgeException('Credentials "'.$name.'" does not exist, try specifying it in the watson-bridge config.',
-                                            500);
-        }
+        $this->app->bind(Bridge::class, function (Application $app) {
+            /** @var Carpenter $carpenter */
+            $carpenter = $app->make(Carpenter::class);
+            /** @var Repository $config */
+            $config = $app->make(Repository::class);
 
-        return config('watson-bridge.credentials.'.$name);
+            return $carpenter->constructBridge($config->get('watson-bridge.default_credentials'), null,
+                                               $config->get('watson-bridge.default_auth_method'));
+        });
     }
 }
diff --git a/src/config/watson-bridge.php b/src/config/watson-bridge.php
diff --git a/tests/TestServiceProvider.php b/tests/TestServiceProvider.php

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,8 @@ public function exists()`
`66`	`66`	`*/`
`67`	`67`	`public function isExpired()`
`68`	`68`	`{`
`69`		`- return $this->hasPayLoad() && ($this->payLoad['created'] + $this->payLoad['expires_in']) < Carbon::now()->format('U');`
	`69`	`+ return $this->hasPayLoad() && ($this->payLoad['created'] + $this->payLoad['expires_in']) < Carbon::now()`
	`70`	`+ ->format('U');`
`70`	`71`	`}`
`71`	`72`
`72`	`73`	`/**`
`@@ -96,11 +97,12 @@ public function isValid()`
`96`	`97`	`*/`
`97`	`98`	`public function save()`
`98`	`99`	`{`
`99`		`- //No payload to save`
	`100`	`+ // No payload to save.`
`100`	`101`	`if (! $this->hasPayLoad()) {`
`101`	`102`	`return false;`
`102`	`103`	`}`
`103`		`- //Save the token`
	`104`	`+`
	`105`	`+ // Save the token.`
`104`	`106`	`return (bool) file_put_contents($this->getFilePath(), collect($this->payLoad)->toJson(), LOCK_EX);`
`105`	`107`	`}`
`106`	`108`
`@@ -121,12 +123,13 @@ public function getFilePath()`
`121`	`123`	`*/`
`122`	`124`	`public function loadPayLoadFromFile()`
`123`	`125`	`{`
`124`		`- //Not found`
	`126`	`+ // Not found.`
`125`	`127`	`if (! $this->exists()) {`
`126`		`- //We return empty array`
	`128`	`+ // We return empty array.`
`127`	`129`	`return [];`
`128`	`130`	`}`
`129`		`- //Load content from file`
	`131`	`+`
	`132`	`+ // Load content from file.`
`130`	`133`	`return json_decode(file_get_contents($this->getFilePath()), true);`
`131`	`134`	`}`
`132`	`135`
`@@ -159,13 +162,14 @@ public function getToken()`
`159`	`162`	`*/`
`160`	`163`	`public function updateToken($token)`
`161`	`164`	`{`
`162`		`- //Update Payload`
	`165`	`+ // Update Payload.`
`163`	`166`	`$this->payLoad = [`
`164`	`167`	`'token' => $token,`
`165`	`168`	`'expires_in' => 3600,`
`166`	`169`	`'created' => Carbon::now()->format('U'),`
`167`	`170`	`];`
`168`		`- //Save token`
	`171`	`+`
	`172`	`+ // Save token.`
`169`	`173`	`return $this->save();`
`170`	`174`	`}`
`171`	`175`	`}`