rbcli 0.2.0 → 0.2.1

data/docs/sitemap.xml

@@ -2,92 +2,97 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
      <loc>/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/imported/quick_reference/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/tutorial/10-getting_started/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/tutorial/20-project_layout/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/tutorial/30-your_first_command/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/tutorial/40-options_parameters_and_arguments/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/tutorial/50-publishing/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/advanced/command_types/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/advanced/user_config_files/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/advanced/hooks/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/advanced/automatic_updates/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/advanced/state_storage/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/advanced/distributed_state_locking/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
+     <changefreq>daily</changefreq>
+    </url>
+    <url>
+     <loc>/advanced/remote_execution/</loc>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/development/contributing/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/development/license/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/development/code_of_conduct/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/imported/changelog/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
     <url>
      <loc>/whoami/</loc>
-     <lastmod>2018-08-05</lastmod>
+     <lastmod>2018-08-08</lastmod>
      <changefreq>daily</changefreq>
     </url>
 </urlset>

data/docs/tutorial/10-getting_started/index.html

@@ -549,6 +549,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/tutorial/20-project_layout/index.html

@@ -583,6 +583,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/tutorial/30-your_first_command/index.html

@@ -556,6 +556,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/tutorial/40-options_parameters_and_arguments/index.html

@@ -570,6 +570,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/tutorial/50-publishing/index.html

@@ -563,6 +563,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/whoami/index.html

@@ -493,6 +493,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-src/docs/advanced/command_types.md

@@ -73,7 +73,7 @@ You can tell a command is a script by the line:
 
 ```ruby
 class List < 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
 ```
 

data/docs-src/docs/advanced/remote_execution.md

@@ -0,0 +1,56 @@
+# Remote Execution
+
+RBCli can be configured to execute commands on a remote machine via SSH instead of locally.
+
+Currently, only `script` and `extern` commands are supported.
+
+## Configuration
+
+To allow remote execution, go to `config/general.rb` and change the following line to `true`:
+
+```ruby
+remote_execution permitted: false
+```
+
+Then, for each command that you would like to enable remote execution for, add the following directive to the command class declaration:
+
+```ruby
+remote_permitted
+```
+
+## Usage
+
+Your end users can now execute a command remotely by specifying the connection string and credentials on the command line as follows:
+
+```bash
+mytool --remote-exec [user@]host[:port] --identity (/path/to/private/ssh/key or password) <command>
+# or
+mytool -r [user@]host[:port] -i (/path/to/private/ssh/key or password) <command>
+```
+
+Some valid examples are:
+
+```bash
+mytool -r example.com -i myPassword showuserfiles -u MyUser
+mytool -r root@server.local -i ~/.ssh/id_rsa update
+mytool -r admin@172.16.0.1:2202 -i ~/.ssh/mykey cleartemp
+```
+
+If the end user is unsure of which commands can or can not be executed remotely, they can check by running `mytool -h`. Commands that have remote execution enabled will have an asterisk (*) by their name:
+
+```bash
+$ mytool -h
+A simple command line tool.
+For more information on individual commands, run `mytool <command> -h`.
+
+Usage:
+      foo [options] command [parameters]
+
+Commands:
+      bar                  TODO: Description goes here
+   *  baz                  TODO: Description goes here
+
+...
+```
+
+In this example, the command `baz` is available for remote execution

data/docs-src/docs/development/contributing.md

@@ -45,5 +45,5 @@ To release a new version, follow theese steps:
 1. Update the version number in `version.rb`
 2. Run `bundle exec rake install`, which will update `gemfile.lock` with the correct version and all dependency changes
 3. Run `docs-src/makesite.sh`, which re-compiles the documentation and pulls in the changelog and quick reference automatically
-4. Commit the above changes to master, but do not push
+4. Commit the above changes to master with a commit message of "vX.X.X" (where X.X.X is the version number), but do not push
 5. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/docs-src/docs/imported/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/docs-src/docs/imported/quick_reference.md

@@ -132,13 +132,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
 
@@ -148,3 +169,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/docs-src/docs/index.md

@@ -30,6 +30,8 @@ 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
+
 
 If you're just getting started with RBCli, take a look at the [Tutorial][tutorial]. Or take a look at the [Advanced] menu above to look through RBCli's additional featureset.
 

data/docs-src/mkdocs.yml

@@ -21,6 +21,7 @@ pages:
     - Automatic Updates: advanced/automatic_updates.md
     - State Storage: advanced/state_storage.md
     - Distributed State Locking: advanced/distributed_state_locking.md
+    - Remote Execution: advanced/remote_execution.md
   - Development:
     - Contribution Guide: development/contributing.md
     - License Info: development/license.md

data/exe/rbcli

@@ -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 "#{File.dirname(__FILE__)}/../lib/rbcli.rb"

data/lib/rbcli/autoupdate/autoupdate.rb

@@ -15,7 +15,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       #
 ##################################################################################
 
 module Rbcli::Configurate

data/lib/rbcli/autoupdate/gem_updater.rb

@@ -15,7 +15,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 'net/http'

data/lib/rbcli/autoupdate/github_updater.rb

@@ -15,7 +15,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 'octokit'

data/lib/rbcli/configuration/config.rb

@@ -15,7 +15,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       #
 ##################################################################################
 
 ####

data/lib/rbcli/configuration/configurate.rb

@@ -15,7 +15,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       #
 ##################################################################################
 
 
@@ -32,7 +32,8 @@ module Rbcli::Configurate
 			pre_hook: nil,
 			post_hook: nil,
 			first_run: nil,
-			halt_after_first_run: false
+			halt_after_first_run: false,
+			remote_execution: false
 	}
 
 	def self.me &block
@@ -113,6 +114,10 @@ module Rbcli::Configurate
 		@data[:first_run] = block
 	end
 
+	def self.remote_execution permitted: true
+		@data[:remote_execution] = permitted
+	end
+
 	##
 	# Data Retrieval
 	##

data/lib/rbcli/engine/command.rb

@@ -15,7 +15,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       #
 ##################################################################################
 
 
@@ -72,6 +72,14 @@ class Rbcli::Command
 		Rbcli::Config::add_default *params
 	end
 
+	def self.remote_permitted
+		@remote_permitted = true
+	end
+
+	def remote_permitted?
+		self.class.instance_variable_get :@remote_permitted
+	end
+
 	##
 	# END Interface Functions
 	##
@@ -85,8 +93,16 @@ class Rbcli::Command
 		global_opts = cliopts
 		config = Rbcli::config
 
-		raise Exception.new("Command #{cmd} has both an extern and action defined. Usage is limiated to one at a time.") if @commands[cmd].extern and @commands[cmd].action
+		raise Exception.new("Command #{cmd} can only have one of `action`, `script`, or `extern` defined.") if (@commands[cmd].extern or @commands[cmd].script) and @commands[cmd].action
+
+		if cliopts[:remote_exec]
+			Rbcli::RemoteExec.new(@commands[cmd], cliopts[:remote_exec], cliopts[:identity], params, args, global_opts, config).run
+			#remote_exec @commands[cmd], params, args, global_opts, config
+			return
+		end
+
 		@commands[cmd].extern.execute params, args, global_opts, config unless @commands[cmd].extern.nil?
+		@commands[cmd].script.execute params, args, global_opts, config unless @commands[cmd].script.nil?
 		@commands[cmd].action.call params, args, global_opts, config unless @commands[cmd].action.nil?
 	end
 
@@ -97,7 +113,13 @@ class Rbcli::Command
 		#descmap = @commands.map { |name, klass| [name, klass.description] }.to_h
 		@commands.map do |name, cmdobj|
 			desc = ''
-			indent_size.times { desc << ' ' }
+			if Rbcli.configuration[:remote_execution] and cmdobj.remote_permitted?
+				indent_size -= 3
+				indent_size.times { desc << ' ' }
+				desc << '*  '
+			else
+				indent_size.times { desc << ' ' }
+			end
 			desc << name.ljust(justification)
 			desc << cmdobj.description
 		end.join("\n")

data/lib/rbcli/engine/load_project.rb

@@ -15,7 +15,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       #
 ##################################################################################
 
 

data/lib/rbcli/engine/parser.rb

@@ -15,7 +15,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       #
 ##################################################################################
 
 
@@ -48,7 +48,11 @@ Commands:
 				opts[:permitted] = nil unless opts.key? :permitted
 				opt name.to_sym, opts[:description], type: opts[:type], default: opts[:default], required: opts[:required], permitted: opts[:permitted], short: opts[:short]
 			end
-			opt :json_output, 'Output result in machine-friendly JSON format', type: :boolean, default: false if data[:allow_json]
+			if data[:remote_execution]
+				opt :remote_exec, 'Remote user@host:port to execute command on', type: :string, default: nil
+				opt :identity, 'Identity for remote execution', type: :string, default: nil
+			end
+			opt :json_output, 'Output result in machine-friendly JSON format', short: :none, type: :boolean, default: false if data[:allow_json]
 			opt :config_file, 'Specify a config file manually', short: :none, type: :string, default: data[:config_userfile] unless data[:config_userfile].nil?
 			opt :generate_config, 'Generate a new config file', short: :none unless data[:config_userfile].nil? #defaults to false
 			stop_on Rbcli::Command.commands.keys
@@ -67,6 +71,10 @@ Commands:
 		elsif Rbcli::Command.commands.key? @cmd[0]
 			@cmd << Rbcli::Command.commands[@cmd[0]].parseopts
 
+			if (@cliopts[:remote_exec_given] and not @cliopts[:identity_given]) or (not @cliopts[:remote_exec_given] and @cliopts[:identity_given])
+				Trollop::die 'Must use `--remote-exec` and `--identity` together.'
+			end
+
 			Rbcli.configuration[:pre_hook].call @cliopts unless Rbcli.configuration[:pre_hook].nil?
 			Rbcli::Command.runcmd(@cmd.shift, @cmd[0], @cliopts)
 			Rbcli.configuration[:post_hook].call @cliopts unless Rbcli.configuration[:post_hook].nil?

data/lib/rbcli/logging/logging.rb

@@ -15,7 +15,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       #
 ##################################################################################