jerbil 1.2.2

data/Bugs.rdoc

@@ -0,0 +1,66 @@
+== Bugs
+
+====31-Jan-2012
+
+* a client that does not respond to a verify can hang jerbil! Is it possible
+  put a timeout on?
+
+10-01-2012
+
+sclient will strip out log options when getting its own! Need to change this or add
+an option in Jellog to not strip them.
+
+01-Dec-2011
+
+JerbilService::Client should be relaxed about config options!
+
+Nov-2011
+
+Nasty race condition where remote server deletes registering service from its local 
+server, so everyone knows about a service except the local server! (Should be fixed in 0.2.12)
+
+09-Sep-2011
+
+There is no checking that services registered locally have the same hostname as the
+server. Should not be an issue, but did cause problems during testing.
+
+There is no way of directing a client or service to a particular jerbil server. Should
+only be relevant to testing, could add a :jerbil_config key to the options hash when calling
+get_server, which would always return nil if it had not been set anyway. (Addressed)
+
+05-Sep-2011
+
+When a server assumes control of a missing service because the server is not there, it fails
+to delete its own copy! And when the missing server resumes, it cannot delete the un-deleted
+service because it does not have the right key for that service anymore.
+
+Colored success response for jerbl -v would be a big benefit
+
+01-Aug-2011
+
+1. service-missing is not working as expected. Needs to be tested to see what happens 
+when a server is ungracefully removed. May need to change logic from removing services
+to removing servers. - See above
+
+2. Need to add client config file for jerbil to avoid having readable files everywhere.
+
+23-June-2011
+
+jerbil -V reports the number of times a service has been accessed through the local server.
+Would be good to share all counts across all servers somehow?
+
+17-Apr-2011
+
+If you run jerbil -v on a remote server it appears to remove a service but the removal fails.
+This is because it tries to remove the service locally. Also, if a server disappears then
+the other servers still think the service is available. They need to remove the service manually if
+that is the case!
+
+Fixed in 0.1.0
+------
+17-May-2011
+
+Would be good to hide the key check in a private function: check_key(key) rather than
+expose the underlying mechanism
+
+Also change key to pkey for private key parameters

data/Gemfile

@@ -0,0 +1,12 @@
+# @markup ruby
+#
+# general utilities
+gem 'netaddr'
+gem 'term-ansicolor'
+gem 'thor'
+gem 'daemons'
+
+# jerbil-related utilities
+gem 'jellog', '>=1.0.14' # for logging
+gem 'jeckyl', '>=0.2.7' # for config files
+gem 'jeni', '>=0.2.3' # for installation

data/History.txt

@@ -0,0 +1,359 @@
+# @markup rdoc
+# @title Change Log
+# @author Robert Sharp
+
+==History
+
+[jerbil-1.2.2 21-Nov-2012]
+
+  Add proper home for jerbil user in jerbil-install. Add guidance on logging to READMEs.
+
+[jerbil-1.2.1 13-Nov-2012]
+
+  Minor bugs fixed in sbin/jerbild and runscript updated to su to jerbil user
+
+[jerbil-1.2.0 12-Nov-2012]
+
+  Housekeeping release with unwanted modules/code removed and documentation tidied for
+  release into wild (evenutally).
+
+[jerbil-1.1.3 22-Sep-2012]
+
+  Add some instrumentation to jserviced to help troubleshoot the numbat runscript.
+
+[jerbil-1.1.2 06-Sep-2012]
+
+  Update runscript to create /var/run/jermine if not already there. 3.0+ kernels
+  appear to use /run on tmpfs
+
+[jerbil-1.1.1 24-Aug-2012]
+
+  Take out the -m option from the su command - no need to preserve any environment
+
+[jerbil-1.1.0 24-Aug-2012]
+
+  Change jservice to use su again as this seems more reliable than changing the user
+  internally. Also add logging to verify calls.
+
+[jerbil-1.0.19 22-Aug-2012]
+
+  add log_daemon to stop and status services
+
+[jerbil-1.0.18 22-Aug-2012]
+
+  Daemons expects STDOUT to be open, so ensure it is!
+
+[jerbil-1.0.17 22-Aug-2012]
+
+  Fix daemon opts that depended on starting a logger
+
+[jerbil-1.0.16 22-Aug-2012]
+
+  Fix problem with log-opts being deleted and not there a second time round
+
+[jerbil-1.0.15 22-Aug-2012]
+
+  Tweaks to sclient.rb to fix daemon problems or help uncover them at least
+
+[jerbil-1.0.14 22-Aug-2012]
+
+  Set log_daemon to true in sbin/jserviced
+
+[jerbil-1.0.13 22-Aug-2012]
+
+  Add log_daemon capability to init files
+
+[jerbil-1.0.12 22-Aug-2012]
+
+  Add log_daemon capability to sbin/jserviced
+
+[jerbil-1.0.11 20-Aug-2012]
+
+  added defaults to key and pid directories in jerbil_service/config
+
+[jerbil-1.0.10 20-Aug-2012]
+
+  fixed cut-and-paste errors in changing group
+
+[jerbil-1.0.9 20-Aug-2012]
+
+  fixed Chuser calls in sbin/jerbild
+
+[jerbil-1.0.8 17-Aug-2012]
+
+  fix another typo in config
+
+[jerbil-1.0.7 17-Aug-2012]
+
+  add require 'etc' to config
+
+[jerbil-1.0.6 17-Aug-2012]
+
+  Fix bug in change_group
+
+[jerbil-1.0.5 17-Aug-2012]
+
+  Provide a separate group parameter cos changing user does not do all the groups
+
+[jerbil-1.0.4 17-Aug-2012]
+
+  Silently ignore register remote and remove remote if the key is invalid to allow 
+  co-existence with pre-1.0 versions
+
+[jerbil-1.0.3 15-Aug-2012]
+
+  Ensure only valid servers are remembered during start-up.
+
+[jerbil-1.0.2 15-Aug-2012]
+
+  Add a catchall for connecting to older servers
+  
+[jerbil-1.0.1 15-Aug-2012]
+
+  Add NoMethodError as a reason why calls tp older servers may fail.
+  
+[jerbil-1.0.0 15-Aug-2012]
+
+  Release of new version, featuring server discovery, the new jservice scripts to start
+  any service, increased reliability, improved jerbil command and other minor changes.
+
+[jerbil-0.99.13 26-Jul-2012]
+
+  Reworked remote server logic to ensure duplicate servers and services are purged
+
+[jerbil-0.99.12 25-Jul-2012]
+
+  further annotations
+
+[jerbil-0.99.11 25-Jul-2012]
+
+  Annotated to help debug key issues
+
+[jerbil-0.99.10 25-Jul-2012]
+
+  jerbil/jerbil_service/client requires server instead of servers
+
+[jerbil-0.99.09 25-Jul-2012]
+
+  Fix typo when adding services from remote server
+
+[jerbil-0.99.08 25-Jul-2012]
+
+  Fix error in thor services verify
+
+[jerbil-0.99.07 24-Jul-2012]
+
+  another release candidate with tweaks to sbin scripts.
+
+[jerbil-0.99.06 23-Jul-2012]
+
+  minor tweaks to config files for installation
+
+[jerbil-0.99.05 23-Jul-2012]
+
+  fixed Etc.getpwnam.name
+
+[jerbil-0.99.04 23-Jul-2012]
+
+  fixed Jerbil::Config to inherit JerbilService::Config
+
+[jerbil-0.99.03 23-Jul-2012]
+
+  Release candidate for testing
+
+[jerbil-0.99.02 12-June-2012]
+
+  Fix mistaken call to get_key, now gone
+
+[jerbil-0.99.01 08-June-2012]
+
+  First pre-release of Jerbil 1.0.0, offering flexible server configuration and a single
+  script for controlling services.
+  
+  * reconfigured options to use Jeckyl::Service and to add net address and mask details
+  * renamed Jerbil::ServerRecord to Jerbil::Servers to reflect the role of the class
+
+[jerbil-0.2.21 19-May-2012]
+
+  Added Aurelius to the default files and rename jers to jerbil
+
+[jerbil-0.2.20 28-Apr-2012]
+
+  Annotate the client calls to try to understand the NoMethod errors raised
+
+[jerbil-0.2.19 22-Mar-2012]
+
+  Fix a bug where 1.9 was failing cos instance_methods returns symbols instead of
+  strings.
+
+jerbil-0.2.18 23-Dec-2011
+
+Some refactoring and ensuring exception backtraces have newlines and not \n between
+them!
+
+jerbil-0.2.17 19-Dec-2011
+
+Attempt to fix error when stopping services: cannot read symbol as string. Assume that
+it is caused by :jerbil_config option. It Worked!
+
+jerbil-0.2.16 19-Dec-2011
+
+Restart logging after daemon is called
+
+jerbil-0.2.15 19-Dec-2011
+
+Change supervisor to catch StandardError and let SystemExit fall through untouched.
+Add opts to log output from daemonize
+
+jerbil-0.2.14 19-Dec-2011
+
+improvements to supervisor class to add daemon log and catch errors more often
+
+jerbil-0.2.12 27-Nov-2011
+
+Attempt to fix bug where restarting service with old records on other servers 
+removes new service's record on own server!
+
+jerbil-0.2.11 25-Sep-2011
+
+Set default config file to be module.rb rather than module.conf
+
+jerbil-0.2.10 24-Sep-2011
+
+thor actions: check that a link exists before testing it is equal
+
+jerbil-0.2.9 24-Sep-2011
+
+Add separate re-useable thor module for common install actions
+
+jerbil-0.2.8 21-Sep-2011
+
+Update jerbs install to ensure files are moved to the correct place
+
+jerbil-0.2.7 21-Sep-2011
+
+Add 'etc' to gemspec
+
+jerbil-0.2.6 21-Sep-2011
+
+Include new jerbs command based on thor, and change Jerbil.remove so that it
+attempts to remove a service from remote servers even if it is not registered
+locally.
+
+jerbil-0.2.5 17-Sep-2011
+
+Adjust RUBYOPT etc in runscript
+
+jerbil-0.2.4 17-Sep-2011
+
+Add chmod to install
+
+jerbil-0.2.3 17-Sep-2011
+
+Correct runscript!
+
+jerbil-0.2.2 17-Sep-2011
+
+Correct uid in jerbs install
+
+jerbil-0.2.1 17-Sep-2011
+
+Adds in the jerbs executable, being a prospective replacement for bin/jerbil using thor
+and including an install command
+
+jerbil-0.2.0 08-Sep-2011
+
+Migrate to Jellog 1.0
+Add colour to jerbil listings
+Fix bug in missing_service that failed to remove from local server
+Add test to see if prior registered service is responding and kick it if it is not
+
+jerbil-0.1.12 04-Aug-2011
+
+ensure that jerbild daemon creates things in a defined directory.
+delete pid and key files before trying to open them in case of permissions problems.
+
+jerbil-0.1.11 02-Aug-2011
+
+Included logging in jerbild to avoid whatever caused the daemonised version to fail.
+Change default config file for jerbil to jerbil-client.conf.
+
+jerbil-0.1.10 09-June-2011
+
+Minor fix for incorrect exception names in jerbil/support
+
+jerbil-0.1.9 01-June-2011
+
+correct version method to respond with Jerbil::Version and add to output of bin/jerbil -S
+
+jerbil-0.1.8 01-June-2011
+
+Added back the verify method to JerbilService::Client!
+
+jerbil-0.1.7 31-May-2011
+
+Update to JerbilService::Client to refactor and redesign the interface to remove use of
+evals that would otherwise compromise security
+
+jerbil-0.1.6 30-May-2011
+
+Add option to JerbilService::Base to not set $SAFE > 0 where subclass needs to set it later
+
+jerbil-0.1.5 17-May-2011
+
+Added a backtrace to Supervisor to help debug!
+
+jerbil-0.1.4 17-May-2011
+
+Added the service_key method to Client to make it easier to get the key for the service
+
+jerbil-0.1.3 17-May-2011
+
+Added a log entry for invalid service keys
+
+jerbil-0.1.2 17-May-2011
+
+Added a check_key method to JerbilService::Base to hide key checking.
+Cleaned up some unnecessary system logging in jerbil.
+
+jerbil-0.1.1 02-May-2011
+
+Minor changes to Client
+
+jerbil-0.1.0 2-May-2011
+
+Second release with a substantial number of changes and tweaks.
+
+jerbil-0.0.8 17-Apr-2011
+
+Further tweaks to initscript install option
+
+jerbil-0.0.7 17-Apr-2011
+
+Tweak to init script for install option
+
+jerbil-0.0.6 17-Apr-2011
+
+Fixed a few more typos and added install to init script
+
+jerbil-0.0.5 16-Apr-2011
+
+Fixed mess up in sbin/jerbild to get real local host server record
+
+jerbil-0.0.4 16-Apr-2011
+
+Minor changes to init scripts and correct spelling mistake on daemonize
+
+jerbil-0.0.3a 16-Apr-2011
+
+Initial release for system level testing only.
+
+
+jerbil-0.0.2 1-Apr-2011
+
+Made a few insignificant changes today
+and that is all
+
+jerbil-0.0.1 1-Apr-2011
+
+Initial create, but never tagged!

data/Intro.txt

@@ -0,0 +1,5 @@
+Provides an Object Request Broker and service framework for ruby-based services.
+Jerbil servers run on each machine in the system and share information on registering
+services. A parent class for services hides all of the jerbil interactions and client
+and supervisor modules hide interactions from scripts or applications interacting
+with these services.

data/LICENCE.rdoc

@@ -0,0 +1,159 @@
+Copyright (c) 2011 Robert Sharp
+
+This software is licensed for use under the Open Software Licence v. 3.0
+The terms of this licence can be found at http://www.opensource.org/licenses/osl-3.0.php
+and below. Under the terms of this licence, all derivative works
+must themselves be licensed under the Open Software Licence v. 3.0
+
+Open Source Initiative OSI - The Open Software Licence 3.0:Licensing
+[OSI Approved Licence]
+Open Software Licence ("OSL") v. 3.0
+
+This Open Software Licence (the "Licence") applies to any original work of authorship
+(the "Original Work") whose owner (the "Licensor") has placed the following licensing
+notice adjacent to the copyright notice for the Original Work:
+
+Licensed under the Open Software Licence version 3.0
+
+1) Grant of Copyright Licence. Licensor grants You a worldwide, royalty-free, non-exclusive,
+sublicensable license, for the duration of the copyright, to do the following:
+
+a) to reproduce the Original Work in copies, either alone or as part of a collective work;
+
+b) to translate, adapt, alter, transform, modify, or arrange the Original Work, thereby
+creating derivative works ("Derivative Works") based upon the Original Work;
+
+c) to distribute or communicate copies of the Original Work and Derivative Works to
+the public, with the proviso that copies of Original Work or Derivative Works that
+You distribute or communicate shall be licensed under this Open Software Licence;
+
+d) to perform the Original Work publicly; and
+
+e) to display the Original Work publicly.
+
+2) Grant of Patent Licence. Licensor grants You a worldwide, royalty-free, non-exclusive,
+sublicensable license, under patent claims owned or controlled by the Licensor that are
+embodied in the Original Work as furnished by the Licensor, for the duration of the
+patents, to make, use, sell, offer for sale, have made, and import the Original Work
+and Derivative Works.
+
+3) Grant of Source Code Licence. The term "Source Code" means the preferred form of
+the Original Work for making modifications to it and all available documentation
+describing how to modify the Original Work. Licensor agrees to provide a machine-readable
+copy of the Source Code of the Original Work along with each copy of the Original Work
+that Licensor distributes. Licensor reserves the right to satisfy this obligation by
+placing a machine-readable copy of the Source Code in an information repository reasonably
+calculated to permit inexpensive and convenient access by You for as long as Licensor
+continues to distribute the Original Work.
+
+4) Exclusions From Licence Grant. Neither the names of Licensor, nor the names of
+any contributors to the Original Work, nor any of their trademarks or service marks,
+may be used to endorse or promote products derived from this Original Work without
+express prior permission of the Licensor. Except as expressly stated herein, nothing
+in this Licence grants any license to Licensor's trademarks, copyrights, patents,
+trade secrets or any other intellectual property. No patent license is granted to
+make, use, sell, offer for sale, have made, or import embodiments of any patent claims
+other than the licensed claims defined in Section 2. No license is granted to the
+trademarks of Licensor even if such marks are included in the Original Work. Nothing
+in this Licence shall be interpreted to prohibit Licensor from licensing under terms
+different from this Licence any Original Work that Licensor otherwise would have a
+right to license.
+
+5) External Deployment. The term "External Deployment" means the use, distribution,
+or communication of the Original Work or Derivative Works in any way such that the
+Original Work or Derivative Works may be used by anyone other than You, whether those
+works are distributed or communicated to those persons or made available as an application
+intended for use over a network. As an express condition for the grants of license hereunder,
+You must treat any External Deployment by You of the Original Work or a Derivative Work
+as a distribution under section 1(c).
+
+6) Attribution Rights. You must retain, in the Source Code of any Derivative Works
+that You create, all copyright, patent, or trademark notices from the Source Code of
+the Original Work, as well as any notices of licensing and any descriptive text identified
+therein as an "Attribution Notice." You must cause the Source Code for any Derivative Works
+that You create to carry a prominent Attribution Notice reasonably calculated to inform
+recipients that You have modified the Original Work.
+
+7) Warranty of Provenance and Disclaimer of Warranty. Licensor warrants that the copyright
+in and to the Original Work and the patent rights granted herein by Licensor are owned by
+the Licensor or are sublicensed to You under the terms of this Licence with the permission
+of the contributor(s) of those copyrights and patent rights. Except as expressly stated in
+the immediately preceding sentence, the Original Work is provided under this Licence on an
+"AS IS" BASIS and WITHOUT WARRANTY, either express or implied, including, without limitation,
+the warranties of non-infringement, merchantability or fitness for a particular purpose.
+THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL WORK IS WITH YOU. This DISCLAIMER OF WARRANTY
+constitutes an essential part of this Licence. No license to the Original Work is granted
+by this Licence except under this disclaimer.
+
+8) Limitation of Liability. Under no circumstances and under no legal theory, whether
+in tort (including negligence), contract, or otherwise, shall the Licensor be liable
+to anyone for any indirect, special, incidental, or consequential damages of any character
+arising as a result of this Licence or the use of the Original Work including, without
+limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction,
+or any and all other commercial damages or losses. This limitation of liability shall not
+apply to the extent applicable law prohibits such limitation.
+
+9) Acceptance and Termination. If, at any time, You expressly assented to this Licence,
+that assent indicates your clear and irrevocable acceptance of this Licence and all of its
+terms and conditions. If You distribute or communicate copies of the Original Work or a
+Derivative Work, You must make a reasonable effort under the circumstances to obtain the
+express assent of recipients to the terms of this Licence. This Licence conditions your
+rights to undertake the activities listed in Section 1, including your right to create
+Derivative Works based upon the Original Work, and doing so without honoring these
+terms and conditions is prohibited by copyright law and international treaty. Nothing
+in this Licence is intended to affect copyright exceptions and limitations (including
+"fair use" or "fair dealing"). This Licence shall terminate immediately and You may no
+longer exercise any of the rights granted to You by this Licence upon your failure to
+honor the conditions in Section 1(c).
+
+10) Termination for Patent Action. This Licence shall terminate automatically and
+You may no longer exercise any of the rights granted to You by this Licence as of
+the date You commence an action, including a cross-claim or counterclaim, against
+Licensor or any licensee alleging that the Original Work infringes a patent. This
+termination provision shall not apply for an action alleging patent infringement
+by combinations of the Original Work with other software or hardware.
+
+11) Jurisdiction, Venue and Governing Law. Any action or suit relating to this Licence
+may be brought only in the courts of a jurisdiction wherein the Licensor resides or
+in which Licensor conducts its primary business, and under the laws of that jurisdiction
+excluding its conflict-of-law provisions. The application of the United Nations Convention
+on Contracts for the International Sale of Goods is expressly excluded. Any use of
+the Original Work outside the scope of this Licence or after its termination shall be
+subject to the requirements and penalties of copyright or patent law in the appropriate
+jurisdiction. This section shall survive the termination of this Licence.
+
+12) Attorneys' Fees. In any action to enforce the terms of this Licence or seeking
+damages relating thereto, the prevailing party shall be entitled to recover its costs
+and expenses, including, without limitation, reasonable attorneys' fees and costs
+incurred in connection with such action, including any appeal of such action. This
+section shall survive the termination of this Licence.
+
+13) Miscellaneous. If any provision of this Licence is held to be unenforceable,
+such provision shall be reformed only to the extent necessary to make it enforceable.
+
+14) Definition of "You" in This Licence. "You" throughout this Licence, whether in
+upper or lower case, means an individual or a legal entity exercising rights under,
+and complying with all of the terms of, this Licence. For legal entities, "You" includes
+any entity that controls, is controlled by, or is under common control with you. For
+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.
+
+15) Right to Use. You may use the Original Work in all ways not otherwise restricted or
+conditioned by this Licence or by law, and Licensor promises not to interfere with or be
+responsible for such uses by You.
+
+16) Modification of This Licence. This Licence is Copyright © 2005 Lawrence Rosen.
+Permission is granted to copy, distribute, or communicate this Licence without modification.
+Nothing in this Licence permits You to modify this Licence as applied to the Original Work
+or to Derivative Works. However, You may modify the text of this Licence and copy, distribute
+or communicate your modified version (the "Modified Licence") and apply it to other original
+works of authorship subject to the following conditions: (i) You may not indicate in any way
+that your Modified Licence is the "Open Software Licence" or "OSL" and you may not use those
+names in the name of your Modified Licence; (ii) You must replace the notice specified in the
+first paragraph above with the notice "Licensed under <insert your license name here>" or
+with a notice of your own that is not confusingly similar to the notice in this Licence;
+and (iii) You may not claim that your original works are open source software unless your
+Modified Licence has been approved by Open Source Initiative (OSI) and You comply with
+its license review and certification process.