symphony 0.3.0.pre20140327204419

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a18ff1610ed82fd8b70b2101553dd540b0855e7
+  data.tar.gz: 13658dcf21296bcb6fc7094cb68fddb263ace02f
+SHA512:
+  metadata.gz: dccd19e742e0817f2de1a8555490aa193f20abde32ea2ecc120b330d1edc5fed2ee511ecbd6097ecd692af1c55b2e1e5028dcd1b7c1040429f6509db875b2049
+  data.tar.gz: 33c92a0f1a2a84b13982a25321af137b0c445d9ac2950372568066fcd4e8329e51af5be0ac5646408940cf32b047be7208b6124ca38604969eb916b63508e3da

data/.simplecov

@@ -0,0 +1,9 @@
+# Simplecov config
+
+SimpleCov.start do
+	add_filter 'spec'
+	add_filter 'integration'
+	add_group "Needing tests" do |file|
+		file.covered_percent < 90
+	end
+end

data/ChangeLog

@@ -0,0 +1,508 @@
+2014-03-17  Mahlon E. Smith  <mahlon@laika.com>
+
+	* USAGE.rdoc:
+	English, do you speak it?
+	[7297d2999838] [tip]
+
+2014-03-17  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* README.rdoc, USAGE.rdoc, lib/symphony/routing.rb:
+	Clean up the README a little, add a USAGE document (that may evolve
+	into a manual later), and allow the #on method in the routing plugin
+	to accept an array of binding topics.
+	[694dfa71528f] [github/master]
+
+2014-03-15  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* Manifest.txt, Rakefile, experiments/mailer_task.rb,
+	lib/symphony/tasks/messaging.rb:
+	Require a recent rubygems to fix a metriks issue with the hitimes
+	dependency. Remove accidentally committed messaging task, a (nearly)
+	empty mailer experiment, and an internal rdoc server location.
+	[8b74abf2494f]
+
+2014-03-14  Michael Granger  <ged@FaerieMUD.org>
+
+	* experiments/ps-publisher.rb:
+	Add an example publisher with some interestingish test data
+	[b671046cb46a]
+
+	* lib/symphony/tasks/auditor.rb,
+	lib/symphony/tasks/failure_logger.rb,
+	lib/symphony/tasks/simulator.rb:
+	Explicitly name queues, clean up the simple task types
+	[9be720b141c5]
+
+	* lib/symphony/queue.rb:
+	Simplify the queue configuration
+	[506e35c44fb7]
+
+	* lib/symphony/routing.rb:
+	Fix routing mixin
+	[0e1a756a8c72]
+
+	* .autotest, Manifest.txt, bin/gctask, bin/gcworkerd,
+	bin/symphony, bin/symphony-task,
+	lib/symphony/task.rb, lib/symphony/tasks/simulator.rb:
+	Checkpoint of work on timeout; renamed binaries
+	[6b0655dc6892]
+
+	* .rvm.gems, Rakefile, lib/symphony/metrics.rb,
+	lib/symphony/routing.rb, lib/symphony/task.rb,
+	lib/symphony/tasks/auditor.rb,
+	lib/symphony/tasks/failure_logger.rb,
+	lib/symphony/tasks/simulator.rb:
+	Checkpoint before adding timeout
+	[c1a33bbb4490]
+
+2014-03-13  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/symphony/queue.rb, lib/symphony/signal_handling.rb,
+	lib/symphony/task.rb:
+	Implement task restart on SIGHUP
+	[1b4d965d8d48]
+
+	* .hgignore:
+	Ignore logfiles
+	[9a8bf7a02a7b]
+
+	* lib/symphony/tasks/auditor.rb,
+	lib/symphony/tasks/failure_logger.rb,
+	lib/symphony/tasks/simulator.rb:
+	Add some basic task types: work simulator, audit logger, failure
+	logger
+	[49b034c13f78]
+
+	* etc/config.yml.example:
+	Add an example config
+	[970e15eafad9]
+
+2014-03-12  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* lib/symphony/queue.rb:
+	Retain the exchange -> queue binding for pre-existing queues.
+	[bc11d76f7ef7]
+
+2014-03-12  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/symphony/queue.rb, lib/symphony/task.rb,
+	lib/symphony/tasks/auditor.rb:
+	Checkpoint commit of AMQP work
+	[3ec6040c9e98]
+
+	* lib/symphony/queue.rb:
+	Use a class-instance variable instead of thread-local for AMQP
+	objects
+	[6401e5aedf57]
+
+	* lib/symphony/queue.rb:
+	Re-raise errors from Bunny while handling messages
+	[384ab73d9b7f]
+
+2014-03-11  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/symphony/queue.rb, lib/symphony/task.rb,
+	lib/symphony/tasks/auditor.rb,
+	spec/symphony/queue_spec.rb:
+	Checkpoint of work on work model, subscription
+	[b023dab4997c]
+
+	* .hgignore, History.rdoc, Manifest.txt, Rakefile, bin/gctask,
+	lib/symphony/daemon.rb, lib/symphony/queue.rb,
+	lib/symphony/signal_handling.rb, lib/symphony/task.rb,
+	lib/symphony/tasks/auditor.rb,
+	lib/symphony/tasks/messaging.rb,
+	spec/symphony/mixins_spec.rb, spec/symphony/queue_spec.rb,
+	spec/symphony/task_spec.rb, spec/symphony_spec.rb:
+	Checkpoint commit.
+	[e86edf8ff23c]
+
+2014-03-03  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems, Rakefile, experiments/mailer_task.rb,
+	lib/symphony/queue.rb, lib/symphony/task.rb,
+	lib/symphony/tasks/pinger.rb, spec/symphony/queue_spec.rb,
+	spec/symphony/task_spec.rb, spec/helpers.rb:
+	Checkpoint of the work from this morning
+	[5c8021195e16]
+
+2014-02-18  Michael Granger  <ged@FaerieMUD.org>
+
+	* .pryrc, .rvm.gems, .rvmrc, .simplecov, Manifest.txt, README.rdoc,
+	Rakefile, bin/gcworkerd, experiments/.foreman, experiments/Procfile,
+	experiments/consumer-sketch.rb, experiments/mailer_task.rb,
+	experiments/producer-sketch.rb, experiments/ssh_system.rb,
+	experiments/test_script.sh, lib/symphony.rb,
+	lib/symphony/daemon.rb, lib/symphony/mixins.rb,
+	lib/symphony/queue.rb, lib/symphony/signal_handling.rb,
+	lib/symphony/task.rb, lib/symphony/tasks/pinger.rb,
+	lib/symphony/tasks/ssh.rb,
+	lib/symphony/tasks/sshscript.rb, lib/laika/symphony.rb,
+	lib/laika/symphony/job.rb, lib/laika/symphony/queue.rb,
+	lib/laika/symphony/task.rb,
+	lib/laika/symphony/tasks/pinger.rb,
+	lib/laika/symphony/tasks/ssh.rb,
+	lib/laika/symphony/tasks/sshscript.rb,
+	lib/laika/symphony/worker.rb,
+	spec/symphony/mixins_spec.rb, spec/symphony/queue_spec.rb,
+	spec/symphony_spec.rb, spec/helpers.rb,
+	spec/laika/symphony/job_spec.rb,
+	spec/laika/symphony/queue_spec.rb,
+	spec/laika/symphony/task_spec.rb,
+	spec/laika/symphony_spec.rb,
+	spec/lib/symphonyconstants.rb,
+	spec/lib/symphonyhelpers.rb:
+	Checkpoint of the weekend's work
+	[4d3da7e3530b]
+
+2012-11-06  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems, Rakefile:
+	Bump dependencies
+	[c3602949056c]
+
+2012-10-17  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems:
+	Bump the laika-ldap version in the RVM gemset
+	[03934b446cbf]
+
+2012-10-09  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems:
+	Bump laika-ldap version in rvm gems
+	[314934c7b53c]
+
+2012-09-24  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/laika/symphony/tasks/sshscript.rb:
+	Adding a 'nocleanup' option to the sshscript task class.
+
+	This is to enable easy troubleshooting; just re-run a failing
+	sshscript-based task with 'nocleanup' enabled, then the script will
+	be preserved on the remote side after it runs.
+	[0b84cb38b9ec]
+
+2012-09-19  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.1.0 for changeset 3027c0e32c9a
+	[7615c18e3f34]
+
+	* .hgsigs:
+	Added signature for changeset 34b213a4b895
+	[3027c0e32c9a] [v0.1.0]
+
+	* History.rdoc, lib/laika/symphony.rb,
+	spec/laika/symphony/job_spec.rb:
+	Bump the minor version, update history.
+	[34b213a4b895]
+
+	* bin/gcworkerd, lib/laika/symphony/task.rb,
+	lib/laika/symphony/worker.rb:
+	Adding beginnings of worker throttling.
+	[399117e719ba]
+
+	* .rvm.gems, Rakefile:
+	Updating dependencies
+	[9ea265531f5c]
+
+2012-09-06  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.0.1 for changeset 82d1fc26369f
+	[c438bca87c28]
+
+	* .hgsigs:
+	Added signature for changeset ea9a4eb4ef02
+	[82d1fc26369f] [v0.0.1]
+
+	* Manifest.txt, bin/symphony:
+	Remove the bin/symphony stub.
+	[ea9a4eb4ef02]
+
+2012-08-20  Michael Granger  <ged@FaerieMUD.org>
+
+	* bin/gcworkerd:
+	Use the configured path to the config file, not the one from ARGV
+	[2e635ab669f0]
+
+	* bin/gcworkerd:
+	Configure gcworkerd via command-line options instead of the config
+	file
+	[797bd5264597]
+
+	* bin/gcworkerd:
+	Fix gem binary invocation.
+	[e113c95b9f39]
+
+	* lib/laika/symphony.rb, lib/laika/symphony/task.rb:
+	Documentation update/fixes
+	[e169ebcecff7]
+
+2012-08-18  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems, Rakefile:
+	Bump laika-base dependency
+	[a66a334650d2]
+
+	* lib/laika/symphony/tasks/sshscript.rb:
+	Turn off ssh protocol debugging in sshscript task
+	[a7a23ebb2927]
+
+2012-08-17  Michael Granger  <ged@FaerieMUD.org>
+
+	* README.rdoc:
+	README fix
+	[20aae4ccec08]
+
+	* lib/laika/symphony/tasks/ssh.rb:
+	Small fixes for ssh task:
+
+	- Use features
+	- Use the fqdn instead of the simple hostname for the ssh command
+	- Log the command shelljoined for easy testing.
+	[59ce700da89b]
+
+2012-08-16  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/laika/symphony/queue.rb, lib/laika/symphony/worker.rb:
+	Logging tweaks to Queues and Workers
+	[07abd8d84699]
+
+	* lib/laika/symphony/tasks/sshscript.rb:
+	Write sshscripts to local /tmp instead of (possibly network) homedir
+	[02c3cb736d43]
+
+	* bin/gcworkerd:
+	Fix select() to not poll in gcworkerd
+	[081f8b6c55cc]
+
+	* .rvm.gems, bin/gcworkerd, spec/laika/symphony/queue_spec.rb,
+	spec/laika/symphony/task_spec.rb:
+	Convert specs to use the update setup_test_database().
+	[bcb8893fbd6a]
+
+	* .rvm.gems, Rakefile:
+	Updating dependencies.
+	[a230af71e731]
+
+	* lib/laika/symphony/job.rb,
+	spec/laika/symphony/job_spec.rb:
+	Explicitly serialize Job#task_options instead of relying on the
+	flaky serialization plugin.
+	[54c014ed337b]
+
+	* lib/laika/symphony/worker.rb:
+	Refactor the child part of Symphony::Worker.start into methods
+	[89621596bf88]
+
+2012-08-15  Michael Granger  <ged@FaerieMUD.org>
+
+	* experiments/producer-sketch.rb, lib/laika/symphony.rb,
+	lib/laika/symphony/job.rb, lib/laika/symphony/queue.rb,
+	lib/laika/symphony/task.rb,
+	lib/laika/symphony/tasks/pinger.rb,
+	lib/laika/symphony/tasks/ssh.rb,
+	lib/laika/symphony/tasks/sshscript.rb,
+	spec/laika/symphony/queue_spec.rb,
+	spec/laika/symphony/task_spec.rb:
+	More work on the Job and Task classes.
+
+	- Simplified job/task arguments to always be a hash of options,
+	renamed to task_options to reflect this.
+	- Pulled some utility methods up from concrete Task classes for
+	pinging remote hosts, expanding hostnames to fqdns, etc.
+	- Refactored existing base task types to use the new refactored
+	methods.
+	[6ae7216e907e]
+
+2012-08-15  Mahlon E. Smith  <mahlon@laika.com>
+
+	* bin/gcworkerd, lib/laika/symphony/job.rb,
+	lib/laika/symphony/task.rb,
+	lib/laika/symphony/tasks/pinger.rb,
+	lib/laika/symphony/tasks/ssh.rb:
+	Checkpoint of yesterday's work.
+	[b46ef27c763e]
+
+2012-08-13  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/laika/symphony/tasks/sshscript.rb:
+	Whitespace fixes
+	[c08e4416dfd7]
+
+2012-08-07  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgignore, .rvm.gems, Rakefile, lib/laika/symphony/task.rb,
+	spec/laika/symphony/task_spec.rb,
+	spec/lib/symphonyhelpers.rb:
+	Add a spec to cover Task#on_error.
+	[cfa2126c2879]
+
+2012-08-06  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgignore, README.rdoc, Rakefile, bin/gcworkerd, experiments
+	/producer-sketch.rb, experiments/test_script.sh,
+	lib/laika/symphony/job.rb, lib/laika/symphony/queue.rb,
+	lib/laika/symphony/task.rb,
+	lib/laika/symphony/tasks/pinger.rb,
+	lib/laika/symphony/tasks/ssh.rb,
+	lib/laika/symphony/tasks/sshscript.rb,
+	lib/laika/symphony/worker.rb:
+	Documentation and consistency updates.
+
+	- Wrote initial API docs for Task, Worker, Job, and Queue.
+	- Updated the pinger side of the producer sketch, and then rewrote the
+	sshscript side to use Queue#add.
+	- Renamed Pinger#unavailable to #problem.
+	- Consolidated SSHScript task logic to its #run method for easier
+	inheritance/consistency.
+	[f0a7bfc7ea6a]
+
+	* bin/gcworkerd:
+	Remove more debugging noise
+	[aa04b9a1590b]
+
+2012-08-02  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems, Manifest.txt, Rakefile, lib/laika/symphony/job.rb,
+	lib/laika/symphony/queue.rb,
+	lib/laika/symphony/tasks/sshscript.rb,
+	lib/laika/symphony/worker.rb:
+	Finish up the initial implementation of the ssh-based task classes.
+	[5d9192bcfb71]
+
+	* bin/gcworkerd:
+	Remove the explicit debug logging from gcworkerd
+	[2d52fc8a521c]
+
+	* experiments/producer-sketch.rb, experiments/test_script.sh:
+	Update the producer experiment to use the ssh-script task
+	[80a0d6635300]
+
+	* lib/laika/symphony/tasks/ssh.rb:
+	Use Ruby1.9 spawn instead of Open3 for the SSH task's pipe
+	[d6ab8ee0d6cc]
+
+	* lib/laika/symphony/tasks/pinger.rb:
+	Fix require in Pinger task
+	[dd2170ed86d3]
+
+	* experiments/ssh_system.rb:
+	Adding an experiment
+	[2f8a6c7173e0]
+
+	* bin/gcworkerd:
+	Fixed child cleanup in the gcworkerd (pair: mahlon)
+	[40d2447fd704]
+
+2012-08-02  Mahlon E. Smith  <mahlon@laika.com>
+
+	* experiments/producer-sketch.rb, lib/laika/symphony/queue.rb,
+	lib/laika/symphony/tasks/pinger.rb,
+	lib/laika/symphony/tasks/ssh.rb,
+	lib/laika/symphony/tasks/sshscript.rb:
+	Checkpoint commit of ssh Symphony tasks.
+	[dff259b79441]
+
+2012-07-31  Mahlon E. Smith  <mahlon@laika.com>
+
+	* bin/gcworkerd, experiments/producer-sketch.rb,
+	lib/laika/symphony/job.rb, lib/laika/symphony/queue.rb,
+	lib/laika/symphony/task.rb,
+	lib/laika/symphony/tasks/pinger.rb,
+	lib/laika/symphony/worker.rb,
+	spec/laika/symphony/job_spec.rb,
+	spec/laika/symphony/task_spec.rb:
+	Small, misc updates:
+
+	 - Small whitespace and comment fixes.
+		- Alter the producer sketch to accept a single host.
+		- Remove the #on_startup API requirement for tasks -- there may not be
+	any setup a task needs to perform, so it seems odd to make that
+	mandatory.
+		- Small display fix for task class names.
+		- Finished up the pinger example task.
+		- Ensure jobs are destroyed/removed on script errors
+	[1ca5aaeb1ed7]
+
+2012-07-30  Michael Granger  <ged@FaerieMUD.org>
+
+	* bin/gcworkerd, lib/laika/symphony/worker.rb:
+	Remove spammy debugging; set application name
+	[90b8cd19faa7]
+
+	* bin/gcworkerd, lib/laika/symphony/worker.rb:
+	Fix signal-handling in gcworkerd
+	[34509c739e1b]
+
+	* .rvm.gems, bin/gcworkerd, lib/laika/symphony.rb,
+	lib/laika/symphony/job.rb, lib/laika/symphony/queue.rb,
+	lib/laika/symphony/task.rb,
+	lib/laika/symphony/tasks/pinger.rb,
+	lib/laika/symphony/worker.rb,
+	spec/laika/symphony/job_spec.rb,
+	spec/laika/symphony/task_spec.rb:
+	Adding first whack at gcworkerd and Task class
+	[3ea444e5997d]
+
+2012-07-27  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems, Rakefile, bin/gcworkerd, experiments/consumer-sketch.rb,
+	experiments/producer-sketch.rb, lib/laika/symphony.rb,
+	lib/laika/symphony/job.rb, lib/laika/symphony/queue.rb,
+	lib/laika/symphony/task.rb,
+	lib/laika/symphony/tasks/pinger.rb,
+	spec/laika/symphony/job_spec.rb,
+	spec/laika/symphony/queue_spec.rb,
+	spec/laika/symphony/task_spec.rb:
+	Snapshot of Thursday's work.
+	[e8da1957a10d]
+
+2012-07-26  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems, Rakefile, experiments/consumer-sketch.rb, experiments
+	/producer-sketch.rb, lib/laika/symphony/job.rb,
+	lib/laika/symphony/queue.rb:
+	Fix queueing logic and update the experiments
+	[7a3609d96123]
+
+2012-07-25  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgignore, .rvm.gems, .tm_properties, Manifest.txt,
+	experiments/.foreman, experiments/Procfile, experiments/consumer-
+	sketch.rb, experiments/producer-sketch.rb, experiments/sketch.rb,
+	lib/laika/symphony.rb, lib/laika/symphony/job.rb,
+	lib/laika/symphony/queue.rb,
+	spec/laika/symphony/job_spec.rb,
+	spec/laika/symphony/queue_spec.rb:
+	Checkpoint commit of afternoon's work (pair: mhix)
+	[501304e7ae7b]
+
+	* experiments/sketch.rb, lib/laika/symphony.rb,
+	lib/laika/symphony/job.rb, lib/laika/symphony/queue.rb,
+	spec/laika/symphony/job_spec.rb,
+	spec/laika/symphony_spec.rb,
+	spec/lib/symphonyconstants.rb,
+	spec/lib/symphonyhelpers.rb:
+	Checkpoint commit of morning's work (pair: mhix)
+	[8cea2906f4fa]
+
+	* .pryrc:
+	Updating pryrc
+	[69a954ee8bb9]
+
+	* .rvm.gems, .rvmrc, Rakefile:
+	Bumping laika-db dependency version
+	[f2cff3435f39]
+
+2012-07-24  Michael Granger  <ged@FaerieMUD.org>
+
+	* .autotest, .hgignore, .irbrc, .pryrc, History.rdoc, Manifest.txt,
+	README.rdoc, Rakefile, bin/symphony,
+	lib/laika/symphony.rb, spec/laika/symphony_spec.rb,
+	spec/lib/symphonyconstants.rb,
+	spec/lib/symphonyhelpers.rb:
+	Initial project boilerplate
+	[99fbce8884cd]

data/History.rdoc

@@ -0,0 +1,15 @@
+== v0.3.0 []
+
+Rewritten for AMQP (and possibly other similar message buses)
+
+
+== v0.1.0 [2012-09-19] Michael Granger <ged@FaerieMUD.org>
+
+- Added beginnings of worker throttling.
+- Updating dependencies
+
+
+== v0.0.1 [2012-07-24] Michael Granger <mgranger@laika.com>
+
+Initial release.
+

data/Manifest.txt

@@ -0,0 +1,30 @@
+.simplecov
+ChangeLog
+History.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+TODO.md
+USAGE.rdoc
+bin/symphony
+bin/symphony-task
+etc/config.yml.example
+lib/symphony.rb
+lib/symphony/daemon.rb
+lib/symphony/metrics.rb
+lib/symphony/mixins.rb
+lib/symphony/queue.rb
+lib/symphony/routing.rb
+lib/symphony/signal_handling.rb
+lib/symphony/task.rb
+lib/symphony/tasks/auditor.rb
+lib/symphony/tasks/failure_logger.rb
+lib/symphony/tasks/pinger.rb
+lib/symphony/tasks/simulator.rb
+lib/symphony/tasks/ssh.rb
+lib/symphony/tasks/sshscript.rb
+spec/symphony/mixins_spec.rb
+spec/symphony/queue_spec.rb
+spec/symphony/task_spec.rb
+spec/symphony_spec.rb
+spec/helpers.rb

data/README.rdoc

@@ -0,0 +1,89 @@
+= symphony
+
+wiki:: http://bitbucket.org/ged/symphony
+docs:: http://deveiate.org/code/symphony
+
+
+== Description
+
+Symphony is a subscription-based asynchronous job system. It
+allows you to define jobs that watch for lightweight events from a
+distributed-messaging AMQP broker, and do work based on their payload.
+
+It includes several executables under bin/:
+
+symphony::
+  A daemon which manages startup and shutdown of one or more Workers
+  running Tasks as they are published from a queue.
+
+symphony-task::
+  A wrapper that runs a single task, useful for testing, or if you don't
+  require the process management that the symphony daemon provides.
+
+
+== Synopsis
+
+	class WorkerTask < Symphony::Task
+		# Process all events
+		subscribe_to '#'
+
+		def work( payload, metadata )
+			puts "I got a payload! %p" % [ payload ]
+			return true
+		end
+	end
+
+
+For a more detailed description of usage, please refer to the USAGE document.
+
+
+== Installation
+
+    gem install symphony
+
+
+== Contributing
+
+You can check out the current development source with Mercurial via its
+{project page}[http://bitbucket.org/ged/symphony]. Or if you prefer Git, via 
+{its Github mirror}[https://github.com/ged/symphony].
+
+After checking out the source, run:
+
+    $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the API documentation.
+
+
+== License
+
+Copyright (c) 2011-2014, Michael Granger and Mahlon E. Smith
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author/s, nor the names of the project's
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+