noah 0.0.5 → 0.0.9

data/.gitignore

@@ -5,3 +5,12 @@ coverage.data
 .gem
 pkg/*
 logs/*
+*.class
+tmp/*
+*.war
+.bundle
+warbler/*
+Gemfile.lock
+doc
+.yardoc/*
+examples/log/*

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,213 +1,69 @@
-# Noah testing quickstart
-(make sure redis is running)
-
-## Setup
-There is no specific configuration file in use anymore. Everything is configured via command-line options to the noah binary or stored in config.ru.
-
-   * The instance of Redis is configured via the `REDIS_URL` env setting. This is honored by Ohm.
-   * Redis DSN strings are in the format of "redis://hostname:port/db"
-   * `RACK_ENV` is honored.
-   * `rake sample["redis://localhost:6379/2"]` populates the locally running redis instance - db 2
-   * `rake spec` runs the test suite (using 'redis://localhost:6379/3' for storing test data)
-
-_rake sample_
-
-	Creating Host entry for 'localhost'
-	Create Service entry for redis
-	Create Service entry for noah
-	Creating Application entry for 'noah'
-	Creating Configuration entry for 'noah'
-	Creating sample entries - Host and Service
-	Creating sample entries - Application and Configuration
-	Setup successful!
-
-## Run it
-There are two way to run Noah
-
-### config.ru
-Edit config.ru to change the redis instance or rack environment.
-
-### bin/noah
-The binary script in bin was created using [Vegas](https://github.com/quirkey/vegas). It accepts the familiar rack options as well as an option for specifying the redis url.
-
-	bin/noah -p 9292 -s thin -d -F -e production -r redis://localhost:6379/2
-	[2011-02-07 16:48:15 -0500] Starting 'noah'...
-	[2011-02-07 16:48:15 -0500] trying port 9292...
-	Couldn't get a file descriptor referring to the console
-	[2011-02-07 16:48:15 -0500] Running with Rack handler: Rack::Handler::Thin
-	>> Thin web server (v1.2.7 codename No Hup)
-	>> Maximum connections set to 1024
-	>> Listening on 0.0.0.0:9292, CTRL+C to stop
-
-If you leave off `-F`, all information will be logged to `$HOME/.vegas/noah`. Run `bin/noah -h` for more options.
-
-Please note on JRuby that the port setting does not work for some f'cking reason. Bug claims to have been fixed. Until then, when on Jruby run like so:
-
-  noah -F -d -r redis://localhost:6379/0
-
-## Example links
-[Noah Start Page](http://localhost:9292/)
-
-If you have Noah running, you can hit the above link for some links created by the setup samples.
-
-## All configs
-_curl http://localhost:9292/c/_
-
-	[
-	 {"id":"1",
-	  "name":"db",
-	  "format":"string",
-	  "body":"redis://127.0.0.1:6379/0",
-	  "update_at":"2011-01-17 14:12:43 UTC",
-	  "application":"noah"
-	 }
-	]
-
-## All services
-_curl http://localhost:9292/s/_
-
-	[
-	 {
-	  "id":"1",
-	  "name":"redis",
-	  "status":"up",
-	  "updated_at":"2011-01-17 14:12:43 UTC",
-	  "host":"localhost"
-	 },
-	 {
-	  "id":"2",
-	  "name":"noah",
-	  "status":"up",
-	  "updated_at":"2011-01-17 14:12:43 UTC",
-	  "host":"localhost"
-	 }
-	]
-
-## All hosts
-_curl http://localhost:9292/h/_
-
-	[
-	 {
-	  "id":"1",
-	  "name":"localhost",
-	  "status":"up",
-	  "updated_at":"2011-01-17 14:12:43 UTC",
-	  "services":[
-		      {
-		       "id":"1",
-		       "name":"redis",
-		       "status":"up",
-		       "updated_at":"2011-01-17 14:12:43 UTC",
-		       "host":"localhost"
-		      },
-		      {
-		       "id":"2",
-		       "name":"noah",
-		       "status":"up",
-		       "updated_at":"2011-01-17 14:12:43 UTC",
-		       "host":"localhost"
-		      }
-		     ]
-	 }
-	]
-
-## All applications
-_curl http://localhost:9292/a/_
-
-	[
-	 {
-	  "id":"1",
-	  "name":"noah",
-	  "updated_at":"2011-01-17 14:12:43 UTC"
-	 }
-	]
-
-Most other combinations of endpoints work as well:
-
-* `http://localhost:9292/h/<hostname>/<servicename>` - `<servicename>` on `<hostname>`
-* `http://localhost:9292/a/<appname>/<configname>` - Configuration for `<appname>`
-* `http://localhost:9292/c/<appname>/<element>` - Specific configuration element for `<appname>`
-
-	{
-	 "id":"1",
-	 "name":"db",
-	 "format":"string",
-	 "body":"redis://127.0.0.1:6379/0",
-	 "update_at":"2011-01-17 14:12:43 UTC",
-	 "application":"noah"
-	}
-
-# Adding new entries
-There are two ways to add new objects: via irb and via the [API](https://github.com/lusis/Noah/wiki/Stabilize-API) on a running instance. The API is still in a state of flux.
-
-## Adding a new application and configuration item
-
-	irb -rohm -rohm/contrib -r./lib/noah/models.rb
-
-	a1 = Application.create(:name => 'myapplication')
-	if a1.save
-	  a1.configurations << Configuration.create(:name => 'jsonconfigobj', :format => 'json', :body => '{"configvar1":"foo","configvar2":"bar"}', :application => a1)
-	end
-	JSON.parse(Configuration[2].body)
-
-	{"configvar1"=>"foo", "configvar2"=>"bar"}
-
-## database.yml inside Noah? Sure!
-
-	dbyaml = <<EOY
-	development:
-	  adapter: mysql
-	  database: rails_development
-	  username: root
-	  password: my super secret password
-	EOY
-	a2 = Application.create(:name => 'myrailsapp')
-	if a2.save
-	  a2.configurations << Configuration.create(:name => 'database.yml', :format => 'yaml', :body => dbyaml, :application => a2)
-	end
-	puts YAML.dump(Configuration[3].body)
-
-	development:
-	  adapter: mysql
-	  database: rails_development
-	  username: root
-	  password: my super secret password
-
-# Hosts and Services/Applications and Configurations
-Host/Services and Applications/Configurations are almost the same thing with a few exceptions. Here are some basic facts:
-
-* Hosts have many Services
-* Applications have many Configurations
-* Hosts and Services have a status - `up`,`down` or `pending`
-
-The intention of the `status` field for Hosts and Services is that a service might, when starting up, set the appropriate status. Same goes for said service shutting down. This also applies to hosts (i.e. a curl PUT is sent to Noah during the boot process).
- 
-While an application might have different "configurations" based on environment (production, qa, dev), the Configuration object in Noah is intended to be more holistic i.e. these are the Configuration atoms (a yaml file, property X, property Y) that form the running configuration of an Application.
-
-Here's a holistic example using a tomcat application:
-
-* Host running tomcat comes up. It sets its status as "pending"
-* Each service on the box starts up and sets its status to "pending" and finally "up" (think steps in the init script for the service)
-* Tomcat (now in the role of `Application`) given a single property in a properties file called "bootstrap.url", grabs a list of `Configuration`atoms it needs to run. Let's say, by default, Tomcat starts up with all webapps disabled. Using the `Configuration` item `webapps`, it knows which ones to start up.
-* Each webapp (an application under a different context root) now has the role of `Application` and the role of `Service`. As an application, the webapp would grab things that would normally be stored in a .properties file. Maybe even the log4j.xml file. In the role of `Service`, a given webapp might be an API endpoint and so it would have a hostname (a virtual host maybe?) and services associated with it. Each of those, has a `status`.
-
-That might be confusing and it's a fairly overly-contrived example. A more comon use case would be the above where, instead of storing the database.yml on the server, the Rails application actually reads the file from Noah. Now that might not be too exciting but try this example:
-
-* Rails application with memcached as part of the stack.
-* Instead of a local configuration file, the list of memcached servers is a `Configuration` object belonging to the rails application's `Application` object.
-* As new memcached servers are brought online, your CM tool (puppet or chef) updates Noah
-* Your Rails application either via restarting (and thus rebootstrapping the list of memcached servers from Noah) or using the Watcher subsystem is instantly aware of those servers. You could fairly easily implement a custom Watcher that, when the list of memcached server changes, the Passenger restart file is written.
-
-Make sense?
-
-# Constraints
-You can view all the constraints inside `models.rb` but here they are for now:
-
-* A new host must have at least `name` and `status` set.
-* A new service must have at least `name` and `status` set.
-* Each Host `name` must be unique
-* Each Service `name` per Host must be unique
-* Each Application `name` must exist and be unique
-* Each Configuration name per Application must be unique.
-* Each Configuration must have `name`,`format` and `body`
+# Noah
+Noah is an application registry loosely based on [Apache ZooKeeper](http://zookeeper.apache.org)
 
+What does that mean? From the ZooKeeper Home Page:
+
+> ZooKeeper is a centralized service for maintaining configuration information, naming, providing distributed synchronization, and providing group services. All of these kinds of services are used in some form or another by distributed applications.
+
+Essentially Noah, is a port of those concepts into a stateless RESTful application.
+
+## Quick Start
+The quickstart guide has been moved to the wiki:
+
+[Quick Start Guide](https://github.com/lusis/Noah/wiki/Quick-Start)
+
+## Design Goals
+Noah has a few basic design goals:
+
+* The system **MUST** support RESTful interaction for operations where REST maps properly
+* The system **MUST** support basic concepts of hosts, services, applications and configurations
+* The system **MUST** support horizontal scaling.
+
+Additionally:
+
+* The system **SHOULD** be flexible in deployment options.
+* The system **SHOULD** support watches similar to ZooKeeper
+* The system **SHOULD** support pluggable callbacks for watches.
+* The system **SHOULD** support being a client of itself.
+
+## Opinionated Stack
+Noah is somewhat opinionated in its stack. Noah attempts to minimize the external requirements wherever possible to allow for the widest possible installation options.
+However, excellent work has been done to create performant and well-tested libraries that would be foolish to ignore. To this end, the current requirements are:
+
+* [Redis 2.0](http://redis.io)
+* [Sinatra](http://www.sinatrarb.com)
+* [Ohm/Ohm-Contrib](http://ohm.keyvalue.org)
+* [EventMachine](http://rubyeventmachine.com)
+
+The above stack provides much of the functionality needed to port over ZooKeeper concepts.
+
+### Redis
+Redis is the backbone of the system. Through the native [datatypes](http://redis.io/commands) and [pubsub](http://redis.io/commands#pubsub) capabilities, much of the heavy lifting has already been done.
+
+### Sinatra
+Sinatra is the perfect library for creating API-only style applications. It allows you do focus on the meat of what an endpoint should do instead of the hassle of creating the endpoint.
+
+### Ohm
+Ohm is quite simply the most unobtrusive and flexible orm for Redis. It gets out of the way and allows you to very easily interact directly with Redis if the need arises
+
+### EventMachine
+EventMachine combined with Redis pubsub forms the basis of the Watcher and callback system.
+
+## Motivation
+It's something I've wanted to do for a while. Everytime I've needed something like Zookeeper, Zookeeper has always been too bulky and had too many moving parts. I've also always needed to interact with it from more than just Java or C. Sometimes it's been Ruby and sometimes it's been Python.
+
+In the end, we reinvent the wheel ANYWAY. Maybe we do something like have our CM tool write our application config files with a list of memcached hosts. Maybe we write our own logic around (shudder) RMI to do some chatty broadcasting around the network for finding local nodes of type X. We always reinvent the wheel in some way.
+
+## More information
+Here are a list of some key [wiki](https://github.com/lusis/Noah/wiki) pages:
+
+* [Concepts](https://github.com/lusis/Noah/wiki/Concepts)
+    How Noah views various object types in the system
+* [API](https://github.com/lusis/Noah/wiki/Stablize-API)
+    The API is currently in draft state. It will be finalized before the 1.0 release.
+* [Example Use Cases](https://github.com/lusis/Noah/wiki/Example-Use-Cases)
+    Some use cases for Noah and how it would fit into an existing application or infrastructure
+* [Watchers and Callbacks](https://github.com/lusis/Noah/wiki/Watchers-and-Callbacks)
+    The general idea behind how Noah would implement watches
+* [Watcher/Callback Examples](https://github.com/lusis/Noah/blob/master/examples/README.md)
+    Some example callbacks.