qup 1.2.0 → 1.4.0

data/HISTORY.rdoc

@@ -1,12 +1,45 @@
 = Changelog
 
+== Version 1.4.0 - 2012-10-31
+
+* Switch to 'kjess' as the Kestrel client.
+
+== Version 1.3.6 - 2012-09-06
+
+* Pass options to the Adapters (thanks rafer)
+
+== Version 1.3.5 - 2012-09-06
+
+* Rename 'Drainer' to 'BatchConsumer' and add documentation (issue #11, thanks rafer)
+
+== Version 1.3.4 - 2012-08-23
+
+* Add 'Drainer' class (issue #10, thanks rafer)
+
+== Version 1.3.3 - 2012-08-06
+
+* Fix newline bug (issue #9, thanks rafer)
+
+== Version 1.3.2 - 2012-07-17
+
+* Make Queue#consume non-blocking everywhere (issue #7, thanks rafer)
+
+== Version 1.3.1 - 2012-06-21
+
+* Add Consumer#depth
+* Check if the data payload is marshalled data and unmarshal it if it is.
+
+== Version 1.2.2 - 2012-05-17
+
+* Use the thrift interface to kestrel instead of the memcache interface
+
 == Version 1.2.0 - 2012-03-17
 
-* Persistent subscriptions for the Redis Adapter (thanks aniero)
+* Persistent subscriptions for the Redis Adapter (issue #2, thanks aniero)
 
 == Version 1.1.0 - 2012-03-12
 
-* Addition of a Redis Adapter (thanks aniero)
+* Addition of a Redis Adapter (issue #1, thanks aniero)
 
 == Version 1.0.0 - 2012-03-10
 

data/Manifest.txt

@@ -18,6 +18,8 @@ lib/qup/adapter/redis.rb
 lib/qup/adapter/redis/connection.rb
 lib/qup/adapter/redis/queue.rb
 lib/qup/adapter/redis/topic.rb
+lib/qup/backoff_sleeper.rb
+lib/qup/batch_consumer.rb
 lib/qup/consumer.rb
 lib/qup/message.rb
 lib/qup/producer.rb
@@ -39,6 +41,8 @@ spec/qup/adapter/redis/topic_spec.rb
 spec/qup/adapter/redis_context.rb
 spec/qup/adapter/redis_spec.rb
 spec/qup/adapter_spec.rb
+spec/qup/backoff_sleeper_sleeper_spec.rb
+spec/qup/batch_consumer_spec.rb
 spec/qup/consumer_spec.rb
 spec/qup/message_spec.rb
 spec/qup/producer_spec.rb

data/README.rdoc

@@ -99,7 +99,8 @@ install additional gems. At the current moment, these are the supported
 messaging backends.
 
 * Qup::Adapter::Maildir - built in and uses the 'maildir' gem
-* Qup::Adapter::Kestrel - uses the 'kestrel-client' gem
+* Qup::Adapter::Kestrel - uses the 'kjess' gem
+* Qup::Adapter::Redis   - uses the 'redis' gem
 
 == INSTALL
 
@@ -123,13 +124,22 @@ Other tasks are viewable with
 
 To run the Kestrel tests you will need:
 
-* gem install kestrel-client
+* gem install kjess
 * A Kestrel server running on <tt>localhost:22133</tt>
 
 You can download Kestrel from http://robey.github.com/kestrel/ and then run the
 +scripts/devel.sh+ command and you will have a default Kestrel server running on
 <tt>localhost:22133</tt>. This will be enough to run the kestrel tests.
 
+=== Redis
+
+To run the Redis tests you will need:
+
+* gem install redis
+* A Redis server running on <tt>localhost:6479</tt>
+
+You can download redis using brew, macports or your favorite linux package
+manager.
 
 == LICENSE
 

data/Rakefile

@@ -7,17 +7,28 @@ This.homepage = "http://github.com/copiousfreetime/#{ This.name }"
 This.version  = Util.version
 
 #------------------------------------------------------------------------------
-# If you want to Develop on qup just run 'rake develop' and you'll have all you
-# need to get going. If you want to use bundler for development, then run
-# 'rake develop:using_bundler'
+# If you want to Develop on this project just run 'rake develop' and you'll
+# have all you need to get going. If you want to use bundler for development,
+# then run 'rake develop:using_bundler'
 #------------------------------------------------------------------------------
 namespace :develop do
+
+  # Install all the development and runtime dependencies of this gem using the
+  # gemspec.
   task :default do
     require 'rubygems/dependency_installer'
     installer = Gem::DependencyInstaller.new
 
+    # list these here instead of gem dependencies since there is not a way to
+    # sepcify ruby version specific dependencies
+    if RUBY_VERSION < "1.9.2"
+      Util.platform_gemspec.add_development_dependency( 'rcov', '~> 1.0.0' )
+    else
+      Util.platform_gemspec.add_development_dependency( 'simplecov', '~> 0.6.4' )
+    end
+
     puts "Installing gem depedencies needed for development"
-    This.gemspec.dependencies.each do |dep|
+    Util.platform_gemspec.dependencies.each do |dep|
       if dep.matching_specs.empty? then
         puts "Installing : #{dep}"
         installer.install dep
@@ -28,6 +39,7 @@ namespace :develop do
     puts "\n\nNow run 'rake test'"
   end
 
+  # Create a Gemfile that just references the gemspec
   file 'Gemfile' => :gemspec do
     File.open( "Gemfile", "w+" ) do |f|
       f.puts 'source :rubygems'
@@ -39,13 +51,15 @@ namespace :develop do
   task :using_bundler => 'Gemfile' do
     puts "Now you can 'bundle'"
   end
+
+  # Gemfiles are build artifacts
   CLOBBER << FileList['Gemfile*']
 end
 desc "Boostrap development"
 task :develop => "develop:default"
 
 #------------------------------------------------------------------------------
-# RSpec
+# RSpec - standard RSpec rake task
 #------------------------------------------------------------------------------
 begin
   require 'rspec/core/rake_task'
@@ -59,7 +73,8 @@ rescue LoadError
 end
 
 #------------------------------------------------------------------------------
-# RDoc
+# RDoc - standard rdoc rake task, although we must make sure to use a more
+#        recent version of rdoc since it is the one that has 'tomdoc' markup
 #------------------------------------------------------------------------------
 begin
   gem 'rdoc' # otherwise we get the wrong task from stdlib
@@ -76,23 +91,38 @@ rescue LoadError
 end
 
 #------------------------------------------------------------------------------
-# Coverage
+# Coverage - optional code coverage, rcov for 1.8 and simplecov for 1.9, so
+#            for the moment only rcov is listed.
 #------------------------------------------------------------------------------
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |t|
-    t.libs      << 'spec'
-    t.pattern   = 'spec/**/*_spec.rb'
-    t.verbose   = true
-    t.rcov_opts << "-x ^/"           # remove all the global files
-    t.rcov_opts << "--sort coverage" # so we see the worst files at the top
+if RUBY_VERSION < "1.9.2"
+  begin
+    require 'rcov/rcovtask'
+    Rcov::RcovTask.new( :coverage ) do |t|
+      t.libs      << 'spec'
+      t.pattern   = 'spec/**/*_spec.rb'
+      t.verbose   = true
+      t.rcov_opts << "-x ^/"           # remove all the global files
+      t.rcov_opts << "--sort coverage" # so we see the worst files at the top
+    end
+  rescue LoadError
+    Util.task_warning( 'rcov' )
+  end
+else
+  begin
+    require 'simplecov'
+    desc "Run tests with code coverage"
+    task :coverage do
+      ENV['COVERAGE'] = 'true'
+      Rake::Task[:test].execute
+    end
+  rescue LoadError
+    Util.task_warning( 'simplecov' )
   end
-rescue LoadError
-  Util.task_warning( 'rcov' )
 end
 
 #------------------------------------------------------------------------------
-# Manifest - most of this is from Hoe
+# Manifest - We want an explicit list of thos files that are to be packaged in
+#            the gem. Most of this is from Hoe.
 #------------------------------------------------------------------------------
 namespace 'manifest' do
   desc "Check the manifest"
@@ -126,7 +156,8 @@ end
 #------------------------------------------------------------------------------
 # Gem Specification
 #------------------------------------------------------------------------------
-This.gemspec = Gem::Specification.new do |spec|
+This.gemspec = Hash.new
+This.gemspec['ruby'] = Gem::Specification.new do |spec|
   spec.name        = This.name
   spec.version     = This.version
   spec.author      = This.author
@@ -145,37 +176,52 @@ This.gemspec = Gem::Specification.new do |spec|
                         "--markup", "tomdoc" ]
 
   # The Runtime Dependencies
-  spec.add_runtime_dependency( 'maildir', '~> 2.0.0' )
+  spec.add_runtime_dependency( 'maildir', '~> 2.1.0' )
 
   # Additional functionality if used
-  spec.add_development_dependency( 'kestrel-client'  , '~> 0.7.1' )
-  spec.add_development_dependency( 'redis'           , '~> 2.2.2' )
-  spec.add_development_dependency( 'SystemTimer'     , '~> 1.2.3' )
+  spec.add_development_dependency( 'kjess' , '~> 1.0.0' )
+  spec.add_development_dependency( 'redis' , '~> 3.0.2' )
 
   # The Development Dependencies
   spec.add_development_dependency( 'rake'  , '~> 0.9.2.2')
-  spec.add_development_dependency( 'rcov'  , '~> 1.0.0'  )
-  spec.add_development_dependency( 'rspec' , '~> 2.8.0'  )
+  spec.add_development_dependency( 'rspec' , '~> 2.11.0' )
   spec.add_development_dependency( 'rdoc'  , '~> 3.12'   )
 
 end
+
+# The name of the gemspec file on disk
 This.gemspec_file = "#{This.name}.gemspec"
 
+# Really this is only here to support those who use bundler
 desc "Build the #{This.name}.gemspec file"
 task :gemspec do
   File.open( This.gemspec_file, "wb+" ) do |f|
-    f.write This.gemspec.to_ruby
+    f.write Util.platform_gemspec.to_ruby
   end
 end
+
+# the gemspec is also a dev artifact and should not be kept around.
 CLOBBER << This.gemspec_file
 
+# The standard gem packaging task, everyone has it.
 require 'rubygems/package_task'
-Gem::PackageTask.new( This.gemspec ) do
+Gem::PackageTask.new( Util.platform_gemspec ) do
   # nothing
 end
 
 #------------------------------------------------------------------------------
-# Release
+# Release - the steps we go through to do a final release, this is pulled from
+#           a compbination of mojombo's rakegem, hoe and hoe-git
+#
+# 1) make sure we are on the master branch
+# 2) make sure there are no uncommitted items
+# 3) check the manifest and make sure all looks good
+# 4) build the gem
+# 5) do an empty commit to have the commit message of the version
+# 6) tag that commit as the version
+# 7) push master
+# 8) push the tag
+# 7) pus the gem
 #------------------------------------------------------------------------------
 task :release_check do
   unless `git branch` =~ /^\* master$/
@@ -186,17 +232,25 @@ task :release_check do
   end
 end
 
-desc "Create tag v#{This.version}, build and push #{This.gemspec.full_name} to rubygems.org"
+desc "Create tag v#{This.version}, build and push #{Util.platform_gemspec.full_name} to rubygems.org"
 task :release => [ :release_check, 'manifest:check', :gem ] do
   sh "git commit --allow-empty -a -m 'Release #{This.version}'"
   sh "git tag -a -m 'v#{This.version}' v#{This.version}"
   sh "git push origin master"
   sh "git push origin v#{This.version}"
-  sh "gem push pkg/#{This.gemspec.full_name}.gem"
+  sh "gem push pkg/#{Util.platform_gemspec.full_name}.gem"
 end
 
 #------------------------------------------------------------------------------
-# Rakefile Support
+# Rakefile Support - This is all the guts and utility methods that are
+#                    necessary to support the above tasks.
+#
+# Lots of Credit for this Rakefile goes to:
+#
+#   Ara T. Howard       - see the Rakefile in all of his projects -
+#                          https://github.com/ahoward/
+#   Tom Preston Werner  - his Rakegem project https://github.com/mojombo/rakegem
+#   Seattle.rb          - Hoe - cuz it has relly good stuff in there
 #------------------------------------------------------------------------------
 BEGIN {
 
@@ -232,16 +286,22 @@ BEGIN {
       abort "You need a Manifest.txt" unless File.readable?( "Manifest.txt" )
       File.readlines( "Manifest.txt" ).map { |l| l.strip }
     end
+
+    def self.platform_gemspec
+      This.gemspec[This.platform]
+    end
   end
 
   # Hold all the metadata about this project
   This = OpenStruct.new
+  This.platform = (RUBY_PLATFORM == "java") ? "java" : Gem::Platform::RUBY
+
   desc = Util.section_of( 'README.rdoc', 'DESCRIPTION')
   This.summary     = desc.first
   This.description = desc.join(" ").tr("\n", ' ').gsub(/[{}]/,'').gsub(/\[[^\]]+\]/,'') # strip rdoc
 
 
-  This.exclude_from_manifest = %r/tmp$|\.(git|DS_Store)|^(doc|coverage|pkg)|\.gemspec$|\.swp$|\.jar|\.rvmrc$|~$/
+  This.exclude_from_manifest = %r/tmp$|\.(git|DS_Store)|^(doc|coverage|pkg)|\.gemspec$|\.swp$|\.jar|\.rvmrc$|^kestrel|~$/
   This.manifest = Util.read_manifest
 
 }

data/lib/qup.rb

@@ -1,6 +1,6 @@
 module Qup
   # The Current Version of the library
-  VERSION = '1.2.0'
+  VERSION = '1.4.0'
 
   class Error < StandardError; end
 
@@ -23,13 +23,14 @@ module Qup
   KNOWN_ADAPTERS = {
     # require => gem
     'maildir' => 'maildir',
-    'kestrel' => 'kestrel-client',
+    'kestrel' => 'kjess',
     'redis'   => 'redis'
   }
 end
 
 require 'qup/adapter'
 require 'qup/consumer'
+require 'qup/batch_consumer'
 require 'qup/message'
 require 'qup/producer'
 require 'qup/publisher'
@@ -37,6 +38,7 @@ require 'qup/queue_api'
 require 'qup/session'
 require 'qup/subscriber'
 require 'qup/topic_api'
+require 'qup/backoff_sleeper'
 
 # Load the known adapters, print a warning if $VERBOSE is set
 Qup::KNOWN_ADAPTERS.each do |adapter, gemname|

data/lib/qup/adapter/kestrel.rb

@@ -1,5 +1,5 @@
 require 'qup/adapter'
-require 'kestrel-client'
+require 'kjess'
 
 class Qup::Adapter
   # Internal: The backing adapter for Qup that uses Kestrel as the messaging
@@ -14,8 +14,11 @@ class Qup::Adapter
     # uri - the URI instance for this adapter to use
     def initialize( uri, options = {} )
       @uri        = uri
-      @addr       = "#{@uri.host}:#{@uri.port}"
-      @options    = options
+      @host       = @uri.host
+      @port       = @uri.port.to_i
+      @client_options = options.merge( :host => @host, :port => @port )
+      @client     = KJess::Client.new( @client_options )
+      @client.ping
       @closed     = false
     end
 
@@ -25,7 +28,7 @@ class Qup::Adapter
     #
     # Returns a Qup::Queue
     def queue( name )
-      Qup::Adapter::Kestrel::Queue.new( @addr, name )
+      Qup::Adapter::Kestrel::Queue.new( @client, name )
     end
 
     # Internal: Create a new Topic from this Adapter
@@ -34,21 +37,21 @@ class Qup::Adapter
     #
     # Returns a Qup::Topic
     def topic( name )
-      Qup::Adapter::Kestrel::Topic.new( @addr, name )
+      Qup::Adapter::Kestrel::Topic.new( @client, name )
     end
 
     # Internal: Close the Kestrel adapter
     #
     # Return nothing
     def close
-      @closed = true
+      @client.disconnect
     end
 
     # Internal: Is the Kestrel Adapter closed
     #
     # Returns true or false
     def closed?
-      @closed
+      not @client.connected?
     end
   end
 end

data/lib/qup/adapter/kestrel/destination.rb

@@ -3,21 +3,18 @@ class Qup::Adapter::Kestrel
   # Internal: The Common base class for Kestrel Topic and Queue
   #
   class Destination
-
     # Internal: the name of the Queue or Topic
     attr_reader :name
 
     # Internal: Create a new Topic or Queue
     #
     # address - the Connection Address string for the Kestrel Client
-    # name    - the String name of the Topic
+    # name    - the String name of the Topic or Queue
     #
-    # Returns a new Topic.
-    def initialize( address, name )
-      @address      = address
-      @client       = blocking_transactional_client( @address )
-      @admin_client = regular_client( @address )
-      @name         = name
+    # Returns a new Topic or Queue.
+    def initialize( client, name )
+      @client = client
+      @name   = name
       ping
     end
 
@@ -27,28 +24,15 @@ class Qup::Adapter::Kestrel
     #
     # Returns nothing.
     def destroy
-      @admin_client.delete( name )
-      @admin_client.delete( name+"_errors" )
+      @client.delete( name )
     end
 
     # Internal: Make sure the Topic or Queue exists
     #
     # Returns nothing
     def ping
-      @admin_client.peek( name )
+      @client.peek( name )
       return true
     end
-
-    #######
-    private
-    #######
-
-    def regular_client( addr )
-      Kestrel::Client.new( addr )
-    end
-
-    def blocking_transactional_client( addr )
-      Kestrel::Client::Blocking.new( Kestrel::Client::Transactional.new( regular_client(addr) ) )
-    end
   end
 end