rbcli 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e1fdf57f967275989d85da3af7efe4be4548c19355a38ad413b5a3eda93df29
-  data.tar.gz: 021efa89a89181c7ec705250824a8c6c3fc1009d9dcbcf5b3480d66f1996d47d
+  metadata.gz: d6ab8b75c47014a1d8fc4ebfb019fd510d6878446c0b5e21b534331518779c69
+  data.tar.gz: 76a749c4eedd63b9372abfb5cf742c418e440bf52c07cfb80e14e4890e19dad2
 SHA512:
-  metadata.gz: f35c7c37d74f54d15ca6393e5a6f9f73b34bbc957a63ff5cd5b0d5e62fdf8643e19a23ec70adab4088b2816c45329b31c309346939726c22f89de491e33b022e
-  data.tar.gz: deb5e7bb66af850aa3278f40826ff506302bf4ae9817cf63f8dac23a6bd0fd9db924ea684aa7ea10ef628b7fbcb6ee6893480639c3f995648423d1c05069569d
+  metadata.gz: 841009711e6ea7507da51246fa3f116c767cee17229775dfb4524e649ed766f20c20069728d426d675d26bdbea9338f0e1a26873fc5120ba63473607815440dd
+  data.tar.gz: edeb6d1302757421d2db44b44c38e07765920a67cd1230c45689541b7a4d29b4b511fd3e3b7d2f08b8abd36b17bbb30c639f71501bfbd5248518b5e4d70cc253

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbcli (0.1.6)
+    rbcli (0.1.7)
       aws-sdk-dynamodb (~> 1.6)
       colorize (~> 0.8)
       deep_merge (~> 1.2)
@@ -15,7 +15,7 @@ GEM
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
     aws-eventstream (1.0.0)
-    aws-partitions (1.87.0)
+    aws-partitions (1.91.0)
     aws-sdk-core (3.21.2)
       aws-eventstream (~> 1.0)
       aws-partitions (~> 1.0)

data/README.md

@@ -1,3 +1,5 @@
+RBCli is currently in Alpha stages of development. All releases can be considered stable, though breaking changes may be made between versions. 
+
 # RBCli
 
 RBCli is a framework to quickly develop advanced command-line tools in Ruby. It has been written from the ground up with the needs of the modern technologist in mind, designed to make advanced CLI tool development as painless as possible.
@@ -22,10 +24,14 @@ Some of its key features include:
 
 * __Automatic Update Notifications__: Just provide the gem name or git repo, and RBCli will take care of notifying users!
 
+* __External Script Wrapping__: High-level wrapping for Bash scripts, or any other applcication you'd like to wrap into a command.
+
+
 ## Installation
 
 RBCli is available on rubygems.org. You can add it to your application's `Gemrile` or `gemspec`, or install it manually via `gem install rbcli`.
 
+
 ## The Basics
 
 RBCli enforces a general command-line structure:
@@ -53,6 +59,7 @@ mytool show -l
 
 Note that all options and parameters will have both a short and long version of the parameter available for use.
 
+
 ## Getting Started
 
 Creating a new skeleton command is as easy as running `rbcli init <filename>`. It will have these key items:
@@ -62,7 +69,6 @@ Creating a new skeleton command is as easy as running `rbcli init <filename>`. I
 * A command declaration
 * The parse command
 
-
 ### Configuration
 
 ```ruby
@@ -119,7 +125,6 @@ If you want to declare more than one option, you can call it multiple times. The
 
 Once parsed, options will be placed in a hash where they can be accessed via their names as shown above. You can see this demonstrated in the `default_action`, `pre_hook`, and `post_hook` blocks.
 
-
 ### Storage Configuration (optional)
 
 ```ruby
@@ -144,9 +149,14 @@ class Test < Rbcli::Command
 	config_defaults 'defaults.yml'                                                     # (Optional, Multiple) Load a YAML file as part of the default config. This can be called multiple times, and the YAML files will be merged. User config is generated from these
 	config_default :myopt2, description: 'Testing this again', value: true             # (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config
 
-	action do |params, args, global_opts, config|                                      # (Required) Block to execute if the command is called.
-		Rbcli::log.info { 'These logs can go to STDERR, STDOUT, or a file' }               # Example log. Interface is identical to Ruby's logger
-		puts "\nArgs:\n#{args}"                    # Arguments that came after the command on the CLI
+	extern path: 'env | grep "^__PARAMS\|^__ARGS\|^__GLOBAL\|^__CONFIG"', envvars: {MYVAR: 'some_value'}     # (Required unless `action` defined) Runs a given application, with optional environment variables, when the user runs the command.
+	extern envvars: {MY_OTHER_VAR: 'another_value'} do |params, args, global_opts, config|                   # Alternate usage. Supplying a block instead of a path allows us to modify the command based on the arguments and configuration supplied by the user.
+		"echo #{params[:force].to_s}__YESSS!!!"
+	end
+
+	action do |params, args, global_opts, config|                                        # (Required unless `extern` defined) Block to execute if the command is called.
+		Rbcli::log.info { 'These logs can go to STDERR, STDOUT, or a file' }                       # Example log. Interface is identical to Ruby's logger
+		puts "\nArgs:\n#{args}"                    # Arguments that came after the command on the CLI (i.e.: `mytool test bar baz` will yield args=['bar', 'baz'])
 		puts "Params:\n#{params}"                  # Parameters, as described through the option statements above
 		puts "Global opts:\n#{global_opts}"        # Global Parameters, as descirbed in the Configurate section
 		puts "Config:\n#{config}"                  # Config file values
@@ -155,7 +165,6 @@ class Test < Rbcli::Command
 		puts "\nDone!!!"
 	end
 end
-
 ```
 
 ### Parse Command
@@ -177,6 +186,7 @@ RBCli takes actions in a specific order when `parse` is run.
 		ii. Otherwise, show the help
 	b. If a command has been entered, the rest of the CLI is parsed for parameters and lineitems, and the code block for the command is called
 
+
 ## Configuration Files
 
 RBCli has two chains to manage configuration: the __defaults chain__ and the __user chain__.
@@ -209,6 +219,7 @@ Rbcli will determine the correct location to locate the user configuration based
 
 Users can generate configs by running `yourclitool -g`. This will generate a config file at the tool's default location specified in the DSL. A specific location can be used via the `-c` parameter. You can test how this works by running `examples/mytool -c test.yml -g`.
 
+
 ## Logging
 
 Logging with RBCli is straightforward - it looks at the config file for logging settings, and instantiates a single, globally accessible [Logger](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html)` object. You can access it as such:
@@ -233,6 +244,7 @@ logger:
   log_target: stderr           # STDOUT, STDERR, or a file path
 ```
 
+
 ## <a name="storage_subsystems"></a>Storage Subsystems
 
 ```ruby
@@ -364,6 +376,7 @@ to force the lock and retrieve the latest data. You can force an unlock by calli
 Rbcli.remote_state.disconnect
 ```
 
+
 ## Automatic Update Check
 
 RBCli can automatically notify users when an update is available. If `force_update` is set (see below), RBCli can halt execution until the user updates their application.
@@ -399,20 +412,93 @@ The `gem` parameter should simply state the name of the gem.
  
 Setting `force_update: true` will halt execution if an update is available, forcing the user to update.
 
+
+## External Script Wrapping
+
+RBCli has the ability to run an external application as a CLI command, passing CLI parameters and environment variables as desired. It provides two modes -- __direct path__ and __variable path__ -- which work similarly through the `extern` keyword.
+
+When an external script is defined in a command, an `action` is no longer required.
+
+To quickly generate a script that shows the environment variables passed to it, you can use RBCli's own tool: `rbcli script`
+
+### Direct Path Mode
+
+ ```ruby
+ class Test < Rbcli::Command                                                          # Declare a new command by subclassing Rbcli::Command
+ 	description 'This is a short description.'                                         # (Required) Short description for the global help
+ 	usage 'This is some really long usage text description!'                           # (Required) Long description for the command-specific help
+ 	parameter :force, 'Force testing', type: :boolean, default: false, required: false # (Optional, Multiple) Add a command-specific CLI parameter. Can be called multiple times
+
+ 	extern path: 'env | grep "^__PARAMS\|^__ARGS\|^__GLOBAL\|^__CONFIG\|^MYVAR"', envvars: {MYVAR: 'some_value'}     # (Required unless `action` defined) Runs a given application, with optional environment variables, when the user runs the command.
+end
+ ```
+
+Here, we supply a string to run the command. We can optioanlly provide environment variables which will be available for the script to use.
+
+RBCli will automatically set several environment variables as well. As you may have guessed by the example above, they are prefixed with:
+
+* `__PARAMS`
+* `__ARGS`
+* `__GLOBAL`
+* `__CONFIG`
+
+These prefixes are applied to their respective properties in RBCli, similar to what you would see when using an `action`.
+
+The command in the example above will show you a list of variables, which should look something like this:
+
+```bash
+__GLOBAL_VERSION=false
+__GLOBAL_HELP=false
+__GLOBAL_GENERATE_CONFIG=false
+__GLOBAL_CONFIG_FILE="/etc/mytool/config.yml"
+__CONFIG_LOGGER={"log_level":"info","log_target":"stderr"}
+__CONFIG_MYOPT=true
+__CONFIG_GITHUB_UPDATE={"access_token":null,"enterprise_hostname":null}
+__PARAMS_FORCE=false
+__PARAMS_HELP=false
+MYVAR=some_value
+```
+
+As you can see above, items which have nested values they are passed in as JSON. If you need to parse them, [JQ](https://stedolan.github.io/jq/) is recommended.
+
+### Variable Path Mode
+
+Variable Path Mode works the same as Direct Path Mode, only instead of providing a string we provide a block that returns a string. This allows us to generate different commands based on the CLI parameters that the user passed:
+
+```ruby
+class Test < Rbcli::Command                                                          # Declare a new command by subclassing Rbcli::Command
+	description 'This is a short description.'                                         # (Required) Short description for the global help
+	usage 'This is some really long usage text description!'                           # (Required) Long description for the command-specific help
+	parameter :force, 'Force testing', type: :boolean, default: false, required: false # (Optional, Multiple) Add a command-specific CLI parameter. Can be called multiple times
+
+	extern envvars: {MY_OTHER_VAR: 'another_value'} do |params, args, global_opts, config|                   # Alternate usage. Supplying a block instead of a path allows us to modify the command based on the arguments and configuration supplied by the user.
+		if params[:force].to_s
+			"externalapp --test-script foo --ignore-errors"
+		else
+			"externalapp"
+		end
+	end
+end
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine from source, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then 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).
 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/akhoury6/rbcli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
+
 ## Code of Conduct
 
 Everyone interacting in the Rbcli project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/akhoury6/rbcli/blob/master/CODE_OF_CONDUCT.md).

data/examples/myscript.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+###
+# This is the RBCli script for the command {{**CMDNAME**}}
+###
+#
+# You can find RBCli's params, args, global_opts, and config through environment
+# variables. They are passed in the formats:
+#
+#   __PARAMS_<param_name>
+#   __ARGS_<arg_name>
+#   __GOBAL <global_opt_name>
+#   __CONFIG <config_name>
+#
+# If any of the options given had nested values in your RBCli application they
+# will be passed as JSON. You can parse them using jq ( https://stedolan.github.io/jq/ )
+#
+# If you specified any environment variables to be set manually, they will be found unmodified.
+#
+###
+#
+
+env | grep "^__PARAMS\|^__ARGS\|^__GLOBAL\|^__CONFIG"

data/examples/mytool

@@ -69,9 +69,14 @@ class Test < Rbcli::Command
 	config_defaults 'defaults.yml'                                                     # (Optional, Multiple) Load a YAML file as part of the default config. This can be called multiple times, and the YAML files will be merged. User config is generated from these
 	config_default :myopt2, description: 'Testing this again', value: true             # (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config
 
-	action do |params, args, global_opts, config|                                      # (Required) Block to execute if the command is called.
-		Rbcli::log.info { 'These logs can go to STDERR, STDOUT, or a file' }               # Example log. Interface is identical to Ruby's logger
-		puts "\nArgs:\n#{args}"                    # Arguments that came after the command on the CLI
+	extern path: 'env | grep "^__PARAMS\|^__ARGS\|^__GLOBAL\|^__CONFIG"', envvars: {MYVAR: 'some_value'}     # (Required unless `action` defined) Runs a given application, with optional environment variables, when the user runs the command.
+	extern envvars: {MY_OTHER_VAR: 'another_value'} do |params, args, global_opts, config|                   # Alternate usage. Supplying a block instead of a path allows us to modify the command based on the arguments and configuration supplied by the user.
+		"echo #{params[:force].to_s}__YESSS!!!"
+	end
+
+	action do |params, args, global_opts, config|                                        # (Required unless `extern` defined) Block to execute if the command is called.
+		Rbcli::log.info { 'These logs can go to STDERR, STDOUT, or a file' }                       # Example log. Interface is identical to Ruby's logger
+		puts "\nArgs:\n#{args}"                    # Arguments that came after the command on the CLI (i.e.: `mytool test bar baz` will yield args=['bar', 'baz'])
 		puts "Params:\n#{params}"                  # Parameters, as described through the option statements above
 		puts "Global opts:\n#{global_opts}"        # Global Parameters, as descirbed in the Configurate section
 		puts "Config:\n#{config}"                  # Config file values

data/exe/rbcli

@@ -2,7 +2,7 @@
 
 require 'rbcli'
 
-Rbcli::configurate do
+Rbcli::Configurate.me do
 	scriptname __FILE__.split('/')[-1]
 	version Rbcli::VERSION
 	description 'RBCli initialization tool'
@@ -16,15 +16,38 @@ class Init < Rbcli::Command
 	action do |params, args, global_opts, config|
 		src = "#{File.dirname(__FILE__)}/../examples/mytool"
 		dest = "#{Dir.pwd}/#{params[:filename]}"
-		if File.exists? dest
-			puts "File #{params[:filename]} already exists. Please delete and try again."
-		else
-			puts "Generating file #{params[:filename]}..."
-			FileUtils.cp src, dest
-			puts "Done!"
-		end
+		cp_file src, dest
 	end
+end
+
+class Script < Rbcli::Command
+	description 'Initialize a skeleton bash script to use as an RBCli command.'
+	usage 'This will generate a new file in the current folder.'
+	parameter :filename, 'Name of file to generate', type: :string, required: true
 
+	action do |params, args, global_opts, config|
+		src = "#{File.dirname(__FILE__)}/../examples/myscript.sh"
+		dest = "#{Dir.pwd}/#{params[:filename]}"
+		cp_file src, dest, template_vars: {'CMDNAME' => params[:filename].chomp('.sh')}
+	end
+end
+
+def cp_file src, dest, template_vars: nil
+	if File.exists? dest
+		puts "File #{dest} already exists. Please delete it and try again."
+	elsif template_vars
+		print "Generating file #{dest}..."
+		text = File.read src
+		template_vars.each do |k, v|
+			text.gsub! /{{\*\*#{k}\*\*}}/, v
+		end
+		File.open(dest, 'w') { |file| file.write text }
+		puts "Done!"
+	else
+		print "Generating file #{dest}..."
+		FileUtils.cp src, dest
+		puts "Done!"
+	end
 end
 
 Rbcli.parse

data/lib/rbcli/autoupdate/autoupdate.rb

@@ -1,6 +1,6 @@
 module Rbcli::Configurate
 	def self.autoupdate gem: nil, github_repo: nil, access_token: nil, enterprise_hostname: nil, force_update: false
-		raise StandardError.new "Autoupdater can not have both a gem and git target defined. Please pick one." if gem and giturl
+		raise StandardError.new "Autoupdater can not have both a gem and git target defined. Please pick one." if gem and github_repo
 		raise StandardError.new "Only one autoupdater can be defined." if @data[:autoupdater]
 		if gem
 			#Rbcli::Autoupdate::GemUpdater.save_defaults

data/lib/rbcli/autoupdate/gem_updater.rb

@@ -12,8 +12,12 @@ module Rbcli::Autoupdate
 		end
 
 		def get_latest_version
-			response = Net::HTTP.get(@uri)
-			JSON.parse(response)['version']
+			begin
+				response = Net::HTTP.get(@uri)
+				JSON.parse(response)['version']
+			rescue SocketError => e
+				# Capture connection errors
+			end
 		end
 
 		def update_message

data/lib/rbcli/autoupdate/github_updater.rb

@@ -24,7 +24,12 @@ module Rbcli::Autoupdate
 		end
 
 		def get_latest_version
-			@client.repo(@reponame).rels[:tags].get.data.map{ |t| t[:name] }[0].sub(/^[v]*/,"")
+			begin
+				@client.repo(@reponame).rels[:tags].get.data.map{ |t| t[:name] }[0].sub(/^[v]*/,"")
+			rescue Faraday::ConnectionFailed => e
+				# This is to capture connection errors without bothering the user.
+			end
+
 		end
 
 		def update_message

data/lib/rbcli/engine/command.rb

@@ -63,7 +63,9 @@ class Rbcli::Command
 		global_opts = cliopts
 		config = Rbcli::config
 
-		@commands[cmd].action.call params, args, global_opts, 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
+		@commands[cmd].extern.execute params, args, global_opts, config unless @commands[cmd].extern.nil?
+		@commands[cmd].action.call params, args, global_opts, config unless @commands[cmd].action.nil?
 	end
 
 	##

data/lib/rbcli/scriptwrapping/scriptwrapper.rb

@@ -0,0 +1,45 @@
+class Rbcli::Command
+	def self.extern path: nil, envvars: nil, &block
+		block = nil unless block_given?
+		@extern = Rbcli::Scriptwrapper.new path, envvars, block
+	end
+
+	def extern;
+		@extern ||= nil
+		self.class.instance_variable_get :@extern
+	end
+end
+
+require 'json'
+class Rbcli::Scriptwrapper
+	def initialize path, envvars = nil, block = nil
+		@path = path
+		@envvars = envvars
+		@block = block
+	end
+
+	def execute params, args, global_opts, config
+		env_hash = {}
+		{
+				'__PARAMS' => params,
+				'__ARGS' => args,
+				'__GLOBAL' => global_opts,
+				'__CONFIG' => config
+		}.each do |name, hsh|
+			hsh.each do |k, v|
+				env_hash["#{name}_#{k.upcase}"] = v.to_json
+			end
+		end
+
+		env_hash.merge!(@envvars.deep_stringify!) unless @envvars.nil?
+
+		if @block
+			path = @block.call params, args, global_opts, config
+		else
+			path = @path
+		end
+
+		system(env_hash, path)
+	end
+
+end

data/lib/rbcli/version.rb

@@ -1,3 +1,3 @@
 module Rbcli
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/rbcli.rb

@@ -1,10 +1,29 @@
+###########
+## RBCLI ##
+###########
+#
+# This file loads the Rbcli systems.
+#
+# Utils and Prereqs must be loaded first.
+#
+###########
+
 lib = File.expand_path('../../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 module Rbcli end # Empty module declaration required to declare submodules freely
 require "rbcli/version"
 
-require "rbcli/util"
+# UTILS
+require 'rbcli/util/hash_deep_symbolize'
+#require 'rbcli/util/string_colorize' # We are using the colorize gem instead. The code is kept here for reference.
+# END UTILS
+
+# BASE PREREQS
+require 'rbcli/configuration/config'
+require 'rbcli/logging/logging'
+# END BASE PREREQS
+
 
 # STATE TOOLS
 require "rbcli/stateful_systems/configuratestorage"
@@ -17,7 +36,12 @@ require "rbcli/stateful_systems/storagetypes/remotestate_dynamodb"
 require "rbcli/autoupdate/autoupdate"
 # END AUTOUPDATE
 
-require "rbcli/configurate"
+# SCRIPT WRAPPER
+require "rbcli/scriptwrapping/scriptwrapper"
+# END SCRIPT WRAPPER
 
+# CORE
+require "rbcli/configuration/configurate"
 require "rbcli/engine/command"
 require "rbcli/engine/parser"
+# END CORE

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbcli
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Andrew Khoury
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-06 00:00:00.000000000 Z
+date: 2018-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -155,24 +155,25 @@ files:
 - bin/console
 - bin/setup
 - examples/defaults.yml
+- examples/myscript.sh
 - examples/mytool
 - exe/rbcli
 - lib/rbcli.rb
 - lib/rbcli/autoupdate/autoupdate.rb
 - lib/rbcli/autoupdate/gem_updater.rb
 - lib/rbcli/autoupdate/github_updater.rb
-- lib/rbcli/configurate.rb
+- lib/rbcli/configuration/config.rb
+- lib/rbcli/configuration/configurate.rb
 - lib/rbcli/engine/command.rb
 - lib/rbcli/engine/parser.rb
+- lib/rbcli/logging/logging.rb
+- lib/rbcli/scriptwrapping/scriptwrapper.rb
 - lib/rbcli/stateful_systems/configuratestorage.rb
 - lib/rbcli/stateful_systems/state_storage.rb
 - lib/rbcli/stateful_systems/storagetypes/localstate.rb
 - lib/rbcli/stateful_systems/storagetypes/remote_state_connectors/dynamodb.rb
 - lib/rbcli/stateful_systems/storagetypes/remotestate_dynamodb.rb
-- lib/rbcli/util.rb
-- lib/rbcli/util/config.rb
 - lib/rbcli/util/hash_deep_symbolize.rb
-- lib/rbcli/util/logging.rb
 - lib/rbcli/util/string_colorize.rb
 - lib/rbcli/util/trollop.rb
 - lib/rbcli/version.rb

data/lib/rbcli/util.rb

@@ -1,4 +0,0 @@
-require 'rbcli/util/hash_deep_symbolize'
-#require 'rbcli/util/string_colorize' # We are using the colorize gem instead. The code is kept here for reference.
-require 'rbcli/util/config'
-require 'rbcli/util/logging'