evented-memcache-client 1.0.0

data/README

@@ -0,0 +1,75 @@
+= INTRODUCTION
+
+Evented Memcache Client is a memcache client written for Ruby's
+EventMachine.  It implements a full (though simple) memcache client.
+
+= INSTALLATION
+
+You'll need eventmachine:
+
+        sudo gem install eventmachine
+
+Then:        
+
+        sudo gem install evented-memcache-client
+
+Naturally a running memcache or starling is needed too.  I use
+starling:
+
+        sudo gem install starling
+        sudo starling -p 12345
+
+= USAGE
+
+Here is a producer:
+
+  require 'rubygems'
+  require 'eventmachine'
+  require 'evented-memcache-client'
+
+  callbacks = {
+    :open => Proc.new { |conn|
+      conn.set(:key => 'x', :data => Time.now.to_s)
+    },
+    :stored => Proc.new { |conn, data, args|
+      puts "Stored a value"
+      EventMachine::stop
+    },
+  }
+  EventMachine::run {
+    EventMachine::connect('127.0.0.1',
+                          12345,
+                          EventMachine::Protocols::Memcache::Client,
+                          callbacks)
+  }
+
+And here is a consumer:
+
+  require 'rubygems'
+  require 'eventmachine'
+  require 'evented-memcache-client'
+
+  callbacks = {
+    :open => Proc.new { |conn|
+      puts 'Opened connection.  Fetching...'
+      conn.get(:key => 'x')
+    },
+    :value => Proc.new { |conn, data, args|
+      key       = args[0]
+      flags     = args[1]
+      puts "Received message: '#{data}'"
+      puts 'Fetching more...'
+      conn.get(:key => 'x')
+    }
+  }
+  EventMachine::run {
+    EventMachine::connect('127.0.0.1',
+                          12345,
+                          EventMachine::Protocols::Memcache::Client,
+                          callbacks)
+  }
+
+= TODO
+
+Needs a test suite.
+

data/Rakefile

@@ -0,0 +1,123 @@
+#############################################################################
+#
+# $Id$
+#
+# Author:: Colin Steele (colin@colinsteele.org)
+# Homepage::  
+# 
+#----------------------------------------------------------------------------
+#
+#      Copyright (C) 2008 by Colin Steele. All Rights Reserved.
+#                        colin@colinsteele.org
+# 
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of either: 1) 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; or 2) Ruby's License.
+# 
+# See the file COPYING for complete licensing information.
+#
+#---------------------------------------------------------------------------
+#
+# 
+#############################################################################
+
+$:.unshift(File.dirname(__FILE__) + "/lib")
+
+require 'evented-memcache-client'
+require 'rubygems'
+require 'rake'
+require 'rubyforge'
+
+PKG_NAME		= "evented-memcache-client"
+PKG_VERSION 		= EventMachine::Protocols::Memcache::VERSION
+RUBYFORGE_GROUP_ID	= 'ev-memcache-cli'
+RUBYFORGE_PKG_NAME	= 'ev-memcache-cli'
+
+Gem::manage_gems
+require 'rake/testtask'  
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+task :default => [:test]
+
+desc "Create a new gem and install it" 
+task(:setup => :package) do
+  puts %x[cd pkg;pwd;sudo -p "Password:" gem install evented-memcache-client-#{PKG_VERSION}.gem]
+end
+
+desc "Recreate the CHANGELOG" 
+task(:changelog) do
+  rm 'CHANGELOG', :force => true
+  File.open('CHANGELOG', 'w') { |f|
+      f.puts "#"
+      f.puts "# This file is automatically generated using 'rake changelog'"
+      f.puts "#"
+  }
+  puts %x[git log --pretty --name-only >> CHANGELOG]
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*.rb']
+end
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README"
+  rd.rdoc_files.include("README", 'COPYING', "lib/**/*.rb", "extras/**/*")
+  rd.rdoc_dir = 'doc'
+  rd.title    = "Evented Memcache Client"
+  rd.options << '--line-numbers'
+  rd.options << '--inline-source'
+  rd.options << '--main' << 'README'
+end
+  
+spec = Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.author = "Colin Steele"
+  s.email = "colin@colinsteele.org"
+  s.homepage = "http://www.colinsteele.org/emc"
+  s.summary = "Eventmachine-based Memcache client"
+  s.files = Rake::FileList["{extras,lib,doc}/**/*"].to_a
+  s.require_path = "lib"
+  s.test_files = Rake::FileList["{test}/**/*test.rb"].to_a
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "COPYING", "Rakefile", "CHANGELOG"]
+  s.add_dependency("eventmachine", ">= 0.12.0")
+  s.rubyforge_project = 'ev-memcache-cli'
+  s.description = <<EOF
+A memcache client built on EventMachine.
+EOF
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+desc 'Package and upload the release to rubyforge.'
+task :release => [:clobber_package, :package] do |t|
+    v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
+    abort "Versions don't match #{v} vs #{version}" if v != PKG_VERSION
+    pkg = "pkg/#{PKG_NAME}-#{v}"
+    
+    if $DEBUG then
+      puts "release_id = rf.add_release #{rubyforge_name.inspect}, #{name.inspect}, #{version.inspect}, \"#{pkg}.tgz\""
+      puts "rf.add_file #{rubyforge_name.inspect}, #{name.inspect}, release_id, \"#{pkg}.gem\""
+    end
+
+    rf = RubyForge.new.configure
+    puts "Logging in"
+    rf.login
+
+    c = rf.userconfig
+    c["release_notes"] = spec.description if spec.description
+    # c["release_changes"] = spec.changes if spec.changes
+    c["preformatted"] = true
+
+    p files = ["#{pkg}.tgz", "#{pkg}.zip", "#{pkg}.gem"]
+    puts "Releasing #{PKG_NAME} v. #{v}"
+    rf.add_release RUBYFORGE_GROUP_ID, RUBYFORGE_PKG_NAME, v, *files
+end

data/doc/classes/EventMachine.html

@@ -0,0 +1,146 @@
+<?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>Module: EventMachine</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="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">EventMachine</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/evented-memcache-client_rb.html">
+                lib/evented-memcache-client.rb
+                </a>
+        <br />
+                <a href="../files/lib/evented_memcache_client/client_rb.html">
+                lib/evented_memcache_client/client.rb
+                </a>
+        <br />
+                <a href="../files/lib/evented_memcache_client/connectable_rb.html">
+                lib/evented_memcache_client/connectable.rb
+                </a>
+        <br />
+                <a href="../files/lib/evented_memcache_client/connection_rb.html">
+                lib/evented_memcache_client/connection.rb
+                </a>
+        <br />
+                <a href="../files/lib/evented_memcache_client/sender_rb.html">
+                lib/evented_memcache_client/sender.rb
+                </a>
+        <br />
+                <a href="../files/lib/evented_memcache_client/server_rb.html">
+                lib/evented_memcache_client/server.rb
+                </a>
+        <br />
+                <a href="../files/lib/evented_memcache_client/tenacious_rb.html">
+                lib/evented_memcache_client/tenacious.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <table>
+<tr><td valign="top">Author:</td><td>Colin Steele (colin@colinsteele.org)
+
+</td></tr>
+</table>
+<p>
+Homepage::
+</p>
+
+    </div>
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Module <a href="EventMachine/Protocols.html" class="link">EventMachine::Protocols</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- 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/classes/EventMachine/Protocols.html

@@ -0,0 +1,135 @@
+<?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>Module: EventMachine::Protocols</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="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">EventMachine::Protocols</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/evented-memcache-client_rb.html">
+                lib/evented-memcache-client.rb
+                </a>
+        <br />
+                <a href="../../files/lib/evented_memcache_client/client_rb.html">
+                lib/evented_memcache_client/client.rb
+                </a>
+        <br />
+                <a href="../../files/lib/evented_memcache_client/connectable_rb.html">
+                lib/evented_memcache_client/connectable.rb
+                </a>
+        <br />
+                <a href="../../files/lib/evented_memcache_client/connection_rb.html">
+                lib/evented_memcache_client/connection.rb
+                </a>
+        <br />
+                <a href="../../files/lib/evented_memcache_client/sender_rb.html">
+                lib/evented_memcache_client/sender.rb
+                </a>
+        <br />
+                <a href="../../files/lib/evented_memcache_client/server_rb.html">
+                lib/evented_memcache_client/server.rb
+                </a>
+        <br />
+                <a href="../../files/lib/evented_memcache_client/tenacious_rb.html">
+                lib/evented_memcache_client/tenacious.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Module <a href="Protocols/Memcache.html" class="link">EventMachine::Protocols::Memcache</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- 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>