RubyGems - boogaloo - Versions diffs - 0.1 - Mend

boogaloo 0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (57) hide show

data/CHANGELOG +2 -0
data/DEBUGGING +4 -0
data/MIT-LICENSE +7 -0
data/README +106 -0
data/RUNNING_UNIT_TESTS +5 -0
data/Rakefile +44 -0
data/bin/boogaloo +159 -0
data/doc/classes/Boogaloo.html +149 -0
data/doc/classes/Boogaloo/Cache.html +121 -0
data/doc/classes/Boogaloo/Cache/Base.html +664 -0
data/doc/classes/Boogaloo/Cache/Persistent.html +122 -0
data/doc/classes/Boogaloo/Cache/Temporary.html +439 -0
data/doc/classes/Boogaloo/Client.html +111 -0
data/doc/classes/Boogaloo/Client/Connection.html +228 -0
data/doc/classes/Boogaloo/Config.html +540 -0
data/doc/classes/Boogaloo/ServiceGateway.html +176 -0
data/doc/classes/Boogaloo/ServiceRequest.html +210 -0
data/doc/classes/Boogaloo/ThreadPool.html +205 -0
data/doc/classes/Boogaloo/WorkerThread.html +239 -0
data/doc/created.rid +1 -0
data/doc/files/DEBUGGING.html +113 -0
data/doc/files/MIT-LICENSE.html +129 -0
data/doc/files/README.html +261 -0
data/doc/files/examples/boogaloo_conf.html +130 -0
data/doc/files/lib/boogaloo/cache/base_rb.html +101 -0
data/doc/files/lib/boogaloo/cache/persistent_rb.html +108 -0
data/doc/files/lib/boogaloo/cache/temporary_rb.html +101 -0
data/doc/files/lib/boogaloo/client/connection_rb.html +101 -0
data/doc/files/lib/boogaloo/config_rb.html +109 -0
data/doc/files/lib/boogaloo/service_gateway_rb.html +110 -0
data/doc/files/lib/boogaloo/service_request_rb.html +108 -0
data/doc/files/lib/boogaloo/thread_pool_rb.html +101 -0
data/doc/files/lib/boogaloo/util_rb.html +240 -0
data/doc/files/lib/boogaloo/version_rb.html +114 -0
data/doc/files/lib/boogaloo/worker_thread_rb.html +101 -0
data/doc/fr_class_index.html +38 -0
data/doc/fr_file_index.html +41 -0
data/doc/fr_method_index.html +67 -0
data/doc/index.html +24 -0
data/doc/rdoc-style.css +208 -0
data/examples/boogaloo.conf +17 -0
data/lib/boogaloo/cache/base.rb +222 -0
data/lib/boogaloo/cache/persistent.rb +15 -0
data/lib/boogaloo/cache/temporary.rb +173 -0
data/lib/boogaloo/client/connection.rb +55 -0
data/lib/boogaloo/config.rb +206 -0
data/lib/boogaloo/service_gateway.rb +37 -0
data/lib/boogaloo/service_request.rb +39 -0
data/lib/boogaloo/thread_pool.rb +40 -0
data/lib/boogaloo/util.rb +29 -0
data/lib/boogaloo/version.rb +1 -0
data/lib/boogaloo/worker_thread.rb +46 -0
data/test/test_persistent_cache.rb +99 -0
data/test/test_service_gateway.rb +27 -0
data/test/test_synchronicity.rb +29 -0
data/test/test_temporary_cache.rb +42 -0
metadata +113 -0

data/doc/files/README.html ADDED Viewed

@@ -0,0 +1,261 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: README</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>README</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>README
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Sat Oct 14 00:37:54 BST 2006</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <h1><a href="../classes/Boogaloo.html">Boogaloo</a> Simple Cache Server</h1>
+<p>
+<a href="../classes/Boogaloo.html">Boogaloo</a> is a very simple cache
+server that provides permanent and temporary object persistence, with the
+ability for objects to &quot;expire&quot;. <a
+href="../classes/Boogaloo.html">Boogaloo</a> can also be used for housing
+custom services, such as a registry or specialized cache implementation.
+</p>
+<p>
+<a href="../classes/Boogaloo.html">Boogaloo</a> was initially developed for
+a RubyOnRails application that needed basic persistant object caching
+across multiple web nodes and a mechanism for caching objects related to a
+user temporarily rather than storing them in the session.
+</p>
+<h2>Getting Started</h2>
+<p>
+Caches are created in <a href="../classes/Boogaloo.html">Boogaloo</a> by
+specifying them in the configuration file. For example, to host one
+persistent and one temporary cache, your config may look something like
+this:
+</p>
+<pre>
+  Server:
+    host: localhost
+    port: 7777
+    worker_threads: 3
+  PersistentCaches:
+    MyPersistentCache:
+      instance_name: main_cache
+  TemporaryCaches:
+    MyTempCache:
+      instance_name: temp_cache
+      check_frequency: 10
+</pre>
+<ol>
+<li><tt>instance_name</tt> is the method via which the cache instance will be
+accessed by the client.
+</li>
+<li><tt>check_frequency</tt> is the frequency in seconds at which the cache
+will check for stale objects to delete.
+</li>
+</ol>
+<p>
+An example configuration file can be found in <a
+href="examples/boogaloo_conf.html">examples/boogalooo.conf</a>.
+</p>
+<p>
+Next start the <a href="../classes/Boogaloo.html">Boogaloo</a> server:
+</p>
+<pre>
+  boogaloo -d -f boogaloo.conf
+</pre>
+<p>
+Now on the client we access the caches like this:
+</p>
+<pre>
+  boogaloo_cache = Boogaloo::Client::Connection.new('localhost', 7777, true)
+  boogaloo_cache.main_cache.set(nil, &quot;some_string&quot;, &quot;Hello, World!&quot;)
+  boogaloo_cache.temp_cache.set(nil, &quot;some_string&quot;, &quot;Hello, World!&quot;, 20)
+</pre>
+<p>
+&quot;Hello, World!&quot; will persist for the lifetime of the server in
+<em>main_cache</em>, yet will be deleted in 20 seconds unless touched in
+<em>temp_cache</em>. By &quot;unless touched&quot; we mean that if the
+object is fetched from the cache with get() 10 seconds after being added,
+it&#8217;s expiration time will be reset to 20 seconds from the time it was
+fetched.
+</p>
+<p>
+The boolean value passed into <a
+href="../classes/Boogaloo/Client/Connection.html">Connection</a> tells the
+connection to return nil for all requests if the cache server is offline
+rather than throwing an exception.
+</p>
+<h2>Command Line Options</h2>
+<dl>
+<dt><tt>&#8212;config -c</tt></dt><dd>The configuration file to use.
+</dd>
+<dt><tt>&#8212;daemon -d</tt></dt><dd>Run as a stand-alone process.
+</dd>
+</dl>
+<h2>Custom Services</h2>
+<p>
+You can also use <a href="../classes/Boogaloo.html">Boogaloo</a> to house
+your own custom services. These services can perform any task you want them
+to, all <a href="../classes/Boogaloo.html">Boogaloo</a> cares about is that
+you provide it with an interface to use.
+</p>
+<p>
+Let say we create a new service called <em>MyService</em> and put it in a
+folder called /home/me/BoogalooServices/MyService, the only required file
+is an interface.rb
+</p>
+<pre>
+  module MyService
+    class Interface
+      def initialize(arg1, arg2)
+        self.arg1 = arg1
+        self.arg2 = arg2
+      end
+      def arg1
+        self.arg1
+      end
+      def arg2
+        self.arg2
+      end
+    end
+  end
+</pre>
+<p>
+And then in our configuration file we put something like:
+</p>
+<pre>
+  Services:
+    MyService:
+      instance_name: my_service
+      path: /home/me/BoogalooServices/MyService
+      arguments:
+        - Hello
+        - World
+</pre>
+<p>
+Restart <a href="../classes/Boogaloo.html">Boogaloo</a> and you&#8217;ll
+your service will be available as <em>my_service</em> on the client.
+</p>
+<p>
+<a href="../classes/Boogaloo.html">Boogaloo</a> requires that your
+<em>Interface</em> class is contained within a module with the same name as
+specified in the configuration, in this case its <em>MyService</em>.
+</p>
+<p>
+<a href="../classes/Boogaloo.html">Boogaloo</a> can also manage your
+$LOAD_PATH for you, see the detailed configuration <a
+href="../classes/Boogaloo/Config.html">documentation</a> for more
+information.
+</p>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/files/examples/boogaloo_conf.html ADDED Viewed

@@ -0,0 +1,130 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: boogaloo.conf</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>boogaloo.conf</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>examples/boogaloo.conf
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Sat Oct 14 01:20:51 BST 2006</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+# Example <a href="../../classes/Boogaloo.html">Boogaloo</a> configuration.
+</p>
+<p>
+Server:
+</p>
+<pre>
+  host: localhost
+  port: 7777
+  worker_threads: 3
+</pre>
+<p>
+PersistentCaches:
+</p>
+<pre>
+  MainCache:
+    instance_name: main_cache
+</pre>
+<p>
+TemporaryCaches:
+</p>
+<pre>
+  TempCache:
+    instance_name: temp_cache
+    check_frequency: 10
+</pre>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/files/lib/boogaloo/cache/base_rb.html ADDED Viewed

@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: base.rb</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>base.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/boogaloo/cache/base.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Sat Oct 14 00:22:24 BST 2006</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>