rbcli 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4368206fc709a9d855156e9a447c8de3715f4916063af8d189a23dba1fb92c1a
-  data.tar.gz: 6f4dbed307cb87216c28a78a9c07774dde6245c3a8615afb921ab0d3d4df9764
+  metadata.gz: 0eefbfff220d04c6c6093ea0d3ec5cdd8fe93a6f02568c720ed04baddf05a25b
+  data.tar.gz: b7d18d8c85c131cd57c7cc78d63656687896bd02f0bb4d84c8e65a0bc332a7f1
 SHA512:
-  metadata.gz: 59a004efa92a3a62d0b6a9bfb1e2fc4c0f0ada6c7c61f26d920a85c7903ba1a0282bd2fcdf91e56db8b56c20e9c0e00fbc82fcde6fcae31c631b4e866813a433
-  data.tar.gz: a96255d756e764c65ea9c25616967194cc77922b813dfe8c7bf7601be107e50a705e12ed3641e0945261c12b510b0d5d821d094d0ca8182054c50003fc3a1985
+  metadata.gz: 28893fa34a3e02a1f67b1279b88fb52812f07601ec9dc20662f15351d55ea06c2a4bc401a7fce9c2877b7eccfc4165183b7a6770c171084114eac2228cb49288
+  data.tar.gz: 96cb8d64eabc9d48e511d1923e174b31c3f1d3f4fd9f74345c3cf19209ff21c3837bc6166ed97ea4b962a089cdfb9efcffea54efa923e9b3f60786e91cb0e249

data/Gemfile.lock

@@ -1,16 +1,19 @@
 PATH
   remote: .
   specs:
-    rbcli (0.1.4)
+    rbcli (0.1.5)
       aws-sdk-dynamodb (~> 1.6)
       colorize (~> 0.8)
       deep_merge (~> 1.2)
       macaddr (~> 1.7)
+      octokit (~> 4.9)
       rufus-scheduler (~> 3.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
     aws-eventstream (1.0.0)
     aws-partitions (1.87.0)
     aws-sdk-core (3.21.2)
@@ -26,6 +29,8 @@ GEM
     deep_merge (1.2.1)
     et-orbi (1.1.2)
       tzinfo
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
     fugit (1.1.1)
       et-orbi (~> 1.1, >= 1.1.1)
       raabro (~> 1.1)
@@ -33,10 +38,17 @@ GEM
     macaddr (1.7.1)
       systemu (~> 2.6.2)
     minitest (5.11.3)
+    multipart-post (2.0.0)
+    octokit (4.9.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    public_suffix (3.0.2)
     raabro (1.1.5)
     rake (10.5.0)
     rufus-scheduler (3.5.0)
       fugit (~> 1.1, >= 1.1.1)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
     systemu (2.6.5)
     thread_safe (0.3.6)
     tzinfo (1.2.5)

data/README.md

@@ -20,6 +20,8 @@ Some of its key features include:
 
 * __State Locking and Sharing__: Share remote state safely between users with built-in locking! When enabled, it makes sure that only one user is accessing the data at any given time.
 
+* __Automatic Update Notifications__: Just provide the gem name or git repo, and RBCli will take care of notifying users!
+
 ## 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`.
@@ -80,6 +82,9 @@ Rbcli::Configurate.me do
 
 	option :name, 'Give me your name', type: :string, default: 'Foo', required: false, permitted: ['Jack', 'Jill']  # (Optional, Multiple) Add a global CLI parameter. Supported types are :string, :boolean, :integer, :float, :date, and :io. Can be called multiple times.
 
+	autoupdate github_repo: 'akhoury6/rbcli', access_token: nil, enterprise_hostname: nil, this_version: Rbcli::VERSION, force_update: false    # (Optional) Check for updates to this application at a GitHub repo. The repo must use version number tags in accordance to best practices: https://help.github.com/articles/creating-releases/
+	autoupdate gem: 'rbcli', this_version: Rbcli::VERSION, force_update: false                                                                  # (Optional) Check for updates to this application through RubyGems.org.
+
 	default_action do |opts|                                               # (Optional) The default code to execute when no subcommand is given. If not present, the help is shown (same as -h)
 		puts "Hello, #{opts[:name]}."
 		puts "To see the help, use -h"
@@ -247,7 +252,25 @@ Once configured you can access it with a standard hash syntax:
 Rbcli.local_state[:yourkeyhere]
 ```
 
-For performance reasons, the only methods available for use are `=` (assignment operator), `delete`, `each`, and `key?`. Also, the `clear` method has been added, which resets the data back to an empty hash. Keys are accessed via either symbols or strings indifferently.
+For performance reasons, the only methods available for use are:
+
+Hash native methods:
+
+* `[]` (Regular hash syntax. Keys are accessed via either symbols or strings indifferently.)
+* `[]=` (Assignment operator)
+* `delete`
+* `each`
+* `key?`
+
+Additional methods:
+
+* `clear`
+	* Resets the data back to an empty hash.
+* `refresh`
+	* Loads the most current version of the data from the disk
+* `disconnect`
+	* Removes the data from memory and sets `Rbcli.local_state = nil`. Data will be read from disk again on next access.
+
 
 Every assignment will result in a write to disk, so if an operation will require a large number of assignments/writes it should be performed to a different hash before beign assigned to this one.
 
@@ -282,6 +305,8 @@ Rbcli.remote_state[:yourkeyhere]
 
 This works the same way that [Local State](#local_state) does, with the same performance caveats (try not to do many writes!).
 
+Note that all state in Rbcli is __lazy-loaded__, so no connections will be made until your code attempts to access the data.
+
 #### DynamoDB Configuration
 
 Before DynamoDB can be used, AWS API credentials have to be created and made available. RBCli will attempt to find credentials from the following locations in order:
@@ -317,7 +342,7 @@ Distributed Locking allows a remote state to be shared among multiple users of t
 
 This is how locking works:
 
-1. The application attempts to acquire a lock on the remote state when it starts
+1. The application attempts to acquire a lock on the remote state when you first access it
 2. If the backend is locked by a different application, wait and try again
 3. If it succeeds, the lock is held and refreshed periodically
 4. When the application exits, the lock is released
@@ -325,6 +350,59 @@ This is how locking works:
 6. If another application steals the lock (unlikely but possible), and the application tries to save data, a `StandardError` will be thrown
 7. You can manually attempt to lock/unlock by calling `Rbcli.remote_state.lock` or `Rbcli.remote_state.unlock`, respectively.
 
+##### Auto-locking vs Manual Locking
+
+Remember: all state in Rbcli is lazy-loaded. Therefore, RBCli wll only attempt to lock the data when you first try to access it. If you need to make sure that the data is locked before executing a block of code, use:
+
+```ruby
+Rbcli.remote_state.refresh
+```
+
+to force the lock and retrieve the latest data. You can force an unlock by calling:
+
+```ruby
+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.
+
+Two sources are currently supported: Github (including Enterprise) and RubyGems.
+
+### GitHub Update Check
+
+The GitHub update check works best when paired with GitHub's best practices on releases. See here: https://help.github.com/articles/creating-releases/
+
+RBCli will check your github repo's tags and compare that version number with one embedded into your code. In this example, we are leveraging the version number that we also use for RBCli's gemspec:
+
+```ruby
+autoupdate github_repo: 'akhoury6/rbcli', access_token: nil, enterprise_hostname: nil, this_version: Rbcli::VERSION, force_update: false    # (Optional) Check for updates to this application at a GitHub repo. The repo must use version number tags in accordance to best practices: https://help.github.com/articles/creating-releases/
+``` 
+The `github_repo` should point to the repo using the `user/repo` syntax. 
+
+The `access_token` can be overridden by the user via their configuration file, so it can be left as `nil`. The token is not needed at all if using a public repo. For instructions on generating a new access token, see [here](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/). 
+
+The `enterprise_hostname` setting allows you to point RBCli at a local GitHub Enterprise server.
+
+The `this_version` parameter should be set to the current version of the tool that the user is running. Here we leverage the default version location that is used for the RBCli gem itself. In your tool, you should replace this with your own version number.
+
+Setting `force_update: true` will halt execution if an update is available, forcing the user to update.
+
+### Rubygems.org Update Check
+
+The Rubygems update check will check if there is a new published version of the gem on Rubygems.org.
+
+```ruby
+autoupdate gem: 'rbcli', this_version: Rbcli::VERSION, force_update: false   # (Optional) Check for updates to this application through RubyGems.org.
+```
+
+The `gem` parameter should simply state the name of the gem.
+
+The `this_version` parameter should be set to the current version of the tool that the user is running. Here we leverage the default version location that is used for the RBCli gem itself. In your tool, you should replace this with your own version number.
+ 
+Setting `force_update: true` will halt execution if an update is available, forcing the user to update.
+
 ## 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.

data/examples/mytool

@@ -22,6 +22,9 @@ Rbcli::Configurate.me do
 
 	option :name, 'Give me your name', type: :string, default: 'Foo', required: false, permitted: ['Jack', 'Jill']  # (Optional, Multiple) Add a global CLI parameter. Supported types are :string, :boolean, :integer, :float, :date, and :io. Can be called multiple times.
 
+	autoupdate github_repo: 'akhoury6/rbcli', access_token: nil, enterprise_hostname: nil, this_version: Rbcli::VERSION, force_update: false    # (Optional) Check for updates to this application at a GitHub repo. The repo must use version number tags in accordance to best practices: https://help.github.com/articles/creating-releases/
+	autoupdate gem: 'rbcli', this_version: Rbcli::VERSION, force_update: false                                                                  # (Optional) Check for updates to this application through RubyGems.org.
+
 	default_action do |opts|                                               # (Optional) The default code to execute when no subcommand is given. If not present, the help is shown (same as -h)
 		puts "Hello, #{opts[:name]}."
 		puts "To see the help, use -h"

data/lib/rbcli.rb

@@ -13,6 +13,10 @@ require "rbcli/stateful_systems/storagetypes/localstate"
 require "rbcli/stateful_systems/storagetypes/remotestate_dynamodb"
 # END STATE TOOLS
 
+# AUTOUPDATE
+require "rbcli/autoupdate/autoupdate"
+# END AUTOUPDATE
+
 require "rbcli/configurate"
 
 require "rbcli/engine/command"

data/lib/rbcli/autoupdate/autoupdate.rb

@@ -0,0 +1,46 @@
+module Rbcli::Configurate
+	def self.autoupdate gem: nil, github_repo: nil, access_token: nil, enterprise_hostname: nil, this_version: 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 "Only one autoupdater can be defined." if @data[:autoupdater]
+		if gem
+			#Rbcli::Autoupdate::GemUpdater.save_defaults
+			@data[:autoupdater] = Rbcli::Autoupdate::GemUpdater.new gem, this_version, force_update
+		else
+			Rbcli::Autoupdate::GithubUpdater.save_defaults
+			@data[:autoupdater] = Rbcli::Autoupdate::GithubUpdater.new github_repo, access_token, enterprise_hostname, this_version, force_update
+		end
+		@data[:autoupdater].show_message if @data[:autoupdater].update_available?
+	end
+end
+
+
+require 'rubygems'
+module Rbcli::Autoupdate
+	module Common
+		def get_latest_version
+			raise Exception.new "Autoupdater type #{self.class.name} must define a 'check_for_updates' method."
+		end
+
+		def update_message
+			raise Exception.new "Autoupdater type #{self.class.name} must define an 'update_message' method."
+		end
+
+		def update_available?
+			@latest_version = get_latest_version
+			Gem::Version.new(@latest_version) > Gem::Version.new(@this_version)
+		end
+
+		def show_message
+			puts "WARNING: An update is available to #{Rbcli::Configurate::configuration[:scriptname]}. You are currently running version #{@this_version}; the latest is #{@latest_version || get_latest_version}."
+			puts update_message
+			puts "\n"
+			if @force_update
+				puts "This application requires that you update to the latest version to continue using it. It will now exit."
+				exit 0
+			end
+		end
+	end
+end
+
+require "rbcli/autoupdate/gem_updater"
+require "rbcli/autoupdate/github_updater"

data/lib/rbcli/autoupdate/gem_updater.rb

@@ -0,0 +1,37 @@
+require 'net/http'
+require 'json'
+
+module Rbcli::Autoupdate
+	class GemUpdater
+		include Common
+
+		def initialize gemname, this_version, force_update
+			@gemname = gemname
+			@uri = URI.parse "https://rubygems.org/api/v1/versions/#{gemname}/latest.json"
+			@this_version = this_version
+			@force_update = force_update
+		end
+
+		def get_latest_version
+			response = Net::HTTP.get(@uri)
+			JSON.parse(response)['version']
+		end
+
+		def update_message
+			"Please check the Ruby gem #{@gemname} for instructions. You can see it at: https://rubygems.org/gems/#{@gemname}/versions/#{@latest_version}"
+		end
+
+		# def self.save_defaults
+		# 	Rbcli::Config::add_categorized_defaults :gem_update, 'Automatically Check for Updates from RubyGems', {
+		# 			access_token: {
+		# 					description: 'Access token for GitHub API. This is only required for private repos. For help, see: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/',
+		# 					value: nil
+		# 			},
+		# 			enterprise_hostname: {
+		# 					description: 'Hostname for GitHub Enterprise. Leave as null (~) for public GitHub.',
+		# 					value: nil
+		# 			}
+		# 	}
+		# end
+	end
+end

data/lib/rbcli/autoupdate/github_updater.rb

@@ -0,0 +1,48 @@
+require 'octokit'
+
+module Rbcli::Autoupdate
+	class GithubUpdater
+		include Common
+
+		def initialize reponame, access_token, enterprise_hostname, this_version, force_update
+			@reponame = reponame
+			@this_version = this_version
+			@force_update = force_update
+
+			access_token = Rbcli.config.key?(:github_updatecheck) ? (Rbcli.config[:github_updatecheck][:access_token] || access_token) : access_token
+			enterprise_hostname = Rbcli.config.key?(:github_updatecheck) ? (Rbcli.config[:github_updatecheck][:enterprise_hostname] || enterprise_hostname) : enterprise_hostname
+
+			# Enterprise Connection
+			if enterprise_hostname
+				Octokit.configure do |c|
+					c.api_endpoint = "https://#{enterprise_hostname}/api/v3/"
+				end
+				# Public Github Connection
+			end
+			#OAuth connection - not used
+			#@client = Octokit::Client.new :client_id => client_id, :client_secret => client_secret
+			@client = Octokit::Client.new(:access_token => access_token)
+		end
+
+		def get_latest_version
+			@client.repo(@reponame).rels[:tags].get.data.map{ |t| t[:name] }[0].sub(/^[v]*/,"")
+		end
+
+		def update_message
+			"Please check the github repo #{@reponame} for instructions."
+		end
+
+		def self.save_defaults
+			Rbcli::Config::add_categorized_defaults :github_update, 'Automatically Check for Updates from GitHub', {
+					access_token: {
+							description: 'Access token for GitHub API. This is only required for private repos. For help, see: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/',
+							value: nil
+					},
+					enterprise_hostname: {
+							description: 'Hostname for GitHub Enterprise. Leave as null (~) for public GitHub.',
+							value: nil
+					}
+			}
+		end
+	end
+end

data/lib/rbcli/engine/parser.rb

@@ -48,7 +48,7 @@ Commands:
 
 			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[:pre_hook].nil?
+			Rbcli.configuration[:post_hook].call @cliopts unless Rbcli.configuration[:post_hook].nil?
 		else
 			Trollop::die "Unknown subcommand #{@cmd[0].inspect}"
 		end

data/lib/rbcli/stateful_systems/state_storage.rb

@@ -7,83 +7,108 @@ module Rbcli::State
 	## Main State Class
 	class StateStorage
 
-		def initialize path, force_creation: false, halt_on_error: true
+		def initialize path, force_creation: false, halt_on_error: true, lazy_load: true
 			@path = path
 			@force_creation = force_creation
 			@halt_on_error = halt_on_error
 
 			state_subsystem_init
 
-			base_data = {
-					data: {},
-					rbcli: {}
-			}
-
-			if state_exists?
-				load_state
-			elsif force_creation
-				create_state
-				@data = base_data
-				save_state
-			else
-				raise StandardError "State location #{@path} does not exist or can not be accessed." if @halt_on_error
-				@data = base_data
-			end
+			# Lazy load option
+			@loaded = false
+			state_create unless lazy_load
 		end
 
 		def []= key, value
+			state_create unless @loaded
 			@data[:data][key.to_sym] = value
 			save_state
 			@data[:data][key.to_sym]
 		end
 
 		def [] key
+			state_create unless @loaded
 			@data[:data][key.to_sym]
 		end
 
 		def delete key, &block
+			state_create unless @loaded
 			result = @data[:data].delete key.to_sym, block
 			save_state
 			result
 		end
 
 		def refresh
-			load_state
+			if @loaded
+				load_state
+			else
+				state_create
+			end
 		end
 
 		def clear
+			state_create unless @loaded
 			@data[:data] = {}
 			save_state
 		end
 
+		def disconnect
+			unlock if self.class.method_defined? :unlock
+			@loaded = false
+			@data[:data] = nil
+		end
+
 		def each &block
+			state_create unless @loaded
 			@data[:data].each &block
 			save_state
 		end
 
 		def key? key
+			state_create unless @loaded
 			@data[:data].key? key.to_sym
 		end
 
 		def to_h
+			state_create unless @loaded
 			@data[:data]
 		end
 
 		def to_s
+			state_create unless @loaded
 			to_h.to_s
 		end
 
 		# For framework's internal use
 
 		def rbclidata key = nil
+			state_create unless @loaded
 			return @data[:rbcli][key.to_sym] unless key.nil?
 			@data[:rbcli]
 		end
 
 		def set_rbclidata key, value
+			state_create unless @loaded
 			@data[:rbcli][key.to_sym] = value
 			save_state
 		end
 
+		private
+
+		def state_create
+			base_data = {data: {}, rbcli: {}}
+			if state_exists?
+				load_state
+			elsif @force_creation
+				create_state
+				@data = base_data
+				save_state
+			else
+				raise StandardError "State location #{@path} does not exist or can not be accessed." if @halt_on_error
+				@data = base_data
+			end
+			@loaded = true
+		end
+
 	end
 end

data/lib/rbcli/stateful_systems/storagetypes/remote_state_connectors/dynamodb.rb

@@ -26,6 +26,8 @@ module Rbcli::State::RemoteConnectors
 			@locking = locking
 			@scheduler = nil
 			@lock_timeout = lock_timeout
+			@exit_code_set = false
+			@should_unlock_at_exit = false
 
 			@dynamo_client = Aws::DynamoDB::Client.new(
 					region: @region,
@@ -131,6 +133,7 @@ module Rbcli::State::RemoteConnectors
 					}
 			)
 			@scheduler.shutdown :kill if @scheduler
+			@should_unlock_at_exit = false
 			@scheduler = nil
 		end
 
@@ -190,8 +193,10 @@ module Rbcli::State::RemoteConnectors
 							lock
 						end
 						# We also make sure we release the lock at exit. In case this doesn't happen, the lock will expire on its own
-						at_exit do
-							unlock
+						@should_unlock_at_exit = true
+						unless @exit_code_set
+							at_exit {unlock if @should_unlock_at_exit}
+							@exit_code_set = true
 						end
 					end
 					puts 'done!' if recursed
@@ -204,7 +209,9 @@ module Rbcli::State::RemoteConnectors
 
 			end
 
-		end # END lock_or_wait
+		end
+
+		# END lock_or_wait
 
 		private
 
@@ -228,12 +235,17 @@ module Rbcli::State::RemoteConnectors
 		end
 
 		def get_lockdata
-			@dynamo_client.get_item(
+			item = @dynamo_client.get_item(
 					{
 							key: {'Script Name' => "#{@item_name}_lock"},
-							table_name: @dynamo_table_name,
+							table_name: @dynamo_table_name
 					}
 			).item
+			if item.nil?
+				lock
+				return get_lockdata
+			end
+			item
 		end
 
 	end

data/lib/rbcli/version.rb

@@ -1,3 +1,3 @@
 module Rbcli
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/rbcli.gemspec

@@ -43,6 +43,7 @@ Gem::Specification.new do |spec|
 	spec.add_dependency 'aws-sdk-dynamodb', '~> 1.6'
 	spec.add_dependency 'macaddr', '~> 1.7'
 	spec.add_dependency 'rufus-scheduler', '~> 3.5'
+	spec.add_dependency 'octokit', '~> 4.9'
 
 	#spec.add_dependency 'trollop', '~> 2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbcli
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Andrew Khoury
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 2018-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.9'
 description: RBCli is a framework to quickly develop command-line tools.
 email:
 - akhoury@live.com
@@ -144,6 +158,9 @@ files:
 - 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/engine/command.rb
 - lib/rbcli/engine/parser.rb