arborist 0.1.0 → 0.2.0.pre20170519125456

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cc3ce9e3d25176605f9895778c5654b57e8aa1c0
-  data.tar.gz: 4528bd2bcc17d925a9ea2ce63c475117839e98cd
+SHA256:
+  metadata.gz: f3104a401cf16ca97836a2311dac418944a103e610652a98fa2395b826b04ab4
+  data.tar.gz: 9d3bc6f71f0a204011e2d3e277a3a7e769194eecdfcbb603aaf427d5b9e4d98e
 SHA512:
-  metadata.gz: fd351f828f9d9dd9738541d93d852f82a7a12bcda91f1e4a7bda5bd38adedbf3da6fe52e7f729eab2f0d0678f71cd6b953ce449532e1b1cd9da14d18076a49c2
-  data.tar.gz: 3ac9921a9a8fc177ccba6036ab1fa00682cfc6ee892e7fde5aa3db34c5dc2832b32fd5a6e3f59518d8b4a9956b48a36ca39e10a83ff3b57dae895c845c5bf800
+  metadata.gz: ed5105cc83f993a12a8634fa8ef7256dc385b93ebbb92ce713bd7cb601d92ca23bbe1aafa34d5085e36c9d6e1f8956eeb5dc8d6d9b96048563016df2b059372e
+  data.tar.gz: 468e3ef96f4518938feeb4612143868beb1912120b1b3394189afdc860581de0f71344ab02dfba457c0ca777459ee1c2e5031ef3cab103a3e9cacffdc87b98f4

data/ChangeLog

@@ -1,14 +1,58 @@
+2017-02-19  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* .ruby-gemset, .ruby-version, .rvmrc, Rakefile:
+	Convert to .ruby-* files. Bump msgpack dependency.
+	[b0cead421802] [github/master, tip]
+
+2017-01-02  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgignore, Rakefile:
+	Remove guard against public release, ignore pkg dir
+	[4e6a4471c246]
+
+	* .hgtags:
+	Added tag v0.1.0 for changeset 859b70361b14
+	[83809e3f33bc]
+
+	* .hgsigs:
+	Added signature for changeset 02a11882f53b
+	[859b70361b14] [v0.1.0]
+
+	* History.md, lib/arborist.rb:
+	Set the minor version, update history file.
+	[02a11882f53b]
+
+	* TODO.md, lib/arborist/monitor.rb, lib/arborist/monitor_runner.rb,
+	spec/arborist/monitor_runner_spec.rb, spec/arborist/monitor_spec.rb:
+	Fix the DSL constructor, set the monitor key in the correct place in
+	the node data.
+	[e12d602bcf1a]
+
 2016-12-28  Michael Granger  <ged@FaerieMUD.org>
 
+	* Monitors.md, lib/arborist/monitor_runner.rb, lib/arborist/node.rb,
+	spec/arborist/node_spec.rb:
+	Add `key` to the monitor docs, use a prefixed key for monitor
+	updates.
+	[7119b40e002a]
+
+	* arborist.gemspec, lib/arborist/command/watch.rb,
+	lib/arborist/monitor.rb, lib/arborist/monitor_runner.rb,
+	lib/arborist/node.rb, spec/arborist/event/node_down_spec.rb,
+	spec/arborist/manager_spec.rb, spec/arborist/monitor_runner_spec.rb,
+	spec/arborist/monitor_spec.rb, spec/arborist/node_spec.rb:
+	Add a key attribute to monitors for error grouping.
+	[aebc20335e43]
+
 	* .gems, Rakefile:
 	Update to latest *ability
-	[09438b7a8aff] [tip]
+	[09438b7a8aff]
 
 2016-10-19  Michael Granger  <ged@FaerieMUD.org>
 
 	* lib/arborist/client.rb:
 	Use ** instead of * for client methods that take keyword args
-	[73b6f150a8c1] [github/master]
+	[73b6f150a8c1]
 
 	* lib/arborist/mixins.rb, lib/arborist/node.rb,
 	spec/arborist/client_spec.rb:

data/Manifest.txt

@@ -31,12 +31,11 @@ lib/arborist/event/node_quieted.rb
 lib/arborist/event/node_unknown.rb
 lib/arborist/event/node_up.rb
 lib/arborist/event/node_update.rb
+lib/arborist/event_api.rb
 lib/arborist/exceptions.rb
 lib/arborist/loader.rb
 lib/arborist/loader/file.rb
 lib/arborist/manager.rb
-lib/arborist/manager/event_publisher.rb
-lib/arborist/manager/tree_api.rb
 lib/arborist/mixins.rb
 lib/arborist/monitor.rb
 lib/arborist/monitor/socket.rb
@@ -52,15 +51,15 @@ lib/arborist/observer/action.rb
 lib/arborist/observer/summarize.rb
 lib/arborist/observer_runner.rb
 lib/arborist/subscription.rb
+lib/arborist/tree_api.rb
 spec/arborist/client_spec.rb
 spec/arborist/dependency_spec.rb
 spec/arborist/event/node_delta_spec.rb
 spec/arborist/event/node_down_spec.rb
 spec/arborist/event/node_spec.rb
 spec/arborist/event/node_update_spec.rb
+spec/arborist/event_api_spec.rb
 spec/arborist/event_spec.rb
-spec/arborist/manager/event_publisher_spec.rb
-spec/arborist/manager/tree_api_spec.rb
 spec/arborist/manager_spec.rb
 spec/arborist/mixins_spec.rb
 spec/arborist/monitor/socket_spec.rb
@@ -77,6 +76,7 @@ spec/arborist/observer/summarize_spec.rb
 spec/arborist/observer_runner_spec.rb
 spec/arborist/observer_spec.rb
 spec/arborist/subscription_spec.rb
+spec/arborist/tree_api_spec.rb
 spec/arborist_spec.rb
 spec/data/monitors/pings.rb
 spec/data/monitors/port_checks.rb

data/Rakefile

@@ -38,12 +38,14 @@ hoespec = Hoe.spec 'arborist' do |spec|
 	spec.dependency 'configurability', '~> 3.0'
 	spec.dependency 'pluggability', '~> 0.4'
 	spec.dependency 'state_machines', '~> 0.2'
-	spec.dependency 'msgpack', '~> 0.6'
-	spec.dependency 'rbczmq', '~> 1.7'
+	spec.dependency 'msgpack', '~> 1.0'
+	spec.dependency 'cztop', '~> 0.11'
+	spec.dependency 'cztop-reactor', '~> 0.3'
 	spec.dependency 'gli', '~> 2.3'
 	spec.dependency 'highline', '~> 1.7'
 
 	spec.dependency 'rspec', '~> 3.2', :developer
+	spec.dependency 'rspec-wait', '~> 0.0', :developer
 	spec.dependency 'simplecov', '~> 0.9', :developer
 	spec.dependency 'timecop', '~> 0.7', :developer
 
@@ -84,13 +86,13 @@ if File.directory?( '.hg' )
 	end
 end
 
-task :gemspec => [ 'ChangeLog', GEMSPEC ]
+task :gemspec => [ 'ChangeLog', __FILE__, GEMSPEC ]
 file GEMSPEC => __FILE__ do |task|
 	spec = $hoespec.spec
 	spec.files.delete( '.gemtest' )
 	spec.files.delete( 'LICENSE' )
 	spec.signing_key = nil
-	spec.version = "#{spec.version}.pre#{Time.now.strftime("%Y%m%d%H%M%S")}"
+	spec.version = "#{spec.version.bump}.0.pre#{Time.now.strftime("%Y%m%d%H%M%S")}"
 	spec.cert_chain = [ 'certs/ged.pem' ]
 	File.open( task.name, 'w' ) do |fh|
 		fh.write( spec.to_ruby )

data/TODO.md

@@ -28,9 +28,25 @@
 
 * Ask a node (via tree-api or otherwise) what nodes it affects (immediate children, secondary dependents)
 
+* Clarify the Tree API:
+	
+	- Rename `list` to `fetch`
+		- Return identified node `node.to_h`
+		- Return identified node and its children in a hierarchy `node.to_h(true)`
+		- Return identified node and its children as a flattened list
+	
+	- Rename `fetch` to `search`
+		- returns list of nodes which satisfy positive/negative criteria
+
+
 ### Observers
 
  * Action dependencies -- as an example, if an action sends an email,
    don't trigger if the email service is offline.  Potential action
    "chains", ie:  If the email service is down, use a separate
    out-of-band action that sends SMS.
+
+### Monitors
+
+Add a one-shot runner command for development of monitors. Loads and runs a monitor one time, maybe with some output describing how often it'd run, what its skew is, etc. [will@laika]
+

data/lib/arborist.rb

@@ -1,7 +1,7 @@
 # -*- ruby -*-
 #encoding: utf-8
 
-require 'rbczmq'
+require 'cztop'
 
 require 'pathname'
 require 'configurability'
@@ -17,7 +17,7 @@ module Arborist
 	VERSION = '0.1.0'
 
 	# Version control revision
-	REVISION = %q$Revision: 02a11882f53b $
+	REVISION = %q$Revision: 17a8567d86e2 $
 
 
 	# The name of the environment variable which can be used to set the config path
@@ -29,49 +29,33 @@ module Arborist
 	# The name of the config file that's loaded if none is specified.
 	DEFAULT_CONFIG_FILE = Pathname( 'arborist.yml' ).expand_path
 
-	# Configurability API -- default configuration values
-	CONFIG_DEFAULTS = {
-		tree_api_url:  'ipc:///tmp/arborist_tree.sock',
-		event_api_url: 'ipc:///tmp/arborist_events.sock',
-	}
-
 
 	##
 	# Set up a logger for the Arborist namespace
 	log_as :arborist
 
 	# Configurability API -- use the 'arborist'
-	config_key :arborist
+	configurability( :arborist ) do
 
+		##
+		# The ZMQ REP socket for the API for accessing the node tree.
+		setting :tree_api_url, default: 'ipc:///tmp/arborist_tree.sock'
 
-	require 'arborist/mixins'
-	extend Arborist::MethodUtilities
+		##
+		# The ZMQ PUB socket for published events
+		setting :event_api_url, default: 'ipc:///tmp/arborist_events.sock'
 
+	end
 
-	##
-	# The ZMQ REP socket for the API for accessing the node tree.
-	singleton_attr_accessor :tree_api_url
-	@tree_api_url = CONFIG_DEFAULTS[ :tree_api_url ]
 
-	##
-	# The ZMQ PUB socket for published events
-	singleton_attr_accessor :event_api_url
-	@event_api_url = CONFIG_DEFAULTS[ :event_api_url ]
+	require 'arborist/mixins'
+	extend Arborist::MethodUtilities
 
 
 	#
 	# :section: Configuration API
 	#
 
-	### Configurability API.
-	def self::configure( config=nil )
-		config = self.defaults.merge( config || {} )
-
-		self.tree_api_url  = config[ :tree_api_url ]
-		self.event_api_url = config[ :event_api_url ]
-	end
-
-
 	### Get the loaded config (a Configurability::Config object)
 	def self::config
 		Configurability.loaded_config
@@ -159,29 +143,6 @@ module Arborist
 	end
 
 
-	### Destroy any existing ZMQ state.
-	def self::reset_zmq_context
-		@zmq_context.destroy if @zmq_context.respond_to?( :destroy )
-		@zmq_context = nil
-	end
-
-
-	### Fetch the ZMQ context for Arborist.
-	def self::zmq_context
-		return @zmq_context ||= begin
-			self.log.info "Using ZeroMQ %s/CZMQ %s" %
-				[ ZMQ.version.join('.'), ZMQ.czmq_version.join('.') ]
-			ZMQ::Context.new
-		end
-	end
-
-
-	### Set the ZMQ context if it's already been created by something else.
-	def self::zmq_context=( existing_context )
-		@zmq_context = existing_context
-	end
-
-
 	require 'arborist/exceptions'
 	require 'arborist/mixins'
 

data/lib/arborist/client.rb

@@ -1,9 +1,11 @@
 # -*- ruby -*-
 #encoding: utf-8
 
-require 'arborist' unless defined?( Arborist )
 require 'msgpack'
 
+require 'arborist' unless defined?( Arborist )
+require 'arborist/tree_api'
+
 
 # Unified Arborist Manager client for both the Tree and Event APIs
 class Arborist::Client
@@ -30,10 +32,10 @@ class Arborist::Client
 	public
 	######
 
-	# The ZMQ URI required to speak to the Arborist tree API.
+	# The ZeroMQ URI required to speak to the Arborist tree API.
 	attr_accessor :tree_api_url
 
-	# The ZMQ URI required to speak to the Arborist event API.
+	# The ZeroMQ URI required to speak to the Arborist event API.
 	attr_accessor :event_api_url
 
 
@@ -87,7 +89,7 @@ class Arborist::Client
 
 	### Return the manager's current status as a hash.
 	def make_status_request
-		return self.pack_message( :status )
+		return Arborist::TreeAPI.request( :status )
 	end
 
 
@@ -105,13 +107,13 @@ class Arborist::Client
 		header[:from] = from if from
 		header[:depth] = depth if depth
 
-		return self.pack_message( :list, header )
+		return Arborist::TreeAPI.request( :list, header )
 	end
 
 
 	### Return the manager's current node tree.
-	def fetch( criteria={}, **args )
-		request = self.make_fetch_request( criteria, **args )
+	def fetch( criteria={}, options={} )
+		request = self.make_fetch_request( criteria, **options )
 		return self.send_tree_api_request( request )
 	end
 
@@ -122,7 +124,7 @@ class Arborist::Client
 		header[ :include_down ] = true if include_down
 		header[ :return ] = properties if properties != :all
 
-		return self.pack_message( :fetch, header, [ criteria, exclude ] )
+		return Arborist::TreeAPI.request( :fetch, header, [ criteria, exclude ] )
 	end
 
 
@@ -136,7 +138,7 @@ class Arborist::Client
 
 	### Update the identified nodes in the manager with the specified data.
 	def make_update_request( data )
-		return self.pack_message( :update, nil, data )
+		return Arborist::TreeAPI.request( :update, nil, data )
 	end
 
 
@@ -144,7 +146,7 @@ class Arborist::Client
 	def subscribe( **args )
 		request = self.make_subscribe_request( **args )
 		response = self.send_tree_api_request( request )
-		return response.first
+		return response['id']
 	end
 
 
@@ -156,7 +158,7 @@ class Arborist::Client
 		header[ :identifier ] = identifier if identifier
 		header[ :event_type ] = event_type
 
-		return self.pack_message( :subscribe, header, [ criteria, exclude ] )
+		return Arborist::TreeAPI.request( :subscribe, header, [ criteria, exclude ] )
 	end
 
 
@@ -172,7 +174,7 @@ class Arborist::Client
 	def make_unsubscribe_request( subid )
 		self.log.debug "Making unsubscribe request for subid: %s" % [ subid ]
 
-		return self.pack_message( :unsubscribe, subscription_id: subid )
+		return Arborist::TreeAPI.request( :unsubscribe, subscription_id: subid )
 	end
 
 
@@ -188,7 +190,7 @@ class Arborist::Client
 	def make_prune_request( identifier )
 		self.log.debug "Making prune request for identifier: %s" % [ identifier ]
 
-		return self.pack_message( :prune, identifier: identifier )
+		return Arborist::TreeAPI.request( :prune, identifier: identifier )
 	end
 
 
@@ -213,7 +215,7 @@ class Arborist::Client
 			type:       type
 		}
 
-		return self.pack_message( :graft, header, attributes )
+		return Arborist::TreeAPI.request( :graft, header, attributes )
 	end
 
 
@@ -229,7 +231,7 @@ class Arborist::Client
 	def make_modify_request( identifier, attributes={} )
 		self.log.debug "Making modify request for identifer: %s" % [ identifier ]
 
-		return self.pack_message( :modify, {identifier: identifier}, attributes )
+		return Arborist::TreeAPI.request( :modify, {identifier: identifier}, attributes )
 	end
 
 
@@ -237,12 +239,12 @@ class Arborist::Client
 	### unsuccessful response, and return the response body.
 	def send_tree_api_request( request )
 		self.log.debug "Sending request: %p" % [ request ]
-		self.tree_api.send( request )
+		request.send_to( self.tree_api )
 
-		res = self.tree_api.recv
+		res = CZTop::Message.receive_from( self.tree_api )
 		self.log.debug "Received response: %p" % [ res ]
 
-		header, body = self.unpack_message( res )
+		header, body = Arborist::TreeAPI.decode( res )
 		unless header[ 'success' ]
 			raise "Arborist manager said: %s" % [ header['reason'] ]
 		end
@@ -255,26 +257,7 @@ class Arborist::Client
 	# Utility methods
 	#
 
-	### Format ruby +data+ for communicating with the Arborist manager.
-	def pack_message( verb, *data )
-		header = data.shift || {}
-		body   = data.shift
-
-		header.merge!( action: verb, version: API_VERSION )
-
-		self.log.debug "Packing message; header: %p, body: %p" % [ header, body ]
-
-		return MessagePack.pack([ header, body ])
-	end
-
-
-	### De-serialize an Arborist manager response.
-	def unpack_message( msg )
-		return MessagePack.unpack( msg )
-	end
-
-
-	### Return a ZMQ REQ socket connected to the manager's tree API, instantiating
+	### Return a ZeroMQ REQ socket connected to the manager's tree API, instantiating
 	### it if necessary.
 	def tree_api
 		return @tree_api ||= self.make_tree_api_socket
@@ -284,10 +267,7 @@ class Arborist::Client
 	### Create a new ZMQ REQ socket connected to the manager's tree API.
 	def make_tree_api_socket
 		self.log.info "Connecting to the tree socket %p" % [ self.tree_api_url ]
-		sock = Arborist.zmq_context.socket( :REQ )
-		sock.connect( self.tree_api_url )
-
-		return sock
+		return CZTop::Socket::REQ.new( self.tree_api_url )
 	end
 
 
@@ -301,10 +281,7 @@ class Arborist::Client
 	### Create a new ZMQ SUB socket connected to the manager's event API.
 	def make_event_api_socket
 		self.log.info "Connecting to the event socket %p" % [ self.event_api_url ]
-		sock = Arborist.zmq_context.socket( :SUB )
-		sock.connect( self.event_api_url )
-
-		return sock
+		return CZTop::Socket::SUB.new( self.event_api_url )
 	end
 
 end # class Arborist::Client