rbcli 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1fc25d55aabbbf099edc8c9a07cf8ee58986f20d5d72bfed19f708b640d9ed2
-  data.tar.gz: 4fc7dd0a975f5f727b1c954909c4fe073bae66be53550b3f242dabccd0f71aca
+  metadata.gz: a94207cc8d9ccc3375e64de968e15a7d350adf14ec90228695df0872e9d09623
+  data.tar.gz: f1ae271537500e57f19604cae534e50f2de19ab0c7960f42ec18370e9ff5248d
 SHA512:
-  metadata.gz: 56dedf772c97a79898f3db0402e5344568b28dfe0fbb0d1d96907483b13541e8e7b66c219f81f02d948b789929fd9b24bcd8498eef8d603fd80ecd6914c06904
-  data.tar.gz: 45cb4f7fbbbed5abb5dc2062087b9000710c301c06b9d8c465793c0431c798c9b103e7d4d39f129c8ca7b4e79bbe828989304dd7d78dad37a7e38f3c43db9382
+  metadata.gz: 584dc90981c04538c1adfca2b9d722d72b5d5ddf38c81c1b5ba88fef9992d5ab4e5f2ddf43697f3fe5923d5269e5fc86d9c9eff21db44892188072de27043910
+  data.tar.gz: 9b9e99a471c271cdcf3cb532a2bbe3a14be901bffffcbd75cd3b0901ff4abc74f72a794f65741dcc7c7958f1d1495f704df99381c2e2f25ca0624f4639051c3b

data/CHANGELOG.md

@@ -1,9 +1,21 @@
 # Changelog
 
+## 0.2.1 (Aug 8, 2018)
+
+### Features
+
+* Remote Execution added for Script and External commands
+
+### Bugfixes
+
+* Fixed a bug that caused RBCli to crash if a direct path mode script's environment variables were declared as symbols
+
+
 ## 0.2.0 (Aug 5, 2018)
 
 ### Features
 
+* CLI tool Autoupdate Enabled; when an upgrade to RBCli is detected, the RBCli CLI tool will notify the developer.
 * Official documentation created and hosted with Github Pages
 * RBCli released under GPLv3
 * Copyright/License notice displayed via RBCli tool with `rbcli license` in accordance with GPLv3 guidelines
@@ -17,7 +29,6 @@
 ### Improvements
 
 * A quick reference guide can now be found in README.md
-* CLI tool Autoupdate Enabled; when an upgrade to RBCli is detected, the RBCli CLI tool will notify the developer.
 * Autoupdate feature now allows supplying a custom message
 * Direct Path Mode for External Commands now
 * Added support for a `lib` folder in projects, as a place for custom code, which is automatically added to `$LOAD_PATH` for developers

data/Gemfile.lock

@@ -1,12 +1,14 @@
 PATH
   remote: .
   specs:
-    rbcli (0.2.0)
+    rbcli (0.2.1)
       aws-sdk-dynamodb (~> 1.6)
       colorize (~> 0.8)
       deep_merge (~> 1.2)
       macaddr (~> 1.7)
       mdless (~> 0.0)
+      net-scp (~> 1.2)
+      net-ssh (~> 5.0)
       octokit (~> 4.9)
       rufus-scheduler (~> 3.5)
 
@@ -22,7 +24,7 @@ GEM
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-dynamodb (1.9.0)
+    aws-sdk-dynamodb (1.10.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sigv4 (1.0.3)
@@ -41,6 +43,9 @@ GEM
     mdless (0.0.10)
     minitest (5.11.3)
     multipart-post (2.0.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (5.0.2)
     octokit (4.9.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     public_suffix (3.0.2)

data/README.md

@@ -1,6 +1,22 @@
+# RBCli
+
 RBCli is currently in Alpha stages of development. All releases can be considered stable, though breaking changes may be made between versions.
 
-# RBCli
+Latest Release: v0.2.1 (Aug 8, 2018) -- See the [changelog][changelog] for complete details.
+
+* Remote Execution Feature Added
+
+Previous Release: v0.2.0 (Aug 5, 2018)
+
+* CLI tool Autoupdate Enabled; when an upgrade to RBCli is detected, the RBCli CLI tool will notify the developer.
+* Official documentation created and hosted with Github Pages
+* RBCli released under GPLv3
+* Copyright/License notice displayed via RBCli tool with `rbcli license` in accordance with GPLv3 guidelines
+* Many improvements and bugfixes
+
+[You can find the Official Documentation for RBCli Here.][documentation_home]
+
+## Introduction
 
 As technologists today, we work with the command line a lot. We script a lot. We write tools to share with each other to make our lives easier. We even write applications to make up for missing features in the 3rd party software that we buy. Unfortunately, when writing CLI tools, this process has typically been very painful. We've been working with low-level frameworks for decades; frameworks like `getopt` (1980) and `curses` (1977). They fit their purpose well; they were both computationally lightweight for the computers of the day, and they gave engineers full control and flexibility when it came to how things were built. Over the years, we've used them to settle on several design patterns that we know work well. Patterns as to what a CLI command looks like, what a config file looks like, what remote execution looks like, and even how to use locks (mutexes, semaphores, etc) to control application flow and data atomicity. Yet we're stuck writing the same low-level code anytime we want to write our tooling. Not anymore.
 
@@ -31,8 +47,10 @@ Some of its key features include:
 
 * __Project Structure and Generators__: Create a well-defined project directory structure which organizes your code and allows you to package and distribute your application as a Gem. Generators can also help speed up the process of creating new commands, scripts, and hooks!
 
+* __Remote Execution__: Automatically execute commands on remote machines via SSH
 
-For more information, take a look at the __[official documentation](http://akhoury6.github.io/rbcli/)__ or keep reading for a quick reference.
+
+For more information, take a look at the __[official documentation][documentation_home]__ or keep reading for a quick reference.
 
 
 # Quick Reference
@@ -169,13 +187,34 @@ RBCli can automatically notify users when an update is available. Two sources ar
 You can configure automatic updates in `config/autoupdate.rb` in your project.
 
 
+## Remote Execution
+
+RBCli can automatically execute script and extern commands on remote machines via SSH. Enable this feature in `config/general.rb` by changing the following line to `true`:
+
+```ruby
+remote_execution permitted: false
+```
+
+Then for each command you want to enable remote execution for, add the following directive:
+
+```ruby
+remote_permitted
+```
+
+Users can then execute commands remotly by specifying the connection string and credentials on the command line:
+
+```bash
+mytool --remote-exec [user@]host[:port] --identity (/path/to/private/ssh/key or password) <command> ...
+```
+
+
 ## Development and Contributing
 
 For more information about development and contributing, please see the [Official Development Documentation][documentation_development]
 
 ## License
 
-The gem is available as open source under the terms of the [GPLv3](https://github.com/akhoury6/rbcli/blob/master/CODE_OF_CONDUCT.md).
+The gem is available as open source under the terms of the [GPLv3][license_text].
 
 ## Full Documentation
 
@@ -185,3 +224,4 @@ The gem is available as open source under the terms of the [GPLv3](https://githu
 [documentation_home]: https://akhoury6.github.com/rbcli
 [documentation_development]: https://akhoury6.github.com/rbcli/development/contributing/
 [license_text]: https://github.com/akhoury6/rbcli/blob/master/LICENSE.txt
+[changelog]: https://github.com/akhoury6/rbcli/blob/master/CHANGELOG.md

data/bin/console

@@ -16,7 +16,7 @@
 #     You should have received a copy of the GNU General Public License          #
 #     along with this program.  If not, see <https://www.gnu.org/licenses/>.     #
 #                                                                                #
-#     For questions regarding licensing, please contact andrew@blacknex.us        #
+#     For questions regarding licensing, please contact andrew@blacknex.us       #
 ##################################################################################
 
 require "bundler/setup"

data/bin/setup

@@ -16,7 +16,7 @@
 #     You should have received a copy of the GNU General Public License          #
 #     along with this program.  If not, see <https://www.gnu.org/licenses/>.     #
 #                                                                                #
-#     For questions regarding licensing, please contact andrew@blacknex.us        #
+#     For questions regarding licensing, please contact andrew@blacknex.us       #
 ##################################################################################
 
 set -euo pipefail

data/docs/404.html

@@ -489,6 +489,18 @@
   </li>
 
         
+          
+          
+          
+
+
+  <li class="md-nav__item">
+    <a href="/advanced/remote_execution/" title="Remote Execution" class="md-nav__link">
+      Remote Execution
+    </a>
+  </li>
+
+        
       </ul>
     </nav>
   </li>

data/docs/advanced/automatic_updates/index.html

@@ -542,6 +542,18 @@
   </li>
 
         
+          
+          
+          
+
+
+  <li class="md-nav__item">
+    <a href="../remote_execution/" title="Remote Execution" class="md-nav__link">
+      Remote Execution
+    </a>
+  </li>
+
+        
       </ul>
     </nav>
   </li>

data/docs/advanced/command_types/index.html

@@ -576,6 +576,18 @@
   </li>
 
         
+          
+          
+          
+
+
+  <li class="md-nav__item">
+    <a href="../remote_execution/" title="Remote Execution" class="md-nav__link">
+      Remote Execution
+    </a>
+  </li>
+
+        
       </ul>
     </nav>
   </li>
@@ -814,7 +826,7 @@ end
 <p>This will create two files in your RBCli project: a Ruby file with the common command declaration (see <a href="#general-command-structure">General Command Structure</a>), and a bash script in the folder <code>application/commands/scripts/</code>.</p>
 <p>You can tell a command is a script by the line:</p>
 <pre><code class="ruby">class List &lt; Rbcli::Command
-    extern path: :default                                                              # (Required): Do not edit this line. Do delete it if you wish to manually specify a script path and set environment variables.
+    script
 end
 </code></pre>
 

data/docs/advanced/distributed_state_locking/index.html

@@ -535,6 +535,18 @@
   </li>
 
         
+          
+          
+          
+
+
+  <li class="md-nav__item">
+    <a href="../remote_execution/" title="Remote Execution" class="md-nav__link">
+      Remote Execution
+    </a>
+  </li>
+
+        
       </ul>
     </nav>
   </li>
@@ -725,13 +737,13 @@
           </a>
         
         
-          <a href="../../development/contributing/" title="Contribution Guide" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
+          <a href="../remote_execution/" title="Remote Execution" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
               <span class="md-flex__ellipsis">
                 <span class="md-footer-nav__direction">
                   Next
                 </span>
-                Contribution Guide
+                Remote Execution
               </span>
             </div>
             <div class="md-flex__cell md-flex__cell--shrink">

data/docs/advanced/hooks/index.html

@@ -556,6 +556,18 @@
   </li>
 
         
+          
+          
+          
+
+
+  <li class="md-nav__item">
+    <a href="../remote_execution/" title="Remote Execution" class="md-nav__link">
+      Remote Execution
+    </a>
+  </li>
+
+        
       </ul>
     </nav>
   </li>