beetle 0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.log
+doc
+pkg
+site
+test/coverage

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 XING AG
+
+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,82 @@
+= Beetle
+
+High Availability AMQP Messaging with Redundant Queues
+
+== About
+
+Beetle grew out of a project to improve an existing ActiveMQ based messaging
+infrastructure. It offers the following features:
+
+* High Availability (by using multiple message broker instances)
+* Redundancy (by replicating queues)
+* Simple client API (by encapsulating the publishing/ deduplication logic)
+
+More information can be found on the {project website}[http://xing.github.com/beetle].
+
+== Usage
+
+=== Configuration
+    # configure machines
+
+    Beetle.config do |c|
+      config.servers = "broker1:5672, broker2:5672"
+      config.redis_hosts = "redis1:6379, redis2:6379"
+    end
+
+    # instantiate a beetle client
+
+    b = Beetle::Client.new
+
+    # configure exchanges, queues, bindings, messages and handlers
+
+    b.configure do |config|
+      config.queue :test
+      config.message :test
+      config.handler(:test) { |message| puts message.data }
+    end
+
+=== Publishing
+    b.publish :test, "I'm a test message"
+
+=== Subscribing
+    b.listen
+
+:include: examples/README.rdoc
+
+== Prerequisites
+
+To set up a redundant messaging system you will need
+* at least 2 AMQP servers (we use {RabbitMQ}[http://www.rabbitmq.com/])
+* at least one Redis server (better are two in a master/slave setup)
+
+== Gem Dependencies
+
+At runtime, Beetle will use
+* {uuid4r}[http://github.com/skaes/uuid4r]
+  (which needs ossp-uuid)
+* {bunny}[http://github.com/celldee/bunny]
+* {redis-rb}[http://github.com/ezmobius/redis-rb]
+  (which needs {redis}[http://github.com/antirez/redis])
+* {amqp}[http://github.com/tmm1/amqp]
+  (which is based on {eventmachine}[http://github.com/eventmachine/eventmachine])
+* activesupport
+
+For development, you'll need
+* mocha
+* rcov
+
+== Authors
+
+{Stefan Kaes}[http://github.com/skaes],
+{Pascal Friederich}[http://github.com/paukul] and
+{Ali Jelveh}[http://github.com/dudemeister].
+
+You cand find out more about our work on our {dev blog}[http://devblog.xing.com].
+
+Copyright (c) 2010 {XING AG}[http://www.xing.com/]
+
+Released under the MIT license. For full details see MIT-LICENSE included in this
+distribution.
+
+
+

data/Rakefile

@@ -0,0 +1,114 @@
+require 'rake'
+require 'rake/testtask'
+require 'lib/beetle'
+require 'rcov/rcovtask'
+
+namespace :test do
+  namespace :coverage do
+    desc "Delete aggregate coverage data."
+    task(:clean) { rm_f "coverage.data" }
+  end
+
+  desc 'Aggregate code coverage'
+  task :coverage => "test:coverage:clean"
+
+  Rcov::RcovTask.new(:coverage) do |t|
+    t.libs << "test"
+    t.test_files = FileList["test/**/*_test.rb"]
+    t.output_dir = "test/coverage"
+    t.verbose = true
+    t.rcov_opts << "--exclude '.*' --include-file 'lib/beetle/'"
+  end
+  task :coverage do
+    system 'open test/coverage/index.html'
+  end if RUBY_PLATFORM =~ /darwin/
+end
+
+
+namespace :beetle do
+  task :test do
+    Beetle::Client.new.test
+  end
+
+  task :trace do
+    trap('INT'){ EM.stop_event_loop }
+    Beetle::Client.new.trace
+  end
+end
+
+namespace :rabbit do
+  def start(node_name, port)
+    script = File.expand_path(File.dirname(__FILE__)+"/script/start_rabbit")
+    puts "starting rabbit #{node_name} on port #{port}"
+    puts "type ^C a RETURN to abort"
+    sleep 1
+    exec "sudo #{script} #{node_name} #{port}"
+  end
+  desc "start rabbit instance 1"
+  task :start1 do
+    start "rabbit1", 5672
+  end
+  desc "start rabbit instance 2"
+  task :start2 do
+    start "rabbit2", 5673
+  end
+end
+
+namespace :redis do
+  def config_file(suffix)
+    File.expand_path(File.dirname(__FILE__)+"/etc/redis-#{suffix}.conf")
+  end
+  desc "start main redis"
+  task :start1 do
+    exec "redis-server #{config_file(:master)}"
+  end
+  desc "start slave redis"
+  task :start2 do
+    exec "redis-server #{config_file(:slave)}"
+  end
+end
+
+task :default do
+  Rake::Task[:test].invoke
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+require 'rake/rdoctask'
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'site/rdoc'
+  rdoc.title    = 'Beetle'
+  rdoc.options << '--line-numbers' << '--inline-source' << '--quiet'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name    = 'beetle'
+    gemspec.version = '0.1'
+    gemspec.summary = "High Availability AMQP Messaging with Redundant Queues"
+    gemspec.description = "A highly available, reliable messaging infrastructure"
+    gemspec.email = "developers@xing.com"
+    gemspec.homepage = "http://xing.github.com/beetle/"
+    gemspec.authors = ["Stefan Kaes", "Pascal Friederich", "Ali Jelveh"]
+    gemspec.add_dependency('uuid4r', '>=0.1.1')
+    gemspec.add_dependency('bunny', '>=0.6.0')
+    gemspec.add_dependency('redis', '>=0.1.2')
+    gemspec.add_dependency('amqp', '>=0.6.7')
+    gemspec.add_dependency('activesupport', '>=2.3.4')
+
+    gemspec.add_development_dependency('mocha')
+    gemspec.add_development_dependency('rcov')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  # puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+

data/TODO

@@ -0,0 +1,7 @@
+- docs
+- example scripts
+- let handlers decide dynamically how long to wait for a retry
+- review log levels in all logger statements
+- optimize redis accesses:
+    - combine multiple redis accesses into one
+- ack redundant messages with attempts limit 1 immediately?

data/beetle.gemspec

@@ -0,0 +1,127 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{beetle}
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Stefan Kaes", "Pascal Friederich", "Ali Jelveh"]
+  s.date = %q{2010-04-14}
+  s.description = %q{A highly available, reliable messaging infrastructure}
+  s.email = %q{developers@xing.com}
+  s.extra_rdoc_files = [
+    "README.rdoc",
+     "TODO"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "beetle.gemspec",
+     "doc/redundant_queues.graffle",
+     "etc/redis-master.conf",
+     "etc/redis-slave.conf",
+     "examples/README.rdoc",
+     "examples/attempts.rb",
+     "examples/handler_class.rb",
+     "examples/handling_exceptions.rb",
+     "examples/multiple_exchanges.rb",
+     "examples/multiple_queues.rb",
+     "examples/redis_failover.rb",
+     "examples/redundant.rb",
+     "examples/rpc.rb",
+     "examples/simple.rb",
+     "lib/beetle.rb",
+     "lib/beetle/base.rb",
+     "lib/beetle/client.rb",
+     "lib/beetle/configuration.rb",
+     "lib/beetle/deduplication_store.rb",
+     "lib/beetle/handler.rb",
+     "lib/beetle/message.rb",
+     "lib/beetle/publisher.rb",
+     "lib/beetle/r_c.rb",
+     "lib/beetle/subscriber.rb",
+     "script/start_rabbit",
+     "snafu.rb",
+     "test/beetle.yml",
+     "test/beetle/base_test.rb",
+     "test/beetle/bla.rb",
+     "test/beetle/client_test.rb",
+     "test/beetle/configuration_test.rb",
+     "test/beetle/deduplication_store_test.rb",
+     "test/beetle/handler_test.rb",
+     "test/beetle/message_test.rb",
+     "test/beetle/publisher_test.rb",
+     "test/beetle/r_c_test.rb",
+     "test/beetle/subscriber_test.rb",
+     "test/beetle_test.rb",
+     "test/test_helper.rb",
+     "tmp/master/.gitignore",
+     "tmp/slave/.gitignore"
+  ]
+  s.homepage = %q{http://xing.github.com/beetle/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{High Availability AMQP Messaging with Redundant Queues}
+  s.test_files = [
+    "test/beetle/base_test.rb",
+     "test/beetle/bla.rb",
+     "test/beetle/client_test.rb",
+     "test/beetle/configuration_test.rb",
+     "test/beetle/deduplication_store_test.rb",
+     "test/beetle/handler_test.rb",
+     "test/beetle/message_test.rb",
+     "test/beetle/publisher_test.rb",
+     "test/beetle/r_c_test.rb",
+     "test/beetle/subscriber_test.rb",
+     "test/beetle_test.rb",
+     "test/test_helper.rb",
+     "examples/attempts.rb",
+     "examples/handler_class.rb",
+     "examples/handling_exceptions.rb",
+     "examples/multiple_exchanges.rb",
+     "examples/multiple_queues.rb",
+     "examples/redis_failover.rb",
+     "examples/redundant.rb",
+     "examples/rpc.rb",
+     "examples/simple.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<uuid4r>, [">= 0.1.1"])
+      s.add_runtime_dependency(%q<bunny>, [">= 0.6.0"])
+      s.add_runtime_dependency(%q<redis>, [">= 0.1.2"])
+      s.add_runtime_dependency(%q<amqp>, [">= 0.6.7"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.4"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<uuid4r>, [">= 0.1.1"])
+      s.add_dependency(%q<bunny>, [">= 0.6.0"])
+      s.add_dependency(%q<redis>, [">= 0.1.2"])
+      s.add_dependency(%q<amqp>, [">= 0.6.7"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.4"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<uuid4r>, [">= 0.1.1"])
+    s.add_dependency(%q<bunny>, [">= 0.6.0"])
+    s.add_dependency(%q<redis>, [">= 0.1.2"])
+    s.add_dependency(%q<amqp>, [">= 0.6.7"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.4"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/etc/redis-master.conf

@@ -0,0 +1,189 @@
+# Redis configuration file example
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
+daemonize no
+
+# When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
+# You can specify a custom pid file location here.
+pidfile ./tmp/redis-master.pid
+
+# Accept connections on the specified port, default is 6379
+port 6379
+
+# If you want you can bind a single interface, if the bind option is not
+# specified all the interfaces will listen for connections.
+#
+# bind 127.0.0.1
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 300
+
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel debug
+
+# Specify the log file name. Also 'stdout' can be used to force
+# the demon to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile stdout
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT <dbid> where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+################################ SNAPSHOTTING  #################################
+#
+# Save the DB on disk:
+#
+#   save <seconds> <changes>
+#
+#   Will save the DB if both the given number of seconds and the given
+#   number of write operations against the DB occurred.
+#
+#   In the example below the behaviour will be to save:
+#   after 900 sec (15 min) if at least 1 key changed
+#   after 300 sec (5 min) if at least 10 keys changed
+#   after 60 sec if at least 10000 keys changed
+save 900 1
+save 300 10
+save 60 10000
+
+# Compress string objects using LZF when dump .rdb databases?
+# For default that's set to 'yes' as it's almost always a win.
+# If you want to save some CPU in the saving child set it to 'no' but
+# the dataset will likely be bigger if you have compressible values or keys.
+rdbcompression yes
+
+# The filename where to dump the DB
+dbfilename dump.rdb
+
+# For default save/load DB in/from the working directory
+# Note that you must specify a directory not a file name.
+dir ./tmp/master/
+
+################################# REPLICATION #################################
+
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. Note that the configuration is local to the slave
+# so for example it is possible to configure the slave to save the DB with a
+# different interval, or to listen to another port, and so on.
+#
+# slaveof <masterip> <masterport>
+
+# If the master is password protected (using the "requirepass" configuration
+# directive below) it is possible to tell the slave to authenticate before
+# starting the replication synchronization process, otherwise the master will
+# refuse the slave request.
+#
+# masterauth <master-password>
+
+################################## SECURITY ###################################
+
+# Require clients to issue AUTH <PASSWORD> before processing any other
+# commands.  This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+#
+# requirepass foobared
+
+################################### LIMITS ####################################
+
+# Set the max number of connected clients at the same time. By default there
+# is no limit, and it's up to the number of file descriptors the Redis process
+# is able to open. The special value '0' means no limts.
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+#
+# maxclients 128
+
+# Don't use more memory than the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys with an
+# EXPIRE set. It will try to start freeing keys that are going to expire
+# in little time and preserve keys with a longer time to live.
+# Redis will also try to remove objects from free lists if possible.
+#
+# If all this fails, Redis will start to reply with errors to commands
+# that will use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to most read-only commands like GET.
+#
+# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
+# 'state' server or cache, not as a real DB. When Redis is used as a real
+# database the memory usage will grow over the weeks, it will be obvious if
+# it is going to use too much memory in the long run, and you'll have the time
+# to upgrade. With maxmemory after the limit is reached you'll start to get
+# errors for write operations, and this may even lead to DB inconsistency.
+#
+# maxmemory <bytes>
+
+############################## APPEND ONLY MODE ###############################
+
+# By default Redis asynchronously dumps the dataset on disk. If you can live
+# with the idea that the latest records will be lost if something like a crash
+# happens this is the preferred way to run Redis. If instead you care a lot
+# about your data and don't want to that a single record can get lost you should
+# enable the append only mode: when this mode is enabled Redis will append
+# every write operation received in the file appendonly.log. This file will
+# be read on startup in order to rebuild the full dataset in memory.
+#
+# Note that you can have both the async dumps and the append only file if you
+# like (you have to comment the "save" statements above to disable the dumps).
+# Still if append only mode is enabled Redis will load the data from the
+# log file at startup ignoring the dump.rdb file.
+#
+# The name of the append only file is "appendonly.log"
+#
+# IMPORTANT: Check the BGREWRITEAOF to check how to rewrite the append
+# log file in background when it gets too big.
+
+appendonly yes
+
+# The fsync() call tells the Operating System to actually write data on disk
+# instead to wait for more data in the output buffer. Some OS will really flush 
+# data on disk, some other OS will just try to do it ASAP.
+#
+# Redis supports three different modes:
+#
+# no: don't fsync, just let the OS flush the data when it wants. Faster.
+# always: fsync after every write to the append only log . Slow, Safest.
+# everysec: fsync only if one second passed since the last fsync. Compromise.
+#
+# The default is "always" that's the safer of the options. It's up to you to
+# understand if you can relax this to "everysec" that will fsync every second
+# or to "no" that will let the operating system flush the output buffer when
+# it want, for better performances (but if you can live with the idea of
+# some data loss consider the default persistence mode that's snapshotting).
+
+# appendfsync always
+appendfsync everysec
+# appendfsync no
+
+############################### ADVANCED CONFIG ###############################
+
+# Glue small output buffers together in order to send small replies in a
+# single TCP packet. Uses a bit more CPU but most of the times it is a win
+# in terms of number of queries per second. Use 'yes' if unsure.
+glueoutputbuf yes
+
+# Use object sharing. Can save a lot of memory if you have many common
+# string in your dataset, but performs lookups against the shared objects
+# pool so it uses more CPU and can be a bit slower. Usually it's a good
+# idea.
+#
+# When object sharing is enabled (shareobjects yes) you can use
+# shareobjectspoolsize to control the size of the pool used in order to try
+# object sharing. A bigger pool size will lead to better sharing capabilities.
+# In general you want this value to be at least the double of the number of
+# very common strings you have in your dataset.
+#
+# WARNING: object sharing is experimental, don't enable this feature
+# in production before of Redis 1.0-stable. Still please try this feature in
+# your development environment so that we can test it better.
+shareobjects no
+shareobjectspoolsize 1024