liveresource 2.0.0

data/.gitignore

@@ -0,0 +1 @@
+*~

data/BSDL

@@ -0,0 +1,24 @@
+Copyright (C) 2010-2012 Spectra Logic. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+
+2. 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.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.

data/COPYING

@@ -0,0 +1,59 @@
+LiveResource is copyrighted free software by Spectra Logic
+<public@joshcarter.com>. You can redistribute it and/or modify it
+under either the terms of the 2-clause BSDL (see the file BSDL), or
+the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+          modifications to Usenet or an equivalent medium, or by
+          allowing the author to include your modifications in the
+          software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software
+          distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+	        together with instructions (in the manual page or
+	        equivalent) on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+			 	  the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/GPL

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/README.md

@@ -0,0 +1,289 @@
+LiveResource 2
+==============
+
+LiveResource is a framework for coordinating processes, statuses, and
+messaging within a distributed system. It provides the following
+abilities:
+
+* Call methods on objects in other threads and processes, locally or
+  on remote machines. Synchronous and asynchronous calling supported,
+  arguments and return values are serialized, exceptions are also
+  propagated back to the caller.
+
+* Set attributes that other threads and processes can see.
+
+These support a variety of use models, for example:
+
+* Web application (Rails, Sinatra, etc.) which needs to gather state
+  from multiple places and render it on a web page. The app should
+  never block for long in its render path, so it needs to pull the
+  state *right now*. Daemons that know the state may be busy (blocked
+  on IO, for example), so they should *push* state into LiveResource
+  when they can, and let the GUI pull it when needed.
+
+* Processes that need to call into another process to do a job. Any
+  process can search the list of resources by resource class, either
+  looking for a specific instance by name, grabbing any, or iterating
+  over all of them. It can call methods synchronously, looking just
+  like a Ruby method call, or async and check for the result later.
+
+LiveResource is built for Ruby and is designed to be familiar to Ruby
+programmers. It uses terms which are as Ruby-esque as possible instead
+of borrowing from other domains (pub/sub, RMI, and so forth).
+
+The underlying tools, however, are available to any language: Redis is
+the hub for communications, and all objects are stored with YAML
+encoding. Ports to other languages would be straightforward (and may
+be forthcoming).
+
+**NOTE: LiveResource 2 introduces significant improvements in its API,
+but breaks compatibility with versions 1.x. The older API is
+maintained on the `stable-1` branch.**
+
+## Requirements
+
+LiveResource requires:
+
+* Ruby 1.9.3 or JRuby in 1.9 mode (`export JRUBY_OPTS=--1.9`).
+
+* [Redis 2.2+.](http://redis.io/) server. (Redis 1.x does not support commands needed by LiveResource.)
+
+* [redis-rb](https://github.com/ezmobius/redis-rb) gem.
+
+## Attributes
+
+Here's a resource with an attribute:
+
+    class FavoriteColor
+      include LiveResource::Resource
+
+      # Set up resource class and instance naming			
+      resource_class :favorite_color
+      resource_name :object_id
+
+      # Declare remote attributes
+      remote_writer :favorite
+    end
+    
+    resource = FavoriteColor.new
+    resource.favorite = "blue"
+
+This resource demonstrates several points:
+
+* LiveResource features are defined in the Resource modules -- you can
+  add LiveResource features to existing classes with little effort.
+
+* "Remote" Attributes are defined much like Ruby's attributes:
+  `remote_reader`, `remote_writer`, and `remote_accessor` are used to
+  automatically create methods for reading and writing a given
+  attribute.
+
+* LiveResource instances have both a class and a name, making your
+  remote interface look just like a normal Ruby object API. (When you
+  don't care about naming, tell LiveResource to assign names based on
+  `:object_id`.)
+
+* By default, LiveResource connects to a Redis server at
+  `localhost:6379`, but you can change any Redis client parameters you
+  need to.
+
+Now let's access the above-published favorite color:
+
+    r = LiveResource::any(:favorite_color)
+    r.favorite # --> "blue"
+
+LiveResource includes the finders `find`, `any`, and `all`. The object
+returned is a *proxy* for the real resource, which could be in a
+different process or on a whole different machine.
+
+Note that attributes can be set to any Ruby objects; they are
+automatically marshaled using YAML. (If you want to create a
+LiveResource interface in another programming language, you just need
+a Redis client and YAML.)
+
+## Attribute Read-Modify-Write
+Reading an attribute is an atomic operation; so is writing one. However, sometimes you need to read,
+modify, and write an attribute or set of attributes as an atomic operation.  LiveResource provides a
+special notation for that:
+
+    class FavoriteColor
+      include LiveResource::Resource 
+
+      # Set up resource class and instance naming			
+      resource_class :favorite_color
+      resource_name :object_id
+
+      remote_accessor :old_favorite
+      remote_accessor :favorite
+
+      # Update favorite color to anything except the currently-published
+      # favorite. Also save off the old favorite.
+      def update_favorite
+        colors = ['red', 'blue', 'green']
+
+        remote_attribute_modify(:old_favorite, :favorite) do |attribute, value|
+          # Value of block will become the new value of the given attribute.
+          if attribute == :old_favorite
+            # Make the old_favorite our current favorite
+            self.favorite
+          else
+            # Choose a new favorite
+            colors.delete(current_favorite)
+            colors.shuffle.first
+          end
+        end
+      end
+
+The method `remote_attribute_modify` takes the attribute(s) to modify (as symbols) and a block. The block is
+provided the attribute name and the current value of the attribute; the ending value of the block
+becomes the new attribute value.
+
+Rather than perform locking on an attribute (which would slow down *all* reads and writes), LiveResource performs *optimistic locking* thanks to features in Redis. If the value of the attribute changes while the `remote_attribute_modify` block is executing, LiveResource simply replays the block with the changed value. This preserves the performance of attribute read/write and eliminates potential deadlocks.
+
+As a consequence, however, the **block passed to `remote_attribute_modify` should not change external state that relies on the block only executing once.**
+
+## Methods
+
+Attributes are good for publishing state information, but how do you
+*interact* with a resource? LiveResource provides actor-like method
+calling from one object to another. Like attributes, it works great
+across processes and machines. An example:
+
+    #
+    # Running in process A
+    #
+    class MathResource
+      include LiveResource::Resource
+
+      remote_class :math
+      remote_name :object_id
+
+      def divide(dividend, divisor)
+        raise ArgumentError.new("cannot divide by zero") if divisor == 0
+        dividend / divisor
+      end
+    end
+
+    # Creating an instances starts its method dispatcher thread.
+    MathResource.new
+    sleep
+
+    # 
+    # Running in processs B
+    #
+    m = LiveResource::any(:math)
+    m.divide(10, 5) # --> 2
+    m.divide(1, 0)  # --> raises ArgumentError
+
+The resource does not need to explicitly declare its remote methods;
+any public methods are automatically remote-callable. (Methods of
+superclasses, however, are not remoted.) When an instance is created,
+a thread is also created to service remote method calls.
+
+When you get a resource proxy (as in process B above) there are a
+couple ways to call a remote method:
+
+* Just call the method exactly as-is, like `divide(...)`, which blocks
+  the calling thread until the resource responds. If the resource's
+  method raises an exception, LiveResource's method dispatcher traps
+  the exception, serializes it, and the exception is raised in the
+  caller's thread.
+
+* Call asynchronously in a fire-and-forget matter by adding an
+  exclamation point to the end of the method name, like
+  `divide!(...)`, with the downside of not being able to get a
+  response.
+
+* Call asynchronously and get the return value later by adding a
+  question mark to the end of the method name, like `divide?(...)`,
+  which we'll discuss shortly.
+
+### Call Method and Check Value Later
+
+There are many times when blocking on a remote method isn't
+acceptable. Continuing the above example, here's how to fire off the
+method and come back for the result later:
+
+    m = LiveResource::any(:math)
+    m.divide?(10, 5)
+    # .. do something else ..
+    m.value # may block, then --> 2
+
+    m.divide?(15, 5)
+    m.done? # --> true or false
+    # .. time elapses ..
+    m.done? # --> true
+    m.value # will not block --> 3
+
+    m.divide?(20, 5)
+    m.value(10) # wait up to 10 seconds, then --> 4
+
+The return value from question-mark form `method?` calls is a Future,
+which allows both polling, blocking, and block-with-timeout
+conventions.
+
+### Forwarding Methods
+
+TODO: needs documentation. In the meantime, refer to
+`test/method_forward_continue_test.rb`.
+
+## Configuring the Redis Client
+
+LiveResource will try to connect to Redis at `localhost` and its
+default port, 6379. If you need to change that, or any other client
+parameters, just assign a new Redis client.
+
+    LiveResource::RedisClient.redis = Redis.new(hostname: 'machine-c.local')
+
+## Missing LiveResource 1.x Features
+
+Some features from 1.x have not been brought to 2.0 yet.
+
+### Attribute Publish/Subscribe
+
+NOTE: attribute pub/sub from LiveResource 1 is not currently supported
+in LiveResource 2. It was never used within Spectra Logic, so it may
+be dropped.
+
+## To-Do
+
+(This section is my to-do list for future versions of LiveResource. -jdc)
+
+* More formally specify and test edge-case behaviors, for example:
+
+  - Getting/setting attributes that don't exist.
+
+  - Forward/continue with methods that fail, methods that time out
+    because no resource is available.
+
+  - Startup order problems with resources and clients of them. Any way
+    allow clients to wait and retry?
+
+  - Serialize exceptions in a less Ruby-specific manner.
+
+  - Merge exception backtrace properly. (ResourceProxy#wait_for_done)
+
+* Benchmarking: try multiple redis clients
+
+* Tools/Debugging:
+
+  - Text/graphical resource monitor/explorer
+
+  - Logging: allow runtime logging level changes (possibly via built-in remote method)
+
+  - Logging: syslog setup
+
+* Finish rdoc, test to make sure it looks right.
+
+## License / Copying
+
+See the file `COPYING`.
+
+## License / Copying
+
+See the file `COPYING`.
+
+## Contributors
+
+LiveResource is brought to you by Josh Carter, Mark von Minden, and
+Rob Grimm of Spectra Logic.