Merge branch 'release/1.0.3'

Author: Diego Hernandes

LICENSE.TXT

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 - Diego Hernandes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

src/Console/Commands/AddCommand.php

@@ -25,22 +25,21 @@ class AddCommand extends BaseCommand
     protected function fire()
     {
         // Greetings.
-        $this->info("Registering a new Server Configuration!");
+        $this->info('Registering a new Server Configuration!');
 
         // Read initial connection data.
-        $serverData['alias'] = $this->ask("Server connection alias (server1):", "server1");
-        $serverData['user'] = $this->ask("Server username (none):");
-        $serverData['host'] = $this->ask("Server hostname or IP Address (192.168.0.1):", "192.168.0.1");
-        $serverData['port'] = $this->ask("Server Port (22):", 22);
-        $serverData['authenticationMethod'] = $this->ask("Authentication Method:[system|key|password] (system):", 'system');
+        $serverData['alias'] = $this->ask('Server connection alias (server1):', 'server1');
+        $serverData['user'] = $this->ask('Server username (none):');
+        $serverData['host'] = $this->ask('Server hostname or IP Address (192.168.0.1):', '192.168.0.1');
+        $serverData['port'] = $this->ask('Server Port (22):', 22);
+        $serverData['authenticationMethod'] = $this->ask('Authentication Method:[system|key|password] (system):', 'system');
 
-        
         if ($serverData['authenticationMethod'] == 'key') {
             // Ask for private key if key was selected as authentication method.
-            $serverData['privateKey'] = $this->ask("Private Key (~/.ssh/id_rsa):", $_SERVER['HOME'].'/.ssh/id_rsa');
+            $serverData['privateKey'] = $this->ask('Private Key (~/.ssh/id_rsa):', $_SERVER['HOME'].'/.ssh/id_rsa');
         } elseif ($serverData['authenticationMethod'] == 'password') {
             // Ask for password if password as selected as authentication method.
-            $serverData['password'] = $this->ask("Password:");
+            $serverData['password'] = $this->ask('Password:');
         } else {
             // don't store anything when system is selected.
         }
@@ -50,7 +49,7 @@ protected function fire()
 
         // If the server was indeed created, congratulate the user.
         if ($this->manager->serverExists($serverData['alias'])) {
-            $this->comment("Server registered successfully!");
+            $this->comment('Server registered successfully!');
         }
     }
-}
+}

src/Console/Commands/BaseCommand.php

@@ -31,7 +31,7 @@ abstract class BaseCommand extends Command
      * @var array Command arguments (if any).
      */
     protected $arguments = [];
-    
+
     /**
      * @var Manager Servers manager instance.
      */
@@ -55,10 +55,8 @@ abstract class BaseCommand extends Command
     /**
      * Main Command method, calls the fire command on it's child commands.
      *
-     * @param InputInterface $input Application provided input handler.
+     * @param InputInterface  $input  Application provided input handler.
      * @param OutputInterface $output Application provided output handler.
-     *
-     * @return void
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
@@ -77,7 +75,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
     }
 
     /**
-     * Initialize the command for the console Application
+     * Initialize the command for the console Application.
      */
     protected function configure()
     {
@@ -103,7 +101,7 @@ abstract protected function fire();
      * Some options are defined by convention, like formatting.
      * 
      * @param string $question The question being asked. 
-     * @param null $default Default value in case the user does not provide an answer.
+     * @param null   $default  Default value in case the user does not provide an answer.
      *
      * @return string The user input or the default value.
      */
@@ -123,12 +121,13 @@ protected function ask($question, $default = null)
      * Any other input will return false.
      * 
      * @param string $question The question to be confirmed.
+     *
      * @return bool Confirmed or Not.
      */
     protected function askConfirmation($question)
     {
         // Creates a new confirmation instance using convention formatting.
-        $confirmQuestion = new ConfirmationQuestion($this->format("$question (Y/n)", 'question'), false) ;
+        $confirmQuestion = new ConfirmationQuestion($this->format("$question (Y/n)", 'question'), false);
 
         // Do ask the question and return the input.
         return $this->questionHelper->ask($this->input, $this->output, $confirmQuestion);
@@ -139,6 +138,7 @@ protected function askConfirmation($question)
      *
      * @param string $text The string to be formatted.
      * @param string $type Desired coloring type.
+     *
      * @return string The formatted string.
      */
     protected function format($text, $type = 'info')
@@ -149,7 +149,7 @@ protected function format($text, $type = 'info')
     /**
      * Write a string into the console output.
      *
-     * @param string $text The string to be displayed.
+     * @param string $text   The string to be displayed.
      * @param string $format The coloring format.
      */
     protected function writeln($text, $format = 'info')
@@ -213,10 +213,11 @@ protected function error($text)
      * Gets the provided value to a given command argument.
      *
      * @param string $name Argument's name
+     *
      * @return mixed The user provided value.
      */
     protected function argument($name)
     {
         return $this->input->getArgument($name);
     }
-}
+}

src/Console/Commands/ConnectCommand.php

@@ -21,7 +21,7 @@ class ConnectCommand extends BaseCommand
      */
     protected $arguments = [
         // Connection alias.
-        ['alias', InputArgument::REQUIRED, 'Connection Alias']
+        ['alias', InputArgument::REQUIRED, 'Connection Alias'],
     ];
 
     /**
@@ -40,4 +40,4 @@ protected function fire()
         // for usage while authenticating
         $this->writelnPlain($server->connectionString());
     }
-}
+}

src/Console/Commands/DeleteCommand.php

@@ -26,7 +26,7 @@ class DeleteCommand extends BaseCommand
      */
     protected $arguments = [
         // Connection alias.
-        ['alias', InputArgument::REQUIRED, 'The connection to be removed.']
+        ['alias', InputArgument::REQUIRED, 'The connection to be removed.'],
     ];
 
     protected function fire()
@@ -37,7 +37,7 @@ protected function fire()
         $this->manager->getServer($alias);
 
         // Greetings.
-        $this->info("Server connection removal.");
+        $this->info('Server connection removal.');
 
         // Ask for confirmation.
         $confirmed = $this->askConfirmation("Are you sure about deleting the connection {$alias}:");
@@ -47,7 +47,7 @@ protected function fire()
             // Delete the connection.
             $this->manager->deleteServer($alias);
             // And congratulate.
-            $this->info("Server connection deleted successfully!");
+            $this->info('Server connection deleted successfully!');
         }
     }
-}
+}

src/Console/Commands/ServersCommand.php

@@ -32,7 +32,7 @@ protected function fire()
 
         // If there is no servers registered.
         if (!count($servers)) {
-            throw new NotFoundException("No servers available.");
+            throw new NotFoundException('No servers available.');
         // Otherwise.
         } else {
             // Render the servers table.
@@ -55,7 +55,7 @@ protected function serversTable(array $servers)
 
         // Loop on available connections to build the rows.
         $rows = [];
-        foreach($servers as $server) {
+        foreach ($servers as $server) {
             $rows[] = [$server->alias, $server->host, $server->user, $server->port, $server->authenticationMethod];
         }
 
@@ -65,4 +65,4 @@ protected function serversTable(array $servers)
         // Render the table.
         $table->render();
     }
-}
+}

src/Servers/Exceptions/NotFoundException.php

@@ -6,12 +6,12 @@
 use Symfony\Component\Console\Exception\RuntimeException;
 
 /**
- * Class NotFoundException
+ * Class NotFoundException.
  *
  * Exception when a given resource is not found or there are no resources into a 
  * given collection.
  */
 class NotFoundException extends RuntimeException implements ExceptionInterface
 {
     //
-}
+}

src/Servers/Manager.php

@@ -29,7 +29,7 @@ public function __construct()
     {
         // created a new Manager instance.
         $this->storageManager = new StorageManager();
-        
+
         // Load servers from storage.
         $this->loadServers();
     }
@@ -41,9 +41,9 @@ protected function loadServers()
     {
         // Get the servers configuration array from the servers.yml file.
         $servers = $this->storageManager->getConfiguration('servers');
-        
+
         // Register each server configuration as a Server instance.
-        foreach($servers as $serverData) {
+        foreach ($servers as $serverData) {
             $this->registerServer($serverData);
         }
     }
@@ -57,7 +57,7 @@ public function registerServer(array $data)
     {
         // Generate a new server connection instance. 
         $server = new Server($data);
-        
+
         // Register the server connection into the servers list. 
         $this->servers[$server->alias] = $server;
     }
@@ -72,7 +72,7 @@ public function createServer(array $data)
     {
         // Register a new server connection instance.
         $this->registerServer($data);
-        
+
         // Write the configuration server with the updated information
         $this->writeServers();
     }
@@ -86,10 +86,10 @@ public function deleteServer($alias)
     {
         // Find the server.
         $server = $this->getServer($alias);
-        
+
         // Forget the server from the server connection instances list
         unset($this->servers[$server->alias]);
-        
+
         // Write the updated configuration file
         $this->writeServers();
     }
@@ -101,7 +101,7 @@ protected function writeServers()
     {
         $servers = [];
         // Parse all current instances into the array representation.
-        foreach($this->servers as $server) {
+        foreach ($this->servers as $server) {
             $servers[] = $server->toArray();
         }
 
@@ -113,15 +113,17 @@ protected function writeServers()
      * Get a server instance.
      * 
      * @param string $alias Server connection alias.
+     *
      * @return Server The Server connection instance.
+     *
      * @throws NotFoundException When the desired alias is not registered.
      */
     public function getServer($alias)
     {
         if ($this->serverExists($alias)) {
             return $this->servers[$alias];
         } else {
-            throw new NotFoundException("Server not found.");
+            throw new NotFoundException('Server not found.');
         }
     }
 
@@ -139,10 +141,11 @@ public function getServers()
      * Is a given connection alias registered?
      * 
      * @param string $alias The given server connection instance alias. 
+     *
      * @return bool Registered or not.
      */
     public function serverExists($alias)
     {
         return array_key_exists($alias, $this->servers);
     }
-}
+}

src/Servers/Server.php

@@ -60,7 +60,7 @@ class Server
     public function __construct(array $config)
     {
         // For each config key
-        foreach($config as $key => $value) {
+        foreach ($config as $key => $value) {
             // Set into it's own attribute.
             $this->$key = $value;
         }
@@ -69,8 +69,8 @@ public function __construct(array $config)
     /**
      * Magic __set method.
      *
-     * @param string $key Attribute name.
-     * @param mixed $value Attribute value
+     * @param string $key   Attribute name.
+     * @param mixed  $value Attribute value
      */
     public function __set($key, $value)
     {
@@ -80,7 +80,9 @@ public function __set($key, $value)
 
     /**
      * Magic __get method.
+     *
      * @param string $key desired attribute.
+     *
      * @return mixed
      */
     public function __get($key)
@@ -93,7 +95,7 @@ public function __get($key)
      */
     protected function portParameter()
     {
-        return $this->port ? "-p{$this->port}" : "";
+        return $this->port ? "-p{$this->port}" : '';
     }
 
     /**
@@ -125,7 +127,7 @@ protected function keyParameter()
             return "-i{$this->privateKey}";
         }
 
-        return "";
+        return '';
     }
 
     /**
@@ -152,7 +154,7 @@ public function toArray()
         if ($this->alias) {
             $configArray['alias'] = $this->alias;
         }
-        
+
         if ($this->host) {
             $configArray['host'] = $this->host;
         }
@@ -176,7 +178,7 @@ public function toArray()
         if ($this->privateKey) {
             $configArray['privateKey'] = $this->privateKey;
         }
-        
+
         return $configArray;
     }
-}
+}