kestrelrb 0.8.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kevin E. Hunt
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,18 @@
+= kestrelrb
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Kevin E. Hunt. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "kestrelrb"
+    gem.summary = %Q{A Ruby interface to Kestrel queues}
+    gem.description = %Q{Kestrel is a queue server written in Scala that runs on the JVM and has a memcached wire API.}
+    gem.email = "kevin@kev.in"
+    gem.homepage = "http://github.com/kevn/kestrelrb"
+    gem.authors = ["Kevin E. Hunt"]
+    gem.add_dependency "memcache-client", ">= 1.7.5"
+    # gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "kestrelrb #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.8.0

data/lib/kestrelrb.rb

@@ -0,0 +1,134 @@
+require 'memcache'
+module Kestrel
+
+  class Queue
+
+    class Unsubscribe < StandardError; end
+
+    SLEEP_DELAY = 0.001 # Seconds to sleep when no messages in queue and GET timeout is 0
+
+    attr_reader :queue_name, :options
+
+    def initialize(queue_name, *args)
+      opts = args.last.is_a?(Hash) ? args.pop : {}
+      @options = validate_queue_options(opts)
+      @queue_name = queue_name
+      servers = args.empty? ? ['localhost:22133'] : args
+      # Instantiate Memcache client with the specified servers and a timeout of 2x the GET timeout
+      @kestrel = MemCache.new(servers, :timeout => timeout * 2)
+    end
+
+    def drop
+      @kestrel.delete(queue_name)
+    end
+    
+    def flush
+      raise NotImplementedError, "FLUSH command is not yet supported."
+      # @kestrel.flush
+    end
+
+    def flush_all
+      @kestrel.flush_all
+    end
+
+    def stats
+      @kestrel.stats
+    end
+
+    def on_error(&block)
+      (@error_handlers ||= []) << block
+    end
+
+    def subscribe(&block)
+      loop do
+        msg = nil
+        begin
+          if msg = get
+            block.call(msg)
+          else
+            sleep SLEEP_DELAY if timeout != 0
+          end
+        rescue Unsubscribe => e
+          break
+        rescue StandardError => e
+          abort if reliable?
+          @error_handlers.each{ |b| b.call(e, msg) } if @error_handlers
+        end
+      end
+    end
+
+    def enqueue(v)
+      @kestrel.set(queue_name, v)
+    end
+
+    def dequeue(raw = false)
+      @kestrel.get(get_key, raw)
+    end
+    alias get dequeue
+
+    def peek(raw = false)
+      @kestrel.get(peek_key, raw)
+    end
+
+    def abort
+      @kestrel.get(abort_key)
+    end
+
+    def timeout
+      options[:timeout]
+    end
+
+    def reliable?
+      options[:reliable]
+    end
+
+  protected
+    def get_key
+      @get_key ||= reliable? ? close_open_key : plain_key
+    end
+
+    def plain_key
+      @plain_key ||= "#{queue_name}/t=#{timeout}"
+    end
+
+    def peek_key
+      @peek_key ||= "#{queue_name}/peek"
+    end
+
+    def close_open_key
+      @close_open_key ||= "#{queue_name}/close/open/t=#{timeout}"
+    end
+
+    def open_key
+      @open_key ||= "#{queue_name}/open/t=#{timeout}"
+    end
+
+    def close_key
+      @close_key ||= close_key = "#{queue_name}/close"
+    end
+
+    def abort_key
+      @abort_key ||= abort_key = "#{queue_name}/abort"
+    end
+
+    def validate_queue_options(opts)
+      options = default_options.merge(opts)
+      unknown_keys = (options.keys - valid_keys)
+      raise "Unknown queue options: #{unknown_keys.inspect}" unless unknown_keys.empty?
+      options
+    end
+
+    def valid_keys
+      [:reliable, :timeout]
+    end
+
+    def default_options
+      {
+        :reliable => true,
+        :timeout  => 500, #ms
+      }
+    end
+
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'kestrelrb'
+
+class Test::Unit::TestCase
+end

data/test/test_kestrelrb.rb

@@ -0,0 +1,80 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../lib/kestrelrb.rb'
+require 'test/unit'
+class ReliableQueueTest < Test::Unit::TestCase
+  
+  QUEUE_NAME = 'test_queue'
+  
+  def setup
+    @q = Kestrel::Queue.new(QUEUE_NAME, :timeout => 100)
+    @q.drop
+    @q.on_error do |exception, msg|
+      puts "Exception: #{exception.class}: #{exception.message} (Message: #{msg})"
+    end
+  end
+
+  def teardown
+    @q.drop
+  end
+
+  def test_empty
+    assert_equal nil, @q.get
+  end
+
+  def test_enqueue_dequeue
+    s = random_string
+    @q.enqueue(s)
+    assert_equal s, @q.dequeue
+  end
+
+  def test_peek
+    assert_equal nil, @q.dequeue
+    s = random_string
+    @q.enqueue(s)
+    assert_equal s, @q.peek
+    assert_equal s, @q.peek
+    assert_equal s, @q.dequeue
+    assert_equal nil, @q.dequeue
+  end
+
+  def test_explicit_requeue
+    assert_equal nil, @q.get
+    s = random_string
+    @q.enqueue(s)
+    assert_equal s, @q.dequeue # First time
+    @q.abort # requeue
+    assert_equal s, @q.dequeue # Second time
+    assert_equal nil, @q.dequeue
+  end
+
+  # FIXME: This test depends on FIFO, even though Kestrel does not guarantee ordering
+  def test_subscribe
+    
+    100.times do
+      @q.enqueue(random_string)
+    end
+    @q.enqueue("LAST MESSAGE")
+    
+    results = []
+    @q.on_error do
+      assert_equal 100, results.size
+    end
+    
+    @q.subscribe do |msg|
+      raise Kestrel::Queue::Unsubscribe if msg == "LAST MESSAGE"
+      results << msg
+    end
+    
+  end
+
+  def test_stats
+    stats = @q.stats
+    assert stats.is_a?(Hash)
+    assert stats['localhost:22133']['bytes_read'].is_a?(Numeric)
+  end
+  
+protected
+  def random_string
+    "This is a test #{rand(10_000)}"
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: kestrelrb
+version: !ruby/object:Gem::Version 
+  version: 0.8.0
+platform: ruby
+authors: 
+- Kevin E. Hunt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: memcache-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.5
+    version: 
+description: Kestrel is a queue server written in Scala that runs on the JVM and has a memcached wire API.
+email: kevin@kev.in
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/kestrelrb.rb
+- test/helper.rb
+- test/test_kestrelrb.rb
+has_rdoc: true
+homepage: http://github.com/kevn/kestrelrb
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Ruby interface to Kestrel queues
+test_files: 
+- test/helper.rb
+- test/test_kestrelrb.rb